ably 1.1.2 → 1.1.6

data/spec/acceptance/rest/push_admin_spec.rb

@@ -89,31 +89,15 @@ describe Ably::Rest::Push::Admin do
           end
         end
 
-        def request_body(request, protocol)
-          if protocol == :msgpack
-            MessagePack.unpack(request.body)
-          else
-            JSON.parse(request.body)
-          end
-        end
-
-        def serialize(object, protocol)
-          if protocol == :msgpack
-            MessagePack.pack(object)
-          else
-            JSON.dump(object)
-          end
-        end
-
         let!(:publish_stub) do
           stub_request(:post, "#{client.endpoint}/push/publish").
             with do |request|
-              expect(request_body(request, protocol)['recipient']['camelCase']['secondLevelCamelCase']).to eql('val')
-              expect(request_body(request, protocol)['recipient']).to_not have_key('camel_case')
+              expect(deserialize_body(request.body, protocol)['recipient']['camelCase']['secondLevelCamelCase']).to eql('val')
+              expect(deserialize_body(request.body, protocol)['recipient']).to_not have_key('camel_case')
               true
             end.to_return(
               :status => 201,
-              :body => serialize({}, protocol),
+              :body => serialize_body({}, protocol),
               :headers => { 'Content-Type' => content_type }
             )
         end

data/spec/shared/client_initializer_behaviour.rb

@@ -69,14 +69,6 @@ shared_examples 'a client initializer' do
         expect { subject }.to raise_error(ArgumentError, /key and key_name or key_secret are mutually exclusive/)
       end
     end
-
-    context 'client_id as only option' do
-      let(:client_options) { { client_id: 'valid' } }
-
-      it 'requires a valid key' do
-        expect { subject }.to raise_error(ArgumentError, /client_id cannot be provided without a complete API key or means to authenticate/)
-      end
-    end
   end
 
   context 'with valid arguments' do
@@ -273,6 +265,137 @@ shared_examples 'a client initializer' do
         end
       end
     end
+
+    context 'environment' do
+      context 'when set without custom fallback hosts configured' do
+        let(:environment) { 'foo' }
+        let(:client_options) { default_options.merge(environment: environment) }
+        let(:default_fallbacks) { %w(a b c d e).map { |id| "#{environment}-#{id}-fallback.ably-realtime.com" } }
+
+        it 'sets the environment attribute' do
+          expect(subject.environment).to eql(environment)
+        end
+
+        it 'uses the default fallback hosts (#TBC, see https://github.com/ably/wiki/issues/361)' do
+          expect(subject.fallback_hosts.sort).to eql(default_fallbacks)
+        end
+      end
+
+      context 'when set with custom fallback hosts configured' do
+        let(:environment) { 'foo' }
+        let(:custom_fallbacks) { %w(a b c).map { |id| "#{environment}-#{id}.foo.com" } }
+        let(:client_options) { default_options.merge(environment: environment, fallback_hosts: custom_fallbacks) }
+
+        it 'sets the environment attribute' do
+          expect(subject.environment).to eql(environment)
+        end
+
+        it 'uses the custom provided fallback hosts (#RSC15a)' do
+          expect(subject.fallback_hosts.sort).to eql(custom_fallbacks)
+        end
+      end
+
+      context 'when set with fallback_hosts_use_default' do
+        let(:environment) { 'foo' }
+        let(:custom_fallbacks) { %w(a b c).map { |id| "#{environment}-#{id}.foo.com" } }
+        let(:default_production_fallbacks) { %w(a b c d e).map { |id| "#{id}.ably-realtime.com" } }
+        let(:client_options) { default_options.merge(environment: environment, fallback_hosts_use_default: true) }
+
+        it 'sets the environment attribute' do
+          expect(subject.environment).to eql(environment)
+        end
+
+        it 'uses the production default fallback hosts (#RTN17b)' do
+          expect(subject.fallback_hosts.sort).to eql(default_production_fallbacks)
+        end
+      end
+    end
+
+    context 'rest_host' do
+      context 'when set without custom fallback hosts configured' do
+        let(:custom_rest_host) { 'foo.com' }
+        let(:client_options) { default_options.merge(rest_host: custom_rest_host) }
+
+        it 'sets the custom_host attribute' do
+          expect(subject.custom_host).to eql(custom_rest_host)
+        end
+
+        it 'has no default fallback hosts' do
+          expect(subject.fallback_hosts).to be_empty
+        end
+      end
+
+      context 'when set with environment and without custom fallback hosts configured' do
+        let(:environment) { 'foobar' }
+        let(:custom_rest_host) { 'foo.com' }
+        let(:client_options) { default_options.merge(environment: environment, rest_host: custom_rest_host) }
+
+        it 'sets the environment attribute' do
+          expect(subject.environment).to eql(environment)
+        end
+
+        it 'sets the custom_host attribute' do
+          expect(subject.custom_host).to eql(custom_rest_host)
+        end
+
+        it 'has no default fallback hosts' do
+          expect(subject.fallback_hosts).to be_empty
+        end
+      end
+
+      context 'when set with custom fallback hosts configured' do
+        let(:custom_rest_host) { 'foo.com' }
+        let(:custom_fallbacks) { %w(a b c).map { |id| "#{environment}-#{id}.foo.com" } }
+        let(:client_options) { default_options.merge(rest_host: custom_rest_host, fallback_hosts: custom_fallbacks) }
+
+        it 'sets the custom_host attribute' do
+          expect(subject.custom_host).to eql(custom_rest_host)
+        end
+
+        it 'has no default fallback hosts' do
+          expect(subject.fallback_hosts.sort).to eql(custom_fallbacks)
+        end
+      end
+    end
+
+    context 'realtime_host' do
+      context 'when set without custom fallback hosts configured' do
+        let(:custom_realtime_host) { 'realtime.foo.com' }
+        let(:client_options) { default_options.merge(realtime_host: custom_realtime_host) }
+
+        # These tests are shared between realtime & rest clients
+        # So don't test for the attribute, instead test the options
+        it 'sets the realtime_host option' do
+          expect(subject.options[:realtime_host]).to eql(custom_realtime_host)
+        end
+
+        it 'has no default fallback hosts' do
+          expect(subject.fallback_hosts).to be_empty
+        end
+      end
+    end
+
+    context 'custom port' do
+      context 'when set without custom fallback hosts configured' do
+        let(:custom_port) { 555 }
+        let(:client_options) { default_options.merge(port: custom_port) }
+
+        it 'has no default fallback hosts' do
+          expect(subject.fallback_hosts).to be_empty
+        end
+      end
+    end
+
+    context 'custom TLS port' do
+      context 'when set without custom fallback hosts configured' do
+        let(:custom_port) { 555 }
+        let(:client_options) { default_options.merge(tls_port: custom_port) }
+
+        it 'has no default fallback hosts' do
+          expect(subject.fallback_hosts).to be_empty
+        end
+      end
+    end
   end
 
   context 'delegators' do

data/spec/spec_helper.rb

@@ -19,6 +19,7 @@ require 'support/event_emitter_helper'
 require 'support/private_api_formatter'
 require 'support/protocol_helper'
 require 'support/random_helper'
+require 'support/serialization_helper'
 require 'support/test_logger_helper'
 
 require 'rspec_config'

data/spec/support/serialization_helper.rb

@@ -0,0 +1,21 @@
+module SerializationHelper
+  def serialize_body(object, protocol)
+    if protocol == :msgpack
+      MessagePack.pack(object)
+    else
+      JSON.dump(object)
+    end
+  end
+
+  def deserialize_body(object, protocol)
+    if protocol == :msgpack
+      MessagePack.unpack(object)
+    else
+      JSON.parse(object)
+    end
+  end
+
+  RSpec.configure do |config|
+    config.include self
+  end
+end

data/spec/support/test_app.rb

@@ -4,11 +4,11 @@ class TestApp
   TEST_RESOURCES_PATH = File.expand_path('../../../lib/submodules/ably-common/test-resources', __FILE__)
 
   # App configuration for test app
-  # See https://github.com/ably/ably-common/blob/master/test-resources/test-app-setup.json
+  # See https://github.com/ably/ably-common/blob/main/test-resources/test-app-setup.json
   APP_SPEC = JSON.parse(File.read(File.join(TEST_RESOURCES_PATH, 'test-app-setup.json')))['post_apps']
 
   # Cipher details used for client_encoded presence data in test app
-  # See https://github.com/ably/ably-common/blob/master/test-resources/test-app-setup.json
+  # See https://github.com/ably/ably-common/blob/main/test-resources/test-app-setup.json
   APP_SPEC_CIPHER = JSON.parse(File.read(File.join(TEST_RESOURCES_PATH, 'test-app-setup.json')))['cipher']
 
   # If an app has already been created and we need a new app, create a new test app

data/spec/unit/realtime/client_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 require 'shared/client_initializer_behaviour'
 
 describe Ably::Realtime::Client do
-  subject do
+  subject(:realtime_client) do
     Ably::Realtime::Client.new(client_options)
   end
 
@@ -15,28 +15,41 @@ describe Ably::Realtime::Client do
     it 'passes on the options to the initializer' do
       rest_client = instance_double('Ably::Rest::Client', auth: instance_double('Ably::Auth'), options: client_options, environment: 'production', use_tls?: true, custom_tls_port: nil)
       expect(Ably::Rest::Client).to receive(:new).with(hash_including(client_options)).and_return(rest_client)
-      subject
+      realtime_client
     end
 
     context 'for attribute' do
       [:environment, :use_tls?, :log_level, :custom_host].each do |attribute|
         specify "##{attribute}" do
-          expect(subject.rest_client).to receive(attribute)
-          subject.public_send attribute
+          expect(realtime_client.rest_client).to receive(attribute)
+          realtime_client.public_send attribute
         end
       end
     end
   end
 
+  context 'when :transport_params option is passed' do
+    let(:expected_transport_params) do
+      { 'heartbeats' => 'true', 'v' => '1.0', 'extra_param' => 'extra_param' }
+    end
+    let(:client_options) do
+      { key: 'appid.keyuid:keysecret', transport_params: { heartbeats: true, v: 1.0, extra_param: 'extra_param'} }
+    end
+
+    it 'converts options to strings' do
+      expect(realtime_client.transport_params).to eq(expected_transport_params)
+    end
+  end
+
   context 'push' do
     let(:client_options) { { key: 'appid.keyuid:keysecret' } }
 
     specify '#device is not supported and raises an exception' do
-      expect { subject.device }.to raise_error Ably::Exceptions::PushNotificationsNotSupported
+      expect { realtime_client.device }.to raise_error Ably::Exceptions::PushNotificationsNotSupported
     end
 
     specify '#push returns a Push object' do
-      expect(subject.push).to be_a(Ably::Realtime::Push)
+      expect(realtime_client.push).to be_a(Ably::Realtime::Push)
     end
   end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ably
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.6
 platform: ruby
 authors:
 - Lewis Marshall
 - Matthew O'Riordan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-06 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -45,42 +45,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '7.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '7.4'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        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
@@ -241,14 +241,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -314,13 +314,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/check.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
+- COPYRIGHT
 - Gemfile
 - LICENSE
+- MAINTAINERS.md
 - README.md
 - Rakefile
 - SPEC.md
@@ -377,6 +379,7 @@ files:
 - lib/ably/realtime/auth.rb
 - lib/ably/realtime/channel.rb
 - lib/ably/realtime/channel/channel_manager.rb
+- lib/ably/realtime/channel/channel_properties.rb
 - lib/ably/realtime/channel/channel_state_machine.rb
 - lib/ably/realtime/channel/publisher.rb
 - lib/ably/realtime/channel/push_channel.rb
@@ -460,6 +463,7 @@ files:
 - spec/support/protocol_helper.rb
 - spec/support/random_helper.rb
 - spec/support/rest_testapp_before_retry.rb
+- spec/support/serialization_helper.rb
 - spec/support/test_app.rb
 - spec/support/test_logger_helper.rb
 - spec/unit/auth_spec.rb
@@ -512,7 +516,7 @@ homepage: http://github.com/ably/ably-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -528,7 +532,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Ruby client library for ably.io realtime messaging implemented using EventMachine
 test_files:
@@ -574,6 +578,7 @@ test_files:
 - spec/support/protocol_helper.rb
 - spec/support/random_helper.rb
 - spec/support/rest_testapp_before_retry.rb
+- spec/support/serialization_helper.rb
 - spec/support/test_app.rb
 - spec/support/test_logger_helper.rb
 - spec/unit/auth_spec.rb

data/.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=