slack-ruby-bot 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59c7b21c6857323515327cf3b14c4cd79bdfe25b
-  data.tar.gz: ae4beccb7a8d933d2f7b6fffb170241fad4a85d4
+  metadata.gz: c8b86a027a9c17bbb4d3e69212493162aacfffca
+  data.tar.gz: 94ec098315fd7611325f567da9c5964d4847d47b
 SHA512:
-  metadata.gz: 213767e2c36e1287e2916e24652b4ed873a3fb9bc84ff60e16bb7e6fcdf847d11dd622174421bed755febf65bf934bfc3000a3d3f0874afab7751b7c0bfc3db0
-  data.tar.gz: aaff927afb06fce22a67e090bf4954cea920a383a84277bf681a00e5c29154f8ff66b5c9ed979625bd03b2a1cf1f79d28b9beb37e0d53fe370bc12aa49ef77da
+  metadata.gz: c97a004bbcfadbbd318158cc8ffe1d59637c7b0026139e771f655393cb362acd02adff508cff69a961781b5da25efa199756c326ca18f098fefc8f6ee85c4b6b
+  data.tar.gz: 15014981779338072114308822e4018d9bfc21b067f58689489ec2fffaec88b7fbf46a05a40a09d963c302da70d9312f9f0d08c42fe25a080ecfab2e78a171cc

data/.travis.yml

@@ -1,3 +1,6 @@
 rvm:
-  - 2.1.6
+  - 2.3.0
+env:
+  - CONCURRENCY=celluloid-io
+  - CONCURRENCY=faye-websocket
 

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.8.0 (5/5/2016)
+
+* [#32](https://github.com/dblock/slack-ruby-bot/issues/32): Don't include `faye-websocket` by default, support `celluloid-io` - [@dblock](https://github.com/dblock).
+* [#54](https://github.com/dblock/slack-ruby-bot/pull/54): Improvements to Hook configuration - [@dramalho](https://github.com/dramalho).
+
 ### 0.7.0 (3/6/2016)
 
 * Improved regular expression matching performance with less matching per command - [@dblock](https://github.com/dblock).

data/Gemfile

@@ -1,3 +1,5 @@
 source 'http://rubygems.org'
 
 gemspec
+
+gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')

data/README.md

@@ -17,7 +17,7 @@ A generic Slack bot framework written in Ruby on top of [slack-ruby-client](http
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-bot, 0.7.0. See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
+You're reading the documentation for the **stable** release of slack-ruby-bot 0.8.0. See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
 
 ## Usage
 
@@ -26,9 +26,10 @@ You're reading the documentation for the **stable** release of slack-ruby-bot, 0
 #### Gemfile
 
 ```ruby
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gem 'slack-ruby-bot'
+gem 'celluloid-io'
 ```
 
 #### pongbot.rb
@@ -190,17 +191,39 @@ Get help.
 
 ### Hooks
 
-Hooks are event handlers and respond to Slack RTM API [events](https://api.slack.com/events), such as [hello](lib/slack-ruby-bot/hooks/hello.rb) or [message](lib/slack-ruby-bot/hooks/message.rb). You can implement your own by extending [SlackRubyBot::Hooks::Base](lib/slack-ruby-bot/hooks/base.rb).
+Hooks are event handlers and respond to Slack RTM API [events](https://api.slack.com/events), such as [hello](lib/slack-ruby-bot/hooks/hello.rb) or [message](lib/slack-ruby-bot/hooks/message.rb). You can implement your own in a couple of ways:
+
+#### Implement and register a Hook Handler
+
+A Hook Handler is any object that respond to a `call` message, like a proc, instance of an object, class with a `call` class method, etc.
+
+Hooks are registered onto the `SlackRubyBot::Server` instance, by way of a configuration hash
+
+```ruby
+SlackRubyBot::Server.new(hook_handlers: {
+  hello: MyBot::Hooks::UserChange.new
+})
+```
+
+or at any time by pushing it to the `HookSet`
+
+```ruby
+# Push an object that implements the
+server.hooks.add(:hello, MyBot::Hooks::UserChange.new)
+
+# Push a lambda to handle the event
+server.hooks.add(:hello, ->(client, data) { puts "Hello!" })
+```
 
 For example, the following hook handles [user_change](https://api.slack.com/events/user_change), an event sent when a team member updates their profile or data. This can be useful to update the local user cache when a user is renamed.
 
 ```ruby
 module MyBot
   module Hooks
-    module UserChange
+    class UserChange
       extend SlackRubyBot::Hooks::Base
 
-      def user_change(client, data)
+      def call(client, data)
         # data['user']['id'] contains the user ID
         # data['user']['name'] contains the new user name
         ...
@@ -210,6 +233,23 @@ module MyBot
 end
 ```
 
+Hooks can also be written as blocks inside the `SlackBotRuby::Server` class, for example
+
+```ruby
+module MyBot
+  class MyServer < SlackRubyBot::Server
+    on 'hello' do |client, data|
+      # data['user']['id'] contains the user ID
+      # data['user']['name'] contains the new user name
+    end
+  end
+end
+```
+
+These will get pushed into the hook set on initialization.
+
+Either by configuration, explicit assignment or hook blocks, multiple handlers can exist for the same event type.
+
 ### Disable Animated GIFs
 
 By default bots send animated GIFs in default commands and errors. To disable animated GIFs set `send_gifs` or `ENV['SLACK_RUBY_BOT_SEND_GIFS']` to `false`.
@@ -230,6 +270,14 @@ SlackRubyBot.configure do |config|
 end
 ```
 
+### Logging
+
+By default bots set a logger to `STDOUT` with `DEBUG` level. The logger is used in both the RealTime and Web clients. Silence logger as follows.
+
+```ruby
+SlackRubyBot::Client.logger.level = Logger::WARN
+```
+
 ### Advanced Integration
 
 You may want to integrate a bot or multiple bots into other systems, in which case a globally configured bot may not work for you. You may create instances of [SlackRubyBot::Server](lib/slack-ruby-bot/server.rb) which accepts `token`, `aliases` and `send_gifs`.

data/UPGRADING.md

@@ -1,6 +1,20 @@
 Upgrading SlackRubyBot
 ======================
 
+### Upgrading to >= 0.8.0
+
+#### Require a concurrency library
+
+The `faye-websocket` library is no longer required by default. Add either `faye-websocket` or `celluiloid-io` to your `Gemfile` depending on which concurrency implementation you'd like to use. We recommend `celluloid-io` moving forward.
+
+#### Hook::Base was removed, explicitly register any custom hook classes
+
+Hook classes are now handled differently, namely they are explicitly registered into `SlackRubyBot::Server` via a configuration option (`hook_handlers`) or by passing a similar hash later on through the `add_hook_handlers` method. Including Hook classes directly into the server class is no longer needed.
+
+A hook is actioned via a `call` message onto the handler object (this can be anything that responds to that), so you'll need to rename your method.
+
+Finally, you can now register multiple hooks for the same event, so if you had any code to remove default hooks, you'll need to change it so you pass a configuration hash into `Server`
+
 ### Upgrading to >= 0.7.0
 
 #### Simplify Match Expression Checking
@@ -175,5 +189,3 @@ def self.call(client, data, match)
   send_message_with_gif client, data.channel, 'hello', 'hi'
 end
 ```
-
-

data/examples/market/Gemfile

@@ -1,4 +1,5 @@
 source 'http://rubygems.org'
 
 gem 'slack-ruby-bot', path: '../..'
+gem 'faye-websocket'
 gem 'yahoo-finance'

data/examples/market/marketbot.rb

@@ -1,6 +1,8 @@
 require 'slack-ruby-bot'
 require 'yahoo-finance'
 
+SlackRubyBot::Client.logger.level = Logger::WARN
+
 class MarketBot < SlackRubyBot::Bot
   scan(/([A-Z]{2,5}+)/) do |client, data, stocks|
     YahooFinance::Client.new.quotes(stocks, [:name, :symbol, :last_trade_price, :change, :change_in_percent]).each do |quote|

data/examples/minimal/Gemfile

@@ -1,3 +1,4 @@
 source 'http://rubygems.org'
 
 gem 'slack-ruby-bot', path: '../..'
+gem 'celluloid-io'

data/examples/weather/Gemfile

@@ -1,3 +1,4 @@
 source 'http://rubygems.org'
 
 gem 'slack-ruby-bot', path: '../..'
+gem 'celluloid-io'

data/examples/weather/weatherbot.rb

@@ -1,5 +1,7 @@
 require 'slack-ruby-bot'
 
+SlackRubyBot::Client.logger.level = Logger::WARN
+
 class WeatherBot < SlackRubyBot::Bot
   match(/^How is the weather in (?<location>\w*)\?$/i) do |client, data, match|
     client.say(channel: data.channel, text: "The weather in #{match[:location]} is nice.")

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

@@ -1,5 +1,5 @@
 module SlackRubyBot
-  ABOUT = <<-ABOUT
+  ABOUT = <<-ABOUT.freeze
     #{SlackRubyBot::VERSION}
     https://github.com/dblock/slack-ruby-bot
     https://twitter.com/dblockdotorg

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

@@ -2,7 +2,7 @@ module SlackRubyBot
   class App < Server
     def initialize(options = {})
       SlackRubyBot.configure do |config|
-        config.token = ENV['SLACK_API_TOKEN'] || fail("Missing ENV['SLACK_API_TOKEN'].")
+        config.token = ENV['SLACK_API_TOKEN'] || raise("Missing ENV['SLACK_API_TOKEN'].")
         config.aliases = ENV['SLACK_RUBY_BOT_ALIASES'].split(' ') if ENV['SLACK_RUBY_BOT_ALIASES']
       end
       Slack.configure do |config|

data/lib/slack-ruby-bot/commands/base.rb

@@ -7,7 +7,7 @@ module SlackRubyBot
       class << self
         def send_message(client, channel, text, options = {})
           logger.warn '[DEPRECATION] `send_message` is deprecated.  Please use `client.say` instead.'
-          if text && text.length > 0
+          if text && !text.length.empty?
             client.say(options.merge(channel: channel, text: text))
           else
             client.say(options.merge(channel: channel, text: 'Nothing to see here.', gif: 'nothing'))
@@ -61,7 +61,7 @@ module SlackRubyBot
             elsif respond_to?(:call)
               send(:call, client, data, match)
             else
-              fail NotImplementedError, data.text
+              raise NotImplementedError, data.text
             end
             break
           end if expression

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

@@ -30,7 +30,7 @@ module SlackRubyBot
       when 1, 'true', 'yes'
         true
       else
-        fail ArgumentError, "Invalid value for #{key}: #{value}."
+        raise ArgumentError, "Invalid value for #{key}: #{value}."
       end
     end
   end

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

@@ -1,3 +1,4 @@
-require 'slack-ruby-bot/hooks/base'
+require 'slack-ruby-bot/hooks/set'
 require 'slack-ruby-bot/hooks/hello'
 require 'slack-ruby-bot/hooks/message'
+require 'slack-ruby-bot/hooks/hook_support'

data/lib/slack-ruby-bot/hooks/hello.rb

@@ -1,9 +1,13 @@
 module SlackRubyBot
   module Hooks
-    module Hello
-      extend Base
+    class Hello
+      attr_accessor :logger
 
-      def hello(client, _data)
+      def initialize(logger)
+        self.logger = logger
+      end
+
+      def call(client, _data)
         return unless client && client.team
         logger.info "Successfully connected to https://#{client.team.domain}.slack.com."
       end

data/lib/slack-ruby-bot/hooks/hook_support.rb

@@ -0,0 +1,37 @@
+module SlackRubyBot
+  module Hooks
+    module HookSupport
+      def self.included(base)
+        base.cattr_accessor :hook_blocks
+
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def on(event_name, &block)
+          self.hook_blocks ||= {}
+
+          self.hook_blocks[event_name] ||= []
+          self.hook_blocks[event_name] << block
+        end
+      end
+
+      # Instance stuff
+      def hooks
+        @hooks ||= SlackRubyBot::Hooks::Set.new
+      end
+
+      def flush_hook_blocks
+        return nil unless self.class.hook_blocks
+
+        add_hook_handlers(self.class.hook_blocks)
+      end
+
+      def add_hook_handlers(handler_hash)
+        handler_hash.each do |hook, handlers|
+          Array(handlers).each { |handler| hooks.add(hook, handler) }
+        end
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot/hooks/message.rb

@@ -1,9 +1,7 @@
 module SlackRubyBot
   module Hooks
-    module Message
-      extend Base
-
-      def message(client, data)
+    class Message
+      def call(client, data)
         return if message_to_self_not_allowed? && message_to_self?(client, data)
         data.text.strip! if data.text
         result = child_command_classes.detect { |d| d.invoke(client, data) }

data/lib/slack-ruby-bot/hooks/set.rb

@@ -0,0 +1,45 @@
+module SlackRubyBot
+  module Hooks
+    class Set
+      attr_accessor :handlers, :client
+
+      def initialize(client = nil)
+        self.handlers = {}
+        self.client = client
+
+        @pending_flush = client.blank?
+      end
+
+      def add(hook_name, handler)
+        if handlers[hook_name].present?
+          handlers[hook_name] << handler
+        else
+          handlers[hook_name] = [handler]
+          register_callback(hook_name)
+        end
+      end
+
+      def client=(client)
+        @client = client
+
+        flush_handlers if @pending_flush
+      end
+
+      protected
+
+      def register_callback(hook_name)
+        return unless client # We'll delay this until client is set
+
+        client.on hook_name do |data|
+          handlers[hook_name].each do |handler|
+            handler.call(client, data)
+          end
+        end
+      end
+
+      def flush_handlers
+        handlers.keys.each { |hook| register_callback(hook) }
+      end
+    end
+  end
+end

data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb

@@ -2,12 +2,20 @@ require 'rspec/expectations'
 
 RSpec::Matchers.define :respond_with_error do |error, error_message|
   match do |actual|
-    channel, user, message = parse(actual)
     allow(Giphy).to receive(:random)
+
+    client = if respond_to?(:client)
+               send(:client)
+             else
+               SlackRubyBot::Client.new
+             end
+
+    message_command = SlackRubyBot::Hooks::Message.new
+    channel, user, message = parse(actual)
+
     begin
       expect do
-        client = app.send(:client)
-        app.send(:message, client, Hashie::Mash.new(text: message, channel: channel, user: user))
+        message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user))
       end.to raise_error error, error_message
     rescue RSpec::Expectations::ExpectationNotMetError => e
       @error_message = e.message

data/lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_message.rb

@@ -2,11 +2,19 @@ require 'rspec/expectations'
 
 RSpec::Matchers.define :respond_with_slack_message do |expected|
   match do |actual|
+    client = if respond_to?(:client)
+               send(:client)
+             else
+               SlackRubyBot::Client.new
+             end
+
+    message_command = SlackRubyBot::Hooks::Message.new
+
     channel, user, message = parse(actual)
     allow(Giphy).to receive(:random)
-    client = app.send(:client)
+
     expect(client).to receive(:message).with(channel: channel, text: expected)
-    app.send(:message, client, Hashie::Mash.new(text: message, channel: channel, user: user))
+    message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user))
     true
   end
 

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

@@ -1,23 +1,30 @@
 module SlackRubyBot
   class Server
     include Loggable
-    cattr_accessor :hooks
+
     attr_accessor :token, :aliases, :send_gifs
 
-    TRAPPED_SIGNALS = %w(INT TERM).freeze
+    include SlackRubyBot::Hooks::HookSupport
 
-    include SlackRubyBot::Hooks::Hello
-    include SlackRubyBot::Hooks::Message
+    TRAPPED_SIGNALS = %w(INT TERM).freeze
 
     def initialize(options = {})
       @token = options[:token]
       @aliases = options[:aliases]
       @send_gifs = options.key?(:send_gifs) ? !!options[:send_gifs] : true
+
+      # Hook Handling
+      flush_hook_blocks
+
+      add_hook_handlers options[:hook_handlers] || {
+        hello: SlackRubyBot::Hooks::Hello.new(logger),
+        message: SlackRubyBot::Hooks::Message.new
+      }
     end
 
     def run
       loop do
-        handle_execeptions do
+        handle_exceptions do
           handle_signals
           start!
         end
@@ -41,11 +48,6 @@ module SlackRubyBot
       client.stop! if @client
     end
 
-    def hello!
-      return unless client.self && client.team
-      logger.info "Welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
-    end
-
     def restart!(wait = 1)
       @async ? start_async : start!
     rescue StandardError => e
@@ -57,7 +59,7 @@ module SlackRubyBot
 
     private
 
-    def handle_execeptions
+    def handle_exceptions
       yield
     rescue Slack::Web::Api::Error => e
       logger.error e
@@ -93,20 +95,8 @@ module SlackRubyBot
           @client = nil
           restart! unless @stopping
         end
-        hooks.each do |hook|
-          client.on hook do |data|
-            begin
-              send hook, client, data
-            rescue StandardError => e
-              logger.error e
-              begin
-                client.message(channel: data['channel'], text: e.message) if data.key?('channel')
-              rescue
-                # ignore
-              end
-            end
-          end
-        end
+        hooks.client = client
+
         client
       end
     end

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

@@ -1,3 +1,3 @@
 module SlackRubyBot
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'.freeze
 end

data/slack-ruby-bot.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
   s.summary = 'The easiest way to write a Slack bot in Ruby.'
   s.add_dependency 'hashie'
   s.add_dependency 'slack-ruby-client', '>= 0.6.0'
-  s.add_dependency 'faye-websocket'
   s.add_dependency 'activesupport'
   s.add_dependency 'giphy', '~> 2.0.2'
   s.add_development_dependency 'rake'
@@ -24,5 +23,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
-  s.add_development_dependency 'rubocop', '0.32.1'
+  s.add_development_dependency 'rubocop', '0.38.0'
 end

data/spec/slack-ruby-bot/commands/about_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
 describe SlackRubyBot::Commands::Default do
-  def app
-    SlackRubyBot::App.new
-  end
   it 'lowercase' do
     expect(message: SlackRubyBot.config.user).to respond_with_slack_message(SlackRubyBot::ABOUT)
   end

data/spec/slack-ruby-bot/commands/aliases_spec.rb

@@ -1,14 +1,8 @@
 require 'spec_helper'
 
 describe SlackRubyBot do
-  def app
-    SlackRubyBot::App.new
-  end
-  before do
-    ENV['SLACK_RUBY_BOT_ALIASES'] = ':emoji: alias каспаров'
-  end
-  after do
-    ENV.delete('SLACK_RUBY_BOT_ALIASES')
+  def client
+    SlackRubyBot::Client.new aliases: %w(:emoji: alias каспаров)
   end
   it 'responds to emoji' do
     expect(message: ':emoji: hi').to respond_with_slack_message('Hi <@user>!')

data/spec/slack-ruby-bot/commands/bot_spec.rb

@@ -8,14 +8,11 @@ describe SlackRubyBot::Bot do
       end
     end
   end
+
   def app
     SlackRubyBot::Bot.instance
   end
-  let(:client) { app.send(:client) }
-  it 'sends a message' do
-    expect(client).to receive(:message).with(channel: 'channel', text: 'message')
-    app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} bot_spec message", channel: 'channel', user: 'user'))
-  end
+
   it 'sends a message' do
     expect(message: "#{SlackRubyBot.config.user} bot_spec message").to respond_with_slack_message('message')
   end

data/spec/slack-ruby-bot/commands/commands_with_expression_spec.rb

@@ -8,7 +8,7 @@ describe SlackRubyBot::Commands do
           k, v = match['expression'].split(/\W+/, 2)
           client.say(channel: data.channel, text: "#{match[:command]}: #{k}=#{v}")
         else
-          client.say(channel: data.channel, text: "#{match[:command]}")
+          client.say(channel: data.channel, text: (match[:command]).to_s)
         end
       end
     end

data/spec/slack-ruby-bot/commands/direct_messages_spec.rb

@@ -20,10 +20,10 @@ describe SlackRubyBot do
   end
   context 'it responds to direct name calling' do
     it 'with bot name' do
-      expect(message: "#{SlackRubyBot.config.user}", channel: 'DEADBEEF').to respond_with_slack_message(SlackRubyBot::ABOUT)
+      expect(message: SlackRubyBot.config.user.to_s, channel: 'DEADBEEF').to respond_with_slack_message(SlackRubyBot::ABOUT)
     end
     it 'with bot name capitalized' do
-      expect(message: "#{SlackRubyBot.config.user.upcase}", channel: 'DEADBEEF').to respond_with_slack_message(SlackRubyBot::ABOUT)
+      expect(message: SlackRubyBot.config.user.upcase.to_s, channel: 'DEADBEEF').to respond_with_slack_message(SlackRubyBot::ABOUT)
     end
     it 'with bot user id' do
       expect(message: "<@#{SlackRubyBot.config.user_id}>", channel: 'DEADBEEF').to respond_with_slack_message(SlackRubyBot::ABOUT)

data/spec/slack-ruby-bot/commands/empty_text_spec.rb

@@ -10,13 +10,8 @@ describe SlackRubyBot::Commands do
       end
     end
   end
-  def app
-    SlackRubyBot::App.new
-  end
-  let(:client) { app.send(:client) }
   it 'sends default text' do
     allow(Giphy).to receive(:random)
-    expect(client).to receive(:message).with(channel: 'channel', text: '')
-    app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} empty_text", channel: 'channel', user: 'user'))
+    expect(message: "#{SlackRubyBot.config.user} empty_text", channel: 'channel', user: 'user').to respond_with_slack_message('')
   end
 end

data/spec/slack-ruby-bot/commands/message_loop_spec.rb

@@ -4,15 +4,19 @@ describe SlackRubyBot::App do
   def app
     SlackRubyBot::App.new
   end
+
   let(:client) { subject.send(:client) }
+  let(:message_hook) { SlackRubyBot::Hooks::Message.new }
+
   before do
     allow(client).to receive(:self).and_return(Hashie::Mash.new('id' => 'UDEADBEEF'))
     allow(Giphy).to receive(:random)
   end
+
   context 'default' do
     it 'does not respond to self' do
       expect(client).to_not receive(:message)
-      subject.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} hi", channel: 'channel', user: 'UDEADBEEF'))
+      message_hook.call(client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} hi", channel: 'channel', user: 'UDEADBEEF'))
     end
   end
   context 'with allow_message_loops=true' do
@@ -28,7 +32,7 @@ describe SlackRubyBot::App do
     end
     it 'responds to self' do
       expect(client).to receive(:message)
-      subject.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} hi", channel: 'channel', user: 'UDEADBEEF'))
+      message_hook.call(client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} hi", channel: 'channel', user: 'UDEADBEEF'))
     end
   end
 end

data/spec/slack-ruby-bot/commands/nil_message_spec.rb

@@ -10,13 +10,14 @@ describe SlackRubyBot::Commands do
       end
     end
   end
-  def app
-    SlackRubyBot::App.new
-  end
+
+  let(:app) { SlackRubyBot::App.new }
   let(:client) { app.send(:client) }
+  let(:message_hook) { SlackRubyBot::Hooks::Message.new }
+
   it 'ignores nil messages' do
     allow(Giphy).to receive(:random)
     expect(client).to_not receive(:message)
-    app.send(:message, client, Hashie::Mash.new(text: nil, channel: 'channel', user: 'user'))
+    message_hook.call(client, Hashie::Mash.new(text: nil, channel: 'channel', user: 'user'))
   end
 end

data/spec/slack-ruby-bot/commands/not_implemented_spec.rb

@@ -6,9 +6,6 @@ describe SlackRubyBot::Commands::Base do
       command 'not_implemented'
     end
   end
-  def app
-    SlackRubyBot::App.new
-  end
   it 'raises not implemented' do
     expect(message: "#{SlackRubyBot.config.user} not_implemented").to respond_with_error(NotImplementedError, 'rubybot not_implemented')
   end

data/spec/slack-ruby-bot/commands/send_gif_spec.rb

@@ -8,25 +8,19 @@ describe SlackRubyBot::Commands do
       end
     end
   end
-  def app
-    SlackRubyBot::App.new
-  end
-  let(:client) { app.send(:client) }
+
   let(:gif_image_url) { 'http://media2.giphy.com/media/pzOijFsdDrsS4/giphy.gif' }
   it 'sends a gif' do
     gif = Giphy::RandomGif.new('image_url' => gif_image_url)
     expect(Giphy).to receive(:random).and_return(gif)
-    expect(client).to receive(:message).with(channel: 'channel', text: gif_image_url)
-    app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} send_gif_spec message", channel: 'channel', user: 'user'))
+    expect(message: "#{SlackRubyBot.config.user} send_gif_spec message").to respond_with_slack_message(gif_image_url)
   end
   it 'eats up the error' do
-    expect(Giphy).to receive(:random) { fail 'oh no!' }
-    expect(client).to receive(:message).with(channel: 'channel', text: '')
-    app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} send_gif_spec message", channel: 'channel', user: 'user'))
+    expect(Giphy).to receive(:random) { raise 'oh no!' }
+    expect(message: "#{SlackRubyBot.config.user} send_gif_spec message").to respond_with_slack_message('')
   end
   it 'eats up nil gif' do
     expect(Giphy).to receive(:random).and_return(nil)
-    expect(client).to receive(:message).with(channel: 'channel', text: '')
-    app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} send_gif_spec message", channel: 'channel', user: 'user'))
+    expect(message: "#{SlackRubyBot.config.user} send_gif_spec message").to respond_with_slack_message('')
   end
 end

data/spec/slack-ruby-bot/commands/send_message_spec.rb

@@ -8,12 +8,7 @@ describe SlackRubyBot::Commands do
       end
     end
   end
-  def app
-    SlackRubyBot::App.new
-  end
-  let(:client) { app.send(:client) }
   it 'sends a message' do
-    expect(client).to receive(:message).with(channel: 'channel', text: 'message')
-    app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} send_message_spec message", channel: 'channel', user: 'user'))
+    expect(message: "#{SlackRubyBot.config.user} send_message_spec message").to respond_with_slack_message('message')
   end
 end

data/spec/slack-ruby-bot/commands/send_message_with_gif_spec.rb

@@ -8,62 +8,58 @@ describe SlackRubyBot::Commands do
       end
     end
   end
-  def app
-    SlackRubyBot::App.new
-  end
-  let(:client) { app.send(:client) }
   let(:gif_image_url) { 'http://media2.giphy.com/media/pzOijFsdDrsS4/giphy.gif' }
+
   it 'sends a message with gif' do
     gif = Giphy::RandomGif.new('image_url' => gif_image_url)
     expect(Giphy).to receive(:random).and_return(gif)
-    expect(client).to receive(:message).with(channel: 'channel', text: "message\n#{gif_image_url}")
-    app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} send_message_with_gif_spec message", channel: 'channel', user: 'user'))
+    expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message("message\n#{gif_image_url}")
   end
+
   it 'eats up the error' do
-    expect(Giphy).to receive(:random) { fail 'oh no!' }
-    expect(client).to receive(:message).with(channel: 'channel', text: 'message')
-    app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} send_message_with_gif_spec message", channel: 'channel', user: 'user'))
+    expect(Giphy).to receive(:random) { raise 'oh no!' }
+    expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
   end
+
   it 'eats up nil gif' do
     expect(Giphy).to receive(:random).and_return(nil)
-    expect(client).to receive(:message).with(channel: 'channel', text: 'message')
-    app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} send_message_with_gif_spec message", channel: 'channel', user: 'user'))
+    expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
   end
+
   context 'send_gifs' do
     context 'set to false via client' do
+      let(:client) { SlackRubyBot::Client.new }
+
       before do
         client.send_gifs = false
       end
+
       it 'does not send a gif' do
         expect(Giphy).to_not receive(:random)
-        expect(client).to receive(:message).with(channel: 'channel', text: 'message')
-        app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} send_message_with_gif_spec message", channel: 'channel', user: 'user'))
-      end
-      after do
-        client.send_gifs = true
+        expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
       end
     end
+
     context 'set to false via config' do
       before do
         SlackRubyBot::Config.send_gifs = false
       end
       it 'does not send a gif' do
         expect(Giphy).to_not receive(:random)
-        expect(client).to receive(:message).with(channel: 'channel', text: 'message')
-        app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} send_message_with_gif_spec message", channel: 'channel', user: 'user'))
+        expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
       end
       after do
         SlackRubyBot::Config.reset!
       end
     end
+
     context 'set to false via SLACK_RUBY_BOT_SEND_GIFS' do
       before do
         ENV['SLACK_RUBY_BOT_SEND_GIFS'] = 'false'
       end
       it 'does not send a gif' do
         expect(Giphy).to_not receive(:random)
-        expect(client).to receive(:message).with(channel: 'channel', text: 'message')
-        app.send(:message, client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} send_message_with_gif_spec message", channel: 'channel', user: 'user'))
+        expect(message: "#{SlackRubyBot.config.user} send_message_with_gif_spec message").to respond_with_slack_message('message')
       end
       after do
         ENV.delete 'SLACK_RUBY_BOT_SEND_GIFS'

data/spec/slack-ruby-bot/commands/unknown_spec.rb

@@ -1,10 +1,6 @@
 require 'spec_helper'
 
 describe SlackRubyBot::Commands::Unknown do
-  def app
-    SlackRubyBot::App.new
-  end
-  let(:client) { app.send(:client) }
   it 'invalid command' do
     expect(message: "#{SlackRubyBot.config.user} foobar").to respond_with_slack_message("Sorry <@user>, I don't understand that command!")
   end
@@ -12,7 +8,10 @@ describe SlackRubyBot::Commands::Unknown do
     expect(message: "<@#{SlackRubyBot.config.user_id}>: foobar").to respond_with_slack_message("Sorry <@user>, I don't understand that command!")
   end
   it 'does not respond to sad face' do
+    client = SlackRubyBot::Client.new
+    message_hook = SlackRubyBot::Hooks::Message.new
+
     expect(SlackRubyBot::Commands::Base).to_not receive(:send_message)
-    SlackRubyBot::App.new.send(:message, client, Hashie::Mash.new(text: ':(('))
+    message_hook.call(client, Hashie::Mash.new(text: ':((', channel: 'channel', user: 'user'))
   end
 end

data/spec/slack-ruby-bot/hooks/hook_support_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Hooks::HookSupport do
+  subject do
+    Class.new do
+      include SlackRubyBot::Hooks::HookSupport
+
+      on 'hello' do |_ = nil, _ = nil|
+        'hello'
+      end
+
+      on 'hello' do |_ = nil, _ = nil|
+        'hello-2'
+      end
+
+      on 'goodbye' do |_ = nil, _ = nil|
+        'goodbye'
+      end
+    end
+  end
+
+  describe 'hook code blocks' do
+    it "let's you define class level code blocks" do
+      expect(subject.hook_blocks.size).to eq(2)
+      expect(subject.hook_blocks.keys).to eq %w(hello goodbye)
+
+      expect(subject.hook_blocks['hello'].size).to eq(2)
+      expect(subject.hook_blocks['goodbye'].size).to eq(1)
+
+      expect(subject.hook_blocks['hello'].first.call).to eq('hello')
+      expect(subject.hook_blocks['hello'].last.call).to eq('hello-2')
+      expect(subject.hook_blocks['goodbye'].last.call).to eq('goodbye')
+    end
+  end
+
+  describe '#flush_hook_blocks' do
+    it 'registers class hook blocks as hook handlers in set' do
+      object = subject.new
+
+      expect(object.hooks).to receive(:add).exactly(3).times.and_call_original
+
+      expect do
+        object.flush_hook_blocks
+      end.to change { object.hooks.handlers.size }.by(2)
+    end
+  end
+end

data/spec/slack-ruby-bot/hooks/message_spec.rb

@@ -1,16 +1,18 @@
 require 'spec_helper'
 
 describe SlackRubyBot::Hooks::Message do
-  let(:server) { SlackRubyBot::Server.new }
+  let(:message_hook) { described_class.new }
+
   describe '#child_command_classes' do
     it 'returns only child command classes' do
-      child_command_classes = server.send(:child_command_classes)
+      child_command_classes = message_hook.send(:child_command_classes)
       expect(child_command_classes).to include SlackRubyBot::Bot
       expect(child_command_classes).to_not include SlackRubyBot::Commands::Hi
     end
   end
+
   describe '#built_in_command_classes' do
-    let(:built_in_command_classes) { server.send(:built_in_command_classes) }
+    let(:built_in_command_classes) { message_hook.send(:built_in_command_classes) }
     it 'returns only built in command classes' do
       expect(built_in_command_classes).to include SlackRubyBot::Commands::Hi
       expect(built_in_command_classes).to include SlackRubyBot::Commands::Default
@@ -27,7 +29,7 @@ describe SlackRubyBot::Hooks::Message do
         SlackRubyBot::Config.allow_message_loops = true
       end
       it do
-        expect(server.send(:message_to_self_not_allowed?)).to be false
+        expect(message_hook.send(:message_to_self_not_allowed?)).to be false
       end
       after do
         SlackRubyBot::Config.reset!
@@ -38,7 +40,7 @@ describe SlackRubyBot::Hooks::Message do
         SlackRubyBot::Config.allow_message_loops = false
       end
       it do
-        expect(server.send(:message_to_self_not_allowed?)).to be true
+        expect(message_hook.send(:message_to_self_not_allowed?)).to be true
       end
       after do
         SlackRubyBot::Config.reset!
@@ -49,12 +51,12 @@ describe SlackRubyBot::Hooks::Message do
     let(:client) { Hashie::Mash.new(self: { 'id' => 'U0K8CKKT1' }) }
     context 'with message to self' do
       it do
-        expect(server.send(:message_to_self?, client, Hashie::Mash.new(user: 'U0K8CKKT1'))).to be true
+        expect(message_hook.send(:message_to_self?, client, Hashie::Mash.new(user: 'U0K8CKKT1'))).to be true
       end
     end
     context 'with message to another user' do
       it do
-        expect(server.send(:message_to_self?, client, Hashie::Mash.new(user: 'U0K8CKKT2'))).to be false
+        expect(message_hook.send(:message_to_self?, client, Hashie::Mash.new(user: 'U0K8CKKT2'))).to be false
       end
     end
   end
@@ -62,7 +64,7 @@ describe SlackRubyBot::Hooks::Message do
     let(:client) { Hashie::Mash.new(self: { 'id' => 'U0K8CKKT1' }) }
     it 'invokes a command' do
       expect(SlackRubyBot::Commands::Unknown).to receive(:invoke)
-      server.message(client, Hashie::Mash.new(user: 'U0K8CKKT2'))
+      message_hook.call(client, Hashie::Mash.new(user: 'U0K8CKKT2'))
     end
   end
 end

data/spec/slack-ruby-bot/hooks/set_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Hooks::Set do
+  let(:client) { Slack::RealTime::Client.new }
+
+  context 'adding hooks' do
+    subject { described_class.new(client) }
+
+    it 'lets you add hook handlers' do
+      handler = ->(_, _) {}
+
+      expect do
+        subject.add(:message, handler)
+      end.to change(subject, :handlers)
+
+      expect(subject.handlers).to have_key(:message)
+      expect(subject.handlers[:message]).to eq [handler]
+    end
+
+    it 'lets you add multiple handlers for the same hook' do
+      handler_1 = ->(_, _) {}
+      handler_2 = ->(_, _) {}
+
+      expect do
+        subject.add(:message, handler_1)
+        subject.add(:message, handler_2)
+      end.to change(subject, :handlers)
+
+      expect(subject.handlers).to have_key(:message)
+      expect(subject.handlers[:message]).to eq [handler_1, handler_2]
+    end
+  end
+
+  context 'Slack Client injection' do
+    subject { described_class.new }
+
+    it "doesn't barf when add callbacks prior to injecting client" do
+      expect do
+        subject.add(:hook, ->(_, _) {})
+      end.to_not raise_error
+    end
+
+    it 'triggers hooks when client is configured later' do
+      handler = ->(_, _) {}
+
+      subject.add(:hook, handler)
+
+      expect(subject).to receive(:flush_handlers).once.and_call_original
+      expect(handler).to receive(:call).once
+
+      subject.client = client
+
+      client.send(:callback, { data: 1 }, :hook) # Abusing the callback method 100% :D
+    end
+  end
+end

data/spec/slack-ruby-bot/rspec/respond_with_error_spec.rb

@@ -6,7 +6,7 @@ describe RSpec do
       command 'raise'
 
       def self.call(_client, _data, match)
-        fail ArgumentError, match[:command]
+        raise ArgumentError, match[:command]
       end
     end
   end

data/spec/slack-ruby-bot/server_spec.rb

@@ -31,12 +31,12 @@ describe SlackRubyBot::Server do
       expect(subject.send(:client).send_gifs?).to be true
     end
     it 'creates a client with a token' do
-      expect(client).to receive(:start!) { fail 'expected' }
+      expect(client).to receive(:start!) { raise 'expected' }
       expect(Slack::RealTime::Client).to receive(:new).with(token: 'token', send_gifs: true, aliases: %w(foo bar)).and_return(client)
       expect { subject.start! }.to raise_error RuntimeError, 'expected'
     end
     it 'asynchronously creates a client with a token' do
-      expect(client).to receive(:start_async) { fail 'expected' }
+      expect(client).to receive(:start_async) { raise 'expected' }
       expect(Slack::RealTime::Client).to receive(:new).with(token: 'token', send_gifs: true, aliases: %w(foo bar)).and_return(client)
       expect { subject.start_async }.to raise_error RuntimeError, 'expected'
     end
@@ -61,9 +61,9 @@ describe SlackRubyBot::Server do
       end.to raise_error Slack::Web::Api::Error, 'unknown'
     end
     [Faraday::Error::ConnectionFailed, Faraday::Error::TimeoutError, Faraday::Error::SSLError].each do |err|
-      it "#{err}" do
-        expect(client).to receive(:start!) { fail err, 'Faraday' }
-        expect(client).to receive(:start!) { fail 'unknown' }
+      it err.to_s do
+        expect(client).to receive(:start!) { raise err, 'Faraday' }
+        expect(client).to receive(:start!) { raise 'unknown' }
         expect do
           subject.run
         end.to raise_error 'unknown'

data/spec/spec_helper.rb

@@ -1 +1,2 @@
 require 'slack-ruby-bot/rspec'
+require 'webmock/rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-06 00:00:00.000000000 Z
+date: 2016-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: faye-websocket
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +142,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: 0.38.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.1
+        version: 0.38.0
 description: 
 email: dblock@dblock.org
 executables: []
@@ -211,9 +197,10 @@ files:
 - lib/slack-ruby-bot/commands/unknown.rb
 - lib/slack-ruby-bot/config.rb
 - lib/slack-ruby-bot/hooks.rb
-- lib/slack-ruby-bot/hooks/base.rb
 - lib/slack-ruby-bot/hooks/hello.rb
+- lib/slack-ruby-bot/hooks/hook_support.rb
 - lib/slack-ruby-bot/hooks/message.rb
+- lib/slack-ruby-bot/hooks/set.rb
 - lib/slack-ruby-bot/rspec.rb
 - lib/slack-ruby-bot/rspec/support/fixtures/slack/migration_in_progress.yml
 - lib/slack-ruby-bot/rspec/support/slack-ruby-bot/it_behaves_like_a_slack_bot.rb
@@ -261,7 +248,9 @@ files:
 - spec/slack-ruby-bot/commands/send_message_with_gif_spec.rb
 - spec/slack-ruby-bot/commands/unknown_spec.rb
 - spec/slack-ruby-bot/config_spec.rb
+- spec/slack-ruby-bot/hooks/hook_support_spec.rb
 - spec/slack-ruby-bot/hooks/message_spec.rb
+- spec/slack-ruby-bot/hooks/set_spec.rb
 - spec/slack-ruby-bot/rspec/respond_with_error_spec.rb
 - spec/slack-ruby-bot/server_spec.rb
 - spec/slack-ruby-bot/support/loggable_spec.rb
@@ -287,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: The easiest way to write a Slack bot in Ruby.
@@ -319,7 +308,9 @@ test_files:
 - spec/slack-ruby-bot/commands/send_message_with_gif_spec.rb
 - spec/slack-ruby-bot/commands/unknown_spec.rb
 - spec/slack-ruby-bot/config_spec.rb
+- spec/slack-ruby-bot/hooks/hook_support_spec.rb
 - spec/slack-ruby-bot/hooks/message_spec.rb
+- spec/slack-ruby-bot/hooks/set_spec.rb
 - spec/slack-ruby-bot/rspec/respond_with_error_spec.rb
 - spec/slack-ruby-bot/server_spec.rb
 - spec/slack-ruby-bot/support/loggable_spec.rb

data/lib/slack-ruby-bot/hooks/base.rb

@@ -1,10 +0,0 @@
-module SlackRubyBot
-  module Hooks
-    module Base
-      def included(caller)
-        caller.hooks ||= []
-        caller.hooks << name.demodulize.underscore.to_sym
-      end
-    end
-  end
-end