ably 1.1.8 → 1.2.2

data/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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.2.2
 platform: ruby
 authors:
 - Lewis Marshall
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-15 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -45,28 +45,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
+- !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: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -171,14 +185,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rspec-retry
   requirement: !ruby/object:Gem::Requirement
@@ -283,14 +311,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -319,6 +347,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.8.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 client library for ably.io realtime messaging
 email:
 - lewis@lmars.net
@@ -340,6 +382,7 @@ files:
 - README.md
 - Rakefile
 - SPEC.md
+- UPDATING.md
 - ably.gemspec
 - lib/ably.rb
 - lib/ably/agent.rb
@@ -347,7 +390,12 @@ files:
 - lib/ably/exceptions.rb
 - lib/ably/logger.rb
 - lib/ably/models/auth_details.rb
+- lib/ably/models/channel_details.rb
+- lib/ably/models/channel_metrics.rb
+- lib/ably/models/channel_occupancy.rb
+- lib/ably/models/channel_options.rb
 - lib/ably/models/channel_state_change.rb
+- lib/ably/models/channel_status.rb
 - lib/ably/models/cipher_params.rb
 - lib/ably/models/connection_details.rb
 - lib/ably/models/connection_state_change.rb
@@ -463,6 +511,7 @@ files:
 - 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
 - spec/rspec_config.rb
 - spec/run_parallel_tests
 - spec/shared/client_initializer_behaviour.rb
@@ -485,7 +534,11 @@ files:
 - spec/unit/auth_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/models/auth_details_spec.rb
+- spec/unit/models/channel_details_spec.rb
+- spec/unit/models/channel_metrics_spec.rb
+- spec/unit/models/channel_occupancy_spec.rb
 - spec/unit/models/channel_state_change_spec.rb
+- spec/unit/models/channel_status_spec.rb
 - spec/unit/models/cipher_params_spec.rb
 - spec/unit/models/connection_details_spec.rb
 - spec/unit/models/connection_state_change_spec.rb
@@ -548,7 +601,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.14
 signing_key:
 specification_version: 4
 summary: A Ruby client library for ably.io realtime messaging implemented using EventMachine
@@ -579,6 +632,7 @@ test_files:
 - 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
 - spec/rspec_config.rb
 - spec/run_parallel_tests
 - spec/shared/client_initializer_behaviour.rb
@@ -601,7 +655,11 @@ test_files:
 - spec/unit/auth_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/models/auth_details_spec.rb
+- spec/unit/models/channel_details_spec.rb
+- spec/unit/models/channel_metrics_spec.rb
+- spec/unit/models/channel_occupancy_spec.rb
 - spec/unit/models/channel_state_change_spec.rb
+- spec/unit/models/channel_status_spec.rb
 - spec/unit/models/cipher_params_spec.rb
 - spec/unit/models/connection_details_spec.rb
 - spec/unit/models/connection_state_change_spec.rb