slack-ruby-client-bhe 0.5.4

checksums.yaml

@@ -0,0 +1,17 @@
+---
+!binary "U0hBMjU2":
+  metadata.gz: !binary |-
+    MzI5YTYwZDcxZDhiMjExYjgyNGExMDYxZGZlZWFmYzg4OWFkNGYwMzdjODM4
+    YTY3MTlhZDU5ZTc0YmMyM2ZjNA==
+  data.tar.gz: !binary |-
+    MDI2MmUwNWY4M2M0NDUyYWQ1ZmIyYTFjYjlmMTVlOTlkOWU3OTJlZTM3NTQy
+    YWQ1ZmM1M2E5OGVmNDZhMTYwNg==
+SHA512:
+  metadata.gz: !binary |-
+    NzQyNGFjMzM4MzU5ZTllYWQ2MWU3YmY5ZGZkYmY5N2QxNWUyNTFiZDRjNWQ5
+    Y2ZiMDI4NTdhZjlkOGEwNjZkNDk3Zjc4ODJjNDc2OTFkM2I5MGU5YWVjMTgw
+    MGNmY2Y0ZTlmMTZkMDcxMDAwOWZkNjY1MmQ5Mzg4YmY1ZjkwNWY=
+  data.tar.gz: !binary |-
+    NjA5ZDgyOWFjODAxY2QxMzBiNjViMzcwNjQ1MzA0ZWMwYWU3ODFmNDllNzM4
+    NWI4OThmNDMyOTg4YzUyYjkyMDJmMjY3OWExOGQ4MjgwMmQxZWQ1NjdkNzI1
+    YTBiMmNjNWQyNjAwMTkzM2I0MWNjOGJhMjY5ODM2NTg0ODg0ZWE=

data/.gitignore

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

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/slack/web/api/slack-api-ref"]
+	path = lib/slack/web/api/slack-api-ref
+	url = git@github.com:dblock/slack-api-ref.git

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - lib/slack/web/api/slack-api-ref/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,78 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-01-22 14:19:14 -0500 using RuboCop version 0.35.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: 3
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/slack/real_time/concurrency/celluloid.rb'
+    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
+    - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreEmptyBlocks.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'lib/slack/messages/formatting.rb'
+
+# Offense count: 7
+Metrics/AbcSize:
+  Max: 22
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 112
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 438
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 288
+
+# Offense count: 4
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 15
+
+# Offense count: 46
+# Configuration parameters: Exclude.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Exclude:
+    - 'lib/slack-ruby-client.rb'
+
+# Offense count: 86
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Enabled: false
+
+# Offense count: 15
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodName:
+  Enabled: false
+
+# Offense count: 3
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/slack/config.rb'
+    - 'lib/slack/real_time/config.rb'
+    - 'lib/slack/web/config.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'lib/slack/messages/formatting.rb'

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0
+  - rbx-2
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: jruby-19mode
+    - rvm: rbx-2
+
+git:
+  submodules: false
+
+env:
+  - CONCURRENCY=celluloid-io
+  - CONCURRENCY=faye-websocket

data/CHANGELOG.md

@@ -0,0 +1,79 @@
+### 0.5.4 (1/23/2016)
+
+* [#45](https://github.com/dblock/slack-ruby-client/issues/45): Added `channels_id`, `groups_id` and `users_id` - [@dblock](https://github.com/dblock).
+* [#45](https://github.com/dblock/slack-ruby-client/issues/45): Automatically lookup channel, group and user ID in Web API methods when Slack API doesn't accept #channel or @user names - [@dblock](https://github.com/dblock).
+* [#49](https://github.com/dblock/slack-ruby-client/pull/49): Fix: Celluloid `#connected?` method. - [@mikz](https://github.com/mikz), [@kandadaboggu](https://github.com/kandadaboggu).
+
+### 0.5.3 (1/11/2016)
+
+* [#47](https://github.com/dblock/slack-ruby-client/pull/47): Fix: default to Celluloid newer API - [@jlyonsmith](https://github.com/jlyonsmith), [@dblock](https://github.com/dblock).
+* Fixed JRuby file encoding regression - [@dblock](https://github.com/dblock).
+
+### 0.5.2 (1/8/2016)
+
+* [#41](https://github.com/dblock/slack-ruby-client/issues/41): Added `Slack::Messages::Formatting#unescape` - [@dblock](https://github.com/dblock).
+* Added `files_comments` to Web API - [@dblock](https://github.com/dblock).
+
+### 0.5.1 (1/4/2016)
+
+* Added `dnd_teamInfo`, `dnd_setSnooze`, `dnd_info`, `dnd_endSnooze` and `dnd_endDnd` to Web API - [@dblock](https://github.com/dblock).
+* The `files_upload` method now requires both `file` and `filename` to Web API - [@dblock](https://github.com/dblock).
+
+### 0.5.0 (12/7/2015)
+
+* Added `usergroups_create`, `usergroups_disable`, `usergroups_enable`, `usergroups_list`, `usergroups_update` and `usergroups_users` to Web API - [@dblock](https://github.com/dblock).
+* Added command-line `slack` client - [@dblock](https://github.com/dblock).
+* [#5](https://github.com/dblock/slack-ruby-client/issues/5): Added Celluloid support - [@mikz](https://github.com/mikz), [@dblock](https://github.com/dblock).
+* [#34](https://github.com/dblock/slack-ruby-client/pull/34): Added `Slack::RealTime::Client#start_async` - [@mikz](https://github.com/mikz), [@dblock](https://github.com/dblock).
+* `Slack::RealTime::Client` supports `:open` and `:close` callbacks - [@dblock](https://github.com/dblock).
+* [#32](https://github.com/dblock/slack-ruby-client/issues/32): Fix: `on_complete: undefined method [] for nil:NilClass` when responding to Slack 400-500 errors - [@dblock](https://github.com/dblock).
+* [#22](https://github.com/dblock/slack-ruby-client/issues/22): Added `Slack::Web::Api::Error#response` - [@dblock](https://github.com/dblock).
+* Added `logger` to `Slack::Web::Client` configuration that logs HTTP requests - [@dblock](https://github.com/dblock).
+
+### 0.4.0 (11/8/2015)
+
+* Added `team_integrationLogs` to Web API - [@dblock](https://github.com/dblock).
+* [#11](https://github.com/dblock/slack-ruby-client/pull/11) - Web API `chat_postMessage` errors only if both `attachments` and `text` are missing - [@dblock](https://github.com/dblock).
+* [#20](https://github.com/dblock/slack-ruby-client/issues/20) - Web API `chat_postMessage` will automatically `to_json` attachments - [@dblock](https://github.com/dblock).
+* Added `mpim_aware` to `rtm_start` to Web API - [@dblock](https://github.com/dblock).
+* Added `mpim_close`, `mpim_history`, `mpim_list`, `mpim_mark` and `mpim_open` to Web API - [@dblock](https://github.com/dblock).
+* Added `unreads` to `channels_history`, `groups_history` and `im_history` to Web API - [@dblock](https://github.com/dblock).
+* Added `stars_add` and `stars_remove` to Web API - [@dblock](https://github.com/dblock).
+
+### 0.3.1 (10/16/2015)
+
+* Added `stars_list`, `stars_add` and `stars_remove` to Web API - [@dblock](https://github.com/dblock).
+* Added `attachments`, `parse` and `link_names` to `chat_update` in Web API - [@dblock](https://github.com/dblock).
+
+### 0.3.0 (9/1/2015)
+
+* Added `team.info` and `accessLogs` to Web API - [@dblock](https://github.com/dblock).
+* Removed obsolete `presence` Web API - [@dblock](https://github.com/dblock).
+* Added `pins_add`, `pins_list` and `pins_remove` from Web API - [@dblock](https://github.com/dblock).
+* Added `presence` to `users_list` in Web API - [@dblock](https://github.com/dblock).
+* Added `groups_info` to Web API - [@dblock](https://github.com/dblock).
+* Added `inclusive` to `groups_history` and `im_history` in Web API - [@dblock](https://github.com/dblock).
+* Added `files_delete` to Web API - [@dblock](https://github.com/dblock).
+* Added `as_user` to `chat_postMessage` in Web API - [@dblock](https://github.com/dblock).
+* Use API reference schema from [github.com/dblock/slack-api-ref](https://github.com/dblock/slack-api-ref) - [@dblock](https://github.com/dblock).
+* Added `reactions_add`, `reactions_list`, `reactions_get` and `reactions_remove` to Web API - [@jakedahn](https://github.com/jakedahn)
+
+### 0.2.1 (8/2/2015)
+
+* Set Slack API token via `Slack::RealTime::Client.new(token: 'token')` and `Slack::Web::Client.new(token: 'token')` - [@dblock](https://github.com/dblock).
+* Set Slack API token via `Slack::RealTime::Client.configure` and `Slack::Web::Client.configure` - [@dblock](https://github.com/dblock).
+
+### 0.2.0 (7/31/2015)
+
+* [#2](https://github.com/dblock/slack-ruby-client/pull/2): `Slack::RealTime::Socket` now pings frames every 30s, as recommended by Slack - [@samdoiron](https://github.com/samdoiron).
+* [#3](https://github.com/dblock/slack-ruby-client/issues/3): RealTime client WebSocket frame ping frequency is now configurable with `Slack::RealTime::Client.websocket_ping` - [@dblock](https://github.com/dblock).
+* [#3](https://github.com/dblock/slack-ruby-client/issues/3): RealTime client WebSocket proxy is now configurable with `Slack::RealTime::Client.websocket_proxy` - [@dblock](https://github.com/dblock).
+* [#3](https://github.com/dblock/slack-ruby-client/issues/3): Added global `Slack::Web::Client` and `Slack::RealTime::Client` configuration options via `Slack::Web::Client.configure` and `Slack::RealTime::Client.configure` - [@dblock](https://github.com/dblock).
+* Exposed `Slack::RealTime::Client.url`, `team`, `self`, `users`, `channels`, `groups`, `ims` and `bots` - [@dblock](https://github.com/dblock).
+* Default user-agent for `Slack::Web::Client` now includes a slash, eg. _Slack Ruby Client/0.1.1_ - [@dblock](https://github.com/dblock).
+* Fix: set `Slack::Web::Client` connection options for `ca_path`, `ca_file`, and `proxy` - [@dblock](https://github.com/dblock).
+
+### 0.1.0 (7/25/2015)
+
+* Initial public release with Web and RealTime Messaging API support - [@dblock](https://github.com/dblock).
+

data/CONTRIBUTING.md

@@ -0,0 +1,157 @@
+# Contributing to Slack-Ruby-Client
+
+This project is work of [many contributors](https://github.com/dblock/slack-ruby-client/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/slack-ruby-client/pulls), [propose features and discuss issues](https://github.com/dblock/slack-ruby-client/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+### Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/slack-ruby-client) and check out your copy.
+
+```
+git clone https://github.com/contributor/slack-ruby-client.git
+cd slack-ruby-client
+git remote add upstream https://github.com/dblock/slack-ruby-client.git
+```
+
+### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+### Run Examples in Development
+
+Sign up for Slack, create a private slack group for yourself.
+
+Create a new Bot Integration under [services/new/bot](http://slack.com/services/new/bot).
+
+![](screenshots/register-bot.png)
+
+On the next screen, note the API token.
+
+To run [the example in examples/hi_real_time](examples/hi_real_time/hi.rb), open a terminal, cd into _examples/hi_real_time_, run `bundle install`, followed by `SLACK_API_TOKEN=<your API token> bundle exec ruby hi.rb`.
+
+## Contribute Code
+
+### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+
+Make sure that `bundle exec rake` completes without errors.
+
+### Update Slack Web API
+
+Slack Web API is updated from https://github.com/dblock/slack-api-ref, a maintained, machine-readable version of Slack API Docs, generated by scraping [api.slack.com](https://api.slack.com). To update the Web API from the latest definition run the following Rake task.
+
+```
+rake slack:web:api:update
+```
+
+#### Patching Slack Web API
+
+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/dblock/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.
+
+```
+git diff HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.1.patch
+```
+
+Run `rake slack:web: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
+
+Document any external behavior in the [README](README.md).
+
+### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
+
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
+
+### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+### Push
+
+```
+git push origin my-feature-branch
+```
+
+### Make a Pull Request
+
+Go to https://github.com/contributor/slack-ruby-client and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/slack-ruby-client/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -0,0 +1,5 @@
+source 'http://rubygems.org'
+
+gemspec
+
+gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2015-2016 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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,385 @@
+Slack Ruby Client
+=================
+
+[![Gem Version](https://badge.fury.io/rb/slack-ruby-client.svg)](http://badge.fury.io/rb/slack-ruby-client)
+[![Build Status](https://travis-ci.org/dblock/slack-ruby-client.svg?branch=master)](https://travis-ci.org/dblock/slack-ruby-client)
+[![Code Climate](https://codeclimate.com/github/dblock/slack-ruby-client/badges/gpa.svg)](https://codeclimate.com/github/dblock/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.
+
+![](slack.png)
+
+## 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-bot-server](https://github.com/dblock/slack-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.5.4. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+
+## Installation
+
+Add to Gemfile.
+
+```
+gem 'slack-ruby-client'
+```
+
+If you're going to be using the RealTime client, add either `eventmachine` and `faye-websocket` or `celluloid-io`. See below for more information about concurrency.
+
+```
+gem 'eventmachine'
+gem 'faye-websocket'
+```
+
+Run `bundle install`.
+
+## Usage
+
+### 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.
+
+![](screenshots/register-bot.png)
+
+### Use the API Token
+
+```ruby
+Slack.configure do |config|
+  config.token = ENV['SLACK_API_TOKEN']
+end
+```
+
+This sets a global default token. You can also pass a token into the initializer of both `Slack::Web::Client` and `Slack::RealTime::Client` or configure those separately via `Slack::Web::Config.configure` and `Slack::RealTime::Config.configure`. The instance token will be used over the client type token over the global default.
+
+### Web Client
+
+The Slack Web API allows you to build applications that interact with Slack.
+
+#### Test Auth
+
+```ruby
+client = Slack::Web::Client.new
+client.auth_test
+```
+
+#### Send Messages
+
+Send messages with [chat_PostMessage](https://api.slack.com/methods/chat.postMessage).
+
+```ruby
+client.chat_postMessage(channel: '#general', text: 'Hello World', as_user: true)
+```
+
+See a fully working example in [examples/hi_web](examples/hi_web/hi.rb).
+
+![](examples/hi_web/hi.gif)
+
+#### List Channels
+
+List channels with [channels_list](https://api.slack.com/methods/channels.list).
+
+```ruby
+channels = client.channels_list['channels']
+
+general_channel = channels.detect { |c| c['name'] == 'general' }
+```
+
+#### Upload a File
+
+Upload a file with [files_upload](https://api.slack.com/methods/files.upload).
+
+```ruby
+client.files_upload(
+  channels: '#general',
+  as_user: true,
+  file: Faraday::UploadIO.new('/path/to/avatar.jpg', 'image/jpeg'),
+  title: 'My Avatar',
+  filename: 'avatar.jpg',
+  initial_comment: 'Attached a selfie.'
+)
+```
+
+### 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.
+
+```ruby
+client.channels_info(channel: 'C04KB5X4D') # calls channels_info
+```
+
+```ruby
+client.channels_info(channel: '#general') # calls channels_list followed by channels_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.
+
+```ruby
+client.users_info(user: 'U092BDCLV') # calls users_info
+```
+
+```ruby
+client.users_info(user: '@dblock') # calls users_list followed by users_info
+```
+
+#### Other
+
+Refer to the [Slack Web API Method Reference](https://api.slack.com/methods) for the list of all available functions.
+
+#### Web Client Options
+
+You can configure the Web client either globally or via the initializer.
+
+```ruby
+Slack::Web::Client.config do |config|
+  config.user_agent = 'Slack Ruby Client/1.0'
+end
+```
+
+```ruby
+client = Slack::Web::Client.new(user_agent: 'Slack Ruby Client/1.0')
+```
+
+The following settings are supported.
+
+setting      | description
+-------------|-------------------------------------------------------------------------------------------------
+token        | Slack API token.
+user_agent   | User-agent, defaults to _Slack Ruby Client/version_.
+proxy        | Optional HTTP proxy.
+ca_path      | Optional SSL certificates path.
+ca_file      | Optional SSL certificates file.
+endpoint     | Slack endpoint, default is _https://slack.com/api_.
+logger       | Optional `Logger` instance that logs HTTP requests.
+
+### RealTime Client
+
+The Real Time Messaging API is a WebSocket-based API that allows you to receive events from Slack in real time and send messages as user.
+
+```ruby
+client = Slack::RealTime::Client.new
+
+client.on :hello do
+  puts "Successfully connected, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
+end
+
+client.on :message do |data|
+  case data['text']
+  when 'bot hi' then
+    client.message channel: data['channel'], text: "Hi <@#{data['user']}>!"
+  when /^bot/ then
+    client.message channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+  end
+end
+
+client.start!
+```
+
+You can send typing indicators with `typing`.
+
+```ruby
+client.typing channel: data['channel']
+```
+
+You can send a ping with `ping`.
+
+```ruby
+client.ping
+```
+
+The client exposes the properties of [rtm.start](https://api.slack.com/methods/rtm.start) upon a successful connection.
+
+property | description
+---------|-------------------------------------------------------------------------------------------------
+url      | A WebSocket Message Server URL.
+self     | Details on the authenticated user.
+team     | Details on the authenticated user's team.
+users    | A list of user objects, one for every member of the team.
+channels | A list of channel objects, one for every channel visible to the authenticated user.
+groups   | A list of group objects, one for every group the authenticated user is in.
+ims      | A list of IM objects, one for every direct message channel visible to the authenticated user.
+bots     | Details of the integrations set up on this team.
+
+You can configure the RealTime client either globally or via the initializer.
+
+```ruby
+Slack::RealTime::Client.config do |config|
+  config.websocket_ping = 42
+end
+```
+
+```ruby
+client = Slack::RealTime::Client.new(websocket_ping: 42)
+```
+
+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_proxy | Connect via proxy, include `:origin` and `:headers`.
+
+Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.start](https://api.slack.com/methods/rtm.start), configure Web client options via `Slack::Web::Client.configure` as described above.
+
+See a fullly working example in [examples/hi_real_time](examples/hi_real_time/hi.rb).
+
+![](examples/hi_real_time/hi.gif)
+
+### Combining RealTime and Web Clients
+
+Since the Web client is used to obtain the RealTime client's WebSocket URL, you can continue using the Web client in combination with the RealTime client.
+
+```ruby
+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']}>!"
+  when /^bot/ then
+    client.web_client.chat_postMessage channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+  end
+end
+
+client.start!
+```
+
+See a fullly working example in [examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb).
+
+![](examples/hi_real_time_and_web/hi.gif)
+
+#### Concurrency
+
+`Slack::RealTime::Client` needs help from a concurrency library and supports [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.
+
+```ruby
+Slack::RealTime.configure do |config|
+  config.concurrency = Slack::RealTime::Concurrency::Eventmachine
+end
+```
+
+Use `client.start_async` instead of `client.start!` if you don't want the library to control the event run loop, such as when integrating into other applications that already use Eventmachine or Celluloid. A good example of such application is [slack-bot-server](https://github.com/dblock/slack-bot-server).
+
+```ruby
+client = Slack::RealTime::Client.new
+
+EM.run do
+  client.start_async
+end
+```
+
+See a fully working example in [examples/hi_real_time_async](examples/hi_real_time_async/hi.rb).
+
+##### Faye::Websocket with Eventmachine
+
+Add the following to your Gemfile.
+
+```
+gem 'faye-websocket'
+```
+
+##### Celluloid
+
+Add the following to your Gemfile.
+
+```
+gem 'celluloid-io'
+```
+
+### Message Parsing
+
+All text in Slack uses the same [system of escaping](https://api.slack.com/docs/formatting): chat messages, direct messages, file comments, etc. Use [Slack::Messages::Formatting](lib/slack/messages/formatting.rb) to unescape incoming messages. This comes handy, for example, you want to treat all input to a real time bot as plain text.
+
+```ruby
+Slack::Messages::Formatting.unescape('Hello &amp; &lt;world&gt;'))
+  # => 'Hello & <world>'
+Slack::Messages::Formatting.unescape('Hey <@U024BE7LH|bob>, did you see my file?'))
+  # => 'Hey @bob, did you see my file?'
+Slack::Messages::Formatting.unescape('Hey <@U02BEFY4U>'))
+  # => 'Hey @U02BEFY4U'
+Slack::Messages::Formatting.unescape('This message contains a URL <http://foo.com/>'))
+  # => 'This message contains a URL http://foo.com/'
+Slack::Messages::Formatting.unescape('So does this one: <http://www.foo.com|www.foo.com>'))
+  # => 'So does this one: www.foo.com'
+Slack::Messages::Formatting.unescape('<mailto:bob@example.com|Bob>'))
+  # => 'Bob'
+Slack::Messages::Formatting.unescape('Hello <@U123|bob>, say hi to <!everyone> in <#C1234|general>'))
+  # => 'Hello @bob, say hi to @everyone in #general'
+Slack::Messages::Formatting.unescape('Hello <@U123|bob> &gt; file.txt'))
+  # => 'Hello @bob > file.txt'
+Slack::Messages::Formatting.unescape('“hello”'))
+  # => '"hello"'
+Slack::Messages::Formatting.unescape('‘hello’'))
+  # => "'hello'"
+```
+
+### Command-Line Client
+
+The slack command-line client returns JSON data from the Slack API.
+
+#### Authenticate with Slack
+
+```
+$ slack --slack-api-token=[token] auth test
+{"ok":true,"url":"...","team":"...","user":"...","team_id":"...","user_id":"..."}
+```
+
+#### Send a Message
+
+```
+export SLACK_API_TOKEN=...
+$ slack chat postMessage --text="hello world" --channel="#general"
+{"ok":true,"channel":"...","ts":"...","message":{"text":"hello world","username":"bot","type":"message","subtype":"bot_message","ts":"..."}}
+```
+
+#### Get Channel Id
+
+```
+$ slack channels id --channel=#general
+{"ok":true,"channel":{"id":"C04KB5X4D"}}
+```
+
+#### Get Channel Info
+
+```
+$ slack channels info --channel=#general
+{"ok":true,"channel":{"id":"C04KB5X4D","name":"general", ...}}
+```
+
+#### List Users
+
+Combine with [jq](http://stedolan.github.io/jq), a command-line JSON parser.
+
+```
+$ slack users list | jq '.members | map({(.id): .name})'
+[
+  {
+    "U04KB5WQR": "dblock"
+  },
+  {
+    "U07518DTL": "rubybot"
+  }
+]
+```
+
+See `slack help` for a complete command-line reference.
+
+## History
+
+This gem is based on [slack-ruby-gem](https://github.com/aki017/slack-ruby-gem), but it more clearly separates the Web and RTM APIs, is more thoroughly tested and is in active development.
+
+## Contributing
+
+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).
+
+This project is licensed under the [MIT License](LICENSE.md).