slack-ruby-bot 0.12.0 → 0.16.1

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Commands
     class Help < Base
@@ -15,7 +17,7 @@ module SlackRubyBot
                  general_text
                end
 
-        client.say(channel: data.channel, text: text, gif: 'help')
+        client.say(channel: data.channel, text: text)
       end
 
       class << self
@@ -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
@@ -7,7 +9,7 @@ module SlackRubyBot
       end
 
       def self.call(client, data, _match)
-        client.say(channel: data.channel, text: "Hi <@#{data.user}>!", gif: 'hi')
+        client.say(channel: data.channel, text: "Hi <@#{data.user}>!")
       end
     end
   end

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

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

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Commands
     class Unknown < Base
       match(/^(?<bot>\S*)[\s]*(?<expression>.*)$/)
 
       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/config.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Config
     extend self
 
-    ATTRS = %i[token url aliases user user_id team team_id allow_message_loops send_gifs logger].freeze
+    ATTRS = %i[token url aliases user user_id team team_id allow_bot_messages allow_message_loops logger].freeze
     attr_accessor(*ATTRS)
 
-    def allow_message_loops?
-      allow_message_loops
+    def allow_bot_messages?
+      !!allow_bot_messages
     end
 
-    def send_gifs?
-      return false unless defined?(Giphy)
-      v = boolean_from_env('SLACK_RUBY_BOT_SEND_GIFS')
-      send_gifs.nil? ? (v.nil? || v) : send_gifs
+    def allow_message_loops?
+      !!allow_message_loops
     end
 
     def reset!

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'slack-ruby-bot/hooks/set'
 require 'slack-ruby-bot/hooks/hello'
 require 'slack-ruby-bot/hooks/message'

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

@@ -1,15 +1,34 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Hooks
     class Hello
-      attr_accessor :logger
+      attr_accessor :logger, :connected_at
 
       def initialize(logger)
         self.logger = logger
       end
 
       def call(client, _data)
-        return unless client && client.team
-        logger.info "Successfully connected team #{client.team.name} (#{client.team.id}) to https://#{client.team.domain}.slack.com."
+        return unless client&.team
+
+        new_connected_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        log = [
+          'Successfully',
+          connected_at ? 'reconnected' : 'connected',
+          "team #{client.team.name} (#{client.team.id}) to https://#{client.team.domain}.slack.com",
+          connected_at ? "after #{last_connection_till(new_connected_at)}s" : nil
+        ].compact.join(' ') + '.'
+
+        logger.info log
+
+        self.connected_at = new_connected_at
+      end
+
+      private
+
+      def last_connection_till(time)
+        (time - connected_at).round(2)
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Hooks
     module HookSupport
@@ -16,12 +18,6 @@ module SlackRubyBot
         end
       end
 
-      # Instance stuff
-      def hooks
-        warn Kernel.caller.first + ' [DEPRECATION] `hooks` method is deprecated. Please use `server.on` instead to register a hook.'
-        _hooks
-      end
-
       def on(event_name, handler)
         _hooks.add(event_name, handler)
       end

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

@@ -1,9 +1,14 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Hooks
     class Message
       def call(client, data)
-        return if message_to_self_not_allowed? && message_to_self?(client, data)
-        data.text = data.text.strip if data.text
+        return if !client.allow_message_loops? && client.message_to_self?(data)
+        return if !client.allow_bot_messages? && client.bot_message?(data)
+
+        prepare!(data)
+
         result = child_command_classes.detect { |d| d.invoke(client, data) }
         result ||= built_in_command_classes.detect { |d| d.invoke(client, data) }
         result ||= SlackRubyBot::Commands::Unknown.tap { |d| d.invoke(client, data) }
@@ -12,12 +17,8 @@ module SlackRubyBot
 
       private
 
-      def message_to_self_not_allowed?
-        !SlackRubyBot::Config.allow_message_loops?
-      end
-
-      def message_to_self?(client, data)
-        client.self && client.self.id == data.user
+      def prepare!(data)
+        data.text = data.text.strip if data.text
       end
 
       #
@@ -36,7 +37,7 @@ module SlackRubyBot
       #
       def child_command_classes
         command_classes.reject do |k|
-          k.name && k.name.starts_with?('SlackRubyBot::Commands::')
+          k.name&.starts_with?('SlackRubyBot::Commands::')
         end
       end
 
@@ -47,7 +48,7 @@ module SlackRubyBot
       #
       def built_in_command_classes
         command_classes.select do |k|
-          k.name && k.name.starts_with?('SlackRubyBot::Commands::') && k != SlackRubyBot::Commands::Unknown
+          k.name&.starts_with?('SlackRubyBot::Commands::') && k != SlackRubyBot::Commands::Unknown
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Hooks
     class Set
@@ -36,7 +38,7 @@ module SlackRubyBot
       end
 
       def flush_handlers
-        handlers.keys.each { |hook| register_callback(hook) }
+        handlers.each_key { |hook| register_callback(hook) }
       end
     end
   end

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

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'slack-ruby-bot/mvc/mvc'

data/lib/slack-ruby-bot/mvc/controller/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module MVC
     module Controller
@@ -45,9 +47,7 @@ module SlackRubyBot
           def inherited(klass) # :nodoc:
             # Define the abstract ivar on subclasses so that we don't get
             # uninitialized ivar warnings
-            unless klass.instance_variable_defined?(:@abstract)
-              klass.instance_variable_set(:@abstract, false)
-            end
+            klass.instance_variable_set(:@abstract, false) unless klass.instance_variable_defined?(:@abstract)
             super
           end
 
@@ -64,6 +64,7 @@ module SlackRubyBot
 
             methods.each do |name|
               next if name[0] == '_'
+
               commands = lookup_command_name(name)
 
               # Generates a command for each controller method *and* its aliases

data/lib/slack-ruby-bot/mvc/model/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module MVC
     module Model

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../mvc/controller/base'
 
 require_relative '../mvc/model/base'

data/lib/slack-ruby-bot/mvc/view/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module MVC
     module View

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
 
 require 'rubygems'
@@ -7,6 +9,6 @@ require 'rack/test'
 require 'config/environment'
 require 'slack-ruby-bot'
 
-Dir[File.join(File.dirname(__FILE__), 'rspec/support', '**/*.rb')].each do |file|
+Dir[File.join(File.dirname(__FILE__), 'rspec/support', '**/*.rb')].sort.each do |file|
   require file
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Testing
   class WeatherBot < SlackRubyBot::Bot
     help do

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

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
+
 shared_examples 'a slack ruby bot' do
   context 'not configured' do
     before do
       @slack_api_token = ENV.delete('SLACK_API_TOKEN')
+      SlackRubyBot.configure { |config| config.token = nil }
     end
     after do
       ENV['SLACK_API_TOKEN'] = @slack_api_token
     end
     it 'requires SLACK_API_TOKEN' do
-      expect { subject }.to raise_error RuntimeError, "Missing ENV['SLACK_API_TOKEN']."
+      expect { described_class.instance }.to raise_error RuntimeError, 'Missing Slack API Token.'
     end
   end
 end

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

@@ -1,12 +1,10 @@
+# frozen_string_literal: true
+
 require 'rspec/expectations'
 
 RSpec::Matchers.define :not_respond do
   match do |actual|
-    client = if respond_to?(:client)
-               send(:client)
-             else
-               SlackRubyBot::Client.new
-             end
+    client = respond_to?(:client) ? send(:client) : SlackRubyBot::Client.new
 
     message_command = SlackRubyBot::Hooks::Message.new
     channel, user, message, attachments = parse(actual)

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

@@ -1,18 +1,14 @@
+# frozen_string_literal: true
+
 require 'rspec/expectations'
 
 RSpec::Matchers.define :respond_with_error do |error, error_message|
   match do |actual|
-    client = if respond_to?(:client)
-               send(:client)
-             else
-               SlackRubyBot::Client.new
-             end
+    client = respond_to?(:client) ? send(:client) : SlackRubyBot::Client.new
 
     message_command = SlackRubyBot::Hooks::Message.new
     channel, user, message, attachments = parse(actual)
 
-    allow(Giphy).to receive(:random) if defined?(Giphy)
-
     begin
       expect do
         message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user, attachments: attachments))

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

@@ -1,33 +1,34 @@
+# frozen_string_literal: true
+
 require 'rspec/expectations'
+
 RSpec::Matchers.define :respond_with_slack_message do |expected|
   include SlackRubyBot::SpecHelpers
+
   match do |actual|
     client = respond_to?(:client) ? send(:client) : SlackRubyBot::Client.new
-    def client.test_messages
-      @test_received_messages
-    end
-
-    def client.say(options = {})
-      super
-      @test_received_messages = @test_received_messages.nil? ? [] : @test_received_messages
-      @test_received_messages.push options
-    end
 
     message_command = SlackRubyBot::Hooks::Message.new
     channel, user, message, attachments = parse(actual)
 
-    allow(Giphy).to receive(:random) if defined?(Giphy)
+    allow(client).to receive(:message) do |options|
+      @messages ||= []
+      @messages.push options
+    end
 
-    allow(client).to receive(:message)
     message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user, attachments: attachments))
-    @messages = client.test_messages
-    expect(client).to have_received(:message).with(hash_including(channel: channel, text: expected)).once
+
+    matcher = have_received(:message).once
+    matcher = matcher.with(hash_including(channel: channel, text: expected)) if channel && expected
+
+    expect(client).to matcher
+
     true
   end
 
   failure_message do |_actual|
     message = "expected to receive message with text: #{expected} once,\n received:"
-    message += @messages.count.zero? ? 'No response messages received' : @messages.inspect
+    message += @messages&.any? ? @messages.inspect : 'none'
     message
   end
 end