slack-ruby-client 0.14.2 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 358de8d699475c86a5e79c8c96e082dd55b9f60fcb44ed806f62758c3e99479e
-  data.tar.gz: ae9bceefa9fef8950b823bcb6f6ff7023ca027a268022500a9e48d8d5aa28f85
+  metadata.gz: c889cedf29a72dd4c60c2d8c1338538c2f35ed7be9d42defa10f04866466997a
+  data.tar.gz: f23223bf65696509321856a536f60411db15c3fe34db3c42f2284672fbc99f47
 SHA512:
-  metadata.gz: 03c79a47ba7b75a13ca37bb1a592faca4c3d6c4d1f53b34ba205a8587bb72b26a6d009fb22cb9a57b63e017dac6b05ef344f13b68f045b57679fd950e0ed686a
-  data.tar.gz: 1761adca1f3ab450cb630102ea77f293340815c9a7e6c17b6afcf0f1fd73172f79cef25e4f89905c134a5b171a4f247d4e733f4c551ca90c57c1519e8f851801
+  metadata.gz: b1c55f1840dbb1604294e83e922188467aa63a8aa04c2d38c744e6e96287db2ba961b33f408ee83c68dae70f9554d362e1fb1278c36dc45b1e1a5190e6b3189f
+  data.tar.gz: 582c4f3d190b998521b5c7e358188c0662d1e3c2c43021cf9e93345e7ca162c027e0d170364c87367ba548132aeb4c0ab989d08c01bc4e5eec4f8312dbaf8ea6

data/.github/FUNDING.yml

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

data/.rubocop.yml

@@ -1,21 +1,37 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
 AllCops:
+  DisplayCopNames: true
   Exclude:
+    - bin/**/*
     - vendor/**/*
     - lib/slack/web/api/slack-api-ref/**/*
+    - lib/slack/web/api/endpoints/* # Auto-generated
+    - lib/slack/web/api/errors.rb # Auto-generated
+    - spec/slack/web/api/endpoints/* # Auto-generated
 
-Metrics:
+Layout/EmptyLineAfterMagicComment:
   Enabled: false
 
-Metrics/LineLength:
-  Max: 512
+Metrics/BlockLength:
+  Max: 250
 
-Style/Documentation:
-  Enabled: false
+Metrics/ClassLength:
+  Max: 250
 
-Naming/MethodName:
+Layout/LineLength:
+  Max: 128
+
+Style/Documentation:
   Enabled: false
 
 Style/ModuleFunction:
   Enabled: false
 
-inherit_from: .rubocop_todo.yml
+Naming/FileName:
+  Exclude:
+    - lib/slack-ruby-client.rb # Required to match gemspec name

data/.rubocop_todo.yml

@@ -1,74 +1,134 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-04-09 22:16:03 -0500 using RuboCop version 0.61.1.
+# on 2020-06-29 08:44:31 -0400 using RuboCop version 0.82.0.
 # 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
-# Configuration parameters: AllowSafeAssignment.
-Lint/AssignmentInCondition:
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/NonDeterministicRequireOrder:
   Exclude:
-    - 'lib/slack/real_time/concurrency/async.rb'
-    - 'lib/slack/real_time/socket.rb'
+    - 'spec/spec_helper.rb'
 
-# Offense count: 4
-Lint/HandleExceptions:
+# Offense count: 2
+# Cop supports --auto-correct.
+Lint/RedundantCopDisableDirective:
   Exclude:
     - 'lib/slack-ruby-client.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowComments.
+Lint/SuppressedException:
+  Exclude:
     - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
     - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
 
-# Offense count: 4
-# 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:
-    - 'bin/commands/chat_scheduledMessages.rb'
-    - 'lib/slack-ruby-client.rb'
-    - 'lib/slack/web/api/endpoints/chat_scheduledMessages.rb'
-    - 'spec/slack/web/api/endpoints/chat_scheduledMessages_spec.rb'
+# Offense count: 11
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 39
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 14
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 32
 
 # Offense count: 1
-# Configuration parameters: EnforcedStyleForLeadingUnderscores.
-# SupportedStylesForLeadingUnderscores: disallowed, required, optional
-Naming/MemoizedInstanceVariableName:
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Performance/RegexpMatch:
   Exclude:
-    - 'lib/slack/logger.rb'
+    - 'lib/tasks/web.rake'
 
 # Offense count: 1
-Security/Open:
+RSpec/AnyInstance:
   Exclude:
-    - 'lib/slack/real_time/client.rb'
+    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
 
-# Offense count: 2
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: inline, group
-Style/AccessModifierDeclarations:
+# Offense count: 5
+# Cop supports --auto-correct.
+RSpec/ContextMethod:
   Exclude:
-    - 'lib/slack/real_time/concurrency/eventmachine.rb'
-    - 'lib/slack/real_time/socket.rb'
+    - 'spec/slack/messages/formatting_spec.rb'
+    - 'spec/slack/web/api/mixins/channels_spec.rb'
+    - 'spec/slack/web/api/mixins/groups_spec.rb'
+    - 'spec/slack/web/api/mixins/users_spec.rb'
 
-# Offense count: 154
-# Configuration parameters: AllowedVariables.
-Style/GlobalVars:
+# Offense count: 71
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 3
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
+# Offense count: 129
+# Cop supports --auto-correct.
+# Configuration parameters: AllowConsecutiveOneLiners.
+RSpec/EmptyLineAfterExample:
+  Enabled: false
+
+# Offense count: 66
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Enabled: false
+
+# Offense count: 17
+# Configuration parameters: CustomTransform, IgnoreMethods.
+RSpec/FilePath:
+  Enabled: false
+
+# Offense count: 13
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
   Exclude:
-    - 'lib/slack/real_time/socket.rb'
-    - 'lib/slack/real_time/stores/store.rb'
-    - 'lib/slack/web/faraday/response/raise_error.rb'
+    - 'spec/integration/integration_spec.rb'
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/slack_spec.rb'
 
-# Offense count: 1
-Style/MixinUsage:
+# Offense count: 77
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 95
+RSpec/MultipleExpectations:
+  Max: 5
+
+# Offense count: 35
+RSpec/NestedGroups:
+  Max: 6
+
+# Offense count: 3
+RSpec/SubjectStub:
   Exclude:
-    - 'bin/slack'
+    - 'spec/slack/web/api/mixins/channels_spec.rb'
+    - 'spec/slack/web/api/mixins/groups_spec.rb'
+    - 'spec/slack/web/api/mixins/users_spec.rb'
 
-# Offense count: 1
-Style/MultilineTernaryOperator:
+# Offense count: 16
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
   Exclude:
+    - 'spec/slack/events/request_spec.rb'
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
+    - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
+    - 'spec/slack/web/faraday/response/raise_error_spec.rb'
     - 'spec/support/real_time/connected_client.rb'
+
+# Offense count: 4
+# Configuration parameters: .
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  EnforcedStyle: unannotated

data/.travis.yml

@@ -3,7 +3,6 @@ language: ruby
 cache: bundler
 
 rvm:
-  - 2.3.8
   - 2.5.3
   - 2.6.0
   - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,40 @@
+### 0.15.0 (2020/7/26)
+
+* [#322](https://github.com/slack-ruby/slack-ruby-client/pull/322): Cache `Faraday::Connection` for persistent adapters - [@drbrain](https://github.com/drbrain).
+* [#324](https://github.com/slack-ruby/slack-ruby-client/pull/324): Require Faraday >= 1.0 - [@dblock](https://github.com/dblock).
+* [#324](https://github.com/slack-ruby/slack-ruby-client/pull/324): Upgrade slack-ruby-danger, rubocop, rubocop-rspec and rubocop-performance - [@dblock](https://github.com/dblock).
+* [#327](https://github.com/slack-ruby/slack-ruby-client/pull/327), [#326](https://github.com/slack-ruby/slack-ruby-client/pull/326): Added `admin_conversations_whitelist`, `admin_usergroups`, `calls` and `calls_participants` endpoints  - [@wasabigeek](https://github.com/wasabigeek).
+* [#329](https://github.com/slack-ruby/slack-ruby-client/pull/329): Log when methods are deprecated - [@wasabigeek](https://github.com/wasabigeek).
+* [#325](https://github.com/slack-ruby/slack-ruby-client/pull/325): Remove activesupport dependency - [@ianks](https://github.com/ianks).
+* [#331](https://github.com/slack-ruby/slack-ruby-client/pull/331): Use `conversations_list` instead of deprecated `channels_list`. Added `admin_conversations_restrictAccess_addGroup`, `admin_conversations_restrictAccess_listGroups` and `admin_conversations_restrictAccess_removeGroup` endpoints - [@wasabigeek](https://github.com/wasabigeek).
+
+### 0.14.6 (2020/3/28)
+
+* [#305](https://github.com/slack-ruby/slack-ruby-client/pull/305): Added `admin_inviteRequests_approve`, `admin_inviteRequests_deny`, `admin_inviteRequests_list`, `admin_inviteRequests_approved_list`, `admin_inviteRequests_denied_list`, `admin_teams_create`, `admin_teams_list`, `admin_teams_admins_list`, `admin_teams_owners_list`, `admin_teams_settings`, `admin_teams_settings_setIcon`, `admin_teams_settings_setName`, `admin_teams_settings_setDescription`, `admin_users_assign`, `admin_users_invite`, `admin_users_remove`, `admin_users_setAdmin`, `admin_users_setOwner` and `admin_users_setRegular` endpoints - [@manuelmeurer](https://github.com/manuelmeurer).
+* [#311](https://github.com/slack-ruby/slack-ruby-client/pull/311): Made Web API `response_metadata` more accessible in errors - [@jmanian](https://github.com/jmanian).
+* [#312](https://github.com/slack-ruby/slack-ruby-client/pull/312): Added specific error classes for Web API - [@jmanian](https://github.com/jmanian).
+* [#313](https://github.com/slack-ruby/slack-ruby-client/pull/313): Added `admin_teams_settings_info`, `admin_users_list`, `admin_users_setExpiration`, `admin_apps_approved_list`, `admin_apps_restricted_list`, `admin_conversations_setTeams`, `admin_emoji_add`, `admin_emoji_addAlias`, `admin_emoji_list`, `admin_emoji_remove` and `admin_emoji_rename` endpoints - [@dblock](https://github.com/dblock).
+
+### 0.14.5 (2019/12/23)
+
+* [#293](https://github.com/slack-ruby/slack-ruby-client/pull/293): Rubocop auto-correct and comprehensive todo - [@jcraigk](https://github.com/jcraigk).
+* [#297](https://github.com/slack-ruby/slack-ruby-client/pull/297): Various Rubocop fixes - [@jcraigk](https://github.com/jcraigk).
+* [#298](https://github.com/slack-ruby/slack-ruby-client/pull/298): Added `admin_apps`, `admin_app_requests` and `views` endpoints - [@jmanian](https://github.com/jmanian).
+* [#303](https://github.com/slack-ruby/slack-ruby-client/pull/303): Added `oauth_v2_access` and `views_publish` endpoints - [@jwright](https://github.com/jwright).
+* [#309](https://github.com/slack-ruby/slack-ruby-client/pull/309): Stop ping on `inactive_account` and `invalid_auth` - [@dblock](https://github.com/dblock).
+
+### 0.14.4 (2019/7/28)
+
+* [#289](https://github.com/slack-ruby/slack-ruby-client/pull/289): Fix reconnects when ping timers under/overshoot - [@georgyangelov](https://github.com/georgyangelov).
+* [#290](https://github.com/slack-ruby/slack-ruby-client/pull/290): Expose Slack::RealTime::Client.logger accessor publicly - [@jcraigk](https://github.com/jcraigk).
+
+### 0.14.3 (2019/7/23)
+
+* [#279](https://github.com/slack-ruby/slack-ruby-client/pull/279): Prevent ping worker from dying on unexpected errors - [@dblock](https://github.com/dblock).
+* [#281](https://github.com/slack-ruby/slack-ruby-client/pull/281): Added `admin_users_session_reset` to Web API - [@dblock](https://github.com/dblock).
+* [#283](https://github.com/slack-ruby/slack-ruby-client/pull/283): Fail when used with incompatible async-websocket > 0.8.0 - [@dblock](https://github.com/dblock).
+* [#284](https://github.com/slack-ruby/slack-ruby-client/pull/284): Include team id, name and domain in log output - [@dblock](https://github.com/dblock).
+
 ### 0.14.2 (2019/4/12)
 
 * [#256](https://github.com/slack-ruby/slack-ruby-client/pull/256): Added support for specifying signing secrets on a per-request basis via optional parameters to the `Slack::Events::Request` constructor - [@gabrielmdeal](https://github.com/gabrielmdeal).
@@ -147,8 +184,8 @@
 ### 0.7.1 (2016/5/2)
 
 * [#82](https://github.com/slack-ruby/slack-ruby-client/pull/82): Fix `usergroups.users.{list,update}` and `files.comments.{add,edit,delete}` APIs - [@masatomo](https://github.com/masatomo).
-* [#73](https://github.com/slack-ruby/slack-ruby-client/issues/73): Add a `closed` event - [@rkadyb](https://github.com/rkadyb).
-* [#69](https://github.com/slack-ruby/slack-ruby-client/issues/69): Add attachments support for `Slack::Web::Api::Endpoints::Chat.chat_update` - [@nicka](https://github.com/nicka).
+* [#73](https://github.com/slack-ruby/slack-ruby-client/issues/73): Added a `closed` event - [@rkadyb](https://github.com/rkadyb).
+* [#69](https://github.com/slack-ruby/slack-ruby-client/issues/69): Added attachments support for `Slack::Web::Api::Endpoints::Chat.chat_update` - [@nicka](https://github.com/nicka).
 * [#85](https://github.com/slack-ruby/slack-ruby-client/issues/85): Compatibility with WebMock 2.0 - [@dblock](https://github.com/dblock).
 * Added `as_user` to `chat_delete` Web API - [@dblock](https://github.com/dblock).
 * Added `reminders_add`, `reminders_complete`, `reminders_delete`, `reminders_info` and `reminders_list` to Web API - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -75,13 +75,31 @@ rake slack:api:update
 
 Sometimes it's necessary to patch auto-generated Slack Web API methods. For example, we want to help clients with calling `to_json` on the `attachments` parameter sent to `chat_postMessage`. See [#20](https://github.com/slack-ruby/slack-ruby-client/issues/20).
 
-Make a change to a generated file, for example `lib/slack/web/api/endpoints/chat.rb` and generate a patch.
+The broad steps are:
+1. Run `rake slack:api:update` to check that existing patches are still valid.
+    - If you run into a `failed to apply patch` error, the auto-generated methods likely drifted from the last patch. Follow the steps [below](#resolving-patch-errors).
+    - This may add new methods if the API has updated, please split them up into multiple PRs if so.
+2. Make a change to a generated file, for example `lib/slack/web/api/endpoints/chat.rb`.
+3. Generate a patch:
+    ```
+    git diff --no-color HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.1.patch
+    ```
+4. Run `rake slack:api:update` to ensure that the patch is cleanly applied. Implement a test for the added or modified functionality and commit the patch file.
+
+##### Resolving Patch Errors
+
+The auto-generated method files may drift overtime e.g. new arguments may be added or descriptions changed. Since previous patches were based on the older auto-generated files, git may be unable to apply them to the new files. Resolving them requires some good ol' splicing:
+1. Comment out the patching code in `lib/tasks/web.rake`:
+    ```ruby
+    # Dir.glob("lib/slack/web/api/patches/#{group}*.patch").sort.each do |patch|
+    #   puts "- patching #{patch}"
+    #   system("git apply #{patch}") || raise('failed to apply patch')
+    # end
+    ```
+2. Run `rake slack:api:update` to create the raw auto-generated files. Commit the files that you are updating, so we can run `git diff` later.
+3. Go through the old patches for the files (e.g. in `lib/slack/web/api/patches/chat.1.patch`), copying code into the new files.
+4. Continue with Step 2 [above](#patching-slack-web-api).
 
-```
-git diff --no-color HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.1.patch
-```
-
-Run `rake slack:api:update` to ensure that the patch is cleanly applied. Implement a test for the added or modified functionality and commit the patch file.
 
 ### Write Documentation
 

data/Dangerfile

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

data/Gemfile

@@ -1,10 +1,17 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gemspec
 
-gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
+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 'danger-toc', '~> 0.1.3', require: false
-  gem 'slack-ruby-danger', '~> 0.1.0', require: false
+  gem 'slack-ruby-danger', '~> 0.2.0', require: false
 end

data/README.md

@@ -16,20 +16,26 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
 - [Installation](#installation)
 - [Usage](#usage)
   - [Create a New Bot Integration](#create-a-new-bot-integration)
-  - [Use the API Token](#use-the-api-token)
+  - [OAuth Code Grant](#oauth-code-grant)
+  - [Using the Legacy API Token](#using-the-legacy-api-token)
   - [Global Settings](#global-settings)
   - [Web Client](#web-client)
-    - [Test Auth](#test-auth)
-    - [Send Messages](#send-messages)
-    - [List Channels](#list-channels)
-    - [Upload a File](#upload-a-file)
-  - [Get Channel Info](#get-channel-info)
-  - [Get User Info](#get-user-info)
-  - [Search for a User](#search-for-a-user)
-    - [Other](#other)
+    - [Web Client Examples](#web-client-examples)
+      - [Test Auth](#test-auth)
+      - [Send Messages](#send-messages)
+      - [List Channels](#list-channels)
+      - [Upload a File](#upload-a-file)
+      - [Get Channel Info](#get-channel-info)
+      - [Get User Info](#get-user-info)
+      - [Search for a User](#search-for-a-user)
+      - [Other](#other)
     - [Web Client Options](#web-client-options)
     - [Pagination Support](#pagination-support)
+    - [Character Encoding](#character-encoding)
     - [Error Handling](#error-handling)
+      - [Slack Errors](#slack-errors)
+      - [Rate Limiting](#rate-limiting)
+      - [Other Errors](#other-errors)
   - [RealTime Client](#realtime-client)
     - [Slack::RealTime::Stores::Store](#slackrealtimestoresstore)
     - [Slack::RealTime::Stores::Starter](#slackrealtimestoresstarter)
@@ -61,12 +67,12 @@ A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messagin
 
 * This library will let you send messages to Slack via the Web API, send and receive messages via the Real Time Messaging API and facilitate integration with the Events API.
 * To respond to slash commands, interactive components or events, implement a web application using your favorite web framework and use this library to call the Slack Web API and to verify that events are coming from Slack.
-* To build a bot using the Real Time Messaging API, use [slack-ruby-bot](https://github.com/dblock/slack-ruby-bot), which uses this library.
-* To roll out a complete service using the Real Time Messaging API with Slack button integration to multiple teams, check out [slack-ruby-bot-server](https://github.com/dblock/slack-ruby-bot-server), which is built on top of slack-ruby-bot, which uses this library.
+* To build a bot using the Real Time Messaging API, use [slack-ruby-bot](https://github.com/slack-ruby/slack-ruby-bot), which uses this library.
+* To roll out a complete service using the Real Time Messaging API with Slack button integration to multiple teams, check out [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server), which is built on top of slack-ruby-bot, which uses this library.
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 0.14.2. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stale** release of slack-ruby-client, v0.15.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -79,7 +85,7 @@ gem 'slack-ruby-client'
 If you're going to be using the RealTime client, add either `async-websocket`, `eventmachine` and `faye-websocket` or `celluloid-io`. See below for more information about concurrency. We recommend you use `async-websocket`.
 
 ```
-gem 'async-websocket'
+gem 'async-websocket', '~> 0.8.0'
 ```
 
 Run `bundle install`.
@@ -88,11 +94,17 @@ Run `bundle install`.
 
 ### Create a New Bot Integration
 
-This is something done in Slack, under [integrations](https://my.slack.com/services). Create a [new bot](https://my.slack.com/services/new/bot), and note its API token.
+To integrate your bot with Slack, you must first create a new [Slack App](https://api.slack.com/apps).
+
+![](screenshots/create-app.png)
+
+### 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).
 
-![](screenshots/register-bot.png)
+### Using the Legacy API Token
 
-### Use the API Token
+Although OAuth is recommended, 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.
 
 ```ruby
 Slack.configure do |config|
@@ -115,14 +127,18 @@ logger       | An optional logger, defaults to `::Logger.new(STDOUT)` at `Logger
 
 The Slack Web API allows you to build applications that interact with Slack.
 
-#### Test Auth
+#### Web Client Examples
+
+Here are some examples of how to use the web client with the Web API.
+
+##### Test Auth
 
 ```ruby
 client = Slack::Web::Client.new
 client.auth_test
 ```
 
-#### Send Messages
+##### Send Messages
 
 Send messages with [chat_PostMessage](https://api.slack.com/methods/chat.postMessage).
 
@@ -134,7 +150,7 @@ See a fully working example in [examples/hi_web](examples/hi_web/hi.rb).
 
 ![](examples/hi_web/hi.gif)
 
-#### List Channels
+##### List Channels
 
 List channels with [channels_list](https://api.slack.com/methods/channels.list).
 
@@ -144,7 +160,7 @@ channels = client.channels_list.channels
 general_channel = channels.detect { |c| c.name == 'general' }
 ```
 
-#### Upload a File
+##### Upload a File
 
 Upload a file with [files_upload](https://api.slack.com/methods/files.upload).
 
@@ -159,7 +175,7 @@ client.files_upload(
 )
 ```
 
-### Get Channel Info
+##### Get Channel Info
 
 You can use a channel ID or name (prefixed with `#`) in all functions that take a `:channel` argument. Lookup by name is not supported by the Slack API and the `channels_id` method called invokes `channels_list` in order to locate the channel ID.
 
@@ -171,7 +187,7 @@ client.channels_info(channel: 'C04KB5X4D') # calls channels_info
 client.channels_info(channel: '#general') # calls channels_list followed by channels_info
 ```
 
-### Get User Info
+##### Get User Info
 
 You can use a user ID or name (prefixed with `@`) in all functions that take a `:user` argument. Lookup by name is not supported by the Slack API and the `users_id` method called invokes `users_list` in order to locate the user ID.
 
@@ -183,7 +199,7 @@ client.users_info(user: 'U092BDCLV') # calls users_info
 client.users_info(user: '@dblock') # calls users_list followed by users_info
 ```
 
-### Search for a User
+##### Search for a User
 
 Constructs an in-memory index of users and searches it. If you want to use this functionality, add the [picky](https://github.com/floere/picky) gem to your project's Gemfile.
 
@@ -191,7 +207,7 @@ Constructs an in-memory index of users and searches it. If you want to use this
 client.users_search(user: 'dblock')
 ```
 
-#### Other
+##### Other
 
 Refer to the [Slack Web API Method Reference](https://api.slack.com/methods) for the list of all available functions.
 
@@ -261,11 +277,53 @@ end
 all_members # many thousands of team members retrieved 10 at a time
 ```
 
+#### Character Encoding
+
+Note that Slack expects `text` to be UTF-8 encoded. If your messages appear with text such as `BAD+11` in Slack, check `text.encoding` and `.encode(Encoding::UTF_8)` your messages before sending them to Slack.
+
+```ruby
+text = 'characters such as "Ñ", "Á", "É"'
+text.encoding
+=> #<Encoding:UTF-8>
+client.chat_postMessage(channel: '#general', text: text, as_user: true)
+# renders 'characters such as "Ñ", "Á", "É"' in Slack
+
+text = text.encode(Encoding::ISO_8859_1)
+text.encoding
+# => #<Encoding:ISO-8859-1>
+client.chat_postMessage(channel: '#general', text: text, as_user: true)
+# renders 'characters such as "BAD+11", "", "BAD+9"' in Slack
+```
+
 #### Error Handling
 
-If a request fails, a `Slack::Web::Api::Errors::SlackError` will be raised. The error message contains the error code. In case of multiple errors, the error codes are separated by commas. The original response is also accessible using the `response` attribute.
+##### Slack Errors
 
-If you exceed [Slack’s rate limits](https://api.slack.com/docs/rate-limits), a `Slack::Web::Api::Errors::TooManyRequestsError` will be raised instead.
+If Slack returns an error for the request, then an error will be raised. The error class is specific to the type of error that Slack returns. For instance if Slack returns `account_inactive` then the error will be `Slack::Web::Api::Errors::AccountInactive`. This allows you to handle certain types of errors as needed:
+
+```ruby
+rescue Slack::Web::Api::Errors::AccountInactive => e
+  # deal with inactive account
+end
+```
+
+All of these errors inherit from `Slack::Web::Api::Errors::SlackError`, so you can handle or silence all errors if necessary:
+
+```ruby
+rescue Slack::Web::Api::Errors::SlackError => e
+  # capture all Slack errors
+end
+```
+
+If there's a new error type that is not yet known by this library, then it will raise `Slack::Web::Api::Errors::SlackError`. (Update the Web API if you find that errors are missing — see [CONTRIBUTING](CONTRIBUTING.md).)
+
+In all of these cases the error message contains the error code, which is also accessible with `slack_error.error`. In case of multiple errors, the error message contains the error codes separated by commas, or they are accessible as an array with `slack_error.errors`. The original response is also accessible using the `response` attribute. The `response_metadata` is accessible with `slack_error.response_metadata`.
+
+##### Rate Limiting
+
+If you exceed [Slack’s rate limits](https://api.slack.com/docs/rate-limits), a `Slack::Web::Api::Errors::TooManyRequestsError` will be raised instead. (This does not inherit from `Slack::Web::Api::Errors::SlackError`.)
+
+##### Other Errors
 
 In any other case, a `Faraday::ClientError` will be raised. This may be the case if Slack is temporarily unavailable, for example.
 
@@ -374,9 +432,11 @@ See a fully working example in [examples/hi_real_time](examples/hi_real_time/hi.
 ##### `websocket_ping`
 This setting determines how long the socket can be idle before sending a ping message to confirm it's still connected.
 
-It's important to note that if a ping message was sent and no response was received within the amount of time specified in `websocket_ping`; the client will attempt to reestablish it's connection to the message server.
+It's important to note that if a ping message was sent and no response was received within the amount of time specified in `websocket_ping` the client will attempt to reestablish it's connection to the message server.
+
+Note that the ping may take between `websocket_ping` and `websocket_ping * 3/2` seconds to actually trigger when there is no activity on the socket. This is because the timer that checks whether to ping is triggered at every `websocket_ping / 2` interval.
 
-To disable this feature; set `websocket_ping` to 0.
+To disable this feature set `websocket_ping` to 0.
 
 ### Connection Methods
 
@@ -438,7 +498,7 @@ Slack::RealTime.configure do |config|
 end
 ```
 
-Use `client.start_async` instead of `client.start!`. A good example of such application is [slack-bot-server](https://github.com/dblock/slack-bot-server).
+Use `client.start_async` instead of `client.start!`. A good example of such application is [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server).
 
 ```ruby
 client = Slack::RealTime::Client.new
@@ -513,7 +573,7 @@ Slack::Events::Request.new(http_request,
                            signature_expires_in: signature_expires_in)
 ```
 
-The `verify!` call may raise `Slack::Events::MissingSigningSecret`, `Slack::Events::InvalidSignature` or `Slack::Events::TimestampExpired` errors.
+The `verify!` call may raise `Slack::Events::Request::MissingSigningSecret`, `Slack::Events::Request::InvalidSignature` or `Slack::Events::Request::TimestampExpired` errors.
 
 ### Message Parsing