ably 1.2.6 → 1.2.8

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/models/protocol_message.rb

@@ -249,7 +249,6 @@ module Ably::Models
     # Return a JSON ready object from the underlying #attributes using Ably naming conventions for keys
     def as_json(*args)
       raise TypeError, ':action is missing, cannot generate a valid Hash for ProtocolMessage' unless action
-      raise TypeError, ':msg_serial is missing, cannot generate a valid Hash for ProtocolMessage' if ack_required? && !has_message_serial?
 
       attributes.dup.tap do |hash_object|
         hash_object['action']   = action.to_i

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.6'
+  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/auth_spec.rb

@@ -617,7 +617,6 @@ describe Ably::Realtime::Auth, :event_machine do
                   deferrable.errback do |error|
                     EventMachine.add_timer(0.2) do
                       expect(connection_failed).to eql(true)
-                      expect(error.message).to match(/invalid.*accessToken/i)
                       expect(error.code).to eql(40005)
                       stop_reactor
                     end
@@ -627,7 +626,6 @@ describe Ably::Realtime::Auth, :event_machine do
               end
 
               client.connection.once(:failed) do
-                expect(client.connection.error_reason.message).to match(/invalid.*accessToken/i)
                 expect(client.connection.error_reason.code).to eql(40005)
                 connection_failed = true
               end
@@ -664,7 +662,6 @@ describe Ably::Realtime::Auth, :event_machine do
                 channel.attach do
                   channel.publish('not-allowed').errback do |error|
                     expect(error.code).to eql(40160)
-                    expect(error.message).to match(/permission denied/)
 
                     client.auth.authorize(nil, auth_callback: upgraded_token_cb)
                     client.connection.once(:update) do
@@ -1058,7 +1055,6 @@ describe Ably::Realtime::Auth, :event_machine do
 
           it 'disconnected includes and invalid signature message' do
             client.connection.once(:disconnected) do |state_change|
-              expect(state_change.reason.message.match(/signature verification failed/i)).to_not be_nil
               expect(state_change.reason.code).to eql(40144)
               stop_reactor
             end
@@ -1111,7 +1107,6 @@ describe Ably::Realtime::Auth, :event_machine do
 
           it 'authentication fails and reason for disconnection is invalid signature' do
             client.connection.once(:disconnected) do |state_change|
-              expect(state_change.reason.message.match(/signature verification failed/i)).to_not be_nil
               expect(state_change.reason.code).to eql(40144)
               stop_reactor
             end
@@ -1143,7 +1138,6 @@ describe Ably::Realtime::Auth, :event_machine do
 
           it 'fails with an invalid signature error' do
             client.connection.once(:disconnected) do |state_change|
-              expect(state_change.reason.message.match(/signature verification failed/i)).to_not be_nil
               expect(state_change.reason.code).to eql(40144)
               stop_reactor
             end
@@ -1248,7 +1242,6 @@ describe Ably::Realtime::Auth, :event_machine do
             allowed_channel = client.channels.get(channel_with_publish_permissions)
             forbidden_channel.publish('not-allowed').errback do |error|
               expect(error.code).to eql(40160)
-              expect(error.message).to match(/permission denied/)
 
               allowed_channel.publish(message_name) do |message|
                 expect(message.name).to eql(message_name)

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/realtime/message_spec.rb

@@ -173,7 +173,7 @@ describe 'Ably::Realtime::Channel Message', :event_machine do
       end
 
       context 'JSON Array' do
-        let(:data) { { 'push' => { 'data' => { 'key' => [ true, false, 55, nil, 'string', { 'Hash' => true }, ['array'] ] } } } }
+        let(:data) { { 'push' => { 'data' => { 'key' => [ true, false, 55.1, nil, 'string', { 'Hash' => true }, ['array'] ] } } } }
 
         it 'is encoded and decoded to the same Array' do
           publish_and_check_extras data

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

data/spec/unit/models/protocol_message_spec.rb

@@ -397,14 +397,6 @@ describe Ably::Models::ProtocolMessage do
       end
     end
 
-    context 'with missing msg_serial for ack message' do
-      let(:model) { new_protocol_message({ :action => message_action }) }
-
-      it 'it raises an exception' do
-        expect { model.to_json }.to raise_error TypeError, /msg_serial.*missing/
-      end
-    end
-
     context 'is aliased by #to_s' do
       let(:model) { new_protocol_message({ :action => attached_action, :channelSerial => 'unique', messages: [message1, message2, message3], :timestamp => as_since_epoch(Time.now) }) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.8
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-08 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
@@ -607,7 +607,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A Ruby client library for ably.io realtime messaging implemented using EventMachine