Awesome
OpenCompany Bot
Background
In the kingdom of glass everything is transparent, and there is no place to hide a dark heart.
Teams struggle to keep everyone on the same page. People are hyper-connected in the moment with chat and email, but it gets noisy as teams grow, and people miss key information. Everyone needs clear and consistent leadership, and the solution is surprisingly simple and effective - great leadership updates that build transparency and alignment.
With that in mind we designed Carrot, a software-as-a-service application powered by the open source OpenCompany platform and a source-available web UI.
With Carrot, important company updates, announcements, stories, and strategic plans create focused, topic-based conversations that keep everyone aligned without interruptions. When information is shared transparently, it inspires trust, new ideas and new levels of stakeholder engagement. Carrot makes it easy for leaders to engage with employees, investors, and customers, creating alignment for everyone.
Transparency expectations are changing. Organizations need to change as well if they are going to attract and retain savvy teams, investors and customers. Just as open source changed the way we build software, transparency changes how we build successful companies with information that is open, interactive, and always accessible. Carrot turns transparency into a competitive advantage.
To get started, head to: Carrot
Overview
The OpenCompany Bot handles interacting with OpenCompany users via Slack conversations.
Local Setup
Prospective users of Carrot should get started by going to Carrot.io. The following local setup is for developers wanting to work on the OpenCompany Bot Service.
Most of the dependencies are internal, meaning Leiningen will handle getting them for you. There are a few exceptions:
- Java - a Java 8+ JRE is needed to run Clojure
- Leiningen - Leiningen 2.9.1+ is a Clojure build and dependency management tool
Java
Your system may already have Java 8+ installed. You can verify this with:
java -version
If you do not have Java 8+ download it and follow the installation instructions.
An option we recommend is OpenJDK. There are instructions for Linux and Homebrew can be used to install OpenJDK on a Mac with:
brew update && brew cask install adoptopenjdk8
Leiningen
Leiningen is easy to install:
- Download the latest lein script from the stable branch.
- Place it somewhere that's on your $PATH (
env | grep PATH)./usr/local/binis a good choice if it is on your PATH. - Set it to be executable.
chmod 755 /usr/local/bin/lein - Run it:
leinThis will finish the installation.
Then let Leiningen install the rest of the dependencies:
git clone https://github.com/open-company/open-company-bot.git
cd open-company-bot
lein deps
Required Configuration and Secrets
An AWS SQS queue is used to pass messages to the Bot. Setup an SQS Queue and key/secret access to the queue using the AWS Web Console or API.
An AWS S3 bucket is used to cache Slack banner images for the Bot.
Another AWS S3 bucket is used to store the 6 footer image variants. You will need to upload the footer image folders to this bucket manually via the S3 console.
For both buckets, make sure the image objects are publicly accessible from the web. This is
preferably done by selecting the object in the S3 console, going to the Permissions tab,
and then checking the Everyone box under Public access. For local development, it's
fine to just make the bucket itself public, but know that this is not acceptable in production,
as it allows anyone to list the contents of the bucket.
An API key is needed for Filestack to build URL's that do image processing.
Before running anything make sure you adjust the values in the config map.
{
:open-company-auth-passphrase "this_is_a_dev_secret" ; JWT secret
:db-name "open_company_auth_dev"
:aws-access-key-id "CHANGE-ME"
:aws-secret-access-key "CHANGE-ME"
:aws-sqs-bot-queue "CHANGE-ME" ; SQS queue to read inbound notifications/requests
:aws-sqs-storage-queue "CHANGE-ME" ; SQS queue to send requests to the Storage service
:filestack-api-key "CHANGE-ME"
:log-level "debug"
}
You can also override these settings with environmental variables in the form of AWS_ACCESS_KEY_ID, etc. Use environmental variables to provide production secrets when running in production.
You will also need to subscribe the SQS queue to the oc-storage and oc-slack SNS topics. To do this you will need to go to the AWS console and follow these instruction:
Go to the AWS SQS Console and select the bot queue configured above. From the 'Queue Actions' dropdown, select 'Subscribe Queue to SNS Topic'. Select the SNS topic you've configured your Storage Service instance to publish to, and click the 'Subscribe' button.
Shared Secrets
A secret, open-company-auth-passphrase, is shared between the OpenCompany services for creating and validating JSON Web Tokens.
Technical Design
┌─────────────────────┐
│ │
│ Slack │
│ │
└─────────────────────┘
│
│
│
HTTP
│
│
▼
┌─────────────────────┐ ┌─────────────────────┐ ┌─────────────────────┐ ┌─────────────────────┐ ┌─────────────────────┐
│ │ │ │ │ │ │ │ │ │
│ Storage Service │ │ Notify Service │ │ Auth Service │ │ Digest Service │ │Slack Router Service │
│ │ │ │ │ │ │ │ │ │
└───┬─────────────────┘ └─────────────────────┘ └─────────────────────┘ └─────────────────────┘ └─────────────────┬───┘
HTTP │ │ │ │ │ │
│ │ │ │ │ │ HTTP
Private │ │ │ │ │ │
board └───────────────────────┴───────────────────────┼───────────────────────┴───────────────────────┘ Add post
events │ events
│ HTTP │
▼ │ ▼
┌─────────────────────┐ ▼ ┌─────────────────────┐
│SNS Topic │ ┌──────────────────────────────────────┐ │SNS Topic │
│ │ │ SQS │ │ │
│ oc-storage │◀──subscribe───│ oc-bot │───subscribe────▶│ oc-slack │
│ │ │ │ │ │
└─────────────────────┘ └──────────────────────────────────────┘ └─────────────────────┘
▲
│
HTTP
│
┌─────────────────────────────────────┐
│ │
│ │
│ │
│ Bot Service │
│ │
│ │
│ │
└─────────────────────────────────────┘
│
HTTP
┌───────────────────────────────┼───────────────────────────────┐
│ │ │
▼ ▼ ▼
┌─────────────────────┐ ┌─────────────────────────────────────┐ ┌─────────────────────┐
│ │ │ │ │ │
│ Auth Service │ │ Slack API │ │ Storage Service │
│ │ │ │ │ │
└─────────────────────┘ └─────────────────────────────────────┘ └─────────────────────┘
Usage
Run the bot with: lein start
Or start a REPL with: lein repl
Start the Bot service at the REPL with (go) and stop it with (stop).
Testing
Tests are run in continuous integration of the master and mainline branches on Travis CI:
To run the tests locally:
lein kibit
lein eastwood
Participation
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
License
Distributed under the GNU Affero General Public License Version 3.
Copyright © 2015-2021 OpenCompany, LLC.
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.