slack-ruby-bot 0.11.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ce2b630c8c8febedc5e967ff7fddeaa50cea17b881fb73fa2a7bf58e486005c
-  data.tar.gz: 7eb5553808ed92fbcb256e35f2d7fb85b5943841a5205fb3b05b73f271f18817
+  metadata.gz: 9684c9f89d4dfb8fa0b6d57c65392979f40a6371bac3021d427f662e0a4c64db
+  data.tar.gz: 67d12056a667d6670b9f3f90c1df15f9e437a87b11a5aa438616bb3774d27b89
 SHA512:
-  metadata.gz: 3b6b488d4b4b2aa1911429abac4d591a977926c715580d534d8b21ebc88f9c3babad8dcbf5e9a773e123abaa882e2a98267aa8befefe9d8f11dc396c307246c0
-  data.tar.gz: 12859a82a5f268068b630efe1535c18206d2cee981839110aa6113e05fabf02f5024a0d3ca297972f4de81de7403d3b77f26af6e5f6f08c58fbea2e65ea4e111
+  metadata.gz: a702d1e2016adf8903fa0283201e51e572663e0bafa8fd2b4ffa255764ce99779022bc653ed8dbc5888490521c6d9ebe8b24774084afb056526c62d9c4b3507c
+  data.tar.gz: d05e13f9c714eb5c97e1257e775126a42579cd5f41181e285aa79df54ceb0175f6138a056c4c7a89160e5ff53fa13fa53fff02a7d2f507c9c05fea0d9ef958f2

data/.github/FUNDING.yml

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

data/.gitignore

@@ -1,4 +1,5 @@
+.bundle
+.DS_Store
 .env
-pkg
 Gemfile.lock
-.bundle
+pkg

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.3
   Exclude:
     - vendor/**/*
     - examples/**/vendor/**/*
@@ -7,10 +8,22 @@ AllCops:
 Metrics:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 512
 
 Style/Documentation:
   Enabled: false
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/ModuleFunction:
+  Enabled: false
+
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,36 +1,22 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-08-27 14:16:34 +0200 using RuboCop version 0.58.2.
+# 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
-  Exclude:
-    - 'lib/slack-ruby-bot/commands/help.rb'
-    - 'spec/slack-ruby-bot/commands/help_spec.rb'
-
 # Offense count: 1
 Lint/DuplicateMethods:
   Exclude:
     - 'lib/slack-ruby-bot/hooks/set.rb'
 
-# Offense count: 2
-Lint/HandleExceptions:
-  Exclude:
-    - 'lib/initializers/giphy.rb'
-    - 'lib/initializers/giphy_client.rb'
-
 # Offense count: 1
-# Cop supports --auto-correct.
-Lint/UnneededCopEnableDirective:
+# 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
+Naming/FileName:
   Exclude:
-    - 'Gemfile'
+    - 'lib/slack-ruby-bot.rb'
 
 # Offense count: 2
 # Configuration parameters: EnforcedStyle.
@@ -46,32 +32,18 @@ Style/AccessModifierDeclarations:
   Exclude:
     - 'lib/slack-ruby-bot/hooks/hook_support.rb'
 
-# Offense count: 1
+# 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'
 
-# Offense count: 5
-# Cop supports --auto-correct.
-Style/ExpandPathArguments:
-  Exclude:
-    - 'lib/config/application.rb'
-    - 'lib/config/environment.rb'
-    - 'lib/slack-ruby-bot.rb'
-    - 'slack-ruby-bot.gemspec'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/slack-ruby-bot/commands/support/match.rb'
-    - 'lib/slack-ruby-bot/mvc/controller/base.rb'
-
-# Offense count: 2
+# Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: module_function, extend_self
-Style/ModuleFunction:
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
   Exclude:
-    - 'lib/initializers/giphy_client.rb'
-    - 'lib/slack-ruby-bot/config.rb'
+    - 'spec/**/*'
+    - 'examples/market/marketbot.rb'

data/.travis.yml

@@ -4,23 +4,21 @@ cache: bundler
 
 matrix:
   include:
-    - rvm: 2.3.0
+    - 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
-      env: CONCURRENCY=celluloid-io WITH_GIPHY=true
-    - rvm: 2.3.0
-      env: CONCURRENCY=faye-websocket WITH_GIPHY=true
-    - rvm: 2.3.0
-      env: CONCURRENCY=celluloid-io WITH_GIPHY_CLIENT=true
-    - rvm: 2.3.0
-      env: CONCURRENCY=faye-websocket WITH_GIPHY_CLIENT=true
-    - rvm: 2.5
-      env: CONCURRENCY=async-websocket WITH_GIPHY_CLIENT=true
+    - rvm: 2.4.0
+      env: CONCURRENCY=async-websocket
+    - rvm: 2.6.5
+      env: CONCURRENCY=celluloid-io
+    - rvm: 2.6.5
+      env: CONCURRENCY=faye-websocket
+    - rvm: 2.6.5
+      env: CONCURRENCY=async-websocket
     - rvm: ruby-head
     - rvm: jruby-head
   allow_failures:

data/CHANGELOG.md

@@ -1,14 +1,47 @@
-### 0.11.2 (2018/12/01)
+### 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).
+* [#256](https://github.com/slack-ruby/slack-ruby-bot/pull/256): Allow command matcher to receive no-break spaces as regular spaces - [@MichaelM-Shopify](https://github.com/MichaelM-Shopify), [@dblock](https://github.com/dblock).
+* [#254](https://github.com/slack-ruby/slack-ruby-bot/pull/254): Allow setting of `config.token` and `config.aliases` in initializer - [@wasabigeek](https://github.com/wasabigeek).
+* [#253](https://github.com/slack-ruby/slack-ruby-bot/pull/253): Remove reference to unsupported Giphy content rating - [@wasabigeek](https://github.com/wasabigeek).
+
+### 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).
+* [#209](https://github.com/slack-ruby/slack-ruby-bot/pull/209): Allow `respond_to_slack_message` and `respond_to_slack_messages` without arguments - [@dblock](https://github.com/dblock).
+* [#216](https://github.com/slack-ruby/slack-ruby-bot/pull/216): Added `start_typing` RSpec matcher - [@dblock](https://github.com/dblock).
+* [#214](https://github.com/slack-ruby/slack-ruby-bot/pull/214): Add passenger deployment documentation - [@cybercrediators](https://github.com/cybercrediators).
+* [#220](https://github.com/slack-ruby/slack-ruby-bot/pull/220): Updated examples/market to pull from IEX instead of defunct yahoo service - [@corprew](https://github.com/corprew).
+* [#246](https://github.com/slack-ruby/slack-ruby-bot/pull/246): Drop support for Ruby 2.2 - [@dblock](https://github.com/dblock).
+
+### 0.12.0 (2019/2/25)
+
+* [#203](https://github.com/slack-ruby/slack-ruby-bot/pull/203): Removing restart logic - [@RodneyU215](https://github.com/RodneyU215).
+
+### 0.11.2 (2018/12/1)
 
 * [#198](https://github.com/slack-ruby/slack-ruby-bot/pull/198): Recommend using `async-websocket` instead of `celluloid-io` - [@dblock](https://github.com/dblock).
 * [#202](https://github.com/slack-ruby/slack-ruby-bot/pull/202): Allow frozen string in Hooks::Message - [@jonosenior](https://github.com/jonosenior).
 
-### 0.11.1 (2018/05/06)
+### 0.11.1 (2018/5/6)
 
 * [#187](https://github.com/slack-ruby/slack-ruby-bot/pull/187): Added support for the [official Giphy SDK](https://github.com/Giphy/giphy-ruby-client) - [@dblock](https://github.com/dblock).
 * [#185](https://github.com/slack-ruby/slack-ruby-bot/pull/185): Log backtrace of exceptions - [@dblock](https://github.com/dblock).
 
-### 0.11.0 (2018/04/02)
+### 0.11.0 (2018/4/2)
 
 * [#182](https://github.com/slack-ruby/slack-ruby-bot/pull/182): Refactor CommandsHelper class and Help module - [@mdudzinski](https://github.com/mdudzinski).
 * [#180](https://github.com/slack-ruby/slack-ruby-bot/pull/180): Allow to respond to text in attachments #177 - [@mdudzinski](https://github.com/mdudzinski).
@@ -24,18 +57,18 @@
 * [#163](https://github.com/slack-ruby/slack-ruby-bot/pull/163): Allow `command` to accept regular expressions - [@kstole](https://github.com/kstole).
 * [#166](https://github.com/slack-ruby/slack-ruby-bot/pull/166): Allow special characters and capitals in bot aliases - [@kstole](https://github.com/kstole).
 
-### 0.10.4 (2017/07/05)
+### 0.10.4 (2017/7/5)
 
 * [#149](https://github.com/slack-ruby/slack-ruby-bot/pull/149): Add `logger` configuration to set a custom logger - [@upscent](https://github.com/upscent).
 * [#147](https://github.com/slack-ruby/slack-ruby-bot/pull/147): Adds `server.on` as a shortcut for `hooks.add` and deprecate `hooks` method - [@laertispappas](https://github.com/laertispappas).
 * [#143](https://github.com/slack-ruby/slack-ruby-bot/pull/143): Provide `permitted?` method to allow for simple authorization extensions - [@chuckremes](https://github.com/chuckremes).
 
-### 0.10.3 (2017/06/15)
+### 0.10.3 (2017/6/15)
 
 * [#145](https://github.com/slack-ruby/slack-ruby-bot/pull/145): Map multiple command strings to same controller method - [@chuckremes](https://github.com/chuckremes).
 * [#144](https://github.com/slack-ruby/slack-ruby-bot/pull/144): Support usage of commands with embedded spaces when using Controller methods - [@chuckremes](https://github.com/chuckremes).
 
-### 0.10.2 (2017/06/03)
+### 0.10.2 (2017/6/3)
 
 * [#137](https://github.com/slack-ruby/slack-ruby-bot/pull/137): Add Model-View-Controller classes to allow for more explicit control over how `command`s are designed - [@chuckremes](https://github.com/chuckremes).
 * [#130](https://github.com/slack-ruby/slack-ruby-bot/issues/130): Added test dependencies in TUTORIAL.md - [@jbristow](https://github.com/jbristow).

data/CONTRIBUTING.md

@@ -18,13 +18,17 @@ git remote add upstream https://github.com/slack-ruby/slack-ruby-bot.git
 
 ## Bundle Install and Test
 
-Ensure that you can build the project and run tests.
+Ensure that you can build the project and run tests. Make sure you have set `CONCURRENCY` env variable to one of the following: `celluloid-io`, `faye-websocket` or `async-websocket`.
 
 ```
+export CONCURRENCY=async-websocket
 bundle install
 bundle exec rake
 ```
 
+Take a look at the [travis configuration](https://github.com/slack-ruby/slack-ruby-bot/blob/master/.travis.yml) for more details.
+
+
 ## Run SlackRubyBot in Development
 
 Create a private slack group for yourself.

data/DEPLOYMENT.md

@@ -1,25 +1,27 @@
 ## Installation
 
-Create a new Bot Integration under [services/new/bot](http://slack.com/services/new/bot).
+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/register-bot.png)
-
-On the next screen, note the API token.
+![](screenshots/create-classic-app.png)
 
 ### Environment
 
+#### OAuth Code Grant
+
+Once created, go to the app's Basic Info tab and grab the Client ID and Client Secret.  You'll need these in order complete an [OAuth code grant flow](https://api.slack.com/docs/oauth#flow) as described at [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server).  A successful flow will result in the receipt of an API token for the specific team that is granting access.
+
+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 SLACK_API_TOKEN from the Bot integration settings on Slack.
+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.
@@ -31,3 +33,55 @@ heroku config:add SLACK_RUBY_BOT_ALIASES=":pong: table-tennis ping-pong"
 ### Heroku Idling
 
 Heroku free tier applications will idle. Either pay 7$ a month for the hobby dyno or use [UptimeRobot](http://uptimerobot.com) or similar to prevent your instance from sleeping or pay for a production dyno.
+
+### Passenger Deployment
+
+Deploying on your self-hosted server is fairly easy, it's pretty much following the [tutorial](https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby), but there are some configuration details to pay attention to.
+
++ Change or add the `gem 'puma'` entry in your `Gemfile` to `gem 'passenger'` and `bundle` it
+  + OPTIONAL: To use passenger for developing too, change the `Procfile` to `web: bundle exec passenger start`, to configure the local passenger you could provide an optional `Passenger.json` file ([configuration options](https://www.phusionpassenger.com/library/config/standalone/reference/))
++ If you want to keep your logs etc. in the correct folders, you could add empty `public/`, `tmp/` and `log` directories. Passenger e.g. will automatically use them for local log files.
++ Make sure, the right ruby version is [installed](https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_language_runtime.html) and your passenger is [ready](https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_passenger_main.html) to go.
++ Clone the repository on your server (You could create a separate user for this) and install the dependencies, by running `bundle install` ([More information](https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/xenial/deploy_app.html))
++ Edit the web-server configuration according to the examples below
+  + `PassengerMaxPreloaderIdleTime 0` or `passenger_max_preloader_idle_time 0;` makes sure to not automatically shut down the process after 5 minutes
+  + `PassengerPreStart http://url:port` or `passenger_pre_start http://url:port` will startup the application instantly, without the first HTTP GET-request needed for passenger
+  + To get the `/path/to/ruby` run `passenger-config about ruby-command` and copy the displayed path
+  + Check the config (`nginx -t`) and restart the server with `service nginx restart`
+  + Execute `passenger-status --verbose` to check if your app is working correctly
+  + Optional: restart the passenger app via `passenger-config restart-app /var/www/bot`
+
+#### Nginx
+
+```
+server {
+  listen 80;
+  server_name example.com;
+  root /var/www/bot/public;
+  passenger_enabled on;
+  passenger_ruby /path/to/ruby
+  passenger_max_preloader_idle_time 0;
+  passenger_app_type rack;
+}
+
+passenger_pre_start http://example.com:80/;
+```
+
+#### Apache
+
+```
+<VirtualHost *:80>
+  ServerName example.com
+  DocumentRoot /var/www/bot/public
+  PassengerRuby /path/to/ruby
+  PassengerMaxPreloaderIdleTime 0
+
+  <Directory /var/www/bot/public>
+    Allow from all
+    Options -MultiViews
+    Require all granted
+  </Directory>
+</VirtualHost>
+
+PassengerPreStart http://example.com:80/
+```

data/Dangerfile

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

data/Gemfile

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec
 
-gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
-
-# rubocop:enable Bundler/OrderedGems
-
-gem 'giphy', require: false if ENV.key?('WITH_GIPHY')
-gem 'GiphyClient', require: false if ENV.key?('WITH_GIPHY_CLIENT')
+if ENV.key?('CONCURRENCY')
+  case ENV['CONCURRENCY']
+  when 'async-websocket'
+    gem 'async-websocket', '~> 0.8.0', require: false
+  else
+    gem ENV['CONCURRENCY'], require: false
+  end
+end
 
 group :test do
-  gem 'slack-ruby-danger', '~> 0.1.0', require: false
+  gem 'slack-ruby-danger', '~> 0.2.0', require: false
 end

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015-2016 Daniel Doubrovkine, Artsy and Contributors
+Copyright (c) 2015-2020 Daniel Doubrovkine, Artsy and Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

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.11.2.
+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
@@ -32,7 +77,7 @@ See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING
 source 'https://rubygems.org'
 
 gem 'slack-ruby-bot'
-gem 'celluloid-io'
+gem 'async-websocket', '~>0.8.0'
 ```
 
 #### pongbot.rb
@@ -83,7 +128,7 @@ end
 
 Command match data includes `match['bot']`, `match['command']` and `match['expression']`. The `bot` match always checks against the `SlackRubyBot::Config.user` and `SlackRubyBot::Config.user_id` values obtained when the bot starts.
 
-The `command` method can take strings, which will have be escaped with `Regexp.escape`, and regular expressions.
+The `command` method can take strings, which will have to be escaped with `Regexp.escape`, and regular expressions.
 
 ```ruby
 class CallBot < SlackRubyBot::Bot
@@ -141,11 +186,9 @@ SlackRubyBot.configure do |config|
 end
 ```
 
-This is particularly fun with emoji.
-
 ![](screenshots/aliases.gif)
 
-Bots also will respond to a direct message, with or without the bot name in the message itself.
+Bots will also respond to a direct message, with or without the bot name in the message itself.
 
 ![](screenshots/dms.gif)
 
@@ -269,7 +312,7 @@ class Market < SlackRubyBot::Bot
   command 'help' do |client, data, match|
     user_command = match[:expression]
     help_attrs = SlackRubyBot::Commands::Support::Help.instance.find_command_help_attrs(user_command)
-    client.say(channel: data.channel, text: "#{help_attrs.command_desc}\n\n#{help_attrs.command_long_desc}"
+    client.say(channel: data.channel, text: "#{help_attrs.command_desc}\n\n#{help_attrs.command_long_desc}")
   end
 end
 ```
@@ -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 rating, which supports Y, G, PG, PG-13, and R. The default value is `G`.
-
-```ruby
-Giphy.configure do |config|
-  config.rating = 'Y' # illustrated content only, i.e. cartoons
-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.
@@ -381,7 +383,7 @@ Get help.
 
 Hooks are event handlers and respond to Slack RTM API [events](https://api.slack.com/events), such as [hello](lib/slack-ruby-bot/hooks/hello.rb) or [message](lib/slack-ruby-bot/hooks/message.rb). You can implement your own in a couple of ways:
 
-#### Implement and register a Hook Handler
+#### Implementing and registering a Hook Handler
 
 A Hook Handler is any object that respond to a `call` message, like a proc, instance of an object, class with a `call` class method, etc.
 
@@ -458,22 +460,19 @@ 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.
 
+### Bot Message Protection
 
-#### Deprecated hook registration
-
-Registering a hook method using `hooks.add` is considered deprecated and
-will be removed on future versions.
+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
-# [DEPRECATED]
-server.hooks.add(:hello, MyBot::Hooks::UserChange.new)
-server.hooks.add(:hello, ->(client, data) { puts "Hello!" })
-
+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`.
+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|
@@ -501,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
 ```
@@ -625,7 +624,7 @@ class MyView < SlackRubyBot::MVC::View::Base
 
   def react_thumbsup
     client.web_client.reactions_add(
-      name: :thumbs_up,
+      name: :thumbsup,
       channel: data.channel,
       timestamp: data.ts,
       as_user: true)
@@ -633,7 +632,7 @@ class MyView < SlackRubyBot::MVC::View::Base
 
   def react_thumbsdown
     client.web_client.reactions_remove(
-      name: :thumbs_up,
+      name: :thumbsup,
       channel: data.channel,
       timestamp: data.ts,
       as_user: true)
@@ -652,14 +651,17 @@ Again, the View will have access to the most up to date `client`, `data`, and `m
 
 View methods are not matched to routes, so there is no restriction on how to name methods as there is in Controllers.
 
-### RSpec Shared Behaviors
+### Testing
+
+#### RSpec Shared Behaviors
 
-Slack-ruby-bot ships with a number of shared RSpec behaviors that can be used in your RSpec tests.
+Slack-ruby-bot comes with a number of shared RSpec behaviors that can be used in your RSpec tests.
 
 * [behaves like a slack bot](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/it_behaves_like_a_slack_bot.rb): A bot quacks like a Slack Ruby bot.
 * [respond with slack message](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_message.rb): The bot responds with a message.
 * [respond with slack messages](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_messages.rb): The bot responds with a multiple messages.
 * [respond with error](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb): An exception is raised inside a bot command.
+* [start typing](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/start_typing.rb): The bot calls `client.start_typing`.
 
 Require `slack-ruby-bot/rspec` in your `spec_helper.rb` along with the following dependencies in Gemfile.
 
@@ -672,6 +674,72 @@ group :development, :test do
 end
 ```
 
+Use the `respond_with_slack_message` matcher.
+
+```ruby
+describe SlackRubyBot::Commands do
+  it 'responds with any message' do
+    expect(message: "#{SlackRubyBot.config.user} hi").to respond_with_slack_message
+  end
+  it 'says hi' do
+    expect(message: "#{SlackRubyBot.config.user} hi").to respond_with_slack_message('hi')
+  end
+end
+```
+
+Use the `respond_with_slack_messages` matcher for multiple messages.
+
+```ruby
+describe SlackRubyBot::Commands do
+  it 'responds with more than one message' do
+    expect(message: "#{SlackRubyBot.config.user} count").to respond_with_slack_messages
+  end
+  it 'says one and two' do
+    expect(message: "#{SlackRubyBot.config.user} count").to respond_with_slack_messages(['one', 'two'])
+  end
+end
+```
+
+Message matchers support regular expressions.
+
+```ruby
+describe SlackRubyBot::Commands do
+  it 'says hi' do
+    expect(message: "#{SlackRubyBot.config.user} hi").to respond_with_slack_message(/hi/)
+  end
+end
+```
+
+Check that the bot called `client.start_typing(channel: 'channel')`.
+
+```ruby
+describe SlackRubyBot::Commands do
+ it 'starts typing on channel' do
+    expect(message: "#{SlackRubyBot.config.user} hi").to start_typing(channel: 'channel')
+  end
+end
+```
+
+#### Testing Lower Level Messages
+
+You can test client behavior at a lower level by fetching the message hook. The following example expects a bot command to call `client.typing(channel: data.channel)`.
+
+```ruby
+describe SlackRubyBot::Commands do
+  let(:app) { Server.new }
+  let(:client) { app.send(:client) }
+  let(:message_hook) { SlackRubyBot::Hooks::Message.new }
+  it 'receives a typing event' do
+      expect(client).to receive(:typing)
+      message_hook.call(
+        client,
+        Hashie::Mash.new(text: "#{SlackRubyBot.config.user} type something", channel: 'channel')
+      )
+    end
+  end
+end
+```
+
 ### Useful Libraries
 
 * [newrelic-slack-ruby-bot](https://github.com/dblock/newrelic-slack-ruby-bot): NewRelic instrumentation for slack-ruby-bot.
@@ -686,6 +754,6 @@ See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING
 
 ## Copyright and License
 
-Copyright (c) 2015-2016, [Daniel Doubrovkine](https://twitter.com/dblockdotorg), [Artsy](https://www.artsy.net) and [Contributors](CHANGELOG.md).
+Copyright (c) 2015-2020, [Daniel Doubrovkine](https://twitter.com/dblockdotorg), [Artsy](https://www.artsy.net) and [Contributors](CHANGELOG.md).
 
 This project is licensed under the [MIT License](LICENSE.md).