slack-ruby-bot 0.12.0 → 0.13.0

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,14 @@
 Upgrading SlackRubyBot
 ======================
 
+### 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!`

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,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gem 'celluloid-io'

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/initializers/giphy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'giphy'
 rescue LoadError

data/lib/initializers/giphy_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'GiphyClient'
 

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   class App < Server
     def initialize(options = {})

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   class Client < Slack::RealTime::Client
     include Loggable
@@ -31,11 +33,12 @@ module SlackRubyBot
 
     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
@@ -51,9 +54,9 @@ module SlackRubyBot
       if keywords && send_gifs?
         gif = begin
           Giphy.random(keywords)
-        rescue StandardError => e
-          logger.warn "Giphy.random: #{e.message}"
-          nil
+              rescue StandardError => e
+                logger.warn "Giphy.random: #{e.message}"
+                nil
         end
       end
       text = [text, gif && gif.image_url.to_s].compact.join("\n")

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'support/match'
 require_relative 'support/help'
 
@@ -55,24 +57,30 @@ module SlackRubyBot
           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 +130,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 +148,8 @@ module SlackRubyBot
         end
 
         def finalize_routes!
-          return if routes && routes.any?
+          return if routes&.any?
+
           command command_name_from_class
         end
 
@@ -148,6 +158,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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Commands
     class Help < Base
@@ -24,16 +26,16 @@ module SlackRubyBot
         def general_text
           bot_desc = Support::Help.instance.bot_desc_and_commands
           other_commands_descs = Support::Help.instance.other_commands_descs
-          <<TEXT
-#{bot_desc.join("\n")}
+          <<~TEXT
+            #{bot_desc.join("\n")}
 
-*Other commands:*
-#{other_commands_descs.join("\n")}
+            *Other commands:*
+            #{other_commands_descs.join("\n")}
 
-For getting description of the command use: *help <command>*
+            For getting description of the command use: *help <command>*
 
-For more information see https://github.com/slack-ruby/slack-ruby-bot, please.
-TEXT
+            For more information see https://github.com/slack-ruby/slack-ruby-bot, please.
+          TEXT
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Commands
     class Hi < Base

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Commands
     module Support

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require_relative 'attrs'
 
@@ -34,12 +36,14 @@ module SlackRubyBot
           help_attrs = find_command_help_attrs(unescaped_name)
           return "There's no command *#{unescaped_name}*" unless help_attrs
           return "There's no description for command *#{unescaped_name}*" if help_attrs.command_long_desc.blank?
+
           "#{command_name_and_desc(help_attrs)}\n\n#{help_attrs.command_long_desc}"
         end
 
         def find_command_help_attrs(name)
           help_attrs = commands_help_attrs.find { |k| k.command_name == name }
           return help_attrs if help_attrs
+
           commands_help_attrs.each { |k| k.commands.each { |c| return c if c.command_name == name } }
           nil
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Commands
     module Support
@@ -9,9 +11,8 @@ module SlackRubyBot
         attr_reader :attachment, :attachment_field
 
         def initialize(match_data, attachment = nil, attachment_field = nil)
-          unless match_data.is_a? MatchData
-            raise ArgumentError, 'match_data should be a type of MatchData'
-          end
+          raise ArgumentError, 'match_data should be a type of MatchData' unless match_data.is_a? MatchData
+
           @match_data = match_data
           @attachment = attachment
           @attachment_field = attachment_field