ably 1.1.4 → 1.1.8

data/spec/unit/models/presence_message_spec.rb

@@ -220,6 +220,55 @@ describe Ably::Models::PresenceMessage do
     end
   end
 
+  describe '#size' do
+    let(:model) { subject.new({ action: 'enter', data: data, client_id: client_id }, protocol_message: protocol_message) }
+
+    context 'String (#TO3l8a)' do
+      let(:data) { 'example string data' }
+      let(:client_id) { '1' }
+
+      it 'should return 20 bytes' do
+        expect(model.size).to eq(20)
+      end
+    end
+
+    context 'Object (#TO3l8b)' do
+      let(:data) { Object.new }
+      let(:client_id) { '10' }
+
+      it 'should return 32 bytes' do
+        expect(model.size).to eq(32)
+      end
+    end
+
+    context 'Array (#TO3l8b)' do
+      let(:data) { [1, 'two', :three] }
+      let(:client_id) { '2' }
+
+      it 'should return 18 bytes' do
+        expect(model.size).to eq(18)
+      end
+    end
+
+    context 'extras (#TO3l8d)' do
+      let(:data) { { example: 'value', score: 1, hash: { test: true } } }
+      let(:client_id) { '3' }
+
+      it 'should return 51 bytes' do
+        expect(model.size).to eq(51)
+      end
+    end
+
+    context 'nil (#TO3l8e)' do
+      let(:data) { nil }
+      let(:client_id) { '4' }
+
+      it 'should return 1 bytes' do
+        expect(model.size).to eq(1)
+      end
+    end
+  end
+
   context 'from REST request with embedded fields', :api_private do
     let(:id) { random_str }
     let(:message_time) { Time.now + 60 }

data/spec/unit/models/protocol_message_spec.rb

@@ -10,9 +10,9 @@ describe Ably::Models::ProtocolMessage do
     subject.new({ action: 1 }.merge(options))
   end
 
-  # TR4n, TR4b, TR4c, TR4d, TR4e
+  # TR4n, TR4b, TR4c, TR4d
   it_behaves_like 'a model',
-    with_simple_attributes: %w(id channel channel_serial connection_id connection_key),
+    with_simple_attributes: %w(id channel channel_serial connection_id),
     base_model_options: { action: 1 } do
 
     let(:model_args) { [] }
@@ -176,6 +176,28 @@ describe Ably::Models::ProtocolMessage do
         end
       end
 
+      context 'when attach resumed flag' do
+        context 'flags is 34' do
+          let(:protocol_message) { new_protocol_message(flags: 34) }
+
+          it '#has_attach_resume_flag? is true' do
+            expect(protocol_message.has_attach_resume_flag?).to be_truthy
+          end
+
+          it '#has_attach_presence_flag? is false' do
+            expect(protocol_message.has_attach_presence_flag?).to be_falsey
+          end
+        end
+
+        context 'flags is 0' do
+          let(:protocol_message) { new_protocol_message(flags: 0) }
+
+          it 'should raise an exception if flags is a float number' do
+            expect(protocol_message.has_attach_resume_flag?).to be_falsy
+          end
+        end
+      end
+
       context 'when channel resumed and presence flags present' do
         let(:protocol_message) { new_protocol_message(flags: 5) }
 
@@ -318,6 +340,54 @@ describe Ably::Models::ProtocolMessage do
       end
     end
 
+    context '#message_size (#TO3l8)' do
+      context 'on presence' do
+        let(:protocol_message) do
+          new_protocol_message(presence: [{ action: 1, data: 'test342343', client_id: 'sdf' }])
+        end
+
+        it 'should return 13 bytes (sum in bytes: data and client_id)' do
+          expect(protocol_message.message_size).to eq(13)
+        end
+      end
+
+      context 'on message' do
+        let(:protocol_message) do
+          new_protocol_message(messages: [{ action: 1, unknown: 'test', data: 'test342343', client_id: 'sdf', name: 'sf23ewrew', extras: { time: Time.now, time_zone: 'UTC' } }])
+        end
+
+        it 'should return 76 bytes (sum in bytes: data, client_id, name, extras)' do
+          expect(protocol_message.message_size).to eq(76)
+        end
+      end
+    end
+
+    context '#has_correct_message_size? (#TO3l8)' do
+      context 'on presence' do
+        it 'should return true when a message has correct size' do
+          protocol_message = new_protocol_message(presence: [{ action: 1, data: 'x' * 100 }])
+          expect(protocol_message.has_correct_message_size?).to eq(true)
+        end
+
+        it 'should return false when a message has not correct size' do
+          protocol_message = new_protocol_message(presence: [{ action: 1, data: 'x' * 65537 }])
+          expect(protocol_message.has_correct_message_size?).to eq(false)
+        end
+      end
+
+      context 'on message' do
+        it 'should return true when a message has correct size' do
+          protocol_message = new_protocol_message(messages: [{ name: 'x' * 100 }])
+          expect(protocol_message.has_correct_message_size?).to eq(true)
+        end
+
+        it 'should return false when a message has not correct size' do
+          protocol_message = new_protocol_message(messages: [{ name: 'x' * 65537 }])
+          expect(protocol_message.has_correct_message_size?).to eq(false)
+        end
+      end
+    end
+
     context '#connection_details (#TR4o)' do
       let(:connection_details) { protocol_message.connection_details }
 
@@ -369,24 +439,6 @@ describe Ably::Models::ProtocolMessage do
         end
       end
     end
-
-    context '#connection_key (#TR4e)' do
-      context 'existing only in #connection_details.connection_key' do
-        let(:protocol_message) { new_protocol_message(connectionDetails: { connectionKey: 'key' }) }
-
-        it 'is returned' do
-          expect(protocol_message.connection_key).to eql('key')
-        end
-      end
-
-      context 'existing in both #connection_key and #connection_details.connection_key' do
-        let(:protocol_message) { new_protocol_message(connectionKey: 'deprecated', connectionDetails: { connectionKey: 'key' }) }
-
-        it 'returns #connection_details.connection_key as #connection_key will be deprecated > 0.8' do
-          expect(protocol_message.connection_key).to eql('key')
-        end
-      end
-    end
   end
 
   context '#to_json', :api_private do

data/spec/unit/realtime/channel_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 require 'shared/protocol_msgbus_behaviour'
 
 describe Ably::Realtime::Channel do
-  let(:client)       { double('client').as_null_object }
+  let(:client)       { Ably::Realtime::Client.new(token: 'valid') }
   let(:channel_name) { 'test' }
 
   subject do
@@ -68,9 +68,10 @@ describe Ably::Realtime::Channel do
 
   describe '#publish name argument' do
     let(:encoded_value) { random_str.encode(encoding) }
-    let(:message) { instance_double('Ably::Models::Message', client_id: nil) }
+    let(:message) { instance_double('Ably::Models::Message', client_id: nil, size: 0) }
 
     before do
+      allow(subject).to receive(:enqueue_messages_on_connection).and_return(message)
       allow(subject).to receive(:create_message).and_return(message)
       allow(subject).to receive(:attach).and_return(:true)
     end

data/spec/unit/realtime/channels_spec.rb

@@ -11,19 +11,19 @@ describe Ably::Realtime::Channels do
 
   context 'creating channels' do
     context '#get' do
-      it 'creates a channel if it does not exist' do
+      it 'creates a channel if it does not exist (RSN3a)' do
         expect(Ably::Realtime::Channel).to receive(:new).with(client, channel_name, options)
         subject.get(channel_name, options)
       end
 
       context 'when an existing channel exists' do
-        it 'will reuse a channel object if it exists' do
+        it 'will reuse a channel object if it exists (RSN3a)' do
           channel = subject.get(channel_name, options)
           expect(channel).to be_a(Ably::Realtime::Channel)
           expect(subject.get(channel_name, options).object_id).to eql(channel.object_id)
         end
 
-        it 'will update the options on the channel if provided' do
+        it 'will update the options on the channel if provided (RSN3c)' do
           channel = subject.get(channel_name, options)
           expect(channel.options).to eql(options)
           expect(channel.options).to_not include(:encrypted)

data/spec/unit/realtime/incoming_message_dispatcher_spec.rb

@@ -32,5 +32,43 @@ describe Ably::Realtime::Client::IncomingMessageDispatcher, :api_private do
       expect(subject).to receive_message_chain(:logger, :warn)
       msgbus.publish :protocol_message, Ably::Models::ProtocolMessage.new(:action => :attached, channel: 'unknown')
     end
+
+    context 'TO3l8' do
+      context 'on action presence' do
+        let(:presence) { 101.times.map { { data: 'x' * 655 } } }
+
+        let(:protocol_message) do
+          Ably::Models::ProtocolMessage.new(action: :presence, channel: 'default', presence: presence, connection_serial: 123123123)
+        end
+
+        it 'should raise a protocol error when message size exceeded 65536 bytes' do
+          allow(connection).to receive(:serial).and_return(12312312)
+          allow(subject).to receive(:update_connection_recovery_info)
+          allow(subject).to receive_message_chain(:logger, :debug)
+          allow(subject).to receive_message_chain(:logger, :warn)
+          expect(subject).to receive_message_chain(:logger, :fatal)
+
+          msgbus.publish :protocol_message, protocol_message
+        end
+      end
+
+      context 'on action message' do
+        let(:messages) { 101.times.map { { data: 'x' * 655 } } }
+
+        let(:protocol_message) do
+          Ably::Models::ProtocolMessage.new(action: :message, channel: 'default', messages: messages, connection_serial: 123123123)
+        end
+
+        it 'should raise a protocol error when message size exceeded 65536 bytes' do
+          allow(connection).to receive(:serial).and_return(12312312)
+          allow(subject).to receive(:update_connection_recovery_info)
+          allow(subject).to receive_message_chain(:logger, :debug)
+          allow(subject).to receive_message_chain(:logger, :warn)
+          expect(subject).to receive_message_chain(:logger, :fatal)
+
+          msgbus.publish :protocol_message, protocol_message
+        end
+      end
+    end
   end
 end

data/spec/unit/rest/channel_spec.rb

@@ -7,10 +7,11 @@ describe Ably::Rest::Channel do
       'Ably::Rest::Client',
       encoders: [],
       post: instance_double('Faraday::Response', status: 201),
-      idempotent_rest_publishing: false,
+      idempotent_rest_publishing: false, max_message_size: max_message_size
     )
   end
   let(:channel_name) { 'unique' }
+  let(:max_message_size) { nil }
 
   subject { Ably::Rest::Channel.new(client, channel_name) }
 
@@ -126,5 +127,47 @@ describe Ably::Rest::Channel do
         expect { subject.publish(encoded_value, 'data') }.to raise_error ArgumentError, /must be a String/
       end
     end
+
+    context 'max message size exceeded' do
+      context 'when max_message_size is nil' do
+        context 'and a message size is 65537 bytes' do
+          it 'should raise Ably::Exceptions::MaxMessageSizeExceeded' do
+            expect { subject.publish('x' * 65537, 'data') }.to raise_error Ably::Exceptions::MaxMessageSizeExceeded
+          end
+        end
+      end
+
+      context 'when max_message_size is 65536 bytes' do
+        let(:max_message_size) { 65536 }
+
+        context 'and a message size is 65537 bytes' do
+          it 'should raise Ably::Exceptions::MaxMessageSizeExceeded' do
+            expect { subject.publish('x' * 65537, 'data') }.to raise_error Ably::Exceptions::MaxMessageSizeExceeded
+          end
+        end
+
+        context 'and a message size is 10 bytes' do
+          it 'should send a message' do
+            expect(subject.publish('x' * 10, 'data')).to eq(true)
+          end
+        end
+      end
+
+      context 'when max_message_size is 10 bytes' do
+        let(:max_message_size) { 10 }
+
+        context 'and a message size is 11 bytes' do
+          it 'should raise Ably::Exceptions::MaxMessageSizeExceeded' do
+            expect { subject.publish('x' * 11, 'data') }.to raise_error Ably::Exceptions::MaxMessageSizeExceeded
+          end
+        end
+
+        context 'and a message size is 2 bytes' do
+          it 'should send a message' do
+            expect(subject.publish('x' * 2, 'data')).to eq(true)
+          end
+        end
+      end
+    end
   end
 end

data/spec/unit/rest/client_spec.rb

@@ -38,6 +38,26 @@ describe Ably::Rest::Client do
       end
     end
 
+    context 'use agent' do
+      context 'set agent to non-default value' do
+        context 'default agent' do
+          let(:client_options) { { key: 'appid.keyuid:keysecret' } }
+
+          it 'should return default ably agent' do
+            expect(subject.agent).to eq(Ably::AGENT)
+          end
+        end
+
+        context 'custom agent' do
+          let(:client_options) { { key: 'appid.keyuid:keysecret', agent: 'example-gem/1.1.4 ably-ruby/1.1.5 ruby/3.0.0' } }
+
+          it 'should overwrite client.agent' do
+            expect(subject.agent).to eq('example-gem/1.1.4 ably-ruby/1.1.5 ruby/3.0.0')
+          end
+        end
+      end
+    end
+
     context ':use_token_auth' do
       context 'set to false' do
         context 'with a key and :tls => false' do
@@ -67,6 +87,33 @@ describe Ably::Rest::Client do
         end
       end
     end
+
+    context 'max_message_size' do
+      context 'is not present' do
+        let(:client_options) { { key: 'appid.keyuid:keysecret' } }
+
+        it 'should return default 65536 (#TO3l8)' do
+          expect(subject.max_message_size).to eq(Ably::Rest::Client::MAX_MESSAGE_SIZE)
+        end
+      end
+
+      context 'is nil' do
+        let(:client_options) { { key: 'appid.keyuid:keysecret', max_message_size: nil } }
+
+        it 'should return default 65536 (#TO3l8)' do
+          expect(Ably::Rest::Client::MAX_MESSAGE_SIZE).to eq(65536)
+          expect(subject.max_message_size).to eq(Ably::Rest::Client::MAX_MESSAGE_SIZE)
+        end
+      end
+
+      context 'is customized 131072 bytes' do
+        let(:client_options) { { key: 'appid.keyuid:keysecret', max_message_size: 131072 } }
+
+        it 'should return 131072' do
+          expect(subject.max_message_size).to eq(131072)
+        end
+      end
+    end
   end
 
   context 'request_id generation' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.8
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -45,48 +45,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.4'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.4'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.12'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.12'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: excon
+  name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.55'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.55'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -149,14 +143,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -177,14 +171,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rspec-retry
   requirement: !ruby/object:Gem::Requirement
@@ -256,61 +250,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.11'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.22'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.22'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
 description: A Ruby client library for ably.io realtime messaging
 email:
 - lewis@lmars.net
@@ -334,6 +342,7 @@ files:
 - SPEC.md
 - ably.gemspec
 - lib/ably.rb
+- lib/ably/agent.rb
 - lib/ably/auth.rb
 - lib/ably/exceptions.rb
 - lib/ably/logger.rb
@@ -342,6 +351,7 @@ files:
 - lib/ably/models/cipher_params.rb
 - lib/ably/models/connection_details.rb
 - lib/ably/models/connection_state_change.rb
+- lib/ably/models/delta_extras.rb
 - lib/ably/models/device_details.rb
 - lib/ably/models/device_push_details.rb
 - lib/ably/models/error_info.rb
@@ -479,6 +489,7 @@ files:
 - spec/unit/models/cipher_params_spec.rb
 - spec/unit/models/connection_details_spec.rb
 - spec/unit/models/connection_state_change_spec.rb
+- spec/unit/models/delta_extras_spec.rb
 - spec/unit/models/device_details_spec.rb
 - spec/unit/models/device_push_details_spec.rb
 - spec/unit/models/error_info_spec.rb
@@ -594,6 +605,7 @@ test_files:
 - spec/unit/models/cipher_params_spec.rb
 - spec/unit/models/connection_details_spec.rb
 - spec/unit/models/connection_state_change_spec.rb
+- spec/unit/models/delta_extras_spec.rb
 - spec/unit/models/device_details_spec.rb
 - spec/unit/models/device_push_details_spec.rb
 - spec/unit/models/error_info_spec.rb