iwant-bot

Slackbot project implemented by Kiwi.com interns.

The bot is supposed to collect requests of users, and notify those who have common requests and can therefore socially interact. So, for example, if Mary tells the bot at 9:00 that she wants to take a coffee break half-hour from now and Jack tells the bot the same at 9:10, the bot will notify them at some point that they can have the coffee together.

However, that's just the basic example, the bot can be used to perform much more things - check out the use cases to see more ideas!

WIP

• First internship crew started on 21th April 2017 and ended at the end of July.
• The basic stup was implemented with the idea how it shoudl works.

How to set up

• Make sure you have docker and docker-compose.
• Create your private.env file in the repository for sensitive information.
• Run database: docker-compose up -d postgres.
• Run app: docker-compose up.
• Check http://localhost:8080 in your browser.

Slack App sets up

Set up your Slack App and connect it with your Slack Team. You will obtain a token for validation of incoming requests. Create a file .env in the repository and insert your tokens: BOT_TOKEN=xoxb-111111111111-a1A1a1A1a1A1a1A1a1A1a1A1 VERIFICATION=b2B2b2B2b2B2b2B2b2B2b2B2, which are private. (And SUPER_TOKEN if you need extra privilege in Slack.)

• iwant-bot server listens to port 8080, so run localtunnel or ngrok to create public adress, which you use in your Slack App.

• The iwant-bot server recognizes slash command /iwant. Set endpoint of URL to /slack/iwant and turn on 'Escape channels, users, and links sent to your app' in Slack API: Slash Commands tab.

• The iwant-bot accept Interactiv Messages from Slack at endpoint /slack/button which should be settup in Slack API: Interactiv Messages tab.

Database sets up

Corner cases

• If a problem occurs when generating the image because it was not possible to get some dependencies, it means that the requirements.txt file needs to be regenerated from requirements.in. See requirements.txt for details on how to do it.
• If the container timezone doesn't match, override the value of the timezone build argument.
• Localtunnel can have some problems with network or stability, try ngrok.
• Do not forget to invite your bot to the channels, if it should post messages into the channel.