slack-ruby-bot 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6c1329b698f67974759dd037ed5b1f5df3b69d3488c46710e15483e8d1c697a
-  data.tar.gz: e936269d17f733b75fe5253e8895c82095839f280e65a6a76d7f209c493c99d0
+  metadata.gz: 9684c9f89d4dfb8fa0b6d57c65392979f40a6371bac3021d427f662e0a4c64db
+  data.tar.gz: 67d12056a667d6670b9f3f90c1df15f9e437a87b11a5aa438616bb3774d27b89
 SHA512:
-  metadata.gz: ddf22b03b7f32b9c9d3d029a75f2e85188799f19940dcfb22dbc058d5cd9bbd94b3ec5fdf028c6c7b51359a2575431f60b0420182c3ca4b45bc3343b38edf01b
-  data.tar.gz: faa773163bd32cd1523b872459b010b33b9a7f5c1ac85872a0fff33301f5527fd3cd381d210956f90cfbd4e00a8f52a509e6b35c7fb7b5b6f3228a07a39d942e
+  metadata.gz: a702d1e2016adf8903fa0283201e51e572663e0bafa8fd2b4ffa255764ce99779022bc653ed8dbc5888490521c6d9ebe8b24774084afb056526c62d9c4b3507c
+  data.tar.gz: d05e13f9c714eb5c97e1257e775126a42579cd5f41181e285aa79df54ceb0175f6138a056c4c7a89160e5ff53fa13fa53fff02a7d2f507c9c05fea0d9ef958f2

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [dblock]

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-03-31 08:37:36 -0400 using RuboCop version 0.80.1.
+# on 2020-06-27 10:38:47 -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
@@ -11,13 +11,6 @@ Lint/DuplicateMethods:
   Exclude:
     - 'lib/slack-ruby-bot/hooks/set.rb'
 
-# Offense count: 2
-# Configuration parameters: AllowComments.
-Lint/SuppressedException:
-  Exclude:
-    - 'lib/initializers/giphy.rb'
-    - 'lib/initializers/giphy_client.rb'
-
 # Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
@@ -39,9 +32,10 @@ Style/AccessModifierDeclarations:
   Exclude:
     - 'lib/slack-ruby-bot/hooks/hook_support.rb'
 
-# Offense count: 3
+# Offense count: 5
 Style/DoubleNegation:
   Exclude:
+    - 'lib/slack-ruby-bot/client.rb'
     - 'lib/slack-ruby-bot/commands/base.rb'
     - 'lib/slack-ruby-bot/config.rb'
 

data/.travis.yml

@@ -7,22 +7,18 @@ matrix:
     - rvm: 2.6.5
       script:
         - bundle exec danger
-    - rvm: 2.3.0
+    - rvm: 2.4.0
       env: CONCURRENCY=celluloid-io
-    - rvm: 2.3.0
+    - rvm: 2.4.0
       env: CONCURRENCY=faye-websocket
-    - rvm: 2.3.0
+    - rvm: 2.4.0
       env: CONCURRENCY=async-websocket
     - rvm: 2.6.5
-      env: CONCURRENCY=celluloid-io WITH_GIPHY=true
-    - rvm: 2.6.5
-      env: CONCURRENCY=faye-websocket WITH_GIPHY=true
-    - rvm: 2.6.5
-      env: CONCURRENCY=celluloid-io WITH_GIPHY_CLIENT=true
+      env: CONCURRENCY=celluloid-io
     - rvm: 2.6.5
-      env: CONCURRENCY=faye-websocket WITH_GIPHY_CLIENT=true
+      env: CONCURRENCY=faye-websocket
     - rvm: 2.6.5
-      env: CONCURRENCY=async-websocket WITH_GIPHY_CLIENT=true
+      env: CONCURRENCY=async-websocket
     - rvm: ruby-head
     - rvm: jruby-head
   allow_failures:

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.16.0 (2020/7/26)
+
+* [#263](https://github.com/slack-ruby/slack-ruby-bot/pull/263): Removed Giphy support - [@dblock](https://github.com/dblock).
+* [#260](https://github.com/slack-ruby/slack-ruby-bot/pull/260): Added a brief migration guide - [@wasabigeek](https://github.com/wasabigeek).
+* [#264](https://github.com/slack-ruby/slack-ruby-bot/pull/264): Added TOC to README - [@dblock](https://github.com/dblock).
+* [#265](https://github.com/slack-ruby/slack-ruby-bot/pull/265): Made `allow_bot_messages` and `allow_message_loops` available in `SlackRubyBot::Client` - [@dblock](https://github.com/dblock).
+* [#266](https://github.com/slack-ruby/slack-ruby-bot/pull/266): Removed deprecated `Server#hooks` - [@dblock](https://github.com/dblock).
+* [#267](https://github.com/slack-ruby/slack-ruby-bot/pull/267): Require Faraday >= 1.0 - [@dblock](https://github.com/dblock).
+
 ### 0.15.0 (2020/5/8)
 
 * [#258](https://github.com/slack-ruby/slack-ruby-bot/pull/258): Extract development dependencies (VCR) from shared rspec configuraion - [@dikond](https://github.com/dikond).

data/DEPLOYMENT.md

@@ -12,6 +12,8 @@ Once created, go to the app's Basic Info tab and grab the Client ID and Client S
 
 Alternatively, you can still [generate a legacy API token](https://api.slack.com/custom-integrations/legacy-tokens) for your app and use it for some interactions.
 
+If you have a legacy API token, and would like to migrate to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server), a brief [migration guide](MIGRATION.md) is provided.
+
 #### SLACK_API_TOKEN
 
 Set the SLACK_API_TOKEN environment variable using the token received above.
@@ -20,10 +22,6 @@ Set the SLACK_API_TOKEN environment variable using the token received above.
 heroku config:add SLACK_API_TOKEN=...
 ```
 
-#### GIPHY_API_KEY
-
-The bot replies with animated GIFs. While it's currently not necessary, you may need to set GIPHY_API_KEY in the future, see [github.com/Giphy/GiphyAPI](https://github.com/Giphy/GiphyAPI) for details.
-
 #### SLACK_RUBY_BOT_ALIASES
 
 Optional names for this bot.
@@ -81,7 +79,7 @@ passenger_pre_start http://example.com:80/;
   <Directory /var/www/bot/public>
     Allow from all
     Options -MultiViews
-    Require all granted    
+    Require all granted
   </Directory>
 </VirtualHost>
 

data/Dangerfile

@@ -1,3 +1,5 @@
 # frozen_string_literal: true
 
 danger.import_dangerfile(gem: 'slack-ruby-danger')
+
+toc.check!

data/Gemfile

@@ -13,9 +13,6 @@ if ENV.key?('CONCURRENCY')
   end
 end
 
-gem 'giphy', require: false if ENV.key?('WITH_GIPHY')
-gem 'GiphyClient', require: false if ENV.key?('WITH_GIPHY_CLIENT')
-
 group :test do
-  gem 'slack-ruby-danger', '~> 0.1.0', require: false
+  gem 'slack-ruby-danger', '~> 0.2.0', require: false
 end

data/MIGRATION.md

@@ -0,0 +1,13 @@
+# Migrating from Legacy API Tokens
+
+New Slack Apps require authentication via OAuth, returning an access token that should be a drop-in replacement for `SLACK_API_TOKEN`. As of the time of writing, the tokens never expire, so you could potentially write your own OAuth flow to retrieve the access token separately.
+
+Alternatively, you could migrate to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server). Note that this requires more infrastructure to support the OAuth flow.
+
+## Migrating to slack-ruby-bot-server
+1. Setup a new `slack-ruby-bot-server` project, following the [guidelines](https://github.com/slack-ruby/slack-ruby-bot-server#run-your-own).
+2. Copy over the `SlackRubyBot::Commands::Base` or `SlackRubyBot::Bot` concrete classes from your `slack-ruby-bot` project into the new project. If you used a [sample app](https://github.com/slack-ruby/slack-ruby-bot-server/tree/master/sample_apps), copy them into the [`commands` folder](https://github.com/slack-ruby/slack-ruby-bot-server/tree/master/sample_apps/sample_app_activerecord/commands) and require it in `commands.rb`.
+3. Create a [Slack Button](https://api.slack.com/docs/slack-button), setting the redirect URL to your OAuth grant endpoint. In the sample app, this would be `<ROOT_URL>/api/teams`.
+4. Run your app and authenticate with the Slack button.
+
+**NOTE**: By default, other teams would be able to authenticate and connect their workspaces using the same Slack button. If this is not what you want, you would need to prevent it.

data/README.md

@@ -11,6 +11,51 @@ If you are not familiar with Slack bots or Slack API concepts, you might want to
 
 ![](slack.png)
 
+# Table of Contents
+
+- [Useful to Me?](#useful-to-me)
+- [Stable Release](#stable-release)
+- [Usage](#usage)
+  - [A Minimal Bot](#a-minimal-bot)
+    - [Gemfile](#gemfile)
+    - [pongbot.rb](#pongbotrb)
+  - [A Production Bot](#a-production-bot)
+  - [More Involved Examples](#more-involved-examples)
+  - [Commands and Operators](#commands-and-operators)
+  - [Threaded Messages](#threaded-messages)
+  - [Bot Aliases](#bot-aliases)
+  - [Generic Routing](#generic-routing)
+  - [Matching text in message attachments](#matching-text-in-message-attachments)
+  - [Providing description for your bot and commands](#providing-description-for-your-bot-and-commands)
+  - [Customize your command help output](#customize-your-command-help-output)
+  - [SlackRubyBot::Commands::Base](#slackrubybotcommandsbase)
+  - [Authorization](#authorization)
+  - [Built-In Commands](#built-in-commands)
+    - [[bot name]](#bot-name)
+    - [[bot name] hi](#bot-name-hi)
+    - [[bot name] help](#bot-name-help)
+  - [Hooks](#hooks)
+    - [Implementing and registering a Hook Handler](#implementing-and-registering-a-hook-handler)
+      - [Hooks registration on SlackRubyBot::Server initialization](#hooks-registration-on-slackrubybotserver-initialization)
+      - [Hooks registration on a SlackRubyBot::Server instance](#hooks-registration-on-a-slackrubybotserver-instance)
+      - [Hooks registration on SlackRubyBot::Server class](#hooks-registration-on-slackrubybotserver-class)
+  - [Bot Message Protection](#bot-message-protection)
+  - [Message Loop Protection](#message-loop-protection)
+  - [Logging](#logging)
+  - [Advanced Integration](#advanced-integration)
+  - [Proxy Configuration](#proxy-configuration)
+  - [Model-View-Controller Design](#model-view-controller-design)
+    - [Controller](#controller)
+    - [Model](#model)
+    - [View](#view)
+  - [Testing](#testing)
+    - [RSpec Shared Behaviors](#rspec-shared-behaviors)
+    - [Testing Lower Level Messages](#testing-lower-level-messages)
+  - [Useful Libraries](#useful-libraries)
+- [Contributing](#contributing)
+- [Upgrading](#upgrading)
+- [Copyright and License](#copyright-and-license)
+
 ## Useful to Me?
 
 * If you are just trying to send messages to Slack, use [slack-ruby-client](https://github.com/slack-ruby/slack-ruby-client), which this library is built on top of.
@@ -19,7 +64,7 @@ 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.15.0.
+You're reading the documentation for the **stable** release of slack-ruby-bot, v0.16.0.
 See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
 
 ## Usage
@@ -141,8 +186,6 @@ SlackRubyBot.configure do |config|
 end
 ```
 
-This is particularly fun with emoji.
-
 ![](screenshots/aliases.gif)
 
 Bots will also respond to a direct message, with or without the bot name in the message itself.
@@ -320,47 +363,6 @@ class AuthorizedBot < SlackRubyBot::Commands::Base
 end
 ```
 
-### Animated GIFs
-
-The `SlackRubyBot::Client` implementation comes with GIF support. To enable it add `gem GiphyClient` (official Giphy SDK) or `gem giphy` (older SDK, deprecated) to your **Gemfile** and set a Giphy key via `ENV['GIPHY_API_KEY']`. Obtain one from [developers.giphy.com](https://developers.giphy.com).
-
-**Note:** Bots send animated GIFs in default commands and errors.
-
-```ruby
-class Phone < SlackRubyBot::Commands::Base
-  command 'call'
-
-  def self.call(client, data, match)
-    client.say(channel: data.channel, text: 'called', gif: 'phone')
-    # Sends the text 'called' and a random GIF that matches the keyword 'phone'.
-  end
-end
-```
-
-Giphy API key is set automatically via `ENV['GIPHY_API_KEY']`. You can override this manually.
-
-```ruby
-Giphy.configure do |config|
-  config.api_key = 'key'
-end
-```
-
-With `GiphyClient` you can configure the default GIF [content rating](https://developers.giphy.com/docs/optional-settings#rating), which supports G, PG, PG-13, and R. The default value is `G`.
-
-```ruby
-Giphy.configure do |config|
-  config.rating = 'PG'
-end
-```
-
-If you use giphy for something else but don't want your bots to send GIFs you can set `ENV['SLACK_RUBY_BOT_SEND_GIFS']` or `SlackRubyBot::Config.send_gifs` to `false`. The latter takes precedence.
-
-```ruby
-SlackRubyBot.configure do |config|
-  config.send_gifs = false
-end
-```
-
 ### Built-In Commands
 
 Slack-ruby-bot comes with several built-in commands. You can re-define built-in commands, normally, as described above.
@@ -458,22 +460,9 @@ These will get pushed into the hook set on initialization.
 
 Either by configuration, explicit assignment or hook blocks, multiple handlers can exist for the same event type.
 
-
-#### Deprecated hook registration
-
-Registering a hook method using `hooks.add` is considered deprecated and
-will be removed on future versions.
-
-```ruby
-# [DEPRECATED]
-server.hooks.add(:hello, MyBot::Hooks::UserChange.new)
-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`.
+By default bots do not respond to self or other bots. If you wish to change that behavior globally, set `allow_bot_messages` to `true`.
 
 ```ruby
 SlackRubyBot.configure do |config|
@@ -483,7 +472,7 @@ 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`.
+By default bots do not respond to their own messages. If you wish to change that behavior globally, set `allow_message_loops` to `true`.
 
 ```ruby
 SlackRubyBot.configure do |config|
@@ -511,14 +500,14 @@ end
 
 ### Advanced Integration
 
-You may want to integrate a bot or multiple bots into other systems, in which case a globally configured bot may not work for you. You may create instances of [SlackRubyBot::Server](lib/slack-ruby-bot/server.rb) which accepts `token`, `aliases` and `send_gifs`.
+You may want to integrate a bot or multiple bots into other systems, in which case a globally configured bot may not work for you. You may create instances of [SlackRubyBot::Server](lib/slack-ruby-bot/server.rb) which accepts `token` and `aliases`.
 
 ```ruby
 EM.run do
   bot1 = SlackRubyBot::Server.new(token: token1, aliases: ['bot1'])
   bot1.start_async
 
-  bot2 = SlackRubyBot::Server.new(token: token2, send_gifs: false, aliases: ['bot2'])
+  bot2 = SlackRubyBot::Server.new(token: token2, aliases: ['bot2'])
   bot2.start_async
 end
 ```

data/UPGRADING.md

@@ -1,6 +1,20 @@
 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

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

@@ -13,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

@@ -4,12 +4,30 @@ 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
@@ -31,12 +49,6 @@ 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&.name
     end
@@ -46,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/about.rb

@@ -7,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

@@ -16,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