slack-ruby-bot 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7cdc662d2370824e2b531aecde4c20b1f55e895e8e10d9c1804ca44a160b884
-  data.tar.gz: 3b5e9e13786df070f3d400c96e4752b4a6e2608472ab889d30e20e3ba95df6d1
+  metadata.gz: 9ab5b8a4dc4ab10bd0f5ef08fa56f0f2a7fb0d9148012f2a37b0b4fd2d8636af
+  data.tar.gz: b819aedc03a60e8ef5dea3798c42c8ba0a549437f3df81c0e666ac07a0038ab2
 SHA512:
-  metadata.gz: 1018f35fb9be750feaf55a420b7ed6faa305e3e3ff6ea6e271db16951e898893b1a96ad184103e37a47e24f28adef7cecee02788821c37ac34e0f7f916620d5a
-  data.tar.gz: a838815a6d65920fe1e1602e606e3bb73ab55c0176c9f565166f87d8cc643b42e37ab785f672ea651d2a156e93de68bf0eeff16b5237da0e6a75b7a98d7c2490
+  metadata.gz: e669b128e63dc889ea502837c7fd0cc74c19c5c4cc03e63e4076e08546899a5801f52f0cb142502990e748eb14287c73199443a60f3cbaae8cb09e59690a2eb6
+  data.tar.gz: ba46b14a83edcc108de08d231079f1c91f8d880f2aa8ae518f60686048d395f8e5c966dc44893d165a0934d22b6e712999aea09be93db0249248ad80d54772b4

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-03-28 18:37:09 -0400 using RuboCop version 0.80.1.
+# on 2020-03-31 08:37:36 -0400 using RuboCop version 0.80.1.
 # 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
@@ -39,10 +39,11 @@ Style/AccessModifierDeclarations:
   Exclude:
     - 'lib/slack-ruby-bot/hooks/hook_support.rb'
 
-# Offense count: 1
+# Offense count: 3
 Style/DoubleNegation:
   Exclude:
     - 'lib/slack-ruby-bot/commands/base.rb'
+    - 'lib/slack-ruby-bot/config.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.14.0 (2020/4/2)
+
+* [#250](https://github.com/slack-ruby/slack-ruby-bot/pull/250): Added `config.allow_bot_messages`, defaults to `false` - [@dblock](https://github.com/dblock).
+
 ### 0.13.0 (2020/3/28)
 
 * [#244](https://github.com/slack-ruby/slack-ruby-bot/pull/244): Change log message when the bot is reconnected - [@wasabigeek](https://github.com/wasabigeek).

data/DEPLOYMENT.md

@@ -1,8 +1,8 @@
 ## Installation
 
-To integrate your bot with Slack, you must first create a new [Slack App](https://api.slack.com/apps).
+To integrate your bot with Slack, you must first create a new [Classic Slack App](https://api.slack.com/authentication/migration#classic) and a [legacy bot](https://api.slack.com/legacy/custom-integrations/bot-users).
 
-![](screenshots/create-app.png)
+![](screenshots/create-classic-app.png)
 
 ### Environment
 

data/README.md

@@ -19,7 +19,8 @@ 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 **stable** release of slack-ruby-bot, v0.13.0. 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 **stable** release of slack-ruby-bot, v0.14.0.
+See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
 
 ## Usage
 
@@ -470,6 +471,16 @@ server.hooks.add(:hello, ->(client, data) { puts "Hello!" })
 
 ```
 
+### Bot Message Protection
+
+By default bots do not respond to self or other bots. If you wish to change that behavior, set `allow_bot_messages` to `true`.
+
+```ruby
+SlackRubyBot.configure do |config|
+  config.allow_bot_messages = true
+end
+```
+
 ### Message Loop Protection
 
 By default bots do not respond to their own messages. If you wish to change that behavior, set `allow_message_loops` to `true`.

data/UPGRADING.md

@@ -1,6 +1,20 @@
 Upgrading SlackRubyBot
 ======================
 
+### 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

data/examples/minimal/Gemfile

@@ -2,5 +2,5 @@
 
 source 'http://rubygems.org'
 
-gem 'celluloid-io'
+gem 'async-websocket', '~> 0.8.0'
 gem 'slack-ruby-bot', path: '../..'

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

@@ -4,11 +4,15 @@ 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 send_gifs logger].freeze
     attr_accessor(*ATTRS)
 
+    def allow_bot_messages?
+      !!allow_bot_messages
+    end
+
     def allow_message_loops?
-      allow_message_loops
+      !!allow_message_loops
     end
 
     def send_gifs?

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

@@ -5,6 +5,7 @@ module SlackRubyBot
     class Message
       def call(client, data)
         return if message_to_self_not_allowed? && message_to_self?(client, data)
+        return if bot_message_not_allowed? && bot_message?(client, data)
 
         data.text = data.text.strip if data.text
         result = child_command_classes.detect { |d| d.invoke(client, data) }
@@ -23,6 +24,14 @@ module SlackRubyBot
         client.self && client.self.id == data.user
       end
 
+      def bot_message_not_allowed?
+        !SlackRubyBot::Config.allow_bot_messages?
+      end
+
+      def bot_message?(_client, data)
+        data.subtype == 'bot_message'
+      end
+
       #
       # All commands.
       #

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SlackRubyBot
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
 end

data/spec/slack-ruby-bot/commands/bot_messages_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+describe SlackRubyBot::App do
+  def app
+    SlackRubyBot::App.new
+  end
+
+  let(:client) { subject.send(:client) }
+  let(:message_hook) { SlackRubyBot::Hooks::Message.new }
+
+  context 'default' do
+    it 'does not respond to bot messages' do
+      expect(client).to_not receive(:message)
+      message_hook.call(client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} hi", subtype: 'bot_message'))
+    end
+  end
+  context 'with allow_bot_messages=true' do
+    before do
+      SlackRubyBot::Config.allow_bot_messages = true
+    end
+    it 'responds to self' do
+      expect(client).to receive(:message)
+      message_hook.call(client, Hashie::Mash.new(text: "#{SlackRubyBot.config.user} hi", subtype: 'bot_message'))
+    end
+  end
+end

data/spec/slack-ruby-bot/hooks/message_spec.rb

@@ -50,6 +50,24 @@ describe SlackRubyBot::Hooks::Message do
       end
     end
   end
+  describe '#bot_message_not_allowed?' do
+    context 'with allow_bot_messages set to true' do
+      before do
+        SlackRubyBot::Config.allow_bot_messages = true
+      end
+      it do
+        expect(message_hook.send(:bot_message_not_allowed?)).to be false
+      end
+    end
+    context 'with allow_bot_messages set to false' do
+      before do
+        SlackRubyBot::Config.allow_bot_messages = false
+      end
+      it do
+        expect(message_hook.send(:bot_message_not_allowed?)).to be true
+      end
+    end
+  end
   describe '#message_to_self?' do
     let(:client) { Hashie::Mash.new(self: { 'id' => 'U0K8CKKT1' }) }
     context 'with message to self' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-28 00:00:00.000000000 Z
+date: 2020-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -207,7 +207,7 @@ files:
 - lib/slack-ruby-bot/version.rb
 - lib/slack_ruby_bot.rb
 - screenshots/aliases.gif
-- screenshots/create-app.png
+- screenshots/create-classic-app.png
 - screenshots/demo.gif
 - screenshots/dms.gif
 - screenshots/help.png
@@ -221,6 +221,7 @@ files:
 - spec/slack-ruby-bot/commands/aliases_spec.rb
 - spec/slack-ruby-bot/commands/attachment_spec.rb
 - spec/slack-ruby-bot/commands/bot_message_spec.rb
+- spec/slack-ruby-bot/commands/bot_messages_spec.rb
 - spec/slack-ruby-bot/commands/bot_spec.rb
 - spec/slack-ruby-bot/commands/commands_command_classes_spec.rb
 - spec/slack-ruby-bot/commands/commands_permitted_spec.rb
@@ -295,6 +296,7 @@ test_files:
 - spec/slack-ruby-bot/commands/aliases_spec.rb
 - spec/slack-ruby-bot/commands/attachment_spec.rb
 - spec/slack-ruby-bot/commands/bot_message_spec.rb
+- spec/slack-ruby-bot/commands/bot_messages_spec.rb
 - spec/slack-ruby-bot/commands/bot_spec.rb
 - spec/slack-ruby-bot/commands/commands_command_classes_spec.rb
 - spec/slack-ruby-bot/commands/commands_permitted_spec.rb