slack-ruby-bot 0.10.5 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3a131c7f852f22c4039f8a40e25a7a914d40a0f
-  data.tar.gz: 1f31b3ef7089c492712d5cc5bc0edec6947a7e5a
+  metadata.gz: 9478d61ec600a816259bd73d8aab8120a1d76ed2
+  data.tar.gz: c1d005b0e9c308af61dbe3d8ec112f3a8e72b62a
 SHA512:
-  metadata.gz: 6d721d75a37a031b6e12003f47a4ba68e7e60be61abd26f2b76999768448b18ef8ab7bc01394aab7047978ef7ee5845ea79a11540232fe7abc2d508c44076188
-  data.tar.gz: '09ca8c66e5ffe883faa832208fe341379131ed710f7ed6945959564d92ce2a9e8ed2196f96a262aace493b043c7d4852f3f6d25bc82dc5e698c754ee7b869328'
+  metadata.gz: ce48f28806019da9be29699e48d7aa292d70b462df75d6e5eccf0f5a7c40dde8eab1f99b3465779c55ec4c14d64c5a91f2cbbb1b370d4e570f4185701ab22720
+  data.tar.gz: 6d13d2fe47144b8cbec5740b6598aa3b7e0f8bdf1010b27ffb41d313eb33f3d67da6e745cffc54221bdede92584a183f48decb3b5a1daeec84ecf866ec423887

data/.rubocop_todo.yml

@@ -1,11 +1,25 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-10-15 13:34:54 -0700 using RuboCop version 0.38.0.
+# on 2018-03-29 16:47:34 +0200 using RuboCop version 0.51.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
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/IndentHeredoc:
+  Exclude:
+    - 'lib/slack-ruby-bot/commands/help.rb'
+    - 'spec/slack-ruby-bot/commands/help_spec.rb'
+
+# Offense count: 1
+Lint/DuplicateMethods:
+  Exclude:
+    - 'lib/slack-ruby-bot/hooks/set.rb'
+
 # Offense count: 1
 Lint/HandleExceptions:
   Exclude:
@@ -15,31 +29,57 @@ Lint/HandleExceptions:
 Metrics/AbcSize:
   Max: 40
 
+# Offense count: 30
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 131
+
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 104
+  Max: 131
 
 # Offense count: 2
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 16
 
-# Offense count: 218
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# Offense count: 249
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 147
+  Max: 151
 
-# Offense count: 10
+# Offense count: 11
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 19
+  Max: 27
 
 # Offense count: 2
 Metrics/PerceivedComplexity:
-  Max: 13
+  Max: 14
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/slack-ruby-bot.rb'
 
-# Offense count: 31
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: snake_case, normalcase, non_integer
+Naming/VariableNumber:
+  Exclude:
+    - 'spec/slack-ruby-bot/hooks/set_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect.
+Performance/HashEachMethods:
+  Exclude:
+    - 'lib/slack-ruby-bot/hooks/set.rb'
+
+# Offense count: 32
 Style/Documentation:
   Enabled: false
 
@@ -49,12 +89,8 @@ Style/DoubleNegation:
     - 'lib/slack-ruby-bot/commands/base.rb'
 
 # Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
-Style/FileName:
-  Exclude:
-    - 'lib/slack-ruby-bot.rb'
-
-# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: module_function, extend_self
 Style/ModuleFunction:
   Exclude:
     - 'lib/slack-ruby-bot/config.rb'

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.11.0 (04/02/2018)
+
+* [#182](https://github.com/slack-ruby/slack-ruby-bot/pull/182): Refactor CommandsHelper class and Help module - [@mdudzinski](https://github.com/mdudzinski).
+* [#180](https://github.com/slack-ruby/slack-ruby-bot/pull/180): Allow to respond to text in attachments #177 - [@mdudzinski](https://github.com/mdudzinski).
+* [#173](https://github.com/slack-ruby/slack-ruby-bot/pull/173): Exposing SlackRubyBot::CommandsHelper.find_command_help_attrs - [@alexagranov](https://github.com/alexagranov).
+* [#179](https://github.com/slack-ruby/slack-ruby-bot/pull/179): Allow multiline expression - [@tiagotex](https://github.com/tiagotex).
+* [#183](https://github.com/slack-ruby/slack-ruby-bot/pull/183): Add missing test dependency to readme.md - [@hoshinotsuyoshi](https://github.com/hoshinotsuyoshi).
+
 ### 0.10.5 (10/15/2017)
 
 * Refactored `SlackRubyBot::MVC::Controller::Base`, consolidated ivar handling, centralized object allocations and DRYed up the code - [@chuckremes](https://github.com/chuckremes).

data/Gemfile

@@ -3,6 +3,9 @@ source 'http://rubygems.org'
 gemspec
 
 gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
+
+# rubocop:enable Bundler/OrderedGems
+
 gem 'giphy', require: false if ENV.key?('WITH_GIPHY')
 
 group :test do

data/README.md

@@ -19,7 +19,9 @@ If you are not familiar with Slack bots or Slack API concepts, you might want to
 
 ## Stable Release
 
-You're reading the documentation for the **next** release of slack-ruby-bot. Please see the documentation for the [last stable release, v0.10.1](https://github.com/slack-ruby/slack-ruby-bot/tree/v0.10.1) unless you're integrating with HEAD. 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 **next** release of slack-ruby-bot.
+Please see the documentation for the [last stable release, v0.10.5](https://github.com/slack-ruby/slack-ruby-bot/tree/v0.10.5) unless you're integrating with HEAD.
+See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
 
 ## Usage
 
@@ -104,6 +106,28 @@ end
 
 Operator match data includes `match['operator']` and `match['expression']`. The `bot` match always checks against the `SlackRubyBot::Config.user` setting.
 
+### Threaded Messages
+
+To reply to a message in a thread you must provide a reference to the first message that initiated the thread, which is available as either `data.ts` if no threaded messages have been sent, or `data.thread_ts` if the message being replied to is already in a thread. See [message-threading](https://api.slack.com/docs/message-threading) for more information.
+
+```ruby
+command 'reply in thread' do |client, data, match|
+  client.say(
+    channel: data.channel,
+    text: "let's avoid spamming everyone, I will tell you what you need in this thread",
+    thread_ts: data.thread_ts || data.ts
+  )
+end
+```
+
+_Note that sending a message using only `thread_ts: data.ts` can cause some permanent issues where Slack will keep reporting inaccessible messages as unread. At the time of writing the slack team is still having problems clearing those notifications. As recommended by the slack documentation ..._
+
+> A true parent's thread_ts should be used when replying. Providing a child's message ID will result in a new, detached thread breaking all context and sense.
+
+_... the replies to a thread should always be sent to the message `ts` that started the thread, available as `thread_ts` for subsequent messages. Hence `data.thread_ts || data.ts`._
+
+For additional options, including broadcasting, see [slack-ruby-client#chat_postMessage](https://github.com/slack-ruby/slack-ruby-client/blob/41539c647ac877400f20aa338aa42d2ebfd2866b/lib/slack/web/api/endpoints/chat.rb#L105).
+
 ### Bot Aliases
 
 A bot will always respond to its name (eg. `rubybot`) and Slack ID (eg. `@rubybot`), but you can specify multiple aliases via the `SLACK_RUBY_BOT_ALIASES` environment variable or via an explicit configuration.
@@ -154,6 +178,46 @@ end
 
 See [examples/market](examples/market/marketbot.rb) for a working example.
 
+### Matching text in message attachments
+
+You can respond to text in [attachments](https://api.slack.com/docs/message-attachments) with 
+`attachment`. It will scan `text`, `pretext` and `title` fields in each attachment until a first
+match is found.
+
+For example you can match [this example attachment](http://goo.gl/K0cLkH)
+by its `title` with the following bot:
+
+```ruby
+class Attachment < SlackRubyBot::Bot
+  attachment 'Slack API Documentation' do |client, data, match|
+    client.say(channel: data.channel, text: "Matched by #{match.attachment_field}.")
+    client.say(channel: data.channel, text: "The attachment's text: #{match.attachment.text}.")
+  end
+end
+```
+
+You can also define which fields in attachment object should be scanned.
+
+Scan only a single field:
+
+```ruby
+class Attachment < SlackRubyBot::Bot
+  attachment 'Slack API Documentation', :title do |client, data, match|
+    # implementation details
+  end
+end
+```
+
+Scan multiple fields:
+
+```ruby
+class Attachment < SlackRubyBot::Bot
+  attachment 'Slack API Documentation', %i[text pretext author_name] do |client, data, match|
+    # implementation details
+  end
+end
+```
+
 ### Providing description for your bot and commands
 
 You can specify help information for bot or commands with `help` block, for example:
@@ -195,6 +259,22 @@ class Deploy < SlackRubyBot::Commands::Base
 end
 ```
 
+### Customize your command help output
+
+If you've used the `help` block described above to document your
+commands, you can provide your own implementation of outputting help
+for commands like so:
+
+```ruby
+class Market < SlackRubyBot::Bot
+  command 'help' do |client, data, match|
+    user_command = match[:expression]
+    help_attrs = SlackRubyBot::Commands::Support::Help.instance.find_command_help_attrs(user_command)
+    client.say(channel: data.channel, text: "#{help_attrs.command_desc}\n\n#{help_attrs.command_long_desc}"
+  end
+end
+```
+
 ### 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.
@@ -290,8 +370,8 @@ Hooks are event handlers and respond to Slack RTM API [events](https://api.slack
 
 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 can be registered using different methods based on user preference / use case. 
-Currently someone can use one of the following methods: 
+Hooks can be registered using different methods based on user preference / use case.
+Currently someone can use one of the following methods:
 
 * Pass `hooks` in `SlackRubyBot::Server` initialization.
 * Register `hooks` on `SlackRubyBot::Server` using `on` class method.
@@ -350,8 +430,8 @@ module MyBot
       # data['user']['id'] contains the user ID
       # data['user']['name'] contains the new user name
     end
-    
-    on 'user_change', ->(client, data) {      
+
+    on 'user_change', ->(client, data) {
       # data['user']['id'] contains the user ID
       # data['user']['name'] contains the new user name
     }
@@ -420,6 +500,12 @@ end
 
 For an example of advanced integration that supports multiple teams, see [slack-gamebot](https://github.com/dblock/slack-gamebot) and [playplay.io](http://playplay.io) that is built on top of it.
 
+### Proxy Configuration
+
+There are [several proxy options](https://github.com/slack-ruby/slack-ruby-client#web-client-options) that can be configured on `Slack::Web::Client`. You can also control what proxy options are used by modifying the `http_proxy` environment variable per [Net::HTTP's documentation](https://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html#class-Net::HTTP-label-Proxies).
+
+Note that Docker on OSX seems to incorrectly set the proxy, [causing `Faraday::ConnectionFailed`](https://github.com/slack-ruby/slack-ruby-bot/issues/155), `ERROR -- : Failed to open TCP connection to : (getaddrinfo: Name or service not known)`. You might need to manually unset `http_proxy` in that case, eg. `http_proxy="" bundle exec ruby ./my_bot.rb`.
+
 ### Model-View-Controller Design
 
 The `command` method is essentially a controller method that receives input from the outside and acts upon it. Complex behaviors could lead to a long and difficult-to-understand `command` block. A complex `command` block is a candidate for separation into classes conforming to the Model-View-Controller pattern popularized by Rails.
@@ -564,6 +650,7 @@ Require `slack-ruby-bot/rspec` in your `spec_helper.rb` along with the following
 
 ```ruby
 group :development, :test do
+  gem 'rack-test'
   gem 'rspec'
   gem 'vcr'
   gem 'webmock'

data/Rakefile

@@ -15,5 +15,5 @@ unless ENV['RACK_ENV'] == 'production'
   require 'rubocop/rake_task'
   RuboCop::RakeTask.new
 
-  task default: [:rubocop, :spec]
+  task default: %i[rubocop spec]
 end

data/examples/inventory/Gemfile

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

data/examples/market/Gemfile

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

data/examples/market/marketbot.rb

@@ -5,7 +5,7 @@ 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|
+    YahooFinance::Client.new.quotes(stocks, %i[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,

data/examples/minimal/Gemfile

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

data/examples/weather/Gemfile

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

data/lib/slack-ruby-bot.rb

@@ -19,7 +19,6 @@ module SlackRubyBot
 end
 
 require 'slack-ruby-client'
-require 'slack-ruby-bot/support/commands_helper'
 require 'slack-ruby-bot/commands'
 require 'slack-ruby-bot/client'
 require 'slack-ruby-bot/server'

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

@@ -22,14 +22,16 @@ module SlackRubyBot
     private
 
     def hello(client, _data)
-      SlackRubyBot.configure do |config|
-        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
+      if client.team && client.self
+        SlackRubyBot.configure do |config|
+          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
+      end
       super
     end
 

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

@@ -48,12 +48,14 @@ module SlackRubyBot
       keywords = options.delete(:gif)
       # text
       text = options.delete(:text)
-      gif = begin
-        Giphy.random(keywords)
-      rescue StandardError => e
-        logger.warn "Giphy.random: #{e.message}"
-        nil
-      end if keywords && send_gifs?
+      if keywords && send_gifs?
+        gif = begin
+          Giphy.random(keywords)
+        rescue StandardError => e
+          logger.warn "Giphy.random: #{e.message}"
+          nil
+        end
+      end
       text = [text, gif && gif.image_url.to_s].compact.join("\n")
       message({ text: text }.merge(options))
     end

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

@@ -1,8 +1,10 @@
+require_relative 'support/match'
+require_relative 'support/help'
+
 module SlackRubyBot
   module Commands
     class Base
       include Loggable
-      class_attribute :routes
 
       class << self
         attr_accessor :command_classes
@@ -32,7 +34,7 @@ module SlackRubyBot
         end
 
         def help(&block)
-          CommandsHelper.instance.capture_help(self, &block)
+          Support::Help.instance.capture_help(self, &block)
         end
 
         def command_name_from_class
@@ -46,24 +48,32 @@ module SlackRubyBot
 
         def command(*values, &block)
           values = values.map { |value| value.is_a?(Regexp) ? value.source : Regexp.escape(value) }.join('|')
-          match Regexp.new("^#{bot_matcher}[\\s]+(?<command>#{values})([\\s]+(?<expression>.*)|)$", Regexp::IGNORECASE), &block
+          match Regexp.new("^#{bot_matcher}[\\s]+(?<command>#{values})([\\s]+(?<expression>.*)|)$", Regexp::IGNORECASE | Regexp::MULTILINE), &block
         end
 
         def invoke(client, data)
           finalize_routes!
           expression, text = parse(client, data)
-          return false unless expression
+          return false unless expression || data.attachments
           routes.each_pair do |route, options|
             match_method = options[:match_method]
             case match_method
             when :match
+              next unless expression
               match = route.match(expression)
               match ||= route.match(text) if text
               next unless match
               next if match.names.include?('bot') && !client.name?(match['bot'])
+              match = Support::Match.new(match)
             when :scan
+              next unless expression
               match = expression.scan(route)
               next unless match.any?
+            when :attachment
+              next unless data.attachments && !data.attachments.empty?
+              match, attachment, field = match_attachments(data, route, options[:fields_to_scan])
+              next unless match
+              match = Support::Match.new(match, attachment, field)
             end
             call_command(client, data, match, options[:block])
             return true
@@ -72,19 +82,30 @@ module SlackRubyBot
         end
 
         def match(match, &block)
-          self.routes ||= ActiveSupport::OrderedHash.new
-          self.routes[match] = { match_method: :match, block: block }
+          routes[match] = { match_method: :match, block: block }
         end
 
         def scan(match, &block)
-          self.routes ||= ActiveSupport::OrderedHash.new
-          self.routes[match] = { match_method: :scan, block: block }
+          routes[match] = { match_method: :scan, block: block }
+        end
+
+        def attachment(match, fields_to_scan = nil, &block)
+          fields_to_scan = [fields_to_scan] unless fields_to_scan.nil? || fields_to_scan.is_a?(Array)
+          routes[match] = {
+            match_method: :attachment,
+            block: block,
+            fields_to_scan: fields_to_scan
+          }
         end
 
         def bot_matcher
           '(?<bot>\S*)'
         end
 
+        def routes
+          @routes ||= ActiveSupport::OrderedHash.new
+        end
+
         private
 
         def call_command(client, data, match, block)
@@ -122,6 +143,18 @@ module SlackRubyBot
           command command_name_from_class
         end
 
+        def match_attachments(data, route, fields_to_scan = nil)
+          fields_to_scan ||= %i[pretext text title]
+          data.attachments.each do |attachment|
+            fields_to_scan.each do |field|
+              next unless attachment[field]
+              match = route.match(attachment[field])
+              return match, attachment, field if match
+            end
+          end
+          false
+        end
+
         # Intended to be overridden by subclasses to hook in an
         # authorization mechanism.
         def permitted?(_client, _data, _match)