https://github.com/willowtreeapps/catalyst-slack-service
Unconscious gender bias has been fueling the gender gap for far too long. We’re releasing the #BiasCorrect code in hopes that coders around the world will adapt it for whatever chat-based platforms they use in order to give more people access to this tool for change.
https://github.com/willowtreeapps/catalyst-slack-service
Last synced: 4 months ago
JSON representation
Unconscious gender bias has been fueling the gender gap for far too long. We’re releasing the #BiasCorrect code in hopes that coders around the world will adapt it for whatever chat-based platforms they use in order to give more people access to this tool for change.
- Host: GitHub
- URL: https://github.com/willowtreeapps/catalyst-slack-service
- Owner: willowtreeapps
- License: apache-2.0
- Created: 2019-12-30T18:42:38.000Z (over 6 years ago)
- Default Branch: develop
- Last Pushed: 2020-11-11T14:41:27.000Z (over 5 years ago)
- Last Synced: 2024-04-14T23:17:07.996Z (about 2 years ago)
- Language: Java
- Homepage:
- Size: 185 KB
- Stars: 12
- Watchers: 15
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# catalyst-slack-service
A microservice that integrates Slack and [Bias Correction Service](https://github.com/willowtreeapps/catalyst-bias-correct-service). This service subscribes to message events on Slack and utilizes the Bias Correction Service for potential suggestions to replace biased terms.
## Prerequisites
* [JDK 12](https://www.oracle.com/java/technologies/javase/jdk12-archive-downloads.html)
* [sbt 1.3.5](https://www.scala-sbt.org/download.html)
* [docker](https://hub.docker.com/editions/community/docker-ce-desktop-mac)
* [redis](https://redis.io/topics/quickstart)
- ```docker run --name my-redis -p 6379:6379 --restart always --detach redis```
## Run
You can run this project using IntelliJ IDEA, Docker or terminal. You will need the same configuration variables for all 3 options.
####Environment Variables
```
REDIS_HOST={REDIS_HOST}
REDIS_PORT={REDIS_PORT}
PLAY_SECRET_KEY={PLAY_SECRET_KEY}
BIAS_CORRECT_URL={BIAS_CORRECT_URL}
SLACK_TOKEN={SLACK_TOKEN}
SLACK_SIGNING_SECRET={SIGNING_SECRET}
SLACK_CLIENT_SECRET={CLIENT_SECRET}
SLACK_CLIENT_ID={CLIENT_ID}
TRACKING_ID={TRACKING_ID}
```
`REDIS_HOST`: Defaults to localhost if not defined
`REDIS_PORT`: Defaults to 6379 if not defined
`PLAY_SECRET_KEY`: You can generate a new secret using `sbt playGenerateSecret` or if you don't already have an sbt server running `head -c 30 /dev/random | base64`.
`BIAS_CORRECT_URL`: URL for the Bias Correction Service Endpoint (ex. http://localhost:8000/corrector/correct).
`SLACK_TOKEN` && `SIGNING_SECRET` && `CLIENT_SECRET` && `CLIENT_ID`: Navigate to api.slack.com/app. Select your app and view the `Basic Information` section.
`TRACKING_ID`: Google Analytics Tracking ID (ex. UA-XXXX-Y).
### [IntelliJ IDEA](https://www.jetbrains.com/idea/)
Open Project
1. Open Project wizard, select **Import Project**.
1. In the window that opens, select this project.
1. On the next page of the wizard, select **Import project from external model** option, choose **sbt project**.
1. On the next page of the wizard, ensure that the **Project JDK** is set to **JDK 12**.
1. Enable Auto-Import for **sbt projects**.
Setup Configuration
1. Add configuration template **sbt Task**.
2. In the window that opens, enter "run" into the **Tasks** input.
3. Uncheck the **Use sbt shell** option.
4. Add the above configuration as environment variables.
Press Run
### [Docker](https://hub.docker.com/editions/community/docker-ce-desktop-mac)
sbt provides the infrastructure to easily build out a Docker image from our application. The current build.sbt file is configured with the options to use OpenJDK 12 on Alpine. This is intended to keep our shipping image as lean as possible. The application.conf file has also been updated to capture a few values from the environment when available. Finally, the build.sbt file has the option to configure the current version from an environment variable (which will be captured in the docker container tags).
Create a `prod.env` file containing all configuration outlined above. Then publish your project locally and run the container.
```
sbt docker:publishLocal
docker run -p 8000:9000 -e PLAY_SECRET_KEY="$(head -c 30 /dev/random | base64)" --env-file prod.env catalyst-slack-service:1.0-SNAPSHOT
```
In the above example, we expose the host/local port 8000 to the container's port 9000 (the default port for the Play framework). We've also chosen to generate a random secret key and use the default Docker tag. If we had specified an environment variable during the build phase (`VERSION_NUMBER=example sbt docker:publishLocal`), then our tag would be `catalyst-slack-service:example`.
### Terminal
You can also run the application using your terminal. Make sure that you have sbt 1.3.5 installed. Export the environment variables defined above if you had not done so previously, then run the application using sbt.
```
sbt version
export REDIS_HOST={REDIS_HOST} && \
export REDIS_PORT={REDIS_PORT} && \
export PLAY_SECRET_KEY={PLAY_SECRET_KEY} && \
export BIAS_CORRECT_URL={BIAS_CORRECT_URL} && \
export SLACK_TOKEN={SLACK_TOKEN} && \
export SLACK_SIGNING_SECRET={SIGNING_SECRET} && \
export SLACK_CLIENT_SECRET={CLIENT_SECRET} && \
export SLACK_CLIENT_ID={CLIENT_ID} && \
export TRACKING_ID={TRACKING_ID}
sbt run
```
## Configure Slack App
After getting your local service running you will need to use [ngrok](https://dashboard.ngrok.com/get-started) to expose your local server.
Setup and connect your ngrok account then expose your local service.
`./ngrok http 4542`
Take note of the forwarding https url. Next you need to update your Slack App with this forwarding url.
Navigate to api.slack.com/apps.
1. Update **Interactivity & Shortcuts** with the **Request URL** `{FORWARDING_URL}/bias-correct/v2/slack/actions`.
2. Update **OAuth & Permissions** with the **Redirect URL** `{FORWARDING_URL}/bias-correct/v2/slack/auth/redirect`.
3. Update **Event Subscriptions** with the **Request URL** `{FORWARDING_URL}/bias-correct/v2/slack/events`.
4. Update **Slash Commands** with the **Request URL** `{FORWARDING_URL}/bias-correct/v2/slack/help`.