slack-ruby-bot-server 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f6c5511a9161eb4105b995b780da2be43a4e10d
-  data.tar.gz: c597b55c62c0da9d73fcbc9403efe72ec9d461e1
+  metadata.gz: fe3d4e567729e994efcff5222076507a045bb6ed
+  data.tar.gz: 0cabe19a3a25a1d6c396a86b9f357ceb6f753faa
 SHA512:
-  metadata.gz: 34c926d67dc9be7450fe7447f259e593fa92e4aaeb989ddb838d0a987f37dfd7ccc4abb46aa008e81b889a84746bdd1b54ff6b4761c19b549bcda99d4e5aa49e
-  data.tar.gz: 2b006e96aca517a203dc2085bf6095abd4c3059e9d2d19121e59864d2cf4dd0f576cd366706f01ea986ebd6d63e1c528bc03abbf1ee3b6ac7d554e646c2d94d6
+  metadata.gz: 2e6fbb4ee203832c867036bff4e20a814b64d6d722306c616a677e04a6fe67627019edba8893d974a7ff5b09890faadf39c88aee074915cae058078aa6030964
+  data.tar.gz: 458eb4c1e9c41be7b509239acdd16d92d9c12ad41d9d99f33d54a8dca4770d5353cc889a33f27d1b53e2a472c23a52f7130591f89f0cbc13cc943f9dfd4dfc33

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-06-20 12:01:59 -0400 using RuboCop version 0.40.0.
+# on 2016-07-01 09:34:39 +0100 using RuboCop version 0.40.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
@@ -11,21 +11,26 @@ Lint/RescueException:
   Exclude:
     - 'lib/slack-ruby-bot-server/app.rb'
 
-# Offense count: 7
+# Offense count: 9
 Metrics/AbcSize:
   Max: 33
 
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 117
+
 # Offense count: 2
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 77
+# Offense count: 68
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 163
 
-# Offense count: 5
+# Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 23
@@ -34,7 +39,7 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Max: 11
 
-# Offense count: 23
+# Offense count: 25
 Style/Documentation:
   Enabled: false
 
@@ -44,3 +49,8 @@ Style/FileName:
   Exclude:
     - 'lib/slack-ruby-bot-server.rb'
     - 'lib/slack-ruby-bot-server/ext/slack-ruby-bot.rb'
+
+# Offense count: 1
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/slack-ruby-bot-server/config.rb'

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ### Changelog
 
+#### 0.3.0 (7/4/2016)
+
+* Specify the server class via `SlackRubyBotServer.configure`, default is `SlackRubyBotServer::Server` - [@dblock](https://github.com/dblock).
+* Added service management lifecycle callbacks when a new team is registered, deactivated, etc - [@dblock](https://github.com/dblock).
+
 #### 0.2.0 (6/21/2016)
 
 * Relaxed dependency versions, notably enabling grape 0.16.2 and Swagger 0.21.0 that uses Swagger 2.0 spec - [@dblock](https://github.com/dblock).

data/README.md

@@ -7,6 +7,14 @@ Slack Ruby Bot Server
 
 A library that enables you to write a complete Slack bot service with Slack button integration, in Ruby. If you are not familiar with Slack bots or Slack API concepts, you might want to watch [this video](http://code.dblock.org/2016/03/11/your-first-slack-bot-service-video.html). A good demo of a service built on top of this is [missingkidsbot.org](http://missingkidsbot.org).
 
+### What is this?
+
+A library that contains a [Grape](http://github.com/ruby-grape/grape) API serving a [Slack Ruby Bot](https://github.com/dblock/slack-ruby-bot) to multiple teams. This gem combines a web server, a RESTful API and multiple instances of [slack-ruby-bot](https://github.com/dblock/slack-ruby-bot). It integrates with the [Slack Platform API](https://medium.com/slack-developer-blog/launch-platform-114754258b91#.od3y71dyo). Your customers can use a Slack button to install the bot.
+
+### Stable Release
+
+You're reading the documentation for the **stable** release of slack-ruby-bot-server, 0.3.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+
 ### Try Me
 
 A demo version of the [sample app](sample_app) is running on Heroku at [slack-ruby-bot-server.herokuapp.com](https://slack-ruby-bot-server.herokuapp.com). Use the _Add to Slack_ button. The bot will join your team as _@slackbotserver_.
@@ -17,10 +25,6 @@ Once a bot is registered, you can invite to a channel with `/invite @slackbotser
 
 ![](images/slackbotserver.gif)
 
-### What is this?
-
-A [Grape](http://github.com/ruby-grape/grape) API serving a [Slack Ruby Bot](https://github.com/dblock/slack-ruby-bot) to multiple teams. This gem combines a web server, a RESTful API and multiple instances of [slack-ruby-bot](https://github.com/dblock/slack-ruby-bot). It integrates with the [Slack Platform API](https://medium.com/slack-developer-blog/launch-platform-114754258b91#.od3y71dyo). Your customers can use a Slack button to install the bot.
-
 ### Run Your Own
 
 You can use the [sample application](sample_app) to bootstrap your project and start adding slack command handlers on top of this code.
@@ -35,6 +39,68 @@ Follow the instructions, note the app's client ID and secret, give the bot a def
 
 If you deploy to Heroku set `SLACK_CLIENT_ID` and `SLACK_CLIENT_SECRET` via `heroku config:add SLACK_CLIENT_ID=... SLACK_CLIENT_SECRET=...`.
 
+### API
+
+This library implements a service manager, [SlackRubyBotServer::Service](lib/slack-ruby-bot-server/service.rb) that creates multiple instances of a bot server class, [SlackRubyBotServer::Server](lib/slack-ruby-bot-server/server.rb), one per team.
+
+#### Service Manager
+
+You can introduce custom behavior into the service lifecycle via callbacks. This can be useful when new team has been registered via the API or a team has been deactivated from Slack.
+
+```ruby
+instance = SlackRubyBotServer::Service.instance
+
+instance.on :created do |team, server, error|
+  # a new team has been registered
+end
+
+instance.on :deactivated do |team, server, error|
+  # an existing team has been deactivated in Slack
+end
+
+instance.on :error do |team, server, error|
+  # an error has occurred
+end
+```
+
+The following callbacks are supported. All callbacks receive a `team`, except `error`, which receives a `StandardError` object.
+
+| callback       |  description                                                     |
+|:--------------:|:-----------------------------------------------------------------|
+| error          | an error has occurred                                            |
+| creating       | a new team is being registered                                   |
+| created        | a new team has been registered                                   |
+| booting        | the service is starting and is connecting a team to Slack        |
+| booted         | the service is starting and has connected a team to Slack        |
+| stopping       | the service is about to disconnect a team from Slack             |
+| stopped        | the service has disconnected a team from Slack                   |
+| starting       | the service is (re)connecting a team to Slack                    |
+| started        | the service has (re)connected a team to Slack                    |
+| deactivating   | a team is being deactivated                                      |
+| deactivated    | a team has been deactivated                                      |
+| resetting      | the service is resetting, all teams being stopped                |
+| reset          | the service has been reset, all teams have been stopped          |
+
+#### Server Class
+
+You can override the server class to handle additional events, and configure the service to use it.
+
+```ruby
+class MyServerClass < SlackRubyBotServer::Server
+  on :hello do |client, data|
+    # connected to Slack
+  end
+
+  on :channel_joined do |client, data|
+    # the bot joined a channel in data.channel['id']
+  end
+end
+
+SlackRubyBotServer.configure do |config|
+  config.server_class = MyServerClass
+end
+```
+
 ### Examples Using Slack Ruby Bot Server
 
 * [slack-amber-alert](https://github.com/dblock/slack-amber-alert), free service at [missingkidsbot.org](https://www.missingkidsbot.org)

data/UPGRADING.md

@@ -0,0 +1,26 @@
+Upgrading Slack-Ruby-Bot-Server
+===============================
+
+### Upgrading to >= 0.3.0
+
+#### Remove Monkey-Patching of SlackRubyBotServer::Server
+
+In the past adding events required monkey-patching of the server class. You can now override the server class to handle additional events, and configure the service to use yours.
+
+```ruby
+class MyServerClass < SlackRubyBotServer::Server
+  on :hello do |client, data|
+    # connected to Slack
+  end
+
+  on :channel_joined do |client, data|
+    # the bot joined a channel in data.channel['id']
+  end
+end
+
+SlackRubyBotServer.configure do |config|
+  config.server_class = MyServerClass
+end
+```
+
+See [#18](https://github.com/dblock/slack-ruby-bot-server/issues/18) for more information.

data/lib/slack-ruby-bot-server.rb

@@ -11,4 +11,5 @@ require 'slack-ruby-bot-server/models'
 require 'slack-ruby-bot-server/api'
 require 'slack-ruby-bot-server/app'
 require 'slack-ruby-bot-server/server'
+require 'slack-ruby-bot-server/config'
 require 'slack-ruby-bot-server/service'

data/lib/slack-ruby-bot-server/api/endpoints/teams_endpoint.rb

@@ -60,7 +60,7 @@ module SlackRubyBotServer
               )
             end
 
-            Service.instance.start!(team)
+            Service.instance.create!(team)
             present team, with: Presenters::TeamPresenter
           end
         end

data/lib/slack-ruby-bot-server/config.rb

@@ -0,0 +1,23 @@
+module SlackRubyBotServer
+  module Config
+    extend self
+
+    attr_accessor :server_class
+
+    def reset!
+      self.server_class = SlackRubyBotServer::Server
+    end
+
+    reset!
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(Config) : Config
+    end
+
+    def config
+      Config
+    end
+  end
+end

data/lib/slack-ruby-bot-server/service.rb

@@ -16,66 +16,121 @@ module SlackRubyBotServer
     def initialize
       @lock = Mutex.new
       @services = {}
+      @callbacks = Hash.new { |h, k| h[k] = [] }
+    end
+
+    def on(type, &block)
+      @callbacks[type.to_s] << block
+    end
+
+    def create!(team)
+      run_callbacks :creating, team
+      server = start!(team)
+      run_callbacks :created, team, server
     end
 
     def start!(team)
       raise 'Token already known.' if @services.key?(team.token)
+      run_callbacks :starting, team
       logger.info "Starting team #{team}."
-      server = SlackRubyBotServer::Server.new(team: team)
+      server = SlackRubyBotServer::Config.server_class.new(team: team)
       @lock.synchronize do
         @services[team.token] = server
       end
-      restart!(team, server)
+      start_server! team, server
+      run_callbacks :started, team, server
+      server
     rescue StandardError => e
+      run_callbacks :error, team, nil, e
       logger.error e
     end
 
+    def restart!(team, server, wait = 1)
+      run_callbacks :restarting, team, server
+      start_server! team, server, wait
+      run_callbacks :restarted, team, server
+    end
+
     def stop!(team)
+      logger.info "Stopping team #{team}."
       @lock.synchronize do
         raise 'Token unknown.' unless @services.key?(team.token)
-        logger.info "Stopping team #{team}."
-        @services[team.token].stop!
+        server = @services[team.token]
+        run_callbacks :stopping, team, server
+        server.stop!
         @services.delete(team.token)
+        run_callbacks :stopped, team, server
       end
     rescue StandardError => e
+      run_callbacks :error, team, @services[team.token], e
       logger.error e
     end
 
     def start_from_database!
       Team.active.each do |team|
-        start!(team)
-      end
-    end
-
-    def restart!(team, server, wait = 1)
-      server.start_async
-    rescue StandardError => e
-      case e.message
-      when 'account_inactive', 'invalid_auth' then
-        logger.error "#{team.name}: #{e.message}, team will be deactivated."
-        deactivate!(team)
-      else
-        logger.error "#{team.name}: #{e.message}, restarting in #{wait} second(s)."
-        sleep(wait)
-        restart! team, server, [wait * 2, 60].min
+        run_callbacks :booting, team
+        server = start!(team)
+        run_callbacks :booted, team, server
       end
     end
 
     def deactivate!(team)
-      team.deactivate!
       @lock.synchronize do
+        raise 'Token unknown.' unless @services.key?(team.token)
+        server = @services[team.token]
+        run_callbacks :deactivating, team, server
+        team.deactivate!
         @services.delete(team.token)
+        run_callbacks :deactivated, team, server
       end
     rescue Mongoid::Errors::Validations => e
+      run_callbacks :error, team, @services[team.token], e
       logger.error "#{team.name}: #{e.message}, error - #{e.document.class}, #{e.document.errors.to_hash}, ignored."
     rescue StandardError => e
+      run_callbacks :error, team, @services[team.token], e
       logger.error "#{team.name}: #{e.class}, #{e.message}, ignored."
     end
 
     def reset!
+      run_callbacks :resetting
       @services.values.to_a.each do |server|
         stop!(server.team)
       end
+      run_callbacks :reset
+    end
+
+    def self.reset!
+      @instance.reset! if @instance
+      @instance = nil
+    end
+
+    private
+
+    def start_server!(team, server, wait = 1)
+      server.start_async
+    rescue StandardError => e
+      run_callbacks :error, team, server, e
+      case e.message
+      when 'account_inactive', 'invalid_auth' then
+        logger.error "#{team.name}: #{e.message}, team will be deactivated."
+        deactivate!(team)
+      else
+        logger.error "#{team.name}: #{e.message}, restarting in #{wait} second(s)."
+        sleep(wait)
+        start_server! team, server, [wait * 2, 60].min
+      end
+    end
+
+    def run_callbacks(type, team = nil, server = nil, error = nil)
+      callbacks = @callbacks[type.to_s]
+      return false unless callbacks
+      callbacks.each do |c|
+        c.call team, server, error
+      end
+      true
+    rescue StandardError => e
+      logger.error e
+      false
     end
   end
 end

data/lib/slack-ruby-bot-server/version.rb

@@ -1,3 +1,3 @@
 module SlackRubyBotServer
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot-server
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-21 00:00:00.000000000 Z
+date: 2016-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-ruby-bot
@@ -213,6 +213,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- UPGRADING.md
 - app.json
 - images/new.png
 - images/slackbotserver.gif
@@ -236,6 +237,7 @@ files:
 - lib/slack-ruby-bot-server/api/presenters/team_presenter.rb
 - lib/slack-ruby-bot-server/api/presenters/teams_presenter.rb
 - lib/slack-ruby-bot-server/app.rb
+- lib/slack-ruby-bot-server/config.rb
 - lib/slack-ruby-bot-server/ext.rb
 - lib/slack-ruby-bot-server/ext/bson/object_id.rb
 - lib/slack-ruby-bot-server/ext/grape/sort_extension.rb
@@ -294,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A Grape API serving a Slack bot to multiple teams.