slack-ruby-bot 0.11.2 → 0.16.0

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

@@ -1,38 +1,45 @@
+# frozen_string_literal: true
+
 require 'rspec/expectations'
+
 RSpec::Matchers.define :respond_with_slack_messages do |expected|
   include SlackRubyBot::SpecHelpers
+
   match do |actual|
-    raise ArgumentError, 'respond_with_slack_messages expects an array of ordered responses' unless expected.respond_to? :each
-    client = respond_to?(:client) ? send(:client) : SlackRubyBot::Client.new
-    def client.test_messages
-      @test_received_messages
-    end
+    raise ArgumentError, 'respond_with_slack_messages expects an array of ordered responses' if expected && !expected.respond_to?(:each)
 
-    def client.say(options = {})
-      super
-      @test_received_messages = @test_received_messages.nil? ? [] : @test_received_messages
-      @test_received_messages.push options
-    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)
+    @messages ||= []
+    allow(client).to receive(:message) do |options|
+      @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
+
     @responses = []
-    expected.each do |exp|
-      @responses.push(expect(client).to(have_received(:message).with(hash_including(channel: channel, text: exp)).once))
+
+    if expected&.any?
+      expected.each do |exp|
+        @responses.push(expect(client).to(have_received(:message).with(hash_including(channel: channel, text: exp)).once))
+      end
+    else
+      expect(@messages.size).to be > 1
     end
+
     true
   end
+
   failure_message do |_actual|
-    message = ''
-    expected.each do |exp|
-      message += "Expected text: #{exp}, got #{@messages[expected.index(exp)] || 'No Response'}\n" unless @responses[expected.index(exp)]
+    if expected&.any?
+      expected.map do |exp|
+        "Expected text: #{exp}, got #{@messages[expected.index(exp)] || 'none'}" unless @responses[expected.index(exp)]
+      end.compact.join("\n")
+    else
+      "Expected to receive multiple messages, got #{@messages.any? ? @messages.size : 'none'}"
     end
-    message
   end
 end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'rspec/expectations'
+
+RSpec::Matchers.define :start_typing do |expected|
+  include SlackRubyBot::SpecHelpers
+
+  match do |actual|
+    client = respond_to?(:client) ? send(:client) : SlackRubyBot::Client.new
+
+    message_command = SlackRubyBot::Hooks::Message.new
+
+    allow(client).to receive(:typing) do |options|
+      @test_options = options
+    end
+
+    channel, user, message, attachments = parse(actual)
+    message_command.call(client, Hashie::Mash.new(text: message, channel: channel, user: user, attachments: attachments))
+
+    matcher = have_received(:typing).once
+    matcher = matcher.with(expected) if expected&.any?
+    expect(client).to matcher
+
+    true
+  end
+
+  failure_message do |_actual|
+    message = "expected to receive typing with: #{expected} once,\n received:"
+    message += @test_options&.any? ? @test_options.inspect : ' none'
+    message
+  end
+end

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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 RSpec.configure do |config|
-  config.before :all do
+  config.before :each do
     ENV['SLACK_API_TOKEN'] ||= 'test'
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.configure do |config|
   config.before :each do
     SlackRubyBot.configure do |c|

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module SpecHelpers
     private

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   class Server
     include Loggable
 
-    attr_accessor :token, :aliases, :send_gifs
+    attr_accessor :token, :aliases
 
     include SlackRubyBot::Hooks::HookSupport
 
@@ -11,7 +13,6 @@ module SlackRubyBot
     def initialize(options = {})
       @token = options[:token]
       @aliases = options[:aliases]
-      @send_gifs = options[:send_gifs]
 
       # Hook Handling
       flush_hook_blocks
@@ -32,37 +33,17 @@ module SlackRubyBot
     end
 
     def start!
-      @stopping = false
-      @async = false
       client.start!
     end
 
     def start_async
-      @stopping = false
-      @async = true
       client.start_async
     end
 
     def stop!
-      @stopping = true
       client.stop! if @client
     end
 
-    def restart!(wait = 1)
-      @async ? start_async : start!
-    rescue StandardError => e
-      case e.message
-      when 'account_inactive', 'invalid_auth'
-        logger.error "#{token}: #{e.message}, team will be deactivated."
-        @stopping = true
-      else
-        sleep wait
-        logger.error "#{e.message}, reconnecting in #{wait} second(s)."
-        logger.debug e
-        restart! [wait * 2, 60].min
-      end
-    end
-
     private
 
     def handle_exceptions
@@ -75,7 +56,7 @@ module SlackRubyBot
       else
         raise e
       end
-    rescue Faraday::Error::TimeoutError, Faraday::Error::ConnectionFailed, Faraday::Error::SSLError => e
+    rescue Faraday::TimeoutError, Faraday::ConnectionFailed, Faraday::SSLError => e
       logger.error e
       sleep 1 # ignore, try again
     rescue StandardError => e
@@ -97,11 +78,7 @@ module SlackRubyBot
 
     def client
       @client ||= begin
-        client = SlackRubyBot::Client.new(aliases: aliases, send_gifs: send_gifs, token: token)
-        client.on :close do |_data|
-          @client = nil
-          restart! unless @stopping
-        end
+        client = SlackRubyBot::Client.new(aliases: aliases, token: token)
         _hooks.client = client
 
         client

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
   module Loggable
     def self.included(base)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SlackRubyBot
-  VERSION = '0.11.2'.freeze
+  VERSION = '0.16.0'
 end

data/lib/slack_ruby_bot.rb

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

data/slack-ruby-bot.gemspec

@@ -1,4 +1,6 @@
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'slack-ruby-bot/version'
 
 Gem::Specification.new do |s|
@@ -14,12 +16,13 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/slack-ruby/slack-ruby-bot'
   s.licenses = ['MIT']
   s.summary = 'The easiest way to write a Slack bot in Ruby.'
+  s.required_ruby_version = '>= 2.3'
   s.add_dependency 'hashie'
-  s.add_dependency 'slack-ruby-client', '>= 0.6.0'
+  s.add_dependency 'slack-ruby-client', '>= 0.14.0'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop', '0.58.2'
+  s.add_development_dependency 'rubocop', '0.80.1'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
 end

data/spec/slack-ruby-bot/app_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 describe SlackRubyBot::App do
   def app
     SlackRubyBot::App.new
@@ -5,10 +7,71 @@ describe SlackRubyBot::App do
   it_behaves_like 'a slack ruby bot'
 
   describe '.instance' do
+    let(:token) { 'slack-api-token' }
+    let(:klass) { Class.new(SlackRubyBot::App) }
+
     it 'creates an instance of the App subclass' do
-      klass = Class.new(SlackRubyBot::App)
       expect(klass.instance.class).to be klass
     end
+
+    it 'sets config.token from ENV' do
+      expect(klass.instance.config.token).to eq('test')
+    end
+
+    context 'when token is not defined' do
+      before do
+        ENV.delete('SLACK_API_TOKEN')
+        SlackRubyBot::Config.token = nil
+      end
+
+      it 'raises error' do
+        expect { klass.instance }.to raise_error RuntimeError, 'Missing Slack API Token.'
+      end
+    end
+
+    context 'when token is defined in ENV but not config' do
+      before do
+        SlackRubyBot::Config.token = nil
+      end
+
+      it 'sets config.token from ENV' do
+        expect(klass.instance.config.token).to eq('test')
+      end
+    end
+
+    context 'when token is not defined in ENV but is defined in config' do
+      before do
+        ENV.delete('SLACK_API_TOKEN')
+      end
+
+      it 'sets config.token from config' do
+        expect(klass.instance.config.token).to eq('testtoken')
+      end
+    end
+
+    context 'when aliases are defined in config only' do
+      let(:aliases) { %w[alias alias2] }
+      before do
+        SlackRubyBot::Config.aliases = aliases
+      end
+
+      it 'sets config.aliases' do
+        expect(klass.instance.config.aliases).to eq(aliases)
+      end
+    end
+
+    context 'when aliases are defined in ENV only' do
+      before do
+        ENV['SLACK_RUBY_BOT_ALIASES'] = 'alias3 alias4'
+      end
+      after do
+        ENV.delete('SLACK_RUBY_BOT_ALIASES')
+      end
+
+      it 'sets config.aliases from env' do
+        expect(klass.instance.config.aliases).to eq(%w[alias3 alias4])
+      end
+    end
   end
 
   describe 'executable' do

data/spec/slack-ruby-bot/client_spec.rb

@@ -1,39 +1,114 @@
+# frozen_string_literal: true
+
 describe SlackRubyBot::Client do
-  describe '#send_gifs?' do
-    context 'without giphy is false', unless: WithGiphy.env? do
-      it 'by default' do
-        expect(subject.send_gifs?).to be false
+  describe '#allow_message_loops?' do
+    context 'with global allow_message_loops set to true' do
+      before do
+        SlackRubyBot::Config.allow_message_loops = true
       end
-
-      it 'when set to true' do
-        subject.send_gifs = true
-        expect(subject.send_gifs?).to be false
+      it do
+        expect(subject.allow_message_loops?).to be true
       end
-
-      it 'when set to true via config' do
-        SlackRubyBot::Config.send_gifs = true
-        expect(SlackRubyBot::Config.send_gifs?).to be false
+      context 'overridden locally' do
+        subject do
+          SlackRubyBot::Client.new(allow_message_loops: false)
+        end
+        it do
+          expect(subject.allow_message_loops?).to be false
+        end
       end
     end
-
-    context 'with giphy', if: WithGiphy.env? do
-      it 'default is true' do
-        expect(subject.send_gifs?).to be true
+    context 'with global allow_message_loops set to false' do
+      before do
+        SlackRubyBot::Config.allow_message_loops = false
       end
-
-      it 'defaults to SlackRubyBot::Config.send_gifs? if set' do
-        SlackRubyBot::Config.send_gifs = false
-        expect(subject.send_gifs?).to be false
+      it do
+        expect(subject.allow_message_loops?).to be false
       end
-
-      it 'client setting takes precedence' do
-        SlackRubyBot::Config.send_gifs = true
-        subject.send_gifs = false
-        expect(subject.send_gifs?).to be false
-        SlackRubyBot::Config.send_gifs = false
-        subject.send_gifs = true
-        expect(subject.send_gifs?).to be true
+      context 'overridden locally' do
+        subject do
+          SlackRubyBot::Client.new(allow_message_loops: true)
+        end
+        it do
+          expect(subject.allow_message_loops?).to be true
+        end
+      end
+    end
+    context 'overridden locally' do
+      subject do
+        SlackRubyBot::Client.new(allow_message_loops: true)
+      end
+      it do
+        expect(subject.allow_message_loops?).to be true
+      end
+    end
+  end
+  describe '#allow_bot_messages?' do
+    context 'with global allow_bot_messages set to true' do
+      before do
+        SlackRubyBot::Config.allow_bot_messages = true
+      end
+      it do
+        expect(subject.allow_bot_messages?).to be true
+      end
+      context 'overridden locally' do
+        subject do
+          SlackRubyBot::Client.new(allow_bot_messages: false)
+        end
+        it do
+          expect(subject.allow_bot_messages?).to be false
+        end
+      end
+    end
+    context 'with global allow_bot_messages set to false' do
+      before do
+        SlackRubyBot::Config.allow_bot_messages = false
       end
+      it do
+        expect(subject.allow_bot_messages?).to be false
+      end
+      context 'overridden locally' do
+        subject do
+          SlackRubyBot::Client.new(allow_bot_messages: true)
+        end
+        it do
+          expect(subject.allow_bot_messages?).to be true
+        end
+      end
+    end
+    context 'overridden locally' do
+      subject do
+        SlackRubyBot::Client.new(allow_bot_messages: true)
+      end
+      it do
+        expect(subject.allow_bot_messages?).to be true
+      end
+    end
+  end
+  describe '#message_to_self?' do
+    before do
+      allow(subject).to receive(:self).and_return(Hashie::Mash.new({ 'id' => 'U0K8CKKT1' }))
+    end
+    context 'with message to self' do
+      it do
+        expect(subject.message_to_self?(Hashie::Mash.new(user: 'U0K8CKKT1'))).to be true
+      end
+    end
+    context 'with message to another user' do
+      it do
+        expect(subject.message_to_self?(Hashie::Mash.new(user: 'U0K8CKKT2'))).to be false
+      end
+    end
+  end
+  describe '#bot_message?' do
+    it 'bot message' do
+      expect(subject.bot_message?(Hashie::Mash.new(subtype: 'bot_message'))).to be true
+    end
+    it 'not bot message' do
+      expect(subject.bot_message?(Hashie::Mash.new(subtype: 'other'))).to be false
+    end
+    it 'no subtype' do
+      expect(subject.bot_message?(Hashie::Mash.new)).to be false
     end
   end
 end