ably 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f26db73bc52944f7e282d9946c31d3c3cca0c12e922a6fdf12fbf017c825c850
-  data.tar.gz: dddf1e3c6fc8bfec7290d75f7da54bdf4c1d126f3a9c2b55a07addfad55f8de7
+  metadata.gz: 16e7e84ef48f6781cea03494b8b603b6e59cf98583ad1200f0421dab0bc0252d
+  data.tar.gz: 39dc6cd4bba9d31f8bd7f94f31c75b97adce21bf1fe07bbf0b3701a0f7075a59
 SHA512:
-  metadata.gz: e9db81f7b4f556708cd4e8e23538266c211b28b726081dba5a4e7022f108f0235bb37b10ab393208266c3aa44eceb1fc599c3cfaef62e85052d5a3371e7ff91b
-  data.tar.gz: c17bf2a1c5db04329d04684ffe39cbdc339e29f5e88fc3059d2b0f70549d07cdd5262d891c146f28fce47969fad9612c6dc70f3203a48ef57f847fbf7cb6e145
+  metadata.gz: 919eaa8f22a8178997e3505b449e03d93824196803aae58ceee9a55220e2199b4a911edad93a1563e225a167c79ec336c18983a4d0bbbd6d9626657b3acf98a9
+  data.tar.gz: 44ff62c2c39e022133039f7e04a52d839fb3d50abf344cd3da3ba1ec8890f51c4e532813a2ea138e78556027a133477d60d01bf839e37ca9183b126a007cff82

data/.github/workflows/check.yml

@@ -32,8 +32,9 @@ jobs:
         run: |
           mkdir junit
           bundle exec parallel_rspec --prefix-output-with-test-env-number --first-is-1 -- spec/${{ matrix.type }}
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
+          name: test-results-ruby-${{ matrix.ruby }}-${{ matrix.protocol }}-${{ matrix.type }}
           path: |
             junit/
             coverage/
@@ -45,7 +46,7 @@ jobs:
           server-url: 'https://test-observability.herokuapp.com'
           server-auth: ${{ secrets.TEST_OBSERVABILITY_SERVER_AUTH_KEY }}
           path: 'junit/'
-      - uses: coverallsapp/github-action@1.1.3
+      - uses: coverallsapp/github-action@v2
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           flag-name: ruby-${{ matrix.ruby }}-${{ matrix.protocol }}-${{ matrix.type }}
@@ -55,7 +56,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Coveralls Finished
-        uses: coverallsapp/github-action@1.1.3
+        uses: coverallsapp/github-action@v2
         with:
           github-token: ${{ secrets.github_token }}
           parallel-finished: true

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## [v1.2.8](https://github.com/ably/ably-ruby/tree/v1.2.8)
+
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v1.2.7...v1.2.8)
+
+**Fixed bugs:**
+
+* Fix incompatibility with `websocket-driver` 0.8 (#443)
+* Do not use fallback hosts as a result of a token error (#443)
+
+**Updated dependencies:**
+
+* Bump `faraday-typhoeus` to 1.1.0 (#442)
+
 ## [v1.2.7](https://github.com/ably/ably-ruby/tree/v1.2.7)
 
 [Full Changelog](https://github.com/ably/ably-ruby/compare/v1.2.6...v1.2.7)

data/SPEC.md

@@ -1,4 +1,4 @@
-# Ably Realtime & REST Client Library 1.2.7 Specification
+# Ably Realtime & REST Client Library 1.2.8 Specification
 
 ### Ably::Realtime::Auth
 _(see [spec/acceptance/realtime/auth_spec.rb](./spec/acceptance/realtime/auth_spec.rb))_
@@ -646,7 +646,7 @@ _(see [spec/acceptance/realtime/connection_failures_spec.rb](./spec/acceptance/r
     * authentication failure
       * when API key is invalid
         * with invalid app part of the key
-          * [enters the failed state and returns a not found error](./spec/acceptance/realtime/connection_failures_spec.rb#L29)
+          * [enters the failed state and returns an invalid credentials error](./spec/acceptance/realtime/connection_failures_spec.rb#L29)
         * with invalid key name part of the key
           * [enters the failed state and returns an authorization error](./spec/acceptance/realtime/connection_failures_spec.rb#L44)
       * with auth_url
@@ -2323,16 +2323,16 @@ _(see [spec/acceptance/rest/base_spec.rb](./spec/acceptance/rest/base_spec.rb))_
   * using JSON protocol
     * failed requests
       * due to invalid Auth
-        * [should raise an InvalidRequest exception with a valid error message and code](./spec/acceptance/rest/base_spec.rb#L75)
+        * [should raise an UnauthorizedRequest exception with a valid error message and code](./spec/acceptance/rest/base_spec.rb#L75)
       * server error with JSON error response body
-        * [should raise a ServerError exception](./spec/acceptance/rest/base_spec.rb#L96)
+        * [should raise a ServerError exception](./spec/acceptance/rest/base_spec.rb#L95)
       * 500 server error without a valid JSON response body
-        * [should raise a ServerError exception](./spec/acceptance/rest/base_spec.rb#L109)
+        * [should raise a ServerError exception](./spec/acceptance/rest/base_spec.rb#L108)
     * token authentication failures
       * when auth#token_renewable?
-        * [should automatically reissue a token](./spec/acceptance/rest/base_spec.rb#L147)
+        * [should automatically reissue a token](./spec/acceptance/rest/base_spec.rb#L146)
       * when NOT auth#token_renewable?
-        * [should raise an TokenExpired exception](./spec/acceptance/rest/base_spec.rb#L162)
+        * [should raise an TokenExpired exception](./spec/acceptance/rest/base_spec.rb#L161)
 
 ### Ably::Rest::Channel
 _(see [spec/acceptance/rest/channel_spec.rb](./spec/acceptance/rest/channel_spec.rb))_
@@ -3100,7 +3100,7 @@ _(see [spec/acceptance/rest/presence_spec.rb](./spec/acceptance/rest/presence_sp
         * default :limit
           * [defaults to a limit of 100](./spec/acceptance/rest/presence_spec.rb#L86)
         * with :client_id option
-          * FAILED: ~~[returns a list members filtered by the provided client ID](./spec/acceptance/rest/presence_spec.rb#L95)~~
+          * [returns a list members filtered by the provided client ID](./spec/acceptance/rest/presence_spec.rb#L95)
         * with :connection_id option
           * [returns a list members filtered by the provided connection ID](./spec/acceptance/rest/presence_spec.rb#L106)
           * [returns a list members filtered by the provided connection ID](./spec/acceptance/rest/presence_spec.rb#L110)
@@ -5075,6 +5075,6 @@ _(see [spec/unit/util/pub_sub_spec.rb](./spec/unit/util/pub_sub_spec.rb))_
 
   ## Test summary
 
-  * Passing tests: 2494
+  * Passing tests: 2495
   * Pending tests: 5
-  * Failing tests: 1
+  * Failing tests: 0

data/ably.gemspec

@@ -22,10 +22,11 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'ably-em-http-request', '~> 1.1.8'
   spec.add_runtime_dependency 'statesman', '~> 9.0'
   spec.add_runtime_dependency 'faraday', '~> 2.2'
-  spec.add_runtime_dependency 'faraday-typhoeus', '~> 0.2.0'
+  spec.add_runtime_dependency 'faraday-typhoeus', '~> 1.1.0'
   spec.add_runtime_dependency 'typhoeus', '~> 1.4'
   spec.add_runtime_dependency 'json'
-  spec.add_runtime_dependency 'websocket-driver', '~> 0.7'
+  # We disallow minor version updates, because this gem has introduced breaking API changes in minor releases before (which it's within its rights to do, given it's pre-v1). If you want to allow a new minor version, bump here and run the tests.
+  spec.add_runtime_dependency 'websocket-driver', '~> 0.8.0'
   spec.add_runtime_dependency 'msgpack', '>= 1.3.0'
   spec.add_runtime_dependency 'addressable', '>= 2.0.0'
 

data/lib/ably/realtime/connection/websocket_transport.rb

@@ -257,7 +257,7 @@ module Ably::Realtime
         when :json
           JSON.parse(data)
         when :msgpack
-          MessagePack.unpack(data.pack('C*'))
+          MessagePack.unpack(data)
         else
           client.logger.fatal { "WebsocketTransport: Unsupported Protocol Message format #{client.protocol}" }
           data

data/lib/ably/realtime/connection.rb

@@ -690,16 +690,44 @@ module Ably
       end
 
       def use_fallback_if_disconnected?
-        second_reconnect_attempt_for(:disconnected, 1)
+        unless second_reconnect_attempt_for(:disconnected, 1)
+          return false
+        end
+
+        does_error_necessitate_fallback(reason_for_last_time_in(:disconnected))
       end
 
       def use_fallback_if_suspended?
-        second_reconnect_attempt_for(:suspended, 2) # on first suspended state use default Ably host again
+        unless second_reconnect_attempt_for(:suspended, 2) # on first suspended state use default Ably host again
+          return false
+        end
+
+        does_error_necessitate_fallback(reason_for_last_time_in(:suspended))
       end
 
       def second_reconnect_attempt_for(state, first_attempt_count)
         previous_state == state && manager.retry_count_for_state(state) >= first_attempt_count
       end
+
+      # Provides a partial implementation of RTN17f's logic for whether an error necessitates a fallback host.
+      def does_error_necessitate_fallback(error)
+        return false unless error
+
+        # For now we just explicitly exclude token errors. TODO: implement properly in https://github.com/ably/ably-ruby/issues/444
+
+        if error.respond_to?(:status_code) && error.status_code == 401 && error.respond_to?(:code) && Ably::Exceptions::TOKEN_EXPIRED_CODE.include?(error.code)
+          return false
+        end
+
+        true
+      end
+
+      # Returns the error associated with the last state change to the given state (e.g. :disconnected).
+      def reason_for_last_time_in(state)
+        history_item = state_history.reverse.find do |history_item|
+          history_item.fetch(:state) == state
+        end.fetch(:metadata).reason
+      end
     end
   end
 end

data/lib/ably/version.rb

@@ -1,5 +1,5 @@
 module Ably
-  VERSION = '1.2.7'
+  VERSION = '1.2.8'
   # The level of compatibility with the Ably service that this SDK supports.
   # Also referred to as the 'wire protocol version'.
   # spec : CSV2

data/spec/acceptance/realtime/client_spec.rb

@@ -34,7 +34,7 @@ describe Ably::Realtime::Client, :event_machine do
             client.connection.once(:failed) do
               expect(custom_logger_object.logs.find do |severity, message|
                 next unless %w(fatal error).include?(severity.to_s)
-                message.match(%r{https://help.ably.io/error/40400})
+                message.match(%r{https://help.ably.io/error/40101})
               end).to_not be_nil
               stop_reactor
             end

data/spec/acceptance/realtime/connection_failures_spec.rb

@@ -26,13 +26,13 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
         context 'with invalid app part of the key' do
           let(:invalid_key) { 'not_an_app.invalid_key_name:invalid_key_value' }
 
-          it 'enters the failed state and returns a not found error' do
+          it 'enters the failed state and returns an invalid credentials error' do
             connection.on(:failed) do |connection_state_change|
               error = connection_state_change.reason
               expect(connection.state).to eq(:failed)
               # TODO: Check error type is an InvalidToken exception
-              expect(error.status).to eq(404)
-              expect(error.code).to eq(40400) # not found
+              expect(error.status).to eq(401)
+              expect(error.code).to eq(40101) # invalid credentials
               stop_reactor
             end
           end
@@ -46,7 +46,7 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
               error = connection_state_change.reason
               expect(connection.state).to eq(:failed)
               # TODO: Check error type is a TokenNotFound exception
-              expect(error.status).to eq(401)
+              expect(error.status).to eq(404)
               expect(error.code).to eq(40400) # not found
               stop_reactor
             end
@@ -1396,10 +1396,10 @@ describe Ably::Realtime::Connection, 'failures', :event_machine do
           channel = client.channels.get("foo")
           channel.attach do
             connection.once(:failed) do |state_change|
-              expect(state_change.reason.code).to eql(40400)
-              expect(connection.error_reason.code).to eql(40400)
+              expect(state_change.reason.code).to eql(40101)
+              expect(connection.error_reason.code).to eql(40101)
               expect(channel).to be_failed
-              expect(channel.error_reason.code).to eql(40400)
+              expect(channel.error_reason.code).to eql(40101)
               stop_reactor
             end
 

data/spec/acceptance/rest/base_spec.rb

@@ -72,13 +72,12 @@ describe Ably::Rest do
 
     describe 'failed requests' do
       context 'due to invalid Auth' do
-        it 'should raise an InvalidRequest exception with a valid error message and code' do
+        it 'should raise an UnauthorizedRequest exception with a valid error message and code' do
           invalid_client = Ably::Rest::Client.new(key: 'appid.keyuid:keysecret', environment: environment)
           expect { invalid_client.channel('test').publish('foo', 'choo') }.to raise_error do |error|
-            expect(error).to be_a(Ably::Exceptions::ResourceMissing)
-            expect(error.message).to match(/No application found/)
-            expect(error.code).to eql(40400)
-            expect(error.status).to eql(404)
+            expect(error).to be_a(Ably::Exceptions::UnauthorizedRequest)
+            expect(error.code).to eql(40101)
+            expect(error.status).to eql(401)
           end
         end
       end

data/spec/acceptance/rest/client_spec.rb

@@ -33,9 +33,9 @@ describe Ably::Rest::Client do
         it 'logs an entry with a help href url matching the code #TI5' do
           begin
             client.channels.get('foo').publish('test')
-            raise 'Expected Ably::Exceptions::ResourceMissing'
-          rescue Ably::Exceptions::ResourceMissing => err
-            expect err.to_s.match(%r{https://help.ably.io/error/40400})
+            raise 'Expected Ably::Exceptions::UnauthorizedRequest'
+          rescue Ably::Exceptions::UnauthorizedRequest => err
+            expect err.to_s.match(%r{https://help.ably.io/error/40101})
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.8
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-11 00:00:00.000000000 Z
+date: 2025-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement