ably-rest 1.1.2 → 1.2.2

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/spec_helper.rb

@@ -15,6 +15,11 @@ require 'support/private_api_formatter'
 require 'support/protocol_helper'
 require 'support/random_helper'
 require 'support/test_logger_helper'
+require 'support/serialization_helper'
+
+RSpec.configure do |config|
+  config.include SerializationHelper
+end
 
 # Load in all shared behaviours
 Dir.glob(File.expand_path("../lib/submodules/ably-ruby/spec/shared/*.rb", File.dirname(__FILE__))).each do |file|

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.2
+  version: 1.2.2
 platform: ruby
 authors:
 - Matthew O'Riordan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: excon
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.55'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: faraday-typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +84,16 @@ dependencies:
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.3'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +156,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: rspec-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 3.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 3.14.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -196,16 +224,16 @@ dependencies:
   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
@@ -220,6 +248,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
 description: A Ruby REST only client library for ably.io realtime messaging
 email:
 - matt@ably.io
@@ -235,6 +277,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
+- MAINTAINERS.md
 - README.md
 - Rakefile
 - SPEC.md
@@ -242,26 +285,36 @@ files:
 - lib/ably-rest.rb
 - lib/ably-rest/modules/eventmachine_deferrable.rb
 - lib/submodules/ably-ruby/.editorconfig
+- lib/submodules/ably-ruby/.github/workflows/check.yml
 - lib/submodules/ably-ruby/.gitignore
 - lib/submodules/ably-ruby/.gitmodules
 - lib/submodules/ably-ruby/.rspec
-- lib/submodules/ably-ruby/.travis.yml
 - lib/submodules/ably-ruby/CHANGELOG.md
+- lib/submodules/ably-ruby/COPYRIGHT
 - lib/submodules/ably-ruby/Gemfile
 - lib/submodules/ably-ruby/LICENSE
+- lib/submodules/ably-ruby/MAINTAINERS.md
 - 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_details.rb
+- lib/submodules/ably-ruby/lib/ably/models/channel_metrics.rb
+- lib/submodules/ably-ruby/lib/ably/models/channel_occupancy.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/channel_status.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
@@ -305,6 +358,7 @@ files:
 - lib/submodules/ably-ruby/lib/ably/realtime/auth.rb
 - lib/submodules/ably-ruby/lib/ably/realtime/channel.rb
 - lib/submodules/ably-ruby/lib/ably/realtime/channel/channel_manager.rb
+- lib/submodules/ably-ruby/lib/ably/realtime/channel/channel_properties.rb
 - lib/submodules/ably-ruby/lib/ably/realtime/channel/channel_state_machine.rb
 - lib/submodules/ably-ruby/lib/ably/realtime/channel/publisher.rb
 - lib/submodules/ably-ruby/lib/ably/realtime/channel/push_channel.rb
@@ -372,6 +426,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
@@ -388,15 +443,21 @@ files:
 - lib/submodules/ably-ruby/spec/support/protocol_helper.rb
 - lib/submodules/ably-ruby/spec/support/random_helper.rb
 - lib/submodules/ably-ruby/spec/support/rest_testapp_before_retry.rb
+- lib/submodules/ably-ruby/spec/support/serialization_helper.rb
 - lib/submodules/ably-ruby/spec/support/test_app.rb
 - lib/submodules/ably-ruby/spec/support/test_logger_helper.rb
 - lib/submodules/ably-ruby/spec/unit/auth_spec.rb
 - lib/submodules/ably-ruby/spec/unit/logger_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/auth_details_spec.rb
+- lib/submodules/ably-ruby/spec/unit/models/channel_details_spec.rb
+- lib/submodules/ably-ruby/spec/unit/models/channel_metrics_spec.rb
+- lib/submodules/ably-ruby/spec/unit/models/channel_occupancy_spec.rb
 - lib/submodules/ably-ruby/spec/unit/models/channel_state_change_spec.rb
+- lib/submodules/ably-ruby/spec/unit/models/channel_status_spec.rb
 - 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
@@ -439,6 +500,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
@@ -447,7 +509,7 @@ homepage: http://github.com/ably/ably-ruby-rest
 licenses:
 - Apache 2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -462,14 +524,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.14
+signing_key:
 specification_version: 4
 summary: A Ruby REST only client library for ably.io realtime messaging
 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

data/lib/submodules/ably-ruby/.travis.yml

@@ -1,19 +0,0 @@
-sudo: false
-env:
-  - RSPEC_RETRY=true PARALLEL_TEST_PROCESSORS=2 PROTOCOL=json
-  - RSPEC_RETRY=true PARALLEL_TEST_PROCESSORS=2 PROTOCOL=msgpack
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.1.10
-  - 2.2.10
-  - 2.3.8
-  - 2.5.5
-  - 2.6.0
-  - 2.6.1
-  - 2.6.2
-  - 2.6.3
-script: spec/run_parallel_tests
-notifications:
-  slack:
-    secure: Xe8MwDcV2C8XLGk6O6Co31LpQiRSxsmS7Toy5vM7rHds5fnVRBNn5iX6Q5mXMdLOlnsMhjKLt7zl4fsBOZv+siQ+Us0omZSIYpXCYSCIj8nofReF0Lj8M4oa6lFSL5OuygO7PH+wLKTRxQURGZ6Pi1nHU+RE5izRmsewQHkhtY0=