Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/j-fuentes/bdaybot-slack
A bot that says happy birthday on Slack.
https://github.com/j-fuentes/bdaybot-slack
golang google-sheets slack slack-bot slackbot
Last synced: 1 day ago
JSON representation
A bot that says happy birthday on Slack.
- Host: GitHub
- URL: https://github.com/j-fuentes/bdaybot-slack
- Owner: j-fuentes
- Created: 2019-03-24T12:20:38.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-13T14:53:01.000Z (over 4 years ago)
- Last Synced: 2023-03-01T02:51:43.552Z (over 1 year ago)
- Topics: golang, google-sheets, slack, slack-bot, slackbot
- Language: Go
- Size: 513 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# bdaybot-slack
This is a program that reads a list of people with their birthdays from a Google Spreadsheet, and says happy bday in Slack.
This is intended to be run by some external mechanism once a day. I run it in a Kubernetes CronJob (see section [**Run on Kubernetes**](./README.md#run-on-kubernetes) section below).
[](https://drive.google.com/file/d/1C6o5qxoTbUxGmmxbXkJMcEWHrllnBxxo/view?usp=sharing)
## Inputs
This uses two input files:
**config.json**
Holds all the configurable options for the app. You can just copy and edit the example in this repo ([config.json.example](./config.json.example)).
Here you have a brief description of the fields in the file:
- `calendar.google_sheet.url`: url to the Google spreadsheet with the list of bdays. You can [make a copy from this example](https://docs.google.com/spreadsheets/d/1f1GJ7MnUgQOC-RsbB4Vi_m3YnjQqTNbE5_-hyIbfuUk/edit?usp=sharing).
- `oauth2.client_id` and `oauth2.client_secret`: these are the credentials of the client part of the oauth client, used for the authentication against Google. You can find more info about how to get this setup [here](./docs/client_oauth.md).
- `slack.webhook_url`: Slack webhook url where to send the happy bday messages. See [instructions here](./docs/slack_webhooks.md).
- `slack.admin_webhook_url`: Slack webhook url where to send errors, or other events. See [instructions here](./docs/slack_webhooks.md).
- `slack.salute_prefix` and `slack.salute_suffix`: These are used to compose the happy birthday message, which would be something like `@alice and @bob`. You can use emojis!
**token.json**
Holds the information that the app uses to authenticate against Google in order to get access to the spreadsheet.
You can generate it by running the tool with `-auth` argument.
## Standalone run
### Using the binary
You can execute the auth flow by running `bdayboy -auth`.
The normal operation is executed when you call the binary without arguments: `bdaybot`.
There is a help command that shows the different configurable options: `bdaybot -help`.
In order to log some interesting messages on screen run `bdaybot -logtostderr`.
It will try to read `config.json` and `token.json` from the working directory.
### Using docker
You can use the same functionality with the docker image. Notice you will need to mount `config.json` and `token.json`:
```
# From the root directory of this repository
touch token.json
cp config.json.example config.json # Create the config.json file from the test one for the first run
docker run -ti -v $PWD/token.json:/token.json -v $PWD/config.json:config.json josefuentes/bdaybot-slack -auth
```
The docker image logs event to stderr by default.
```
docker run -ti -v $PWD/config.json:/config.json -v $PWD/token.json:/token.json josefuentes/bdaybot-slack
```
## Run on Kubernetes
This is a way of running this in Kubernetes using a [CronJob](https://kubernetes.io/docs/concepts/workloads/controllers/cron-jobs/).
Create the `bdaybot` namespace and the CronJob by running:
```
kubectl create -f kubernetes.yml
```
Then, create the secrets for the config and the auth token by running:
```
kubectl -n bdaybot create secret generic bdaybot-config --from-file=/tmp/bday/config.json
```
and
```
kubectl -n bdaybot create secret generic bdaybot-token --from-file=/tmp/bday/token.json
```
The CronJob is configured to run daily (check [`kubernetes.yml`](./kubernetes.yml))
## Build from scratch
### Using Docker
You can build a minimal docker image by running:
```
docker build -t .
```
### Just Go
Just run `go build -o bdaybot` and a binary called `bdaybot` will be generated.