slack-ruby-bot 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 875e496a2ad1228dd53fb09a429cef5d26bb2b33
-  data.tar.gz: 115852404bdba1534728728a3cd56cf818c4ac0e
+  metadata.gz: 59c7b21c6857323515327cf3b14c4cd79bdfe25b
+  data.tar.gz: ae4beccb7a8d933d2f7b6fffb170241fad4a85d4
 SHA512:
-  metadata.gz: e7442eeded435d0f5b23b63310086946170f8c15b51b9bf4d45592a01197aa3eaf95ef27df7bbaa6bab1290c538b0ebb1847f030d5979cc7e43db0385a7c00bd
-  data.tar.gz: 670e97f790446e1974429ac8dad199e6a3312356df6b55f28ed605e9464262468c9527f0b0f6a768ad9e7f125d8d652c704722db96d018e7a6cea92358b3b65e
+  metadata.gz: 213767e2c36e1287e2916e24652b4ed873a3fb9bc84ff60e16bb7e6fcdf847d11dd622174421bed755febf65bf934bfc3000a3d3f0874afab7751b7c0bfc3db0
+  data.tar.gz: aaff927afb06fce22a67e090bf4954cea920a383a84277bf681a00e5c29154f8ff66b5c9ed979625bd03b2a1cf1f79d28b9beb37e0d53fe370bc12aa49ef77da

data/.rubocop_todo.yml

@@ -1,5 +1,5 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2016-02-02 07:10:58 -0500 using RuboCop version 0.32.1.
+# on 2016-02-09 15:33:27 -0500 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
@@ -11,27 +11,32 @@ Lint/HandleExceptions:
 
 # Offense count: 6
 Metrics/AbcSize:
-  Max: 28
+  Max: 42
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 102
 
 # Offense count: 2
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 12
 
-# Offense count: 126
+# Offense count: 130
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 158
 
-# Offense count: 6
+# Offense count: 7
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 21
+  Max: 27
 
 # Offense count: 2
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 12
 
-# Offense count: 19
+# Offense count: 20
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.7.0 (3/6/2016)
+
+* Improved regular expression matching performance with less matching per command - [@dblock](https://github.com/dblock).
+* Don't attempt to pre-authenticate via `auth!`, use RealTime client local store - [@dblock](https://github.com/dblock).
+* Extended `match` with `scan` that can make multiple captures - [@dblock](https://github.com/dblock).
+
 ### 0.6.2 (2/4/2016)
 
 * [#44](https://github.com/dblock/slack-ruby-bot/pull/44): Bot graceful shutdown - [@accessd](https://github.com/accessd).

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. 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.7.0. See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
 
 ## Usage
 
@@ -125,6 +125,20 @@ end
 
 ![](screenshots/weather.gif)
 
+You can also capture multiple matchers with `scan`.
+
+```ruby
+class Market < SlackRubyBot::Bot
+  scan(/(\[A-Z]{2,5})/) do |client, data, stocks|
+    # lookup stock market price
+  end
+end
+```
+
+![](screenshots/market.gif)
+
+See [examples/market](examples/market/marketbot.rb) for a working example.
+
 ### SlackRubyBot::Commands::Base
 
 The `SlackRubyBot::Bot` class is DSL sugar deriving from `SlackRubyBot::Commands::Base`. For more involved bots you can organize the bot implementation into subclasses of `SlackRubyBot::Commands::Base` manually. By default a command class responds, case-insensitively, to its name. A class called `Phone` that inherits from `SlackRubyBot::Commands::Base` responds to `phone` and `Phone` and calls the `call` method when implemented.
@@ -223,11 +237,9 @@ You may want to integrate a bot or multiple bots into other systems, in which ca
 ```ruby
 EM.run do
   bot1 = SlackRubyBot::Server.new(token: token1, aliases: ['bot1'])
-  bot1.auth!
   bot1.start_async
 
   bot2 = SlackRubyBot::Server.new(token: token2, send_gifs: false, aliases: ['bot2'])
-  bot2.auth!
   bot2.start_async
 end
 ```

data/UPGRADING.md

@@ -1,6 +1,16 @@
 Upgrading SlackRubyBot
 ======================
 
+### Upgrading to >= 0.7.0
+
+#### Simplify Match Expression Checking
+
+The regular expression parser for commands will now include a `nil` value for `expression` when an expression is not present. You can therefore no longer rely on checking `match.names.include?('expression')`, instead check `match['expression']`.
+
+#### Remove any bot.auth! calls
+
+SlackRubyBot 0.6.x versions invoked a method called `auth!`, which caused a pre-flight authentication via Slack Web API `auth_test` method and collected a number of properties, such as client and team ID or name. This method has been removed in favor of using data available in the `Slack::RealTime::Client` local store introduced in [slack-ruby-client#54](https://github.com/dblock/slack-ruby-client/issues/54). Remove any explicit calls to this method.
+
 ### Upgrading to >= 0.6.0
 
 While entirely compatible with the 0.5.x series, a number of methods have been deprecated and will be removed in the next release.

data/examples/market/Gemfile

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

data/examples/market/Procfile

@@ -0,0 +1 @@
+console: bundle exec ruby marketbot.rb

data/examples/market/marketbot.rb

@@ -0,0 +1,24 @@
+require 'slack-ruby-bot'
+require 'yahoo-finance'
+
+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|
+      next if quote.symbol == 'N/A'
+      client.web_client.chat_postMessage(
+        channel: data.channel,
+        as_user: true,
+        attachments: [
+          {
+            fallback: "#{quote.name} (#{quote.symbol}): $#{quote.last_trade_price}",
+            title: "#{quote.name} (#{quote.symbol})",
+            text: "$#{quote.last_trade_price} (#{quote.change_in_percent})",
+            color: quote.change.to_f > 0 ? '#00FF00' : '#FF0000'
+          }
+        ]
+      )
+    end
+  end
+end
+
+MarketBot.run

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

@@ -21,15 +21,16 @@ module SlackRubyBot
 
     private
 
-    def auth!
-      super
+    def hello(client, _data)
       SlackRubyBot.configure do |config|
-        config.url = client.auth['url']
-        config.team = client.auth['team']
-        config.user = client.auth['user']
-        config.team_id = client.auth['team_id']
-        config.user_id = client.auth['user_id']
-      end
+        config.url = "https://#{client.team.domain}.slack.com"
+        config.team = client.team.name
+        config.team_id = client.team.id
+        config.user = client.self.name
+        config.user_id = client.self.id
+        logger.info "Welcome #{config.user} to the #{config.team} team."
+      end if client.team && client.self
+      super
     end
 
     def reset!

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

@@ -1,7 +1,6 @@
 module SlackRubyBot
   class Client < Slack::RealTime::Client
     include Loggable
-    attr_accessor :auth
     attr_accessor :aliases
     attr_accessor :send_gifs
 
@@ -14,14 +13,14 @@ module SlackRubyBot
     def names
       [
         SlackRubyBot::Config.user,
-        auth ? auth['user'] : nil,
+        self.self ? self.self.name : nil,
         aliases,
         SlackRubyBot::Config.aliases,
-        auth ? "<@#{auth['user_id'].downcase}>" : nil,
+        self.self && self.self.id ? "<@#{self.self.id.downcase}>" : nil,
         SlackRubyBot::Config.user_id ? "<@#{SlackRubyBot::Config.user_id.downcase}>" : nil,
-        auth ? "<@#{auth['user_id'].downcase}>:" : nil,
+        self.self && self.self.id ? "<@#{self.self.id.downcase}>:" : nil,
         SlackRubyBot::Config.user_id ? "<@#{SlackRubyBot::Config.user_id.downcase}>:" : nil,
-        auth ? "#{auth['user']}:" : nil,
+        self.self && self.self.name ? "#{self.self.name.downcase}:" : nil,
         SlackRubyBot::Config.user ? "#{SlackRubyBot::Config.user}:" : nil
       ].compact.flatten
     end
@@ -35,11 +34,11 @@ module SlackRubyBot
     end
 
     def name
-      SlackRubyBot.config.user || (auth && auth['user'])
+      SlackRubyBot.config.user || (self.self && self.self.name)
     end
 
     def url
-      SlackRubyBot.config.url || (auth && auth['url'])
+      SlackRubyBot.config.url || super
     end
 
     def say(options = {})

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

@@ -29,44 +29,53 @@ module SlackRubyBot
         end
 
         def operator(*values, &block)
-          values.each do |value|
-            match Regexp.new("^(?<operator>\\#{value})(?<expression>.*)$", Regexp::IGNORECASE), &block
-          end
+          values = values.map { |value| Regexp.escape(value) }.join('|')
+          match Regexp.new("^(?<operator>#{values})(?<expression>.*)$", Regexp::IGNORECASE), &block
         end
 
         def command(*values, &block)
-          values.each do |value|
-            escaped = Regexp.escape(value)
-            match Regexp.new("^(?<bot>[[:alnum:][:punct:]@<>]*)[\\s]+(?<command>#{escaped})$", Regexp::IGNORECASE), &block
-            match Regexp.new("^(?<bot>[[:alnum:][:punct:]@<>]*)[\\s]+(?<command>#{escaped})[\\s]+(?<expression>.*)$", Regexp::IGNORECASE), &block
-          end
+          values = values.map { |value| Regexp.escape(value) }.join('|')
+          match Regexp.new("^(?<bot>[[:alnum:][:punct:]@<>]*)[\\s]+(?<command>#{values})([\\s]+(?<expression>.*)|)$", Regexp::IGNORECASE), &block
         end
 
         def invoke(client, data)
           finalize_routes!
           expression, text = parse(client, 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') && !client.name?(match['bot'])
+          routes.each_pair do |route, options|
+            match_method = options[:match_method]
+            case match_method
+            when :match
+              match = route.match(expression)
+              match ||= route.match(text) if text
+              next unless match
+              next if match.names.include?('bot') && !client.name?(match['bot'])
+            when :scan
+              match = expression.scan(route)
+              next unless match.any?
+            end
             called = true
-            if method
-              method.call(client, data, match)
+            call = options[:call]
+            if call
+              call.call(client, data, match)
             elsif respond_to?(:call)
               send(:call, client, data, match)
             else
               fail NotImplementedError, data.text
             end
             break
-          end
+          end if expression
           called
         end
 
         def match(match, &block)
           self.routes ||= {}
-          self.routes[match] = block
+          self.routes[match] = { match_method: :match, call: block }
+        end
+
+        def scan(match, &block)
+          self.routes ||= {}
+          self.routes[match] = { match_method: :scan, call: block }
         end
 
         private

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

@@ -4,7 +4,8 @@ module SlackRubyBot
       extend Base
 
       def hello(client, _data)
-        logger.info "Successfully connected to #{client.url || 'slack'}."
+        return unless client && client.team
+        logger.info "Successfully connected to https://#{client.team.domain}.slack.com."
       end
     end
   end

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

@@ -10,18 +10,4 @@ shared_examples 'a slack ruby bot' do
       expect { subject }.to raise_error RuntimeError, "Missing ENV['SLACK_API_TOKEN']."
     end
   end
-  context 'configured', vcr: { cassette_name: 'auth_test' } do
-    context 'run' do
-      before do
-        subject.send(:auth!)
-      end
-      it 'succeeds auth' do
-        expect(subject.config.url).to eq 'https://rubybot.slack.com/'
-        expect(subject.config.team).to eq 'team_name'
-        expect(subject.config.user).to eq 'user_name'
-        expect(subject.config.team_id).to eq 'TDEADBEEF'
-        expect(subject.config.user_id).to eq 'UBAADFOOD'
-      end
-    end
-  end
 end

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

@@ -16,7 +16,6 @@ module SlackRubyBot
     end
 
     def run
-      auth!
       loop do
         handle_execeptions do
           handle_signals
@@ -25,11 +24,6 @@ module SlackRubyBot
       end
     end
 
-    def auth!
-      client.auth = client.web_client.auth_test
-      logger.info "Welcome '#{client.auth['user']}' to the '#{client.auth['team']}' team at #{client.auth['url']}."
-    end
-
     def start!
       @stopping = false
       @async = false
@@ -47,6 +41,11 @@ 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

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

@@ -1,3 +1,3 @@
 module SlackRubyBot
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

data/slack-ruby-bot.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
-  s.homepage = 'http://github.com/dblock/slack-ruby-bot'
+  s.homepage = 'https://github.com/dblock/slack-ruby-bot'
   s.licenses = ['MIT']
   s.summary = 'The easiest way to write a Slack bot in Ruby.'
   s.add_dependency 'hashie'

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

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands do
+  let! :command do
+    Class.new(SlackRubyBot::Commands::Base) do
+      command 'set' do |client, data, match|
+        if match['expression']
+          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]}")
+        end
+      end
+    end
+  end
+  def app
+    SlackRubyBot::App.new
+  end
+  it 'parses expression' do
+    expect(message: "#{SlackRubyBot.config.user} set").to respond_with_slack_message('set')
+    expect(message: "#{SlackRubyBot.config.user} set x").to respond_with_slack_message('set: x=')
+    expect(message: "#{SlackRubyBot.config.user} set x y").to respond_with_slack_message('set: x=y')
+  end
+end

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

@@ -6,7 +6,7 @@ describe SlackRubyBot::Commands do
       command 'nil_text'
 
       def self.call(_client, data, _match)
-        send_message cilent, data.channel, nil
+        send_message client, data.channel, nil
       end
     end
   end

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

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe SlackRubyBot::Commands do
+  let! :command do
+    Class.new(SlackRubyBot::Commands::Base) do
+      scan(/(\$[A-Z]+)/) do |client, data, captures|
+        client.say(channel: data.channel, text: "There were #{captures.count} captures: #{captures.join(', ')}.")
+      end
+    end
+  end
+  def app
+    SlackRubyBot::App.new
+  end
+  it 'captures' do
+    expect(message: 'quote $YHOO and $MSFT').to respond_with_slack_message('There were 2 captures: $YHOO, $MSFT.')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-04 00:00:00.000000000 Z
+date: 2016-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -185,6 +185,9 @@ files:
 - Rakefile
 - TUTORIAL.md
 - UPGRADING.md
+- examples/market/Gemfile
+- examples/market/Procfile
+- examples/market/marketbot.rb
 - examples/minimal/Gemfile
 - examples/minimal/Procfile
 - examples/minimal/pongbot.rb
@@ -212,7 +215,6 @@ files:
 - lib/slack-ruby-bot/hooks/hello.rb
 - lib/slack-ruby-bot/hooks/message.rb
 - lib/slack-ruby-bot/rspec.rb
-- lib/slack-ruby-bot/rspec/support/fixtures/slack/auth_test.yml
 - 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
 - lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb
@@ -227,6 +229,7 @@ files:
 - screenshots/aliases.gif
 - screenshots/demo.gif
 - screenshots/dms.gif
+- screenshots/market.gif
 - screenshots/register-bot.png
 - screenshots/weather.gif
 - slack-ruby-bot.gemspec
@@ -241,6 +244,7 @@ files:
 - spec/slack-ruby-bot/commands/commands_spaces_spec.rb
 - spec/slack-ruby-bot/commands/commands_spec.rb
 - spec/slack-ruby-bot/commands/commands_with_block_spec.rb
+- spec/slack-ruby-bot/commands/commands_with_expression_spec.rb
 - spec/slack-ruby-bot/commands/direct_messages_spec.rb
 - spec/slack-ruby-bot/commands/empty_text_spec.rb
 - spec/slack-ruby-bot/commands/help_spec.rb
@@ -251,6 +255,7 @@ files:
 - spec/slack-ruby-bot/commands/not_implemented_spec.rb
 - spec/slack-ruby-bot/commands/operators_spec.rb
 - spec/slack-ruby-bot/commands/operators_with_block_spec.rb
+- spec/slack-ruby-bot/commands/scan_spec.rb
 - spec/slack-ruby-bot/commands/send_gif_spec.rb
 - spec/slack-ruby-bot/commands/send_message_spec.rb
 - spec/slack-ruby-bot/commands/send_message_with_gif_spec.rb
@@ -262,7 +267,7 @@ files:
 - spec/slack-ruby-bot/support/loggable_spec.rb
 - spec/slack-ruby-bot/version_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/dblock/slack-ruby-bot
+homepage: https://github.com/dblock/slack-ruby-bot
 licenses:
 - MIT
 metadata: {}
@@ -297,6 +302,7 @@ test_files:
 - spec/slack-ruby-bot/commands/commands_spaces_spec.rb
 - spec/slack-ruby-bot/commands/commands_spec.rb
 - spec/slack-ruby-bot/commands/commands_with_block_spec.rb
+- spec/slack-ruby-bot/commands/commands_with_expression_spec.rb
 - spec/slack-ruby-bot/commands/direct_messages_spec.rb
 - spec/slack-ruby-bot/commands/empty_text_spec.rb
 - spec/slack-ruby-bot/commands/help_spec.rb
@@ -307,6 +313,7 @@ test_files:
 - spec/slack-ruby-bot/commands/not_implemented_spec.rb
 - spec/slack-ruby-bot/commands/operators_spec.rb
 - spec/slack-ruby-bot/commands/operators_with_block_spec.rb
+- spec/slack-ruby-bot/commands/scan_spec.rb
 - spec/slack-ruby-bot/commands/send_gif_spec.rb
 - spec/slack-ruby-bot/commands/send_message_spec.rb
 - spec/slack-ruby-bot/commands/send_message_with_gif_spec.rb

data/lib/slack-ruby-bot/rspec/support/fixtures/slack/auth_test.yml

@@ -1,16 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://slack.com/api/auth.test
-    body:
-      string: token=token
-  response:
-    status:
-      code: 200
-      message: OK
-    body:
-      encoding: UTF-8
-      string: '{"ok":true,"url":"https:\/\/rubybot.slack.com\/","team":"team_name","user":"user_name","team_id":"TDEADBEEF","user_id":"UBAADFOOD"}'
-    http_version:
-  recorded_at: Tue, 28 Apr 2015 12:55:22 GMT