ably-rest 1.1.6 → 1.2.0

data/lib/submodules/ably-ruby/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/lib/submodules/ably-ruby/spec/unit/rest/channels_spec.rb

@@ -2,30 +2,97 @@
 require 'spec_helper'
 
 describe Ably::Rest::Channels do
-  let(:client)       { instance_double('Ably::Rest::Client') }
+  let(:client)       { instance_double('Ably::Rest::Client', logger: double('logger').as_null_object) }
   let(:channel_name) { 'unique'.encode(Encoding::UTF_8) }
-  let(:options)      { { 'bizarre' => 'value' } }
+  let(:options)      do
+    { params: { 'bizarre' => 'value' } }
+  end
 
   subject { Ably::Rest::Channels.new(client) }
 
-  context 'creating channels' do
-    it '#get creates a channel' do
-      expect(Ably::Rest::Channel).to receive(:new).with(client, channel_name, options)
-      subject.get(channel_name, options)
-    end
+  describe '#get' do
+    context "when channel doesn't exist" do
+      shared_examples 'creates a channel' do
+        it 'creates a channel (RSN3a)' do
+          expect(Ably::Rest::Channel).to receive(:new).with(client, channel_name, options)
+          subject.get(channel_name, options)
+        end
+      end
 
-    it '#get will reuse the channel object' do
-      channel = subject.get(channel_name, options)
-      expect(channel).to be_a(Ably::Rest::Channel)
-      expect(subject.get(channel_name, options).object_id).to eql(channel.object_id)
+      describe 'hash' do
+        let(:channel_options) { options }
+        it { expect(channel_options).to be_a(Hash) }
+
+        include_examples 'creates a channel'
+      end
+
+      describe 'ChannelOptions object' do
+        let(:channel_options) { Ably::Models::ChannelOptions.new(options) }
+        it { expect(channel_options).to be_a(Ably::Models::ChannelOptions) }
+
+        include_examples 'creates a channel'
+      end
     end
 
-    it '[] creates a channel' do
-      expect(Ably::Rest::Channel).to receive(:new).with(client, channel_name, options)
-      subject.get(channel_name, options)
+    context 'when an existing channel exists' do
+      shared_examples 'reuse a channel object if it exists' do
+        it 'will reuse a channel object if it exists (RSN3a)' do
+          channel = subject.get(channel_name, channel_options)
+          expect(channel).to be_a(Ably::Rest::Channel)
+          expect(subject.get(channel_name, channel_options).object_id).to eql(channel.object_id)
+        end
+      end
+
+      describe 'hash' do
+        let(:channel_options) { options }
+        it { expect(channel_options).to be_a(Hash) }
+
+        include_examples 'reuse a channel object if it exists'
+      end
+
+      describe 'ChannelOptions object' do
+        let(:channel_options) { Ably::Models::ChannelOptions.new(options) }
+        it { expect(channel_options).to be_a(Ably::Models::ChannelOptions) }
+
+        include_examples 'reuse a channel object if it exists'
+      end
+
+      context 'with new channel_options modes' do
+        shared_examples 'update channel with provided options :modes' do
+          it 'will update channel with provided options modes (RSN3c)' do
+            channel = subject.get(channel_name, channel_options)
+            expect(channel.options.modes).to eq(modes)
+
+            subject.get(channel_name, channel_options)
+            expect(channel.options.modes).to eq(modes)
+          end
+        end
+
+        let(:modes) { %i[subscribe] }
+        let(:new_options) { { modes: modes } }
+
+        describe 'hash' do
+          let(:channel_options) { new_options }
+          it { expect(channel_options).to be_a(Hash) }
+
+          include_examples 'update channel with provided options :modes'
+        end
+
+        describe 'ChannelOptions object' do
+          let(:channel_options) { Ably::Models::ChannelOptions.new(new_options) }
+          it { expect(channel_options).to be_a(Ably::Models::ChannelOptions) }
+
+          include_examples 'update channel with provided options :modes'
+        end
+      end
     end
   end
 
+  it '[] creates a channel' do
+    expect(Ably::Rest::Channel).to receive(:new).with(client, channel_name, options)
+    subject.get(channel_name, options)
+  end
+
   context '#fetch' do
     it 'retrieves a channel if it exists' do
       channel = subject.get(channel_name, options)

data/lib/submodules/ably-ruby/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

data/spec/unit/client_spec.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Ably::Rest::Client do
+  subject do
+    Ably::Rest::Client.new(client_options)
+  end
+
+  context 'initializer options' do
+    context 'default agent' do
+      let(:client_options) { { key: 'appid.keyuid:keysecret' } }
+
+      it 'should return Ably::AGENT identifier' do
+        expect(subject.agent).to eq(Ably::AGENT)
+      end
+
+      it 'should show ably-ruby ruby and ably-ruby-rest identifier' do
+        expect(subject.agent).to match(/^ably-ruby\/\d.\d.\d ruby\/\d.\d.\d ably-ruby-rest$/)
+      end
+    end
+
+    context 'custom agent' do
+      let(:client_options) { { key: 'appid.keyuid:keysecret', agent: 'my-custom-agent/1.1' } }
+
+      it 'should show my-custom-agent/1.1' do
+        expect(subject.agent).to eq('my-custom-agent/1.1')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ably-rest
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.2.0
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2022-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -283,16 +283,20 @@ files:
 - lib/submodules/ably-ruby/README.md
 - lib/submodules/ably-ruby/Rakefile
 - lib/submodules/ably-ruby/SPEC.md
+- lib/submodules/ably-ruby/UPDATING.md
 - lib/submodules/ably-ruby/ably.gemspec
 - lib/submodules/ably-ruby/lib/ably.rb
+- lib/submodules/ably-ruby/lib/ably/agent.rb
 - lib/submodules/ably-ruby/lib/ably/auth.rb
 - lib/submodules/ably-ruby/lib/ably/exceptions.rb
 - lib/submodules/ably-ruby/lib/ably/logger.rb
 - lib/submodules/ably-ruby/lib/ably/models/auth_details.rb
+- lib/submodules/ably-ruby/lib/ably/models/channel_options.rb
 - lib/submodules/ably-ruby/lib/ably/models/channel_state_change.rb
 - lib/submodules/ably-ruby/lib/ably/models/cipher_params.rb
 - lib/submodules/ably-ruby/lib/ably/models/connection_details.rb
 - lib/submodules/ably-ruby/lib/ably/models/connection_state_change.rb
+- lib/submodules/ably-ruby/lib/ably/models/delta_extras.rb
 - lib/submodules/ably-ruby/lib/ably/models/device_details.rb
 - lib/submodules/ably-ruby/lib/ably/models/device_push_details.rb
 - lib/submodules/ably-ruby/lib/ably/models/error_info.rb
@@ -404,6 +408,7 @@ files:
 - lib/submodules/ably-ruby/spec/acceptance/rest/push_spec.rb
 - lib/submodules/ably-ruby/spec/acceptance/rest/stats_spec.rb
 - lib/submodules/ably-ruby/spec/acceptance/rest/time_spec.rb
+- lib/submodules/ably-ruby/spec/lib/unit/models/channel_options_spec.rb
 - lib/submodules/ably-ruby/spec/rspec_config.rb
 - lib/submodules/ably-ruby/spec/run_parallel_tests
 - lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb
@@ -430,6 +435,7 @@ files:
 - lib/submodules/ably-ruby/spec/unit/models/cipher_params_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/connection_details_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/connection_state_change_spec.rb
+- lib/submodules/ably-ruby/spec/unit/models/delta_extras_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/device_details_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/device_push_details_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/error_info_spec.rb
@@ -472,6 +478,7 @@ files:
 - spec/acceptance/rest_spec.rb
 - spec/spec_helper.rb
 - spec/unit/base_spec.rb
+- spec/unit/client_spec.rb
 - spec/unit/models_spec.rb
 - spec/unit/modules_spec.rb
 - spec/unit/rest_spec.rb
@@ -495,7 +502,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A Ruby REST only client library for ably.io realtime messaging
@@ -503,6 +510,7 @@ test_files:
 - spec/acceptance/rest_spec.rb
 - spec/spec_helper.rb
 - spec/unit/base_spec.rb
+- spec/unit/client_spec.rb
 - spec/unit/models_spec.rb
 - spec/unit/modules_spec.rb
 - spec/unit/rest_spec.rb