slack-ruby-bot 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e5f5c4438e5c5fa63f3b7debdcb264d1070f050
-  data.tar.gz: a9414930ce2d2284564db60086a85a190ece557c
+  metadata.gz: e7cc27a7b3b83580c0e59dfc18919ac3a6ec68c4
+  data.tar.gz: af0fd175600080e47df3d3285bc9aa0ad665c95e
 SHA512:
-  metadata.gz: 5d2fb96b140f27a2ebb4195d39f87c7ac972faf15a95d6823149c5561292b8fab8543bc19c546100a0f431d25ce51db765feab3719b96ea0cd6ae7b66d1263ee
-  data.tar.gz: 6d55c7c74e378924db8689625e145807d6b40f50b3de3dfbef48f37e9daee0b775ff01bdcf44f648db8ba434ca324f503522e328f857d0a613e342e668f34655
+  metadata.gz: cc4d80b5c27530ddb7d53e7043e75e44420d2ea3f57ee1aff16993dce0bc22f848523f00982d0f6cd153e90aed0bf4b8dafc622d2474e572b44f949432e6a2ff
+  data.tar.gz: eb6b9f4a8b1233256040854dc9d8642826e3743453b72708adab1f2854be83160bccd5caa7fca767803af09428394758a846babf099ddacacadc3edff68c9e92

data/.rubocop_todo.yml

@@ -1,5 +1,5 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-09-23 08:45:19 -0400 using RuboCop version 0.32.1.
+# on 2015-10-28 17:37:44 -0700 using RuboCop version 0.32.1.
 # 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
@@ -13,15 +13,15 @@ Lint/HandleExceptions:
 Lint/UselessAccessModifier:
   Enabled: false
 
-# Offense count: 4
+# Offense count: 5
 Metrics/AbcSize:
   Max: 23
 
-# Offense count: 1
+# Offense count: 2
 Metrics/CyclomaticComplexity:
   Max: 7
 
-# Offense count: 85
+# Offense count: 91
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 142
@@ -31,6 +31,10 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 21
 
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8
+
 # Offense count: 15
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -1,27 +1,32 @@
-### 0.4.4 (Next)
+### 0.4.5 (10/29/2015)
 
-* [#17](https://github.com/dblock/slack-ruby-bot/issues/17): Address bot by `name:` - [@dblock](https://githubcom/dblock).
-* [#19](https://github.com/dblock/slack-ruby-bot/issues/19): Retry on `Faraday::Error::TimeoutError`, `TimeoutError` and `SSLError` - [@dblock](https://githubcom/dblock).
-* [#3](https://github.com/dblock/slack-ruby-bot/issues/3): Retry on `migration_in_progress` errors during `rtm.start` - [@dblock](https://githubcom/dblock).
-* Respond to direct messages without being addressed by name - [@dblock](https://githubcom/dblock).
+* [#23](https://github.com/dblock/slack-ruby-bot/pull/23): Fixed `match` that forced bot name into the expression being evaluated - [@dblock](https://github.com/dblock).
+* [#22](https://github.com/dblock/slack-ruby-bot/issues/22), [slack-ruby-client#17](https://github.com/dblock/slack-ruby-client/issues/17): Do not respond to messages from self, override with `allow_message_loops` - [@dblock](https://github.com/dblock).
+
+### 0.4.4 (10/5/2015)
+
+* [#17](https://github.com/dblock/slack-ruby-bot/issues/17): Address bot by `name:` - [@dblock](https://github.com/dblock).
+* [#19](https://github.com/dblock/slack-ruby-bot/issues/19): Retry on `Faraday::Error::TimeoutError`, `TimeoutError` and `SSLError` - [@dblock](https://github.com/dblock).
+* [#3](https://github.com/dblock/slack-ruby-bot/issues/3): Retry on `migration_in_progress` errors during `rtm.start` - [@dblock](https://github.com/dblock).
+* Respond to direct messages without being addressed by name - [@dblock](https://github.com/dblock).
 * Added `send_gif`, to allow GIFs to be sent without text - [@maclover7](https://github.com/maclover7).
 
 ### 0.4.3 (8/21/2015)
 
-* [#13](https://github.com/dblock/slack-ruby-bot/issues/13): You can now address the bot by its Slack @id - [@dblock](https://githubcom/dblock).
+* [#13](https://github.com/dblock/slack-ruby-bot/issues/13): You can now address the bot by its Slack @id - [@dblock](https://github.com/dblock).
 
 ### 0.4.2 (8/20/2015)
 
-* [#12](https://github.com/dblock/slack-ruby-bot/issues/12): Added support for bot aliases - [@dblock](https://githubcom/dblock).
+* [#12](https://github.com/dblock/slack-ruby-bot/issues/12): Added support for bot aliases - [@dblock](https://github.com/dblock).
 
 ### 0.4.1 (7/25/2015)
 
-* Use a real client in `respond_with_slack_message` expectaions - [@dblock](https://githubcom/dblock).
+* Use a real client in `respond_with_slack_message` expectaions - [@dblock](https://github.com/dblock).
 
 ### 0.4.0 (7/25/2015)
 
-* Using [slack-ruby-client](https://github.com/dblock/slack-ruby-client) - [@dblock](https://githubcom/dblock).
-* Use RealTime API to post messages - [@dblock](https://githubcom/dblock).
+* Using [slack-ruby-client](https://github.com/dblock/slack-ruby-client) - [@dblock](https://github.com/dblock).
+* Use RealTime API to post messages - [@dblock](https://github.com/dblock).
 
 ### 0.3.1 (7/21/2015)
 

data/README.md

@@ -6,6 +6,8 @@ Slack-Ruby-Bot
 
 A generic Slack bot framework written in Ruby on top of [slack-ruby-client](https://github.com/dblock/slack-ruby-client). This library does all the heavy lifting, such as message parsing, so you can focus on implementing slack bot commands. It also attempts to introduce the bare minimum number of requirements or any sorts of limitations. It's a Slack bot boilerplate.
 
+![](slack.png)
+
 ## Usage
 
 ### A Minimal Bot
@@ -193,6 +195,16 @@ module MyBot
 end
 ```
 
+### Message Loop Protection
+
+By default bots do not respond to their own messages. If you wish to change that behavior, set `allow_message_loops` to `true`.
+
+```ruby
+SlackRubyBot.configure do |config|
+  config.allow_message_loops = true
+end
+```
+
 ### RSpec Shared Behaviors
 
 Slack-ruby-bot ships with a number of shared RSpec behaviors that can be used in your RSpec tests. Require 'slack-ruby-bot/rspec' in your `spec_helper.rb`.

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

@@ -54,10 +54,11 @@ module SlackRubyBot
 
       def self.invoke(client, data)
         self.finalize_routes!
-        expression = parse(data)
+        expression, text = parse(data)
         called = false
         routes.each_pair do |route, method|
           match = route.match(expression)
+          match ||= route.match(text) if text
           next unless match
           next if match.names.include?('bot') && !SlackRubyBot.config.name?(match['bot'])
           called = true
@@ -88,7 +89,7 @@ module SlackRubyBot
             return text if td == name || td.starts_with?("#{name} ")
           end
         end
-        "#{SlackRubyBot.config.user} #{text}"
+        ["#{SlackRubyBot.config.user} #{text}", text]
       end
 
       def self.finalize_routes!

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

@@ -9,6 +9,7 @@ module SlackRubyBot
     attr_accessor :user_id
     attr_accessor :team
     attr_accessor :team_id
+    attr_accessor :allow_message_loops
 
     def names
       [user, aliases, "<@#{user_id.downcase}>", "<@#{user_id.downcase}>:", "#{user}:"].compact.flatten

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

@@ -5,6 +5,7 @@ module SlackRubyBot
 
       def message(client, data)
         data = Hashie::Mash.new(data)
+        return if !SlackRubyBot::Config.allow_message_loops && (client.self && client.self['id'] == data.user)
         data.text.strip! if data.text
         result = child_command_classes.detect { |d| d.invoke(client, data) }
         result ||= built_in_command_classes.detect { |d| d.invoke(client, data) }

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

@@ -1,3 +1,3 @@
 module SlackRubyBot
-  VERSION = '0.4.4'
+  VERSION = '0.4.5'
 end

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

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands do
+  let! :command do
+    Class.new(SlackRubyBot::Commands::Base) do
+      match(/^Reticulate (?<spline_name>\w*)$/) do |client, data, match|
+        send_message client, data.channel, "Reticulated #{match[:spline_name]}."
+      end
+    end
+  end
+  def app
+    SlackRubyBot::App.new
+  end
+  it 'matches' do
+    expect(message: 'Reticulate spline').to respond_with_slack_message('Reticulated spline.')
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe SlackRubyBot::App do
+  def app
+    SlackRubyBot::App.new
+  end
+  let(:client) { subject.send(:client) }
+  before do
+    allow(client).to receive(:self).and_return('id' => 'UDEADBEEF')
+    allow(Giphy).to receive(:random)
+  end
+  context 'default' do
+    it 'does not respond to self' do
+      expect(SlackRubyBot::Commands::Base).to_not receive(:send_client_message)
+      subject.send(:message, client, text: "#{SlackRubyBot.config.user} hi", channel: 'channel', user: 'UDEADBEEF')
+    end
+  end
+  context 'with allow_message_loops=true' do
+    before do
+      SlackRubyBot.configure do |config|
+        config.allow_message_loops = true
+      end
+    end
+    after do
+      SlackRubyBot.configure do |config|
+        config.allow_message_loops = nil
+      end
+    end
+    it 'responds to self' do
+      expect(SlackRubyBot::Commands::Base).to receive(:send_client_message)
+      subject.send(:message, client, text: "#{SlackRubyBot.config.user} hi", channel: 'channel', user: 'UDEADBEEF')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -226,6 +226,7 @@ files:
 - screenshots/register-bot.png
 - screenshots/weather.gif
 - slack-ruby-bot.gemspec
+- slack.png
 - spec/slack-ruby-bot/app_spec.rb
 - spec/slack-ruby-bot/commands/about_spec.rb
 - spec/slack-ruby-bot/commands/aliases_spec.rb
@@ -237,6 +238,8 @@ files:
 - spec/slack-ruby-bot/commands/empty_text_spec.rb
 - spec/slack-ruby-bot/commands/help_spec.rb
 - spec/slack-ruby-bot/commands/hi_spec.rb
+- spec/slack-ruby-bot/commands/match_spec.rb
+- spec/slack-ruby-bot/commands/message_loop_spec.rb
 - spec/slack-ruby-bot/commands/nil_message_spec.rb
 - spec/slack-ruby-bot/commands/not_implemented_spec.rb
 - spec/slack-ruby-bot/commands/operators_spec.rb
@@ -284,6 +287,8 @@ test_files:
 - spec/slack-ruby-bot/commands/empty_text_spec.rb
 - spec/slack-ruby-bot/commands/help_spec.rb
 - spec/slack-ruby-bot/commands/hi_spec.rb
+- spec/slack-ruby-bot/commands/match_spec.rb
+- spec/slack-ruby-bot/commands/message_loop_spec.rb
 - spec/slack-ruby-bot/commands/nil_message_spec.rb
 - spec/slack-ruby-bot/commands/not_implemented_spec.rb
 - spec/slack-ruby-bot/commands/operators_spec.rb