Slack Bot Manager

Slack Bot Manager is a Ruby gem that allows for the management of multiple Slack RTM connections based on tokens. With only a few configuration changes, you can run a system for handling hundreds of simulatenous RTM connections for your Slack app.

This is in pre-release and may change before release of version 0.1.0.

How to tell if you need this:

• You are making a Slack app requiring Real-time Messaging
• You want to be able to handle multiple RTM connections
• You don't want to make your own RTM (websocket) connection manager

gem 'slack-bot-manager'

This gem requires a key-value storage system for managing tokens and connection statuses. Currently, this gem supports redis and dalli (memcached).

gem 'redis'
gem 'dalli'

To get started, get a token (or few) and start your script.

botmanager = SlackBotManager::Manager.new
botmanager.add_token('token1', 'token2', 'token3')
botmanager.start
botmanager.monitor

Once you initialize a new SlackBotManager::Manager, you can use the following connection and token methods to run your cool new Slack bot app.

You can run a manager supporting multiple RTM connections with just three lines!

botmanager = SlackBotManager::Manager.new
botmanager.start
botmanager.monitor

These are the available connecton methods:

Tokens are managed using the defined storage adapter (Redis or Dalli). SlackBotManager will manage and monitor these keys for additions, updates, and removals. New connections will be added into the key teams_key, like so:

botmanager = SlackBotManager::Manager.new
botmanager.add_token('token1', 'token2', 'token3') # takes array

These are the available token methods:

Each RTM connection handled by SlackBotManager::Manager is generated by SlackBotManager::Client. This client class assists in checking RTM (websocket) connection status, storing various attributes, and includes event listener support.

The following instance variables are accessible by Client and the included Commands module:

These are some common client methods you can use to manage incoming events and interact with Slack.

You will want to handle your own RTM event listeners to perform specific functions. This is achieved by extending the SlackBotManager:Commands module, which is included within the SlackBotManager::Client class (and access to subsequent instance variables specific to that connection).

Each event must be prefixed with on_, e.g. on_messsage will handing incoming messages.

module SlackBotManager
  module Commands
    def on_hello(data)
      puts "Connected to %s" % self.id
    end

    def on_team_join(data)
      message(data['channel'], "Welcome: %s" % data['user']['username'])
    end
  end
end

(A full list of events is available from the Slack API docs.)

You can define these configuration options as:

SlackBotManager.configure do |config|
  config.storage_adapter = SlackBotManager::Storage::Redis
  config.storage_options = {host: '0.0.0.0', port: 6379}
end

Manager configuration options include the global options (storage_adapter, storage_options, logger, log_level, & verbose), in addition to:

You can define these configuration options as:

SlackBotManager::Manager.configure do |config|
  config.storage_adapter = SlackBotManager::Storage::Redis
  config.storage_options = {host: '0.0.0.0', port: 6379}
  config.check_interval = 10 # in seconds
end

You can additionally send an existing storage method as the storage_option, such as:

$redis = Redis.new
SlackBotManager::Manager.configure do |config|
  config.storage_options = $redis
end

Client configuration options include the global options (storage_adapter, storage_options, logger, log_level, & verbose)

You can define these configuration options as:

SlackBotManager::Client.configure do |config|
  config.log_level = ::Logger::INFO
end

For customization of Slack connections, including proxy, websocket ping, endpoint, user-agent, and more, check out the slack-ruby-client README.

You can check a few creative examples in the examples folder.

This gem will be released soon, and is based on earlier work created by betaworks for PlusPlus++ Slack app.

Also thanks to slack-ruby-client.

See CONTRIBUTING.

Thanks to our contributors Greg Leuch and Alex Baldwin.

Copyright (c) 2016 Greg Leuch & betaworks.

Licensed under MIT License.