slack-ruby-client 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cc706e591e468957eef12d0ea962b1a8273f9ce
-  data.tar.gz: edfcbef27ea25566be7342d61d213cb6bc4c651e
+  metadata.gz: c27d0774e9e56d2188bf8e9aea953b86821a9156
+  data.tar.gz: d4ca8180bcc3d643e5dcc0b326975086831df51f
 SHA512:
-  metadata.gz: 3c768313646d77b02ff5284daa7b58f413e48b37c6c72dd33b3eb39645d19c54c863e67fb1beb6a31eb11ed6047c013ad19ec0959b6546d3de94378925071834
-  data.tar.gz: 8739d5a2f3824770e003b3f9d274391e278dfa19ca21592b9ce3908371807fb1add7252e19d8074302f5db264c8894163f77853d1269a732483374dd9c4262f6
+  metadata.gz: '0395ba1c14c66f1f3360c71a9bb294fd33ed88775de08c933e6cb7c23aa47485a864e151a3dd41354debd266cd9d9fa1ba80d0c5260afb5f62b60c46c1784a4c'
+  data.tar.gz: bbe81ee65b8358950dc946791bb72c8e8e3c84ce6ac52fe73a9a66c2f70073394153d604fce446b3eff3590b94ff87a4236a5d447522c8e0e10af4dd54daeddd

data/.rubocop_todo.yml

@@ -1,16 +1,15 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-05-03 16:35:06 -0400 using RuboCop version 0.35.0.
+# on 2017-04-30 12:02:22 -0400 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: 4
+# Offense count: 3
 Lint/HandleExceptions:
   Exclude:
     - 'lib/slack-ruby-client.rb'
-    - 'lib/slack/real_time/concurrency/celluloid.rb'
     - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
     - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
 
@@ -21,20 +20,20 @@ Lint/UnusedBlockArgument:
   Exclude:
     - 'lib/slack/messages/formatting.rb'
 
-# Offense count: 15
+# Offense count: 14
 Metrics/AbcSize:
   Max: 44
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 156
+  Max: 165
 
-# Offense count: 2
+# Offense count: 3
 Metrics/CyclomaticComplexity:
   Max: 9
 
-# Offense count: 595
+# Offense count: 720
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 288
@@ -48,7 +47,7 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Max: 11
 
-# Offense count: 55
+# Offense count: 59
 # Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false
@@ -59,12 +58,12 @@ Style/FileName:
   Exclude:
     - 'lib/slack-ruby-client.rb'
 
-# Offense count: 100
+# Offense count: 116
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false
 
-# Offense count: 17
+# Offense count: 21
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/MethodName:
   Enabled: false
@@ -76,6 +75,17 @@ Style/ModuleFunction:
     - 'lib/slack/real_time/config.rb'
     - 'lib/slack/web/config.rb'
 
+# Offense count: 1
+Style/MultilineTernaryOperator:
+  Exclude:
+    - 'spec/support/real_time/connected_client.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RescueModifier:
+  Exclude:
+    - 'lib/slack/real_time/concurrency/celluloid.rb'
+
 # Offense count: 2
 # Cop supports --auto-correct.
 Style/SpecialGlobalVars:

data/.travis.yml

@@ -2,22 +2,28 @@ language: ruby
 
 cache: bundler
 
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0
+  - rbx-2
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+
 matrix:
   include:
-    - rvm: 2.3.1
+    - rvm: 2.4.1
       script:
         - bundle exec danger
-    - rvm: 2.3.1
+    - rvm: 2.4.1
       env: CONCURRENCY=celluloid-io
-    - rvm: 2.3.1
+    - rvm: 2.4.1
+      env: CONCURRENCY=faye-websocket
+    - rvm: 2.3.4
+      env: CONCURRENCY=celluloid-io
+    - rvm: 2.3.4
       env: CONCURRENCY=faye-websocket
-    - rvm: 2.2
-    - rvm: 2.1
-    - rvm: 2.0
-    - rvm: rbx-2
-    - rvm: jruby-19mode
-    - rvm: ruby-head
-    - rvm: jruby-head
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.9.0 (8/6/2017)
+
+* [#146](https://github.com/slack-ruby/slack-ruby-client/issues/146): Fix: `undefined method running?` and `ThreadError: Target thread must not be current thread` with `Celluloid::IO` - [@dblock](https://github.com/dblock).
+* [#145](https://github.com/slack-ruby/slack-ruby-client/pull/145): Automatically select `rtm_connect` vs. `rtm_start` - [@dblock](https://github.com/dblock).
+* [#154](https://github.com/slack-ruby/slack-ruby-client/pull/154): Raise a dedicated error class with 429 responses - [@greggroth](https://github.com/greggroth).
+* [#154](https://github.com/slack-ruby/slack-ruby-client/pull/154): Namespace error classes under `Slack::Web::Api::Errors` module - [@greggroth](https://github.com/greggroth).
+
 ### 0.8.1 (4/28/2017)
 
 * Added `exclude_members` option to `channels_list` Web API - [@dblock](https://github.com/dblock).

data/README.md

@@ -18,7 +18,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messa
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 0.8.1. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.9.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -244,11 +244,11 @@ Tracking with a local store can be disabled with `Slack::RealTime::Client.new(st
 
 #### Slack::RealTime::Stores::Store
 
-The default store that tracks all changes.
+The default store that tracks all changes. By default the client will be connected using `rtm_start`.
 
 #### Slack::RealTime::Stores::Starter
 
-A smaller store that only stores and tracks information about the bot user, but not channels, users, groups, ims or bots.
+A smaller store that only stores and tracks information about the bot user, but not channels, users, groups, ims or bots. By default the client will be connected using `rtm_connect`.
 
 ### Configuring Slack::RealTime::Client
 
@@ -272,15 +272,26 @@ 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`.
 store_class     | Local store class name, default is an in-memory `Slack::RealTime::Stores::Store`.
-start_options   | Options to pass into `rtm.start`, default is `{ request: { timeout: 180 } }`.
+start_method    | Optional start method, either `:rtm_start` or `:rtm_connect`.
+start_options   | Options to pass into `rtm.start` or `rtm.connect`, default is `{ request: { timeout: 180 } }`.
 logger          | Optional `Logger` instance that logs RealTime requests and socket data.
 
-Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.start](https://api.slack.com/methods/rtm.start). While `token` and `logger` options are passed down from the RealTime client, you may also configure Web client options via `Slack::Web::Client.configure` as described above.
+Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.start](https://api.slack.com/methods/rtm.start) or [rtm.connect](https://api.slack.com/methods/rtm.connect). While `token` and `logger` options are passed down from the RealTime client, you may also configure Web client options via `Slack::Web::Client.configure` as described above.
 
 See a fully working example in [examples/hi_real_time](examples/hi_real_time/hi.rb).
 
 ![](examples/hi_real_time/hi.gif)
 
+### 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.
+
+```ruby
+Slack::RealTime::Client.config do |config|
+  config.start_method = :rtm_start
+end
+```
+
 ### 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.

data/UPGRADING.md

@@ -1,6 +1,22 @@
 Upgrading Slack-Ruby-Client
 ===========================
 
+### Upgrading to >= 0.9.0
+
+#### Changes in How the RTM Client Connects
+
+The RealTime client now automatically chooses 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 newer and preferred, while the latter is required to use the full `Slack::RealTime::Stores::Store` storage class.
+
+Prior versions always used `rtm.start`, to restore this behavior, configure `start_method`.
+
+```ruby
+Slack::RealTime::Client.config do |config|
+  config.start_method = :rtm_start
+end
+```
+
+See [#145](https://github.com/slack-ruby/slack-ruby-client/pull/145) for more information.
+
 ### Upgrading to >= 0.8.0
 
 The default timeout for `rtm.start` has been increased from 60 to 180 seconds via `Slack::RealTime::Client.config.start_options[:request][:timeout]`. If you're explicitly setting `start_options` in your application, preserve the value by merging settings instead of replacing the entire `start_options` value.

data/lib/slack-ruby-client.rb

@@ -18,6 +18,8 @@ rescue LoadError
   # ignore, only used in users_search
 end
 require_relative 'slack/web/config'
+require_relative 'slack/web/api/errors/slack_error'
+require_relative 'slack/web/api/errors/too_many_requests_error'
 require_relative 'slack/web/api/error'
 require_relative 'slack/web/faraday/response/raise_error'
 require_relative 'slack/web/faraday/connection'

data/lib/slack/real_time/client.rb

@@ -107,13 +107,23 @@ module Slack
       # @return [Slack::RealTime::Socket]
       def build_socket
         fail ClientAlreadyStartedError if started?
-        start = web_client.rtm_start(start_options)
+        start = web_client.send(rtm_start_method, start_options)
         data = Slack::Messages::Message.new(start)
         @url = data.url
         @store = @store_class.new(data) if @store_class
         socket_class.new(@url, socket_options)
       end
 
+      def rtm_start_method
+        if start_method
+          start_method
+        elsif @store_class == Slack::RealTime::Stores::Store
+          :rtm_start
+        else
+          :rtm_connect
+        end
+      end
+
       def socket_options
         socket_options = {}
         socket_options[:ping] = websocket_ping if websocket_ping

data/lib/slack/real_time/concurrency/celluloid.rb

@@ -38,7 +38,7 @@ module Slack
             logger.debug("#{self.class}##{__method__}") { e }
             driver.emit(:close, WebSocket::Driver::CloseEvent.new(1001, 'server closed connection')) unless @closing
           ensure
-            current_actor.terminate if current_actor.alive? && current_actor.running?
+            current_actor.terminate if current_actor.alive? rescue nil
           end
 
           def close
@@ -90,8 +90,8 @@ module Slack
           end
 
           def build_socket
-            socket = TCPSocket.new(addr, port)
-            socket = SSLSocket.new(socket, build_ssl_context) if secure?
+            socket = ::Celluloid::IO::TCPSocket.new(addr, port)
+            socket = ::Celluloid::IO::SSLSocket.new(socket, build_ssl_context) if secure?
             socket
           end
 

data/lib/slack/real_time/config.rb

@@ -10,6 +10,7 @@ module Slack
         :websocket_ping,
         :websocket_proxy,
         :concurrency,
+        :start_method,
         :start_options,
         :store_class,
         :logger
@@ -22,6 +23,7 @@ module Slack
         self.websocket_proxy = nil
         self.token = nil
         self.concurrency = method(:detect_concurrency)
+        self.start_method = nil
         self.start_options = { request: { timeout: 180 } }
         self.store_class = Slack::RealTime::Store
         self.logger = nil

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.8.1'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/lib/slack/web/api/error.rb

@@ -1,14 +1,7 @@
 module Slack
   module Web
     module Api
-      class Error < ::Faraday::Error
-        attr_reader :response
-
-        def initialize(message, response = nil)
-          @response = response
-          super message
-        end
-      end
+      Error = Errors::SlackError
     end
   end
 end

data/lib/slack/web/api/errors/slack_error.rb

@@ -0,0 +1,16 @@
+module Slack
+  module Web
+    module Api
+      module Errors
+        class SlackError < ::Faraday::Error
+          attr_reader :response
+
+          def initialize(message, response = nil)
+            @response = response
+            super message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/errors/too_many_requests_error.rb

@@ -0,0 +1,23 @@
+module Slack
+  module Web
+    module Api
+      module Errors
+        class TooManyRequestsError < ::Faraday::Error
+          attr_reader :response
+
+          def initialize(response)
+            @response = response
+          end
+
+          def message
+            "Retry after #{retry_after} seconds"
+          end
+
+          def retry_after
+            response.headers['retry-after'].to_i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/mixins/ids.id.rb

@@ -14,7 +14,7 @@ module Slack
               end
             end
 
-            fail Slack::Web::Api::Error, not_found_error
+            fail Slack::Web::Api::Errors::SlackError, not_found_error
           end
         end
       end

data/lib/slack/web/faraday/connection.rb

@@ -21,10 +21,10 @@ module Slack
           ::Faraday::Connection.new(endpoint, options) do |connection|
             connection.use ::Faraday::Request::Multipart
             connection.use ::Faraday::Request::UrlEncoded
+            connection.use ::Faraday::Response::RaiseError
             connection.use ::Slack::Web::Faraday::Response::RaiseError
             connection.use ::FaradayMiddleware::Mashify, mash_class: Slack::Messages::Message
             connection.use ::FaradayMiddleware::ParseJson
-            connection.use ::Faraday::Response::RaiseError
             connection.response :logger, logger if logger
             connection.adapter ::Faraday.default_adapter
           end

data/lib/slack/web/faraday/response/raise_error.rb

@@ -4,9 +4,13 @@ module Slack
       module Response
         class RaiseError < ::Faraday::Response::Middleware
           def on_complete(env)
-            body = env.body
-            return if body['ok']
-            fail Slack::Web::Api::Error.new(body['error'], env.response)
+            if env.status == 429
+              fail Slack::Web::Api::Errors::TooManyRequestsError, env.response
+            elsif (body = env.body) && body['ok']
+              return
+            else
+              fail Slack::Web::Api::Errors::SlackError.new(body['error'], env.response)
+            end
           end
         end
       end

data/spec/fixtures/slack/web/429_error.yml

@@ -22,6 +22,8 @@ http_interactions:
     headers:
       Access-Control-Allow-Origin:
       - '*'
+      Retry-After:
+      - 3600
       Date:
       - Sat, 25 Jul 2015 14:42:07 GMT
       Server:

data/spec/fixtures/slack/web/rtm_connect.yml

@@ -0,0 +1,70 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://slack.com/api/rtm.connect
+    body:
+      encoding: UTF-8
+      string: token=token
+    headers:
+      Accept:
+      - application/json; charset=utf-8
+      User-Agent:
+      - Slack Ruby Client/0.8.2
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '303'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - private, no-cache, no-store, must-revalidate
+      Date:
+      - Fri, 28 Apr 2017 21:28:13 GMT
+      Expires:
+      - Mon, 26 Jul 1997 05:00:00 GMT
+      Pragma:
+      - no-cache
+      Referrer-Policy:
+      - no-referrer
+      Server:
+      - Apache
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      Vary:
+      - Accept-Encoding
+      X-Accepted-Oauth-Scopes:
+      - rtm:stream,client
+      X-Content-Type-Options:
+      - nosniff
+      X-Oauth-Scopes:
+      - identify,read,post,client,apps
+      X-Slack-Backend:
+      - h
+      X-Slack-Req-Id:
+      - 5126a5af-f201-4e61-8615-85ed74719049
+      X-Xss-Protection:
+      - '0'
+      X-Cache:
+      - Miss from cloudfront
+      Via:
+      - 1.1 bcaa616eaffeeb31e6c9015320755821.cloudfront.net (CloudFront)
+      X-Amz-Cf-Id:
+      - Hogs0uicEVP-FBGmgEZfEJz0EJHJwCny92KhIHz2j6YNYAJL0oVTJw==
+    body:
+      encoding: ASCII-8BIT
+      string: '{"ok":true,"url":"wss:\/\/mpmulti-w5tz.slack-msgs.com\/websocket\/uid","team":{"id":"T04KB5WQH","name":"dblock","domain":"dblockdotorg"},"self":{"id":"U07518DTL","name":"testbot"}}'
+    http_version:
+  recorded_at: Fri, 28 Apr 2017 21:28:14 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/slack/web/rtm_start.yml

@@ -101,4 +101,4 @@ http_interactions:
         Explorer","icons":{"image_36":"https:\/\/s3-us-west-2.amazonaws.com\/slack-files2\/avatars\/2016-01-21\/19073538231_edf8d896148b6bfef790_36.png","image_48":"https:\/\/s3-us-west-2.amazonaws.com\/slack-files2\/avatars\/2016-01-21\/19073538231_edf8d896148b6bfef790_48.png","image_72":"https:\/\/s3-us-west-2.amazonaws.com\/slack-files2\/avatars\/2016-01-21\/19073538231_edf8d896148b6bfef790_72.png"}}],"url":"wss:\/\/ms173.slack-msgs.com\/websocket\/lqcUiAvrKTP-uuid="}'
     http_version:
   recorded_at: Sun, 31 Jan 2016 22:42:57 GMT
-recorded_with: VCR 3.0.0
+recorded_with: VCR 3.0.3

data/spec/slack/real_time/client_spec.rb

@@ -1,8 +1,7 @@
 require 'spec_helper'
 
-RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' } do
+RSpec.describe Slack::RealTime::Client do
   let(:ws) { double(Slack::RealTime::Concurrency::Mock::WebSocket, on: true) }
-  let(:url) { 'wss://ms173.slack-msgs.com/websocket/lqcUiAvrKTP-uuid=' }
   before do
     @token = ENV.delete('SLACK_API_TOKEN')
     Slack::Config.reset
@@ -43,110 +42,182 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
       end
     end
   end
-  context 'client' do
-    context 'started' do
-      let(:client) { Slack::RealTime::Client.new(store_class: Slack::RealTime::Stores::Store) }
-      describe '#start!' do
-        let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
-        before do
-          allow(Slack::RealTime::Socket).to receive(:new).with(url, ping: 30, logger: Slack::Logger.default).and_return(socket)
-          allow(socket).to receive(:connect!)
-          allow(socket).to receive(:start_sync)
-          client.start!
+  context 'client with a full store', vcr: { cassette_name: 'web/rtm_start' } do
+    let(:client) { Slack::RealTime::Client.new(store_class: Slack::RealTime::Stores::Store) }
+    let(:url) { 'wss://ms173.slack-msgs.com/websocket/lqcUiAvrKTP-uuid=' }
+    describe '#start!' do
+      let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+      before do
+        allow(Slack::RealTime::Socket).to receive(:new).with(url, ping: 30, logger: Slack::Logger.default).and_return(socket)
+        allow(socket).to receive(:connect!)
+        allow(socket).to receive(:start_sync)
+        client.start!
+      end
+      context 'properties provided upon connection' do
+        it 'sets url' do
+          expect(client.url).to eq url
         end
-        context 'properties provided upon connection' do
-          it 'sets url' do
-            expect(client.url).to eq url
-          end
-          it 'sets team' do
-            expect(client.team.domain).to eq 'dblockdotorg'
-          end
-          it 'sets teams' do
-            expect(client.teams.count).to eq 1
-            expect(client.teams.values.first).to eq client.team
-          end
-          it 'sets self' do
-            expect(client.self.id).to eq 'U07518DTL'
-          end
-          it 'sets users' do
-            expect(client.users.count).to eq 18
-            expect(client.users.values.first['id']).to eq 'U07518DTL'
-          end
-          it 'sets channels' do
-            expect(client.channels.count).to eq 37
-            expect(client.channels.values.first['name']).to eq 'a1'
-          end
-          it 'sets ims' do
-            expect(client.ims.count).to eq 2
-            expect(client.ims.values.first['user']).to eq 'USLACKBOT'
-          end
-          it 'sets bots' do
-            expect(client.bots.count).to eq 16
-            expect(client.bots.values.first['name']).to eq 'bot'
-          end
-          it 'sets groups' do
-            expect(client.groups.count).to eq 1
-          end
+        it 'sets team' do
+          expect(client.team.domain).to eq 'dblockdotorg'
+        end
+        it 'sets teams' do
+          expect(client.teams.count).to eq 1
+          expect(client.teams.values.first).to eq client.team
+        end
+        it 'sets self' do
+          expect(client.self.id).to eq 'U07518DTL'
+        end
+        it 'sets users' do
+          expect(client.users.count).to eq 18
+          expect(client.users.values.first['id']).to eq 'U07518DTL'
+        end
+        it 'sets channels' do
+          expect(client.channels.count).to eq 37
+          expect(client.channels.values.first['name']).to eq 'a1'
+        end
+        it 'sets ims' do
+          expect(client.ims.count).to eq 2
+          expect(client.ims.values.first['user']).to eq 'USLACKBOT'
         end
-        it 'uses web client to fetch url' do
-          expect(client.web_client).to be_a Slack::Web::Client
+        it 'sets bots' do
+          expect(client.bots.count).to eq 16
+          expect(client.bots.values.first['name']).to eq 'bot'
         end
-        it 'remembers socket' do
-          expect(client.instance_variable_get('@socket')).to eq socket
+        it 'sets groups' do
+          expect(client.groups.count).to eq 1
+        end
+      end
+      it 'uses web client to fetch url' do
+        expect(client.web_client).to be_a Slack::Web::Client
+      end
+      it 'remembers socket' do
+        expect(client.instance_variable_get('@socket')).to eq socket
+      end
+      it 'cannot be invoked twice' do
+        expect do
+          client.start!
+        end.to raise_error Slack::RealTime::Client::ClientAlreadyStartedError
+      end
+      describe '#stop!' do
+        before do
+          expect(socket).to receive(:disconnect!)
+          client.stop!
         end
         it 'cannot be invoked twice' do
+          client.instance_variable_set('@socket', nil) # caused by a :close callback
           expect do
-            client.start!
-          end.to raise_error Slack::RealTime::Client::ClientAlreadyStartedError
+            client.stop!
+          end.to raise_error Slack::RealTime::Client::ClientNotStartedError
         end
-        describe '#stop!' do
-          before do
-            expect(socket).to receive(:disconnect!)
+      end
+      describe '#next_id' do
+        it 'increments' do
+          previous_id = client.send(:next_id)
+          expect(client.send(:next_id)).to eq previous_id + 1
+        end
+      end
+      context 'subclassed' do
+        let(:client) { Class.new(Slack::RealTime::Client).new(store_class: Slack::RealTime::Stores::Store) }
+        it 'runs event handlers' do
+          event = Slack::RealTime::Event.new(
+            'type' => 'team_rename',
+            'name' => 'New Team Name Inc.'
+          )
+          client.send(:dispatch, event)
+          expect(client.store.team.name).to eq 'New Team Name Inc.'
+        end
+      end
+    end
+  end
+  context 'client with a default store', vcr: { cassette_name: 'web/rtm_connect' } do
+    let(:client) { Slack::RealTime::Client.new }
+    let(:url) { 'wss://mpmulti-w5tz.slack-msgs.com/websocket/uid' }
+    describe '#start!' do
+      let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+      before do
+        allow(Slack::RealTime::Socket).to receive(:new).with(url, ping: 30, logger: Slack::Logger.default).and_return(socket)
+        allow(socket).to receive(:connect!)
+        allow(socket).to receive(:start_sync)
+        client.start!
+      end
+      context 'properties provided upon connection' do
+        it 'sets url' do
+          expect(client.url).to eq url
+        end
+        it 'sets team' do
+          expect(client.team.domain).to eq 'dblockdotorg'
+        end
+        it 'sets teams' do
+          expect(client.teams.count).to eq 1
+          expect(client.teams.values.first).to eq client.team
+        end
+        it 'sets self' do
+          expect(client.self.id).to eq 'U07518DTL'
+        end
+        it 'sets user' do
+          expect(client.users.count).to eq 1
+          expect(client.users.values.first['id']).to eq 'U07518DTL'
+        end
+        it 'no channels' do
+          expect(client.channels.count).to eq 0
+        end
+        it 'no ims' do
+          expect(client.ims.count).to eq 0
+        end
+        it 'no bots' do
+          expect(client.bots.count).to eq 0
+        end
+        it 'no groups' do
+          expect(client.groups.count).to eq 0
+        end
+      end
+      it 'uses web client to fetch url' do
+        expect(client.web_client).to be_a Slack::Web::Client
+      end
+      it 'remembers socket' do
+        expect(client.instance_variable_get('@socket')).to eq socket
+      end
+      it 'cannot be invoked twice' do
+        expect do
+          client.start!
+        end.to raise_error Slack::RealTime::Client::ClientAlreadyStartedError
+      end
+      describe '#stop!' do
+        before do
+          expect(socket).to receive(:disconnect!)
+          client.stop!
+        end
+        it 'cannot be invoked twice' do
+          client.instance_variable_set('@socket', nil) # caused by a :close callback
+          expect do
             client.stop!
-          end
-          it 'cannot be invoked twice' do
-            client.instance_variable_set('@socket', nil) # caused by a :close callback
-            expect do
-              client.stop!
-            end.to raise_error Slack::RealTime::Client::ClientNotStartedError
-          end
+          end.to raise_error Slack::RealTime::Client::ClientNotStartedError
         end
-        describe '#next_id' do
-          it 'increments' do
-            previous_id = client.send(:next_id)
-            expect(client.send(:next_id)).to eq previous_id + 1
-          end
+      end
+      describe '#next_id' do
+        it 'increments' do
+          previous_id = client.send(:next_id)
+          expect(client.send(:next_id)).to eq previous_id + 1
         end
-        context 'store_class: nil' do
-          let(:client) { Slack::RealTime::Client.new(store_class: nil) }
-          it 'sets store to nil' do
-            expect(client.store).to be nil
-          end
-          it "doesn't handle events" do
-            event = Slack::RealTime::Event.new(
-              'type' => 'team_rename',
-              'name' => 'New Team Name Inc.'
-            )
-            expect(client).to_not receive(:run_handlers)
-            client.send(:dispatch, event)
-          end
-          it 'self' do
-            expect(client.self).to be nil
-          end
-          it 'team' do
-            expect(client.team).to be nil
-          end
+      end
+      context 'store_class: nil' do
+        let(:client) { Slack::RealTime::Client.new(store_class: nil) }
+        it 'sets store to nil' do
+          expect(client.store).to be nil
         end
-        context 'subclassed' do
-          let(:client) { Class.new(Slack::RealTime::Client).new(store_class: Slack::RealTime::Stores::Store) }
-          it 'runs event handlers' do
-            event = Slack::RealTime::Event.new(
-              'type' => 'team_rename',
-              'name' => 'New Team Name Inc.'
-            )
-            client.send(:dispatch, event)
-            expect(client.store.team.name).to eq 'New Team Name Inc.'
-          end
+        it "doesn't handle events" do
+          event = Slack::RealTime::Event.new(
+            'type' => 'team_rename',
+            'name' => 'New Team Name Inc.'
+          )
+          expect(client).to_not receive(:run_handlers)
+          client.send(:dispatch, event)
+        end
+        it 'self' do
+          expect(client.self).to be nil
+        end
+        it 'team' do
+          expect(client.team).to be nil
         end
       end
     end
@@ -190,6 +261,7 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
     after do
       Slack::RealTime::Client.config.reset
     end
+    let(:url) { 'wss://mpmulti-w5tz.slack-msgs.com/websocket/uid' }
     let(:client) { Slack::RealTime::Client.new }
     context 'ping' do
       before do
@@ -201,7 +273,7 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
         it 'sets ping' do
           expect(client.websocket_ping).to eq 15
         end
-        it 'creates a connection with custom ping' do
+        it 'creates a connection with custom ping', vcr: { cassette_name: 'web/rtm_connect' } do
           expect(Slack::RealTime::Concurrency::Mock::WebSocket).to receive(:new).with(url, nil, ping: 15).and_return(ws)
           client.start!
         end
@@ -226,7 +298,7 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
             headers: { 'User-Agent' => 'ruby' }
           )
         end
-        it 'creates a connection with custom proxy' do
+        it 'creates a connection with custom proxy', vcr: { cassette_name: 'web/rtm_connect' } do
           expect(Slack::RealTime::Concurrency::Mock::WebSocket).to receive(:new).with(
             url,
             nil,
@@ -256,26 +328,85 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
             allow(socket).to receive(:connect!)
             allow(socket).to receive(:start_sync)
           end
-          it 'calls rtm_start with start options' do
-            expect(client.web_client).to receive(:rtm_start).with(simple_latest: true).and_call_original
+          it 'calls rtm_start with start options', vcr: { cassette_name: 'web/rtm_connect' } do
+            expect(client.web_client).to receive(:rtm_connect).with(simple_latest: true).and_call_original
             client.start!
           end
         end
       end
     end
     context 'store_class' do
-      before do
-        Slack::RealTime::Client.configure do |config|
-          config.store_class = Slack::RealTime::Stores::Starter
+      context 'starter' do
+        before do
+          Slack::RealTime::Client.configure do |config|
+            config.store_class = Slack::RealTime::Stores::Starter
+          end
+        end
+        describe '#initialize' do
+          it 'can be overriden explicitly' do
+            client = Slack::RealTime::Client.new(store_class: Slack::RealTime::Store)
+            expect(client.send(:store_class)).to eq Slack::RealTime::Store
+          end
+          it 'sets store_class' do
+            expect(client.send(:store_class)).to eq(Slack::RealTime::Stores::Starter)
+          end
+          context 'start!' do
+            let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+            before do
+              allow(Slack::RealTime::Socket).to receive(:new).and_return(socket)
+              allow(socket).to receive(:connect!)
+              allow(socket).to receive(:start_sync)
+            end
+            it 'instantiates the correct store class', vcr: { cassette_name: 'web/rtm_connect' } do
+              client.start!
+              expect(client.store).to be_a Slack::RealTime::Stores::Starter
+            end
+          end
         end
       end
+      context 'store' do
+        before do
+          Slack::RealTime::Client.configure do |config|
+            config.store_class = Slack::RealTime::Stores::Store
+          end
+        end
+        describe '#initialize' do
+          context 'start!' do
+            let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
+            before do
+              allow(Slack::RealTime::Socket).to receive(:new).and_return(socket)
+              allow(socket).to receive(:connect!)
+              allow(socket).to receive(:start_sync)
+            end
+            it 'calls rtm_start and not rtm_connect', vcr: { cassette_name: 'web/rtm_start' } do
+              expect(client.web_client).to receive(:rtm_start).and_call_original
+              client.start!
+            end
+          end
+        end
+      end
+    end
+    context 'start_method' do
       describe '#initialize' do
         it 'can be overriden explicitly' do
-          client = Slack::RealTime::Client.new(store_class: Slack::RealTime::Store)
-          expect(client.send(:store_class)).to eq Slack::RealTime::Store
+          client = Slack::RealTime::Client.new(start_method: :overriden)
+          expect(client.send(:start_method)).to eq :overriden
         end
-        it 'sets store_class' do
-          expect(client.send(:store_class)).to eq(Slack::RealTime::Stores::Starter)
+        context 'with start_method' do
+          before do
+            Slack::RealTime::Client.configure do |config|
+              config.start_method = :overriden
+            end
+          end
+          it 'sets start_method' do
+            expect(client.send(:start_method)).to eq :overriden
+          end
+          it 'calls the overriden method' do
+            expect(client.web_client).to receive(:overriden).and_raise('overriden')
+            expect do
+              client.start!
+            end.to raise_error RuntimeError, 'overriden'
+          end
         end
         context 'start!' do
           let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
@@ -284,9 +415,9 @@ RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_start' }
             allow(socket).to receive(:connect!)
             allow(socket).to receive(:start_sync)
           end
-          it 'instantiates the correct store class' do
+          it 'defaults to :rtm_connect', vcr: { cassette_name: 'web/rtm_connect' } do
+            expect(client.web_client).to receive(:rtm_connect).and_call_original
             client.start!
-            expect(client.store).to be_a Slack::RealTime::Stores::Starter
           end
         end
       end

data/spec/slack/real_time/concurrency/celluloid_spec.rb

@@ -7,20 +7,41 @@ begin
     context 'with url' do
       let(:url) { 'wss://echo.websocket.org/websocket/xyz' }
       let(:logger) { ::Logger.new(STDOUT) }
-      subject(:socket) { described_class.new(url, ping: 42, logger: logger) }
+      let(:test_socket) do
+        Class.new(described_class) do
+          def read
+            fail EOFError
+          end
+        end
+      end
+      let(:socket) { test_socket.new(url, ping: 42, logger: logger) }
       let(:driver) { WebSocket::Driver::Client }
       let(:ws) { double(driver) }
+      subject { socket }
 
       describe '#connect!' do
         pending 'connects'
         pending 'pings every 30s'
       end
 
-      describe '#disconnect!' do
-        it 'closes and nils the websocket' do
+      context 'with a driver' do
+        before do
           socket.instance_variable_set('@driver', ws)
-          expect(ws).to receive(:close)
-          socket.disconnect!
+        end
+
+        describe '#disconnect!' do
+          it 'closes and nils the websocket' do
+            expect(ws).to receive(:close)
+            socket.disconnect!
+          end
+        end
+
+        describe '#run_loop' do
+          it 'runs' do
+            expect(ws).to receive(:emit)
+            expect(ws).to receive(:start)
+            socket.run_loop
+          end
         end
       end
 

data/spec/slack/real_time/event_handlers/team_spec.rb

@@ -1,16 +1,18 @@
 require 'spec_helper'
 
 [Slack::RealTime::Stores::Store, Slack::RealTime::Stores::Starter].each do |store_class|
-  RSpec.describe store_class, vcr: { cassette_name: 'web/rtm_start' } do
+  RSpec.describe store_class, vcr: { cassette_name: store_class == Slack::RealTime::Stores::Store ? 'web/rtm_start' : 'web/rtm_connect' } do
     include_context 'connected client', store_class: store_class
 
     context 'team' do
       it 'sets team data on rtm.start' do
         expect(client.team.name).to eq 'dblock'
         expect(client.team.domain).to eq 'dblockdotorg'
-        expect(client.team.email_domain).to eq 'dblock.org'
-        expect(client.team.prefs.invites_only_admins).to be true
-        expect(client.team.plan).to eq ''
+        if store_class == Slack::RealTime::Stores::Store
+          expect(client.team.email_domain).to eq 'dblock.org'
+          expect(client.team.prefs.invites_only_admins).to be true
+          expect(client.team.plan).to eq ''
+        end
       end
       it 'team_domain_change' do
         event = Slack::RealTime::Event.new(

data/spec/slack/real_time/rtm_connect_spec.rb

@@ -0,0 +1,13 @@
+# require 'spec_helper'
+
+#
+# to re-record a rtm_connect fixture run with
+# SLACK_API_TOKEN=... CONCURRENCY=faye-websocket rspec spec/slack/real_time/rtm_connect_spec.rb
+# edit rtm_connect.yml and remove the token, fix wss:// path (run specs, fix failures)
+#
+
+# RSpec.describe Slack::RealTime::Client, vcr: { cassette_name: 'web/rtm_connect' } do
+#   it 'connects' do
+#     Slack::Web::Client.new.rtm_connect(mpim_aware: true)
+#   end
+# end

data/spec/slack/web/api/endpoints/custom_specs/auth_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Slack::Web::Api::Endpoints::Auth do
   let(:client) { Slack::Web::Client.new }
   context 'without auth', vcr: { cassette_name: 'web/auth_test_error' } do
     it 'fails with an exception' do
-      expect { client.auth_test }.to raise_error Slack::Web::Api::Error, 'not_authed'
+      expect { client.auth_test }.to raise_error Slack::Web::Api::Errors::SlackError, 'not_authed'
     end
   end
   context 'with auth', vcr: { cassette_name: 'web/auth_test_success' } do
@@ -13,8 +13,13 @@ RSpec.describe Slack::Web::Api::Endpoints::Auth do
     end
   end
   context '429 error', vcr: { cassette_name: 'web/429_error' } do
-    it 'fails with an exception' do
-      expect { client.auth_test }.to raise_error Faraday::ClientError
+    it 'fails with an specific exception' do
+      begin
+        client.auth_test
+      rescue Slack::Web::Api::Errors::TooManyRequestsError => e
+        expect(e.message).to eq('Retry after 3600 seconds')
+        expect(e.retry_after).to eq(3600)
+      end
     end
   end
 end

data/spec/slack/web/api/errors/slack_error_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+RSpec.describe Slack::Web::Api::Errors::SlackError do
+  let(:client) { Slack::Web::Client.new }
+  it 'provides access to the response object', vcr: { cassette_name: 'web/auth_test_error' } do
+    begin
+      client.auth_test
+      fail 'Expected to receive Slack::Web::Api::Errors::SlackError.'
+    rescue Slack::Web::Api::Errors::SlackError => e
+      expect(e.response).to_not be_nil
+      expect(e.response.status).to eq 200
+    end
+  end
+end

data/spec/slack/web/api/mixins/channels_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe Slack::Web::Api::Mixins::Channels do
       expect(subject.channels_id(channel: '#general')).to eq('ok' => true, 'channel' => { 'id' => 'CDEADBEEF' })
     end
     it 'fails with an exception' do
-      expect { subject.channels_id(channel: '#invalid') }.to raise_error Slack::Web::Api::Error, 'channel_not_found'
+      expect { subject.channels_id(channel: '#invalid') }.to raise_error Slack::Web::Api::Errors::SlackError, 'channel_not_found'
     end
   end
 end

data/spec/slack/web/api/mixins/groups_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe Slack::Web::Api::Mixins::Groups do
       expect(subject.groups_id(channel: '#general')).to eq('ok' => true, 'group' => { 'id' => 'CDEADBEEF' })
     end
     it 'fails with an exception' do
-      expect { subject.groups_id(channel: '#invalid') }.to raise_error Slack::Web::Api::Error, 'channel_not_found'
+      expect { subject.groups_id(channel: '#invalid') }.to raise_error Slack::Web::Api::Errors::SlackError, 'channel_not_found'
     end
   end
 end

data/spec/slack/web/api/mixins/users_spec.rb

@@ -26,7 +26,7 @@ RSpec.describe Slack::Web::Api::Mixins::Users do
       expect(subject.users_id(user: '@aws')).to eq('ok' => true, 'user' => { 'id' => 'UDEADBEEF' })
     end
     it 'fails with an exception' do
-      expect { subject.users_id(user: '@foo') }.to raise_error Slack::Web::Api::Error, 'user_not_found'
+      expect { subject.users_id(user: '@foo') }.to raise_error Slack::Web::Api::Errors::SlackError, 'user_not_found'
     end
   end
   context '#users_search' do

data/spec/support/real_time/connected_client.rb

@@ -1,11 +1,16 @@
 RSpec.shared_context 'connected client' do |opts|
   let(:client) { Slack::RealTime::Client.new(opts || {}) }
   let(:ws) { double(Slack::RealTime::Concurrency::Mock::WebSocket) }
-  let(:url) { 'wss://ms173.slack-msgs.com/websocket/lqcUiAvrKTP-uuid=' }
+  let(:url) do
+    Slack::RealTime.config.store_class == Slack::RealTime::Stores::Store ?
+      'wss://ms173.slack-msgs.com/websocket/lqcUiAvrKTP-uuid=' :
+      'wss://mpmulti-w5tz.slack-msgs.com/websocket/uid'
+  end
   let(:socket) { double(Slack::RealTime::Socket, connected?: true) }
   before do
     Slack::RealTime.configure do |config|
       config.concurrency = Slack::RealTime::Concurrency::Mock
+      config.store_class = (opts || {})[:store_class] || Slack::RealTime::Stores::Store
     end
     allow(Slack::RealTime::Socket).to receive(:new).with(url, ping: 30, logger: Slack::Logger.default).and_return(socket)
     allow(socket).to receive(:start_sync)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -331,6 +331,8 @@ files:
 - lib/slack/web/api/endpoints/users.rb
 - lib/slack/web/api/endpoints/users_profile.rb
 - lib/slack/web/api/error.rb
+- lib/slack/web/api/errors/slack_error.rb
+- lib/slack/web/api/errors/too_many_requests_error.rb
 - lib/slack/web/api/mixins.rb
 - lib/slack/web/api/mixins/channels.id.json
 - lib/slack/web/api/mixins/channels.id.rb
@@ -369,6 +371,7 @@ files:
 - spec/fixtures/slack/web/auth_test_success.yml
 - spec/fixtures/slack/web/channels_info.yml
 - spec/fixtures/slack/web/groups_info.yml
+- spec/fixtures/slack/web/rtm_connect.yml
 - spec/fixtures/slack/web/rtm_start.yml
 - spec/fixtures/slack/web/users_info.yml
 - spec/fixtures/slack/web/users_list.yml
@@ -389,6 +392,7 @@ files:
 - spec/slack/real_time/event_handlers/im_spec.rb
 - spec/slack/real_time/event_handlers/team_spec.rb
 - spec/slack/real_time/event_handlers/user_spec.rb
+- spec/slack/real_time/rtm_connect_spec.rb
 - spec/slack/real_time/rtm_start_spec.rb
 - spec/slack/real_time/store_spec.rb
 - spec/slack/slack_spec.rb
@@ -419,6 +423,7 @@ files:
 - spec/slack/web/api/endpoints/usergroups_users_spec.rb
 - spec/slack/web/api/endpoints/users_profile_spec.rb
 - spec/slack/web/api/error_spec.rb
+- spec/slack/web/api/errors/slack_error_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
@@ -450,7 +455,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Slack Web and RealTime API client.
@@ -460,6 +465,7 @@ test_files:
 - spec/fixtures/slack/web/auth_test_success.yml
 - spec/fixtures/slack/web/channels_info.yml
 - spec/fixtures/slack/web/groups_info.yml
+- spec/fixtures/slack/web/rtm_connect.yml
 - spec/fixtures/slack/web/rtm_start.yml
 - spec/fixtures/slack/web/users_info.yml
 - spec/fixtures/slack/web/users_list.yml
@@ -480,6 +486,7 @@ test_files:
 - spec/slack/real_time/event_handlers/im_spec.rb
 - spec/slack/real_time/event_handlers/team_spec.rb
 - spec/slack/real_time/event_handlers/user_spec.rb
+- spec/slack/real_time/rtm_connect_spec.rb
 - spec/slack/real_time/rtm_start_spec.rb
 - spec/slack/real_time/store_spec.rb
 - spec/slack/slack_spec.rb
@@ -510,6 +517,7 @@ test_files:
 - spec/slack/web/api/endpoints/usergroups_users_spec.rb
 - spec/slack/web/api/endpoints/users_profile_spec.rb
 - spec/slack/web/api/error_spec.rb
+- spec/slack/web/api/errors/slack_error_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