slack-ruby-client 0.13.0 → 0.17.0

data/CONTRIBUTING.md

@@ -75,13 +75,24 @@ 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. Run `rake slack:api:update SKIP_PATCH=true` to create the raw auto-generated files. Commit the files that you are updating, so we can run `git diff` later.
+2. 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.
+3. 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 +1,3 @@
+# frozen_string_literal: true
+
 danger.import_dangerfile(gem: 'slack-ruby-danger')

data/Gemfile

@@ -1,12 +1,17 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gemspec
 
-gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
-
-gem 'activesupport', '~> 4.0'
-gem 'picky' unless RUBY_PLATFORM == 'java'
+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-2021 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/README.md

@@ -5,20 +5,72 @@ Slack Ruby Client
 [![Build Status](https://travis-ci.org/slack-ruby/slack-ruby-client.svg?branch=master)](https://travis-ci.org/slack-ruby/slack-ruby-client)
 [![Code Climate](https://codeclimate.com/github/slack-ruby/slack-ruby-client/badges/gpa.svg)](https://codeclimate.com/github/slack-ruby/slack-ruby-client)
 
-A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messaging](https://api.slack.com/rtm) APIs. Comes with a handy command-line client, too. If you are not familiar with these concepts, you might want to watch [this video](http://code.dblock.org/2016/03/11/your-first-slack-bot-service-video.html).
+A Ruby client for the Slack [Web](https://api.slack.com/web), [RealTime Messaging](https://api.slack.com/rtm) and [Events](https://api.slack.com/events-api) APIs. Comes with a handy command-line client, too. If you are not familiar with these concepts, you might want to watch [this video](http://code.dblock.org/2016/03/11/your-first-slack-bot-service-video.html).
 
 ![](slack.png)
 
+## Table of Contents
+
+- [Useful to Me?](#useful-to-me)
+- [Stable Release](#stable-release)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Create a New Bot Integration](#create-a-new-bot-integration)
+  - [OAuth Code Grant](#oauth-code-grant)
+  - [Using the Legacy API Token](#using-the-legacy-api-token)
+  - [Global Settings](#global-settings)
+  - [Web Client](#web-client)
+    - [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)
+  - [Configuring Slack::RealTime::Client](#configuring-slackrealtimeclient)
+    - [Caveats](#caveats)
+      - [websocket_ping](#websocket_ping)
+  - [Connection Methods](#connection-methods)
+  - [Combining RealTime and Web Clients](#combining-realtime-and-web-clients)
+  - [Large Team Considerations](#large-team-considerations)
+    - [Concurrency](#concurrency)
+      - [Async](#async)
+  - [Events API](#events-api)
+    - [Configuring Slack::Events](#configuring-slackevents)
+    - [Verifying the Request Signature](#verifying-the-request-signature)
+  - [Message Parsing](#message-parsing)
+  - [Command-Line Client](#command-line-client)
+    - [Authenticate with Slack](#authenticate-with-slack)
+    - [Send a Message](#send-a-message)
+    - [Get Channel Id](#get-channel-id)
+    - [Get Channel Info](#get-channel-info-1)
+    - [List Users](#list-users)
+- [History](#history)
+- [Contributing](#contributing)
+- [Copyright and License](#copyright-and-license)
+
 ## Useful to Me?
 
-* This piece of the puzzle will help you send messages to Slack via the Web API and send and receive messages via the Real Time API.
-* If you're trying to respond to slash commands, just write a basic web application and use this library to call the Slack Web API.
-* If you're trying to build a Real Time bot, use [slack-ruby-bot](https://github.com/dblock/slack-ruby-bot), which uses this library.
-* If you're trying to roll out a full service 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.
+* 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/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, v0.13.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.17.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -28,10 +80,10 @@ Add to Gemfile.
 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`.
+If you're going to be using the RealTime client, add `async-websocket`. See below for more information about concurrency.
 
 ```
-gem 'async-websocket'
+gem 'async-websocket', '~> 0.8.0'
 ```
 
 Run `bundle install`.
@@ -40,11 +92,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)
 
-![](screenshots/register-bot.png)
+### OAuth Code Grant
 
-### Use the API Token
+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).
+
+### Using the Legacy 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|
@@ -67,14 +125,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).
 
@@ -86,17 +148,17 @@ 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).
+List channels with [conversations_list](https://api.slack.com/methods/conversations.list).
 
 ```ruby
-channels = client.channels_list.channels
+channels = client.conversations_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).
 
@@ -111,19 +173,19 @@ 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.
+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 `conversations_list` in order to locate the channel ID.
 
 ```ruby
-client.channels_info(channel: 'C04KB5X4D') # calls channels_info
+client.conversations_info(channel: 'C04KB5X4D') # calls conversations_info
 ```
 
 ```ruby
-client.channels_info(channel: '#general') # calls channels_list followed by channels_info
+client.conversations_info(channel: '#general') # calls conversations_list followed by conversations_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.
 
@@ -135,7 +197,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.
 
@@ -143,7 +205,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.
 
@@ -176,11 +238,12 @@ timeout             | Optional open/read timeout in seconds.
 open_timeout        | Optional connection open timeout in seconds.
 default_page_size   | Optional page size for paginated requests, default is _100_.
 default_max_retries | Optional number of retries for paginated requests, default is _100_.
+adapter             | Optional HTTP adapter to use, defaults to `Faraday.default_adapter`.
 
 You can also pass request options, including `timeout` and `open_timeout` into individual calls.
 
 ```ruby
-client.channels_list(request: { timeout: 180 })
+client.conversations_list(request: { timeout: 180 })
 ```
 
 You can also control what proxy options are used by modifying the `http_proxy` environment variable per [Net::HTTP's documentation](https://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html#class-Net::HTTP-label-Proxies).
@@ -213,13 +276,59 @@ 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 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 you exceed [Slack’s rate limits](https://api.slack.com/docs/rate-limits), a `Slack::Web::Api::Errors::TooManyRequestsError` will be raised instead.
+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 any other case, a `Faraday::ClientError` will be raised. This may be the case if Slack is temporarily unavailable, for example.
+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 case of Slack temporarily unavailability a `Slack::Web::Api::Errors::ServerError` (`Slack::Web::Api::Errors::SlackError` subclass) subclasses will be raised and original `Faraday::Error` will be accesible via `exception.cause`.
+
+Specifically `Slack::Web::Api::Errors::ParsingError` will be raised on non-json response (i. e. 200 OK with `Slack unavailable` HTML page) and `Slack::Web::Api::Errors::HttpRequestError` subclasses for connection failures (`Slack::Web::Api::Errors::TimeoutError` for read/open timeouts & `Slack::Web::Api::Errors::UnavailableError` for 5xx HTTP responses).
+
+In any other case, a `Faraday::ClientError` will be raised.
 
 ### RealTime Client
 
@@ -235,9 +344,9 @@ end
 client.on :message do |data|
   case data.text
   when 'bot hi' then
-    client.message channel: data.channel, text: "Hi <@#{data.user}>!"
+    client.message(channel: data.channel, text: "Hi <@#{data.user}>!")
   when /^bot/ then
-    client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
+    client.message(channel: data.channel, text: "Sorry <@#{data.user}>, what?")
   end
 end
 
@@ -308,7 +417,7 @@ The following settings are supported.
 setting         | description
 ----------------|-----------------------------------------------------------------------------------------------------
 token           | Slack API token.
-websocket_ping  | The number of seconds that indicates how often the WebSocket should send ping frames, default is 30.
+websocket_ping  | How long the socket can be idle before sending a ping message to confirm it's still connected, default is 30.
 websocket_proxy | Connect via proxy, include `:origin` and `:headers`.
 store_class     | Local store class name, default is an in-memory `Slack::RealTime::Stores::Store`.
 start_method    | Optional start method, either `:rtm_start` or `:rtm_connect`.
@@ -321,6 +430,17 @@ See a fully working example in [examples/hi_real_time](examples/hi_real_time/hi.
 
 ![](examples/hi_real_time/hi.gif)
 
+#### Caveats
+
+##### `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.
+
+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.
+
 ### Connection Methods
 
 The RealTime client uses either [rtm.start](https://api.slack.com/methods/rtm.start) or [rtm.connect](https://api.slack.com/methods/rtm.connect) to open a connection. The former retrieves a lot of team information while the latter only serves connection purposes and is preferred. You should let the library choose the right method for you based on the `store_class` used and override this behavior with `start_method` when necessary.
@@ -341,9 +461,9 @@ client = Slack::RealTime::Client.new
 client.on :message do |data|
   case data.text
   when 'bot hi' then
-    client.web_client.chat_postMessage channel: data.channel, text: "Hi <@#{data.user}>!"
+    client.web_client.chat_postMessage(channel: data.channel, text: "Hi <@#{data.user}>!")
   when /^bot/ then
-    client.web_client.chat_postMessage channel: data.channel, text: "Sorry <@#{data.user}>, what?"
+    client.web_client.chat_postMessage(channel: data.channel, text: "Sorry <@#{data.user}>, what?")
   end
 end
 
@@ -373,7 +493,7 @@ See [#134](https://github.com/slack-ruby/slack-ruby-client/issues/134) for a dis
 
 #### Concurrency
 
-`Slack::RealTime::Client` needs help from a concurrency library and supports [Async](https://github.com/socketry/async), [Faye::WebSocket](https://github.com/faye/faye-websocket-ruby) with [Eventmachine](https://github.com/eventmachine/eventmachine) and [Celluloid](https://github.com/celluloid/celluloid). It will auto-detect one or the other depending on the gems in your Gemfile, but you can also set concurrency explicitly.
+`Slack::RealTime::Client` needs help from a concurrency library and supports [Async](https://github.com/socketry/async).
 
 ```ruby
 Slack::RealTime.configure do |config|
@@ -381,7 +501,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
@@ -391,7 +511,7 @@ client.start_async
 
 ##### Async
 
-This is the recommended library. Add `async-websocket` to your Gemfile.
+Add `async-websocket` to your Gemfile.
 
 ```
 gem 'async-websocket'
@@ -399,27 +519,44 @@ gem 'async-websocket'
 
 See a fully working example in [examples/hi_real_time_async_async](examples/hi_real_time_async_async/hi.rb).
 
-##### Faye::Websocket with Eventmachine
+### Events API
 
-Add the following to your Gemfile.
+This library provides limited support for the [Slack Events API](https://api.slack.com/events-api).
 
-```
-gem 'faye-websocket'
+#### Configuring Slack::Events
+
+You can configure Events support globally.
+
+```ruby
+Slack::Events.configure do |config|
+  config.signing_secret = 'secret'
+end
 ```
 
-See a fully working example in [examples/hi_real_time_async_eventmachine](examples/hi_real_time_async_eventmachine/hi.rb).
+The following settings are supported.
 
-##### Celluloid
+setting               | description
+----------------------|---------------------------------------------------------------------------------------------------
+signing_secret        | Slack signing secret, defaults is `ENV['SLACK_SIGNING_SECRET']`.
+signature_expires_in  | Signature expiration window in seconds, default is `300`.
 
-Add the following to your Gemfile.
+#### Verifying the Request Signature
 
-```
-gem 'celluloid-io', require: ['celluloid/current', 'celluloid/io']
+Slack signs its requests using a secret that's unique to your app. Verify incoming HTTP requests as follows.
+
+```ruby
+slack_request = Slack::Events::Request.new(http_request)
+slack_request.verify!
 ```
 
-See a fully working example in [examples/hi_real_time_async_celluloid](examples/hi_real_time_async_celluloid/hi.rb).
+To specify secrets on a per-request basis:
+```ruby
+Slack::Events::Request.new(http_request,
+                           signing_secret: signing_secret,
+                           signature_expires_in: signature_expires_in)
+```
 
-Require
+The `verify!` call may raise `Slack::Events::Request::MissingSigningSecret`, `Slack::Events::Request::InvalidSignature` or `Slack::Events::Request::TimestampExpired` errors.
 
 ### Message Parsing
 
@@ -509,6 +646,6 @@ See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## 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-2021, [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).