ably 1.2.5 → 1.2.7

data/spec/unit/models/protocol_message_spec.rb

@@ -127,14 +127,6 @@ describe Ably::Models::ProtocolMessage do
       end
     end
 
-    context '#connection_serial' do
-      let(:protocol_message) { new_protocol_message(connection_serial: "55") }
-      it 'converts :connection_serial to an Integer' do
-        expect(protocol_message.connection_serial).to be_a(Integer)
-        expect(protocol_message.connection_serial).to eql(55)
-      end
-    end
-
     context '#flags (#TR4i)' do
       context 'when nil' do
         let(:protocol_message) { new_protocol_message({}) }
@@ -241,76 +233,6 @@ describe Ably::Models::ProtocolMessage do
       end
     end
 
-    context '#has_connection_serial?' do
-      context 'without connection_serial' do
-        let(:protocol_message) { new_protocol_message({}) }
-
-        it 'returns false' do
-          expect(protocol_message.has_connection_serial?).to eql(false)
-        end
-      end
-
-      context 'with connection_serial' do
-        let(:protocol_message) { new_protocol_message(connection_serial: "55") }
-
-        it 'returns true' do
-          expect(protocol_message.has_connection_serial?).to eql(true)
-        end
-      end
-    end
-
-    context '#serial' do
-      context 'with underlying msg_serial' do
-        let(:protocol_message) { new_protocol_message(msg_serial: "55") }
-        it 'converts :msg_serial to an Integer' do
-          expect(protocol_message.serial).to be_a(Integer)
-          expect(protocol_message.serial).to eql(55)
-        end
-      end
-
-      context 'with underlying connection_serial' do
-        let(:protocol_message) { new_protocol_message(connection_serial: "55") }
-        it 'converts :connection_serial to an Integer' do
-          expect(protocol_message.serial).to be_a(Integer)
-          expect(protocol_message.serial).to eql(55)
-        end
-      end
-
-      context 'with underlying connection_serial and msg_serial' do
-        let(:protocol_message) { new_protocol_message(connection_serial: "99", msg_serial: "11") }
-        it 'prefers connection_serial and converts :connection_serial to an Integer' do
-          expect(protocol_message.serial).to be_a(Integer)
-          expect(protocol_message.serial).to eql(99)
-        end
-      end
-    end
-
-    context '#has_serial?' do
-      context 'without msg_serial or connection_serial' do
-        let(:protocol_message) { new_protocol_message({}) }
-
-        it 'returns false' do
-          expect(protocol_message.has_serial?).to eql(false)
-        end
-      end
-
-      context 'with msg_serial' do
-        let(:protocol_message) { new_protocol_message(msg_serial: "55") }
-
-        it 'returns true' do
-          expect(protocol_message.has_serial?).to eql(true)
-        end
-      end
-
-      context 'with connection_serial' do
-        let(:protocol_message) { new_protocol_message(connection_serial: "55") }
-
-        it 'returns true' do
-          expect(protocol_message.has_serial?).to eql(true)
-        end
-      end
-    end
-
     context '#error' do
       context 'with no error attribute' do
         let(:protocol_message) { new_protocol_message(action: 1) }
@@ -475,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) }) }
 

data/spec/unit/models/token_details_spec.rb

@@ -56,6 +56,7 @@ describe Ably::Models::TokenDetails do
 
     context '#expired?' do
       let(:expire_time) { Time.now + Ably::Models::TokenDetails::TOKEN_EXPIRY_BUFFER }
+      let(:clock_skew) { 1 } # clock skew of 1 second
 
       context 'once grace period buffer has passed' do
         subject { Ably::Models::TokenDetails.new(expires: expire_time - 1) }
@@ -74,7 +75,7 @@ describe Ably::Models::TokenDetails do
       end
 
       context 'when expires is not available (i.e. string tokens)' do
-        subject { Ably::Models::TokenDetails.new() }
+        subject { Ably::Models::TokenDetails.new }
 
         it 'is always false' do
           expect(subject.expired?).to eql(false)
@@ -90,8 +91,9 @@ describe Ably::Models::TokenDetails do
           expect(subject.expired?(from: (Time.now - server_offset_time))).to eql(false)
         end
 
+        # Test is flaky and fails on CI, so adding a bit of extra tolerance (clock_skew) to make it work
         it 'is true' do
-          expect(subject.expired?(from: Time.now)).to eql(true)
+          expect(subject.expired?(from: Time.now + clock_skew)).to eql(true)
         end
       end
     end

data/spec/unit/realtime/channels_spec.rb

@@ -2,7 +2,7 @@
 require 'spec_helper'
 
 describe Ably::Realtime::Channels do
-  let(:connection) { instance_double('Ably::Realtime::Connection', unsafe_on: true, on_resume: true) }
+  let(:connection) { instance_double('Ably::Realtime::Connection', unsafe_on: true) }
   let(:client) do
     instance_double('Ably::Realtime::Client', connection: connection, client_id: 'clientId', logger: double('logger').as_null_object)
   end

data/spec/unit/realtime/connection_spec.rb

@@ -34,36 +34,6 @@ describe Ably::Realtime::Connection do
   it_behaves_like 'an incoming protocol message bus'
   it_behaves_like 'an outgoing protocol message bus'
 
-  describe 'connection resume callbacks', api_private: true do
-    let(:callbacks) { [] }
-
-    describe '#trigger_resumed' do
-      it 'executes the callbacks' do
-        subject.on_resume { callbacks << true }
-        subject.trigger_resumed
-        expect(callbacks.count).to eql(1)
-      end
-    end
-
-    describe '#on_resume' do
-      it 'registers a callback' do
-        subject.on_resume { callbacks << true }
-        subject.trigger_resumed
-        expect(callbacks.count).to eql(1)
-      end
-    end
-
-    describe '#off_resume' do
-      it 'registers a callback' do
-        subject.on_resume { callbacks << true }
-        additional_proc = lambda { raise 'This should not be called' }
-        subject.off_resume(&additional_proc)
-        subject.trigger_resumed
-        expect(callbacks.count).to eql(1)
-      end
-    end
-  end
-
   after(:all) do
     sleep 1 # let realtime library shut down any open clients
   end

data/spec/unit/realtime/recovery_key_context_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'ably/realtime/recovery_key_context'
+
+describe Ably::Realtime::RecoveryKeyContext do
+
+  context 'connection recovery key' do
+
+    it 'should encode recovery key - RTN16i, RTN16f, RTN16j' do
+      connection_key = 'key'
+      msg_serial = 123
+      channel_serials = {
+        'channel1' => 'serial1',
+        'channel2' => 'serial2'
+      }
+      recovery_context = Ably::Realtime::RecoveryKeyContext.new(connection_key, msg_serial, channel_serials)
+      encoded_recovery_key = recovery_context.to_json
+      expect(encoded_recovery_key).to eq "{\"connection_key\":\"key\",\"msg_serial\":123," <<
+                                                "\"channel_serials\":{\"channel1\":\"serial1\",\"channel2\":\"serial2\"}}"
+    end
+
+    it 'should decode recovery key - RTN16i, RTN16f, RTN16j' do
+      encoded_recovery_key = "{\"connection_key\":\"key\",\"msg_serial\":123," <<
+                                     "\"channel_serials\":{\"channel1\":\"serial1\",\"channel2\":\"serial2\"}}"
+      decoded_recovery_key = Ably::Realtime::RecoveryKeyContext.from_json(encoded_recovery_key)
+      expect(decoded_recovery_key.connection_key).to eq("key")
+      expect(decoded_recovery_key.msg_serial).to eq(123)
+    end
+
+    it 'should return nil for invalid recovery key - RTN16i, RTN16f, RTN16j' do
+      encoded_recovery_key = "{\"invalid key\"}"
+      decoded_recovery_key = Ably::Realtime::RecoveryKeyContext.from_json(encoded_recovery_key)
+      expect(decoded_recovery_key).to be_nil
+    end
+
+  end
+end

data/spec/unit/util/crypto_spec.rb

@@ -72,26 +72,26 @@ describe Ably::Util::Crypto do
     end
   end
 
-  context 'encrypts & decrypt' do
+  context '#encrypt & #decrypt' do
     let(:string) { random_str }
-    let(:byte_array) { random_str.to_msgpack.unpack('C*') }
-
-    specify '#encrypt encrypts a string' do
-      encrypted = subject.encrypt(string)
-      expect(subject.decrypt(encrypted)).to eql(string)
-    end
+    let(:empty_string) { '' }
 
-    specify '#decrypt decrypts a string' do
+    specify 'encrypts and decrypts a non-empty string' do
+      expect(string).to be_ascii_only
       encrypted = subject.encrypt(string)
-      expect(subject.decrypt(encrypted)).to eql(string)
+      expect(encrypted).to be_truthy
+      decrypted = subject.decrypt(encrypted)
+      expect(decrypted).to eql(string)
+      expect(decrypted).to be_ascii_only
     end
-  end
-
-  context 'encrypting an empty string' do
-    let(:empty_string) { '' }
 
-    it 'raises an ArgumentError' do
-      expect { subject.encrypt(empty_string) }.to raise_error ArgumentError, /data must not be empty/
+    specify 'encrypts and decrypts an empty string' do
+      expect(empty_string).to be_ascii_only
+      encrypted = subject.encrypt(empty_string)
+      expect(encrypted).to be_truthy
+      decrypted = subject.decrypt(encrypted)
+      expect(decrypted).to eql(empty_string)
+      expect(decrypted).to be_ascii_only
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.7
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -283,14 +283,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
@@ -469,6 +469,7 @@ files:
 - lib/ably/realtime/push/admin.rb
 - lib/ably/realtime/push/channel_subscriptions.rb
 - lib/ably/realtime/push/device_registrations.rb
+- lib/ably/realtime/recovery_key_context.rb
 - lib/ably/rest.rb
 - lib/ably/rest/channel.rb
 - lib/ably/rest/channel/push_channel.rb
@@ -486,6 +487,7 @@ files:
 - lib/ably/rest/push/admin.rb
 - lib/ably/rest/push/channel_subscriptions.rb
 - lib/ably/rest/push/device_registrations.rb
+- lib/ably/util/ably_extensions.rb
 - lib/ably/util/crypto.rb
 - lib/ably/util/pub_sub.rb
 - lib/ably/util/safe_deferrable.rb
@@ -501,7 +503,6 @@ files:
 - spec/acceptance/realtime/presence_history_spec.rb
 - spec/acceptance/realtime/presence_spec.rb
 - spec/acceptance/realtime/push_admin_spec.rb
-- spec/acceptance/realtime/push_spec.rb
 - spec/acceptance/realtime/stats_spec.rb
 - spec/acceptance/realtime/time_spec.rb
 - spec/acceptance/rest/auth_spec.rb
@@ -513,7 +514,6 @@ files:
 - spec/acceptance/rest/message_spec.rb
 - spec/acceptance/rest/presence_spec.rb
 - spec/acceptance/rest/push_admin_spec.rb
-- spec/acceptance/rest/push_spec.rb
 - spec/acceptance/rest/stats_spec.rb
 - spec/acceptance/rest/time_spec.rb
 - spec/lib/unit/models/channel_options_spec.rb
@@ -578,6 +578,7 @@ files:
 - spec/unit/realtime/presence_spec.rb
 - spec/unit/realtime/push_channel_spec.rb
 - spec/unit/realtime/realtime_spec.rb
+- spec/unit/realtime/recovery_key_context_spec.rb
 - spec/unit/realtime/safe_deferrable_spec.rb
 - spec/unit/realtime/websocket_transport_spec.rb
 - spec/unit/rest/channel_spec.rb
@@ -622,7 +623,6 @@ test_files:
 - spec/acceptance/realtime/presence_history_spec.rb
 - spec/acceptance/realtime/presence_spec.rb
 - spec/acceptance/realtime/push_admin_spec.rb
-- spec/acceptance/realtime/push_spec.rb
 - spec/acceptance/realtime/stats_spec.rb
 - spec/acceptance/realtime/time_spec.rb
 - spec/acceptance/rest/auth_spec.rb
@@ -634,7 +634,6 @@ test_files:
 - spec/acceptance/rest/message_spec.rb
 - spec/acceptance/rest/presence_spec.rb
 - spec/acceptance/rest/push_admin_spec.rb
-- spec/acceptance/rest/push_spec.rb
 - spec/acceptance/rest/stats_spec.rb
 - spec/acceptance/rest/time_spec.rb
 - spec/lib/unit/models/channel_options_spec.rb
@@ -699,6 +698,7 @@ test_files:
 - spec/unit/realtime/presence_spec.rb
 - spec/unit/realtime/push_channel_spec.rb
 - spec/unit/realtime/realtime_spec.rb
+- spec/unit/realtime/recovery_key_context_spec.rb
 - spec/unit/realtime/safe_deferrable_spec.rb
 - spec/unit/realtime/websocket_transport_spec.rb
 - spec/unit/rest/channel_spec.rb

data/spec/acceptance/realtime/push_spec.rb

@@ -1,27 +0,0 @@
-# encoding: utf-8
-require 'spec_helper'
-
-describe Ably::Realtime::Push, :event_machine do
-  vary_by_protocol do
-    let(:default_options) { { key: api_key, environment: environment, protocol: protocol} }
-    let(:client_options)  { default_options }
-    let(:client) do
-      Ably::Realtime::Client.new(client_options)
-    end
-    subject { client.push }
-
-    describe '#activate' do
-      it 'raises an unsupported exception' do
-        expect { subject.activate('foo') }.to raise_error(Ably::Exceptions::PushNotificationsNotSupported)
-        stop_reactor
-      end
-    end
-
-    describe '#deactivate' do
-      it 'raises an unsupported exception' do
-        expect { subject.deactivate('foo') }.to raise_error(Ably::Exceptions::PushNotificationsNotSupported)
-        stop_reactor
-      end
-    end
-  end
-end

data/spec/acceptance/rest/push_spec.rb

@@ -1,25 +0,0 @@
-# encoding: utf-8
-require 'spec_helper'
-
-describe Ably::Rest::Push do
-  vary_by_protocol do
-    let(:default_options) { { key: api_key, environment: environment, protocol: protocol} }
-    let(:client_options)  { default_options }
-    let(:client) do
-      Ably::Rest::Client.new(client_options)
-    end
-    subject { client.push }
-
-    describe '#activate' do
-      it 'raises an unsupported exception' do
-        expect { subject.activate('foo') }.to raise_error(Ably::Exceptions::PushNotificationsNotSupported)
-      end
-    end
-
-    describe '#deactivate' do
-      it 'raises an unsupported exception' do
-        expect { subject.deactivate('foo') }.to raise_error(Ably::Exceptions::PushNotificationsNotSupported)
-      end
-    end
-  end
-end