🎉🎈🎂🍾🎊🍻💃
Automated attendance checker via slack.
Simple serverless script that will query for user presence as a means of determining attendance.
The daily portion is achieved with a configured CRON job on Webtask. This job will invoke a function that POSTs to a Slack Incoming Webhook. We query slack for channels created on the day of execution (assuming a fresh channel has been started pertaining to contents of current lecture) and based on those channels we further check for a keyword (defaults to lecture). Based on members in channels that match the above two criteria, we query for presence and push to another slack channel for measurement.
Self explanatory, chatroom tool in use like...a lot. They've great API support! Super developer friendly! Great vehicle for practice content delivery.
Javascript focused serverless tool, very easy to configure and deploy. However, it is not meant to be used for more involved applications. Future iterations of this bot may have to migrate over to AWS Lambda for this reason.
There's a few steps required to deploy this script. Ideally, these steps could be made simpler - please submit PRs and ideas/issues around this!
$ <git clone repo, cd into it>
$ cd app/
$ npm install
Everything is installed locally, so you will have to use ./node_modules/.bin/<script> to run scripts. Yes, this is annoying. Yes, it is worth the pain.
If you don't have webtask CLI already set up, please do so now. Setting up Webtask CLI.
In order to properly use this script, you will have to supply some scripts. In the app/ directory you will see a .secrets.txt.sample.
First, let's copy it.
$ cd app/
$ cp .secrets.txt.sample .secrets.txt
Below, please find an explanation of what each key does. NOTE: Not all are "secrets" per-se but for now easier to keep all in one place.
SLACK_USER_TOKEN=XXXXXXXXXXX
SLACK_WEBHOOK=https://hooks.slack.com/services/XXXXXXXXXXX/XXXXXXXXXXX/XXXXXXXXXXX
BOT_DAY=tuesday,thursday
| SECRET NAME | SECRET VALUE |
|---|---|
SLACK_USER_TOKEN |
legacy user token) |
SLACK_WEBHOOK |
refers to slack incoming webhooks. Set that up here |
BOT_DAY |
days to execute bot, time is determined by CRON script |
$ cd app/
$ npm run deploy -- -t sample-task -c "50 20 * * *"
Where -c is defined CRON frequency, -t is the name of your task.
Donezo!
- Better test coverage
- More meaningful tests
- Convert more of the javascript codebase to use webpack generated 'bundle.js'
- Dedicated AWS Lambda / DynamoDB store (ie: migrate off of MyJSON API)
PRs welcome! Please follow guidelines here.
This project is a remotecontrol service.