slack-bot-manager 0.1.0pre1 → 0.1.0pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 211a6a7bd9fb7a2557d3c946bbf495ae562a186d
-  data.tar.gz: e2fc191df9ff401007c4f8e8e35bd2cf18302a8a
+  metadata.gz: e99eff3580607b9be5f2a6693e549ec0f4e8b111
+  data.tar.gz: f70a660184a3dc53ebcf2f8c575854d29813a615
 SHA512:
-  metadata.gz: 0349d9425e90b8b68ea9b890b2edcf255ef2896f1a7e5606c5d1fc9c8146111c0698b88ab7416ee132399b96dfbd02369e5f84bde88a181b1c69e932e08de48d
-  data.tar.gz: 128445cb7a39b80058bddd14fa89e0abda4db055fddb345ce330643a0c970c1fefbad3ec9978ebc6288226275bf1ed27625bf46b526618b5d0e7c66fbc92429f
+  metadata.gz: 926df5bbfeee60eaf86a51baff44679ea524f27f9b85cde4ff6078fea5f986556cb3c9ea714db877c57cef434d4b32564e337ce380bd7996aef750d0c561083d
+  data.tar.gz: 7165e5e5dc98dbf1745cdeec70257252c41f8f478bb0403a43bbb6012de02708e07a1deda7370a2b592cd9ac2eb5892c382624171330075ccad4339d3d591f30

data/.gitignore

@@ -4,3 +4,4 @@
 pkg
 Gemfile.lock
 tokens.yml
+slack-bot-manager-*.gem

data/.gitmodules

@@ -7,6 +7,3 @@
 [submodule "examples/botspotting"]
 	path = examples/botspotting
 	url = git@github.com:goosey/botspotting.git
-[submodule "examples/dm-bot"]
-	path = examples/dm-bot
-	url = git@github.com:gleuch/dm-bot.git

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - examples/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,81 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-02-07 01:40:37 -0500 using RuboCop version 0.36.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'spec/integration/manager_spec.rb'
+
+# Offense count: 4
+Metrics/AbcSize:
+  Max: 90
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 13
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 120
+
+# Offense count: 6
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 43
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 113
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# Offense count: 16
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/slack-bot-manager/client/base.rb'
+    - 'lib/slack-bot-manager/client/commands.rb'
+    - 'lib/slack-bot-manager/config.rb'
+    - 'lib/slack-bot-manager/errors.rb'
+    - 'lib/slack-bot-manager/extend.rb'
+    - 'lib/slack-bot-manager/logger.rb'
+    - 'lib/slack-bot-manager/manager/base.rb'
+    - 'lib/slack-bot-manager/manager/connection.rb'
+    - 'lib/slack-bot-manager/manager/storage.rb'
+    - 'lib/slack-bot-manager/manager/storage/dalli.rb'
+    - 'lib/slack-bot-manager/manager/storage/redis.rb'
+    - 'lib/slack-bot-manager/manager/tokens.rb'
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
+Style/FileName:
+  Exclude:
+    - 'lib/slack-bot-manager.rb'
+
+# Offense count: 1
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/slack-bot-manager/config.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/slack-bot-manager/config.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/RescueModifier:
+  Exclude:
+    - 'lib/slack-bot-manager/manager/connection.rb'

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0
+  - rbx-2
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-19mode
+    - rvm: rbx-2
+
+git:
+  submodules: false
+
+env:
+  #- CONCURRENCY=celluloid-io
+  - CONCURRENCY=faye-websocket

data/CHANGELOG.md

@@ -1,7 +1,7 @@
 
 ### Version 0.1.0 (20 Jan 2016)
 
-__**NOT YET RELEASED**__
+__**Pre-release at 0.1.0pre2**__
 
 This is the first version of Slack Bot Manager, and includes
 

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
+gem 'picky' unless RUBY_PLATFORM == 'java'

data/README.md

@@ -1,23 +1,43 @@
 # Slack Bot Manager
 
+[![Gem Version](https://badge.fury.io/rb/slack-bot-manager.svg)](http://badge.fury.io/rb/slack-bot-manager)
+[![Build Status](https://travis-ci.org/betaworks/slack-bot-manager.svg?branch=master)](https://travis-ci.org/betaworks/slack-bot-manager)
+[![Code Climate](https://codeclimate.com/github/betaworks/slack-bot-manager/badges/gpa.svg)](https://codeclimate.com/github/betaworks/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._
 
 
-## Installation
+__How to tell if you need this:__
 
-While this has yet to be compiled to a Ruby gem, it can be installed from this repository within your Gemfile:
+* 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', github: 'betaworks/slack-bot-manager', branch: 'master'`
 
-__**This gem requires `redis` for tracking the status of tokens.**__
-You will need to have `redis` running for this gem to work.
+## Installation
 
+`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'
+```
 
 
 ## Getting Started
 
-(TODO)
+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
+```
 
 
 
@@ -49,7 +69,7 @@ methods     | description
 
 ### Token Management Methods
 
-Tokens are managed within Redis. SlackBotManager will manage and monitor these redis keys for additions, updates, and remvoals. New connections must be added into the redis `teams_key`, like so:
+Tokens are managed using key storage, currently only supporting Redis. 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
@@ -76,7 +96,7 @@ The following instance variables are accessible by Client and the included Comma
 variable      | description
 --------------|----------------------------------------------------------------------------------------
 `connection`  | `Slack::RealTime::Client`  connection
-`id`          | Team's Slack ID (ex. `T123ABC`)
+`id`          | Team's Slack ID (ex. `T123ABC`) _(set after successful connection)_
 `token`       | Team's Slack access token (ex. `xoxb-123abc456def`)
 `status`      | Known connection status. (`connected`, `disconnected`, `rate_limited`, `token_revoked`)
 
@@ -114,7 +134,8 @@ setting           | description
 `tokens_key`      | Redis key name for where tokens' status are stored. _(default: tokens:statuses)_
 `teams_key`       | Redis key name for where teams' tokens are stored. _(default: tokens:teams)_
 `check_interval`  | Interval (in seconds) for checking connections and tokens status. _(default: 5)_
-`redis`           | Define Redis connection. _(default: Redis.new)_
+`storage_method`  | Token storage method. _(default: nil)_
+`storage_options` | Token storage method options. _(default: {})_
 `logger`          | Define the logger to use. _(default: Rails.logger or ::Logger.new(STDOUT))_
 `log_level`       | Explicity define the logger level. _(default: ::Logger::WARN)_
 `verbose`         | When true, set `log_level` to ::Logger::DEBUG. _(default: false)_
@@ -123,18 +144,47 @@ You can define these configuration options as:
 
 ```
 SlackBotManager::Manager.configure do |config|
-  config.redis = Redis.new(host: '0.0.0.0', port: 6379)
+  config.storage_method = 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:
+
+```
+SlackBotManager::Manager.configure do |config|
+  config.storage_options = $redis # Existing Redis connection, where $redis = Redis.new
+end
+```
+
+### Client configuration options
+
+setting           | description
+------------------|-----------------------------------------------------------------------------------
+`logger`          | Define the logger to use. _(default: Rails.logger or ::Logger.new(STDOUT))_
+`log_level`       | Explicity define the logger level. _(default: ::Logger::WARN)_
+`verbose`         | When true, set `log_level` to ::Logger::DEBUG. _(default: false)_
+
+You can define these configuration options as:
+
+```
+SlackBotManager::Client.configure do |config|
+  config.check_interval = 10 # in seconds
+  config.log_level = ::Logger::INFO
+end
+```
+
+
+### Additional configuration options
+
 For customization of Slack connections, including proxy, websocket ping, endpoint, user-agent, and more, check out the [slack-ruby-client README](https://github.com/dblock/slack-ruby-client/blob/master/README.md).
 
 
 
 ## Examples
 
-(TODO)
+You can check a few creative examples in the [examples](examples/) folder.
 
 
 
@@ -150,6 +200,7 @@ Also thanks to [slack-ruby-client](https://github.com/dblock/slack-ruby-client).
 
 See [CONTRIBUTING](CONTRIBUTING.md).
 
+Thanks to our contributors [Greg Leuch](https://gleu.ch) and [Alex Baldwin](http://goose.im).
 
 
 ## Copyright and License

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/examples/dm-bot/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+ruby '2.2.3'
+
+gem 'slack-bot-manager'
+gem 'redis'

data/examples/dm-bot/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    eventmachine (1.0.9.1)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    faye-websocket (0.10.2)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
+    gli (2.13.4)
+    hashie (3.4.3)
+    json (1.8.3)
+    multipart-post (2.0.0)
+    redis (3.2.2)
+    slack-bot-manager (0.1.0pre1)
+      faye-websocket (>= 0.10.0)
+      redis (>= 3.2.2)
+      slack-ruby-client (>= 0.5.1)
+    slack-ruby-client (0.6.0)
+      faraday
+      faraday_middleware
+      gli
+      hashie
+      json
+      websocket-driver
+    websocket-driver (0.6.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  redis
+  slack-bot-manager
+
+BUNDLED WITH
+   1.10.6

data/examples/dm-bot/README.md

@@ -0,0 +1,23 @@
+# DM-Bot
+
+An exmaple bot for handling direct messages with users using [slack-bot-manager](https://github.com/betaworks/slack-bot-manager).
+
+## Installation
+
+
+Install `slack-bot-manager` and move over your `tokens.yml` file.
+
+```
+bundle install
+mv tokens.yml.sample tokens.yml
+```
+
+Add your token(s) into `tokens.yml`.
+
+Run it! `ruby dm-bot.rb`
+
+
+## License & Copyright
+
+Copyright 2016 Greg Leuch & betaworks.
+Licensed under MIT

data/examples/dm-bot/dm-bot.rb

@@ -0,0 +1,98 @@
+#
+# dm-bot.rb
+# -------------------------------------------------
+#
+# Example created for slack-bot-manager by @gleuch.
+# License: MIT
+# https://github.com/betaworks/slack-bot-manager
+#
+# -------------------------------------------------
+#
+# To get started:
+#   1. Run: `mv tokens.yml.sample tokens.yml`
+#   2. Add your token(s) to tokens.yml
+#   3. Run: `ruby dm-bot.rb`
+#
+
+
+# Require necessary gems
+require 'yaml'
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require
+
+# Use Redis and configure slack-bot-manager
+$redis = Redis.new
+SlackBotManager.configure do |config|
+  config.storage_options = $redis # Set entire instance as option
+end
+
+# Extend commands to handle what we want done
+module SlackBotManager
+  module Commands
+
+    def on_message(data)
+      # Only support DMs with bot
+      return unless data['channel'].start_with?('D')
+
+      # Get user info
+      user_key = ['users', self.id, data['user']].join(':')
+      $redis.del user_key
+      unless $redis.exists user_key
+        # Get user info from Slack
+        user_info = self.connection.web_client.users_info(user: data['user'])['user']
+
+        # Store the basics into redis for quicker lookups
+        $redis.hmset user_key, *{ id: user_info['id'], name: user_info['name'], real_name: user_info['real_name'], is_bot: user_info['is_bot'] ? 1 : 0 }.flatten
+        # Expire this redis key weekly so that we do regular updates
+        $redis.expire user_key, 604800 # 1 week in seconds
+      end
+      user_info = $redis.hgetall user_key
+
+      return if [1,'1','true'].include?(user_info['is_bot'])
+
+      # Get IM info, send hello message if first time
+      im_key = ['ims', self.id, data['channel']].join(':')
+      $redis.del im_key
+      unless $redis.exists im_key
+        $redis.hmset im_key, *{ id: data['channel'], user: user_info['id'], started: Time.now.to_i, messages_sent: 0, messages_received: 0 }.flatten
+        self.send_message(data['channel'], "Hello there <@#{user_info['id']}>! I'm happy to listen to what you have to say. :simple_smile:")
+        $redis.hincrby im_key, 'messages_sent', 1
+      end
+      im_info = $redis.hgetall im_key
+
+      # Increment message count
+      $redis.hincrby im_key, 'messages_received', 1
+
+      # Parse message contents
+      message = 'If i was smarter, I would respond with something witty.'
+
+      self.send_message(data['channel'], message)
+      $redis.hincrby im_key, 'messages_sent', 1
+    end
+
+  end
+end
+
+# Initialize SlackBotManager
+@bot_manager = SlackBotManager::Manager.new
+
+# Load tokens from YAML list
+tokens = YAML.load_file('tokens.yml')['tokens']
+@bot_manager.add_token(*tokens) # Add tokens
+
+# Close connections on sig interrupts
+['INT','TERM'].each do |s|
+  Signal.trap(s) do
+    @bot_manager.stop
+    @bot_manager.clear_tokens
+    exit
+  end
+end
+
+# Start the RTM connections
+@bot_manager.start
+
+# Lets monitor the connection
+@bot_manager.monitor

data/examples/dm-bot/tokens.yml.sample

@@ -0,0 +1,2 @@
+tokens:
+  - 'FIRST TOKEN HERE'

data/lib/slack-bot-manager/client/base.rb

@@ -1,6 +1,5 @@
 module SlackBotManager
   class Client
-
     include Commands
     include Errors
     include Logger
@@ -8,9 +7,13 @@ module SlackBotManager
     attr_accessor :commands, :connection, :id, :token, :status
     attr_accessor(*Config::CLIENT_ATTRIBUTES)
 
-    def initialize(id, token, *args)
+    def initialize(token, *args)
       options = args.extract_options!
-      @id, @token, @events, @status = id, token, options[:events] || {}, :disconnected
+
+      # Option values
+      @token = token
+      @id = options[:id]
+      @status = :disconnected
 
       # Setup client and assign commands
       @connection = Slack::RealTime::Client.new(token: @token)
@@ -21,28 +24,34 @@ module SlackBotManager
       end
 
       # Assign commands
-      self.methods.each do |n|
+      methods.each do |n|
         # Require methods to include on_*
-        next unless n.match(/^on_/) && self.respond_to?(n)
+        next unless n.match(/^on_/) && respond_to?(n)
         assign_event(n.to_s.gsub(/^on_/, ''), n)
       end
+    end
 
-      connect
+    # Pull info from slack-ruby-client gem
+    SlackBotManager::Config::RTM_CLIENT_METHODS.each do |attr|
+      define_method "client_#{attr}" do
+        connection.send(attr) if connected?
+      end
     end
 
     def connect
       connection.start_async
+      @id ||= client_team['id']
       @status = :connected
     rescue => err
       handle_error(err)
     end
 
-    def disconnect(reason=:disconnected)
+    def disconnect(reason = nil)
       connection && connection.stop!
     rescue => err
       handle_error(err)
     ensure
-      @status = reason if @status == :connected
+      @status = reason || :disconnected # if @status == :connected
       remove_instance_variable(:@connection) if @connection
     end
 
@@ -54,8 +63,15 @@ module SlackBotManager
       !connected?
     end
 
+    def on(evt, &block)
+      self.class.send(:define_method, "on_#{evt}", &block)
+      assign_event(evt, "on_#{evt}")
+    end
 
-  protected
+    def off(evt)
+      self.class.send(:remove_method, "on_#{evt}")
+      unassign_event(evt)
+    end
 
     def send_message(channel, text, *args)
       options = args.extract_options!
@@ -65,6 +81,8 @@ module SlackBotManager
       connection.message(options)
     end
 
+    protected
+
     def assign_event(evt, evt_name)
       connection.on(evt) do |data|
         begin
@@ -75,15 +93,33 @@ module SlackBotManager
       end
     end
 
+    def unassign_event(evt)
+      connection.off(evt) if connection
+    end
+
     # Handle different error cases
-    def handle_error(err, data=nil)
+    def handle_error(err, data = nil)
       case determine_error_type(err)
-        when :token_revoked;  on_revoke(data)
-        when :rate_limited;   on_rate_limit(data)
-        when :closed;         on_close(data)
-        else;                 on_error(err, data)
+      when :token_revoked
+        on_revoke(data)
+      when :rate_limited
+        on_rate_limit(data)
+      when :closed
+        on_close(data)
+      else
+        on_error(err, data)
       end
     end
 
+    # Include config helpers
+    class << self
+      def configure
+        block_given? ? yield(config) : config
+      end
+
+      def config
+        Config
+      end
+    end
   end
 end

data/lib/slack-bot-manager/client/commands.rb

@@ -1,26 +1,24 @@
 module SlackBotManager
   module Commands
-
     # Handle when connection gets closed
     def on_close(data, *args)
       options = args.extract_options!
       options[:code] ||= (data && data.code) || '1000'
 
       disconnect
-      raise SlackBotManager::ConnectionRateLimited if ['1008','429'].include?(options[:code].to_s)
+      fail SlackBotManager::ConnectionRateLimited if %w(1008 429).include?(options[:code].to_s)
     end
 
     # Handle rate limit errors coming from web API
-    def on_revoke(data)
+    def on_revoke(*)
       disconnect(:token_revoked)
-      raise SlackBotManager::TokenRevoked
+      fail SlackBotManager::TokenRevoked
     end
 
     # Handle rate limit errors coming from web API
-    def on_rate_limit(data)
+    def on_rate_limit(*)
       disconnect(:rate_limited)
-      raise SlackBotManager::ConnectionRateLimited
+      fail SlackBotManager::ConnectionRateLimited
     end
-
   end
 end