alinetskyi / kubot

Kubot

Kubot is a Slack support bot that uses Slack API to foward messages from workspaces that are given support to workspace that provides it. It creates a database where all registered workspaces are stored. And once Kubot is asked a question on channel in a supported workspace a corresponding channel will be created in support workspace and all the messages will be forwarded between these two channels. It's a helpful tool to manage your support workflow.

Installation

Add this line to your application's Gemfile:

gem 'kubot'

And then execute:

$ bundle

Or install it yourself as:

$ gem install kubot

Usage

Create an app on Slack.

Press Build your own app

Setup a bot and retrive your SLACK_CLIENT_ID and SLACK_CLIENT_SECRET

Find out your team id to make it a support team

Go to this link

Choose your workspace and press Test Method and then you can get your team id from the response

export SLACK_CLIENT_ID, SLACK_CLIENT_SECRET and SLACK_SUPPORT_TEAM

export SLACK_CLIENT_ID='...'
export SLACK_CLIENT_SECRET='...'
export SLACK_SUPPORT_TEAM='...'

You can also add users that will be instantly added to support channels. To do so add their user id's to SLACK_SUPPORT_USERS env variable

export SLACK_SUPPORT_USERS='USR1 USR2 USR3'

Run kubot

kubot start

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kubot.