slack-ruby-bot 0.11.2 → 0.16.0

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 require 'bundler/gem_tasks'

data/TUTORIAL.md

@@ -36,6 +36,10 @@ end
 
 Run `bundle install` to get all the gems.
 
+##### Passenger
+
+To use passenger standalone change `gem 'puma'` to `gem 'passenger'`
+
 #### Application
 
 Create a folder called `slack-mathbot` and inside of it create `bot.rb`.
@@ -141,6 +145,25 @@ Create a `Procfile` which `foreman` will use when you run the `foreman start` co
 web: bundle exec puma -p $PORT
 ```
 
+#### Passenger
+
+If you want to use passenger locally change it to:
+
+```
+web: bundle exec passenger -p $PORT
+```
+
+Add the following folders to your project root: 'tmp/', 'log/', 'public/' 
+Passenger will automatically save the local logs to these folders.
+
+Optional: Change the port in a `Passenger.json`
+
+```
+{
+  "port": "1234" 
+}
+```
+
 ### Run the Bot
 
 Run `foreman start`. Your bot should be running.

data/UPGRADING.md

@@ -1,6 +1,56 @@
 Upgrading SlackRubyBot
 ======================
 
+### Upgrading to >= 0.16.0
+
+#### Removed GIF support
+
+GIF, Giphy and other animated GIF support has been removed. Remove `gif` options from all `client.say(gif: 'keyword')` method calls, the `GIPHY_API_KEY` ENV var, `gem 'giphy'` or `gem 'GiphyClient'`, and any references to `send_gifs`. The previously deprecated `SlackRubyBot::Commands::Base#send_message`, `send_message_with_gif` and `send_gif` methods have also been removed.
+
+See [#261](https://github.com/slack-ruby/slack-ruby-bot/issues/261) for details.
+
+#### Removed deprecated `server.hooks`
+
+The previously deprecated `SlackRubyBot::Server#hooks` has been removed.
+
+See [#266](https://github.com/slack-ruby/slack-ruby-bot/issues/266) for details.
+
+### Upgrading to >= 0.15.0
+
+#### Set up VCR explicitly
+
+Requiring `slack-ruby-bot/rspec` will no longer set up [VCR](https://rubygems.org/gems/vcr) anymore. If your spec suite implicitly relies on this you would need to set up VCR explicitly in your spec suite. Just follow standard VCR documentation.
+
+See [#258](https://github.com/slack-ruby/slack-ruby-bot/pull/258) for more information.
+
+### Upgrading to >= 0.14.0
+
+#### Bot Messages Disabled
+
+By default bots will no longer respond to other bots. This caused confusing "I don't understand this command." errors when DMing the bot and rendering URLs that were being sent back as DMs. If you wish to restore the old behavior, set `allow_bot_messages` to `true`.
+
+```ruby
+SlackRubyBot.configure do |config|
+  config.allow_bot_messages = true
+end
+```
+
+See [#250](https://github.com/slack-ruby/slack-ruby-bot/pull/250) for more information.
+
+### Upgrading to >= 0.13.0
+
+#### Minimum Ruby Version
+
+Ruby 2.3 or later is now required.
+
+See [#246](https://github.com/slack-ruby/slack-ruby-bot/pull/246) for more information.
+
+### Upgrading to >= 0.12.0
+
+#### Remove any references to `SlackRubyBot::Server#restart!`
+
+We have removed `SlackRubyBot::Server#restart!` since the [`slack-ruby-client`](https://github.com/slack-ruby/slack-ruby-client/blob/master/CHANGELOG.md) now restarts any connection that was not intentionally stopped via `SlackRubyBot::Server#stop!`.
+
 ### Upgrading to >= 0.10.4
 
 #### Replace `server.hooks.add` with `server.on`

data/examples/inventory/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gem 'celluloid-io'

data/examples/inventory/inventorybot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'slack-ruby-bot'
 require 'sqlite3'
 
@@ -56,6 +58,7 @@ class InventoryController < SlackRubyBot::MVC::Controller::Base
   def notify_admin
     row = _row.first
     return if row[:quantity].to_i.zero?
+
     view.email_admin("Inventory item #{row[:name]} needs to be refilled.")
     view.say(channel: data.channel, text: "Administrator notified via email to refill #{row[:name]}.")
   end
@@ -93,6 +96,7 @@ class InventoryModel < SlackRubyBot::MVC::Model::Base
     count = 0
     count += 1 while results.next
     return if count < 4
+
     add_item "'Audi',3,52642"
     add_item "'Mercedes',1,57127"
     add_item "'Skoda',5,9000"
@@ -241,7 +245,7 @@ class InventoryBot < SlackRubyBot::Bot
   view = InventoryView.new
   @controller = InventoryController.new(model, view)
   @controller.class.command_class.routes.each do |route|
-    STDERR.puts route.inspect
+    warn route.inspect
   end
 end
 

data/examples/market/Gemfile

@@ -1,5 +1,6 @@
-source 'http://rubygems.org'
+# frozen_string_literal: true
 
+source 'http://rubygems.org'
 gem 'faye-websocket'
-gem 'slack-ruby-bot', path: '../..'
-gem 'yahoo-finance'
+gem 'iex-ruby-client'
+gem 'slack-ruby-bot'

data/examples/market/marketbot.rb

@@ -1,24 +1,31 @@
+# frozen_string_literal: true
+
+require 'iex-ruby-client'
 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, %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,
-        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'
-          }
-        ]
-      )
+    stocks.each do |stock|
+      begin
+        quote = IEX::Resources::Quote.get(stock.first)
+
+        client.web_client.chat_postMessage(
+          channel: data.channel,
+          as_user: true,
+          attachments: [
+            {
+              fallback: "#{quote.company_name} (#{quote.symbol}): $#{quote.latest_price}",
+              title: "#{quote.company_name} (#{quote.symbol})",
+              text: "$#{quote.latest_price} (#{quote.change_percent})",
+              color: quote.change.to_f > 0 ? '#00FF00' : '#FF0000'
+            }
+          ]
+        )
+      rescue IEX::Errors::SymbolNotFoundError
+        logger.warn "no stock found for symbol #{stock}"
+      end
     end
   end
 end

data/examples/minimal/Gemfile

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
-gem 'celluloid-io'
+gem 'async-websocket', '~> 0.8.0'
 gem 'slack-ruby-bot', path: '../..'

data/examples/minimal/pongbot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'slack-ruby-bot'
 
 class Bot < SlackRubyBot::Bot

data/examples/weather/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gem 'celluloid-io'

data/examples/weather/weatherbot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'slack-ruby-bot'
 
 SlackRubyBot::Client.logger.level = Logger::WARN

data/lib/config/application.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'boot'
 
-Dir[File.expand_path('../../initializers', __FILE__) + '/**/*.rb'].each do |file|
+Dir[File.expand_path('../initializers', __dir__) + '/**/*.rb'].sort.each do |file|
   require file
 end
 
-require File.expand_path('../application', __FILE__)
+require File.expand_path('application', __dir__)
 
 require 'slack_ruby_bot'

data/lib/config/boot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'logger'
 require 'active_support'

data/lib/config/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ENV['RACK_ENV'] ||= 'development'
 
-require File.expand_path('../application', __FILE__)
+require File.expand_path('application', __dir__)

data/lib/slack-ruby-bot.rb

@@ -1,4 +1,6 @@
-require File.expand_path('../config/environment', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('config/environment', __dir__)
 
 require 'slack-ruby-bot/version'
 require 'slack-ruby-bot/support/loggable'

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

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

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

@@ -1,22 +1,28 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   class App < Server
-    def initialize(options = {})
-      SlackRubyBot.configure do |config|
-        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|
-        config.token = SlackRubyBot.config.token
-      end
-      super
-    end
-
     def config
       SlackRubyBot.config
     end
 
     def self.instance
-      @instance ||= new
+      @instance ||= begin
+        configure!
+        new(token: SlackRubyBot.config.token)
+      end
+    end
+
+    def self.configure!
+      SlackRubyBot.configure do |config|
+        config.token = ENV['SLACK_API_TOKEN'] if ENV.key?('SLACK_API_TOKEN')
+        raise('Missing Slack API Token.') unless config.token.present?
+
+        config.aliases = ENV['SLACK_RUBY_BOT_ALIASES'].split(' ') if ENV.key?('SLACK_RUBY_BOT_ALIASES')
+      end
+      Slack.configure do |config|
+        config.token = SlackRubyBot.config.token
+      end
     end
 
     private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   class Bot < SlackRubyBot::Commands::Base
     delegate :client, to: :instance
@@ -11,7 +13,7 @@ module SlackRubyBot
     end
 
     def self.call(client, data, _match)
-      client.say(channel: data.channel, text: "Sorry <@#{data.user}>, I don't understand that command!", gif: 'understand')
+      client.say(channel: data.channel, text: "Sorry <@#{data.user}>, I don't understand that command!")
     end
   end
 end

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

@@ -1,13 +1,33 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   class Client < Slack::RealTime::Client
     include Loggable
     attr_accessor :aliases
-    attr_accessor :send_gifs
+    attr_accessor :allow_bot_messages
+    attr_accessor :allow_message_loops
 
     def initialize(attrs = {})
       super(attrs)
       @aliases = attrs[:aliases]
-      @send_gifs = attrs[:send_gifs]
+      @allow_message_loops = attrs[:allow_message_loops]
+      @allow_bot_messages = attrs[:allow_bot_messages]
+    end
+
+    def allow_message_loops?
+      @allow_message_loops.nil? ? SlackRubyBot::Config.allow_message_loops? : !!@allow_message_loops
+    end
+
+    def allow_bot_messages?
+      @allow_bot_messages.nil? ? SlackRubyBot::Config.allow_bot_messages? : !!@allow_bot_messages
+    end
+
+    def message_to_self?(data)
+      !!(self.self && self.self.id == data.user)
+    end
+
+    def bot_message?(data)
+      data.subtype == 'bot_message'
     end
 
     def names
@@ -29,13 +49,8 @@ module SlackRubyBot
       name && names.include?(name.downcase)
     end
 
-    def send_gifs?
-      return false unless defined?(Giphy)
-      send_gifs.nil? ? SlackRubyBot::Config.send_gifs? : send_gifs
-    end
-
     def name
-      SlackRubyBot.config.user || (self.self && self.self.name)
+      SlackRubyBot.config.user || self.self&.name
     end
 
     def url
@@ -43,21 +58,8 @@ module SlackRubyBot
     end
 
     def say(options = {})
-      options = options.dup
-      # get GIF
-      keywords = options.delete(:gif)
-      # text
-      text = options.delete(:text)
-      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))
+      logger.warn '[DEPRECATION] `gif:` is deprecated and has no effect.' if options.key?(:gif)
+      message({ text: '' }.merge(options))
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'slack-ruby-bot/commands/base'
 require 'slack-ruby-bot/commands/about'
 require 'slack-ruby-bot/commands/help'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Commands
     class Default < Base
@@ -5,7 +7,7 @@ module SlackRubyBot
       match(/^#{bot_matcher}$/u)
 
       def self.call(client, data, _match)
-        client.say(channel: data.channel, text: SlackRubyBot::ABOUT, gif: 'selfie')
+        client.say(channel: data.channel, text: SlackRubyBot::ABOUT)
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'support/match'
 require_relative 'support/help'
 
@@ -14,25 +16,6 @@ module SlackRubyBot
           SlackRubyBot::Commands::Base.command_classes << subclass
         end
 
-        def send_message(client, channel, text, options = {})
-          logger.warn '[DEPRECATION] `send_message` is deprecated.  Please use `client.say` instead.'
-          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'))
-          end
-        end
-
-        def send_message_with_gif(client, channel, text, keywords, options = {})
-          logger.warn '[DEPRECATION] `send_message_with_gif` is deprecated.  Please use `client.say` instead.'
-          client.say(options.merge(channel: channel, text: text, gif: keywords))
-        end
-
-        def send_gif(client, channel, keywords, options = {})
-          logger.warn '[DEPRECATION] `send_gif` is deprecated.  Please use `client.say` instead.'
-          client.say(options.merge(channel: channel, text: '', gif: keywords))
-        end
-
         def help(&block)
           Support::Help.instance.capture_help(self, &block)
         end
@@ -48,31 +31,37 @@ 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 | Regexp::MULTILINE), &block
+          match Regexp.new("^#{bot_matcher}[[:space:]]+(?<command>#{values})([[:space:]]+(?<expression>.*)|)$", Regexp::IGNORECASE | Regexp::MULTILINE), &block
         end
 
         def invoke(client, data)
           finalize_routes!
           expression, text = parse(client, data)
           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])
@@ -122,6 +111,7 @@ module SlackRubyBot
           text = data.text
           return text unless direct_message?(data) && message_from_another_user?(data)
           return text if message_begins_with_bot_mention?(text, client.names)
+
           ["#{client.name} #{text}", text]
         end
 
@@ -139,7 +129,8 @@ module SlackRubyBot
         end
 
         def finalize_routes!
-          return if routes && routes.any?
+          return if routes&.any?
+
           command command_name_from_class
         end
 
@@ -148,6 +139,7 @@ module SlackRubyBot
           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