slack-ruby-bot-server 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe3d4e567729e994efcff5222076507a045bb6ed
-  data.tar.gz: 0cabe19a3a25a1d6c396a86b9f357ceb6f753faa
+  metadata.gz: 4d16d65efc278c6cc7ae66e43012323a7675f45d
+  data.tar.gz: 4a4a3392ab0fb18640a23d6f56f848d731b113e9
 SHA512:
-  metadata.gz: 2e6fbb4ee203832c867036bff4e20a814b64d6d722306c616a677e04a6fe67627019edba8893d974a7ff5b09890faadf39c88aee074915cae058078aa6030964
-  data.tar.gz: 458eb4c1e9c41be7b509239acdd16d92d9c12ad41d9d99f33d54a8dca4770d5353cc889a33f27d1b53e2a472c23a52f7130591f89f0cbc13cc943f9dfd4dfc33
+  metadata.gz: 074ba2f86c6761a2e5c41f4dbca6bd1f8a5b7d226a19370c297b9fc1b6410d1123784f2f7540e6596498a84e502fdb4fabc733055bd5ceb4ef4a270b94f2393a
+  data.tar.gz: 040856718b74ad9f9fd9ecabd7e3d77c1cdd0257051d3aa126bf82007118696aa63a9152df5b14aa3cc15250c0718f8215934066ffc7360082f445b5e3738ec3

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Changelog
 
+#### 0.3.1 (7/10/2016)
+
+* [#22](https://github.com/dblock/slack-ruby-bot-server/issues/22): Subclassing `SlackRubyBotServer::App` creates an `.instance` of child class - [@dblock](https://github.com/dblock).
+
 #### 0.3.0 (7/4/2016)
 
 * Specify the server class via `SlackRubyBotServer.configure`, default is `SlackRubyBotServer::Server` - [@dblock](https://github.com/dblock).

data/README.md

@@ -13,7 +13,7 @@ A library that contains a [Grape](http://github.com/ruby-grape/grape) API servin
 
 ### 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.
+You're reading the documentation for the **stable** release of slack-ruby-bot-server 0.3.1. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ### Try Me
 
@@ -41,7 +41,33 @@ If you deploy to Heroku set `SLACK_CLIENT_ID` and `SLACK_CLIENT_SECRET` via `her
 
 ### 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.
+This library implements an app, [SlackRubyBotServer::App](lib/slack-ruby-bot-server/app.rb), 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.
+
+#### App
+
+The app instance checks for a working MongoDB connection, ensures database indexes, performs database migrations, sets up bot aliases and log levels. You can introduce custom behavior into the app lifecycle by subclassing `SlackRubyBotServer::App` and creating an instance of the child class in `config.ru`.
+
+```ruby
+class MyApp < SlackRubyBotServer::App
+  def prepare!
+    super
+    deactivate_sleepy_teams!
+  end
+
+  private
+
+  def deactivate_sleepy_teams!
+    Team.active.each do |team|
+      next unless team.sleepy?
+      team.deactivate!
+    end
+  end
+end
+```
+
+```ruby
+MyApp.instance.prepare!
+```
 
 #### Service Manager
 
@@ -86,7 +112,7 @@ The following callbacks are supported. All callbacks receive a `team`, except `e
 You can override the server class to handle additional events, and configure the service to use it.
 
 ```ruby
-class MyServerClass < SlackRubyBotServer::Server
+class MyServer < SlackRubyBotServer::Server
   on :hello do |client, data|
     # connected to Slack
   end
@@ -97,7 +123,7 @@ class MyServerClass < SlackRubyBotServer::Server
 end
 
 SlackRubyBotServer.configure do |config|
-  config.server_class = MyServerClass
+  config.server_class = MyServer
 end
 ```
 

data/UPGRADING.md

@@ -1,6 +1,38 @@
 Upgrading Slack-Ruby-Bot-Server
 ===============================
 
+### Upgrading to >= 0.3.1
+
+#### Remove Monkey-Patching of SlackRubyBotServer::App
+
+You no longer need to monkey-patch the app class. You can subclass it and invoke additional `prepare!` methods.
+
+```ruby
+class MyApp < SlackRubyBotServer::App
+  def prepare!
+    super
+    deactivate_sleepy_teams!
+  end
+
+  private
+
+  def deactivate_sleepy_teams!
+    Team.active.each do |team|
+      next unless team.sleepy?
+      team.deactivate!
+    end
+  end
+end
+```
+
+Make sure to create an `.instance` of the child class.
+
+```ruby
+MyApp.instance.prepare!
+```
+
+See [#22](https://github.com/dblock/slack-ruby-bot-server/issues/22) for additional information.
+
 ### Upgrading to >= 0.3.0
 
 #### Remove Monkey-Patching of SlackRubyBotServer::Server

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

@@ -13,7 +13,7 @@ module SlackRubyBotServer
     end
 
     def self.instance
-      @instance ||= SlackRubyBotServer::App.new
+      @instance ||= new
     end
 
     private

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot-server
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-04 00:00:00.000000000 Z
+date: 2016-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-ruby-bot