ably 1.1.4.rc → 1.1.4

data/spec/acceptance/rest/client_spec.rb

@@ -12,7 +12,7 @@ describe Ably::Rest::Client do
     http_defaults = Ably::Rest::Client::HTTP_DEFAULTS
 
     def encode64(text)
-      Base64.encode64(text).gsub("\n", '')
+      Base64.urlsafe_encode64(text)
     end
 
     context '#initialize' do
@@ -56,14 +56,6 @@ describe Ably::Rest::Client do
         end
       end
 
-      context 'with a :client_id configured' do
-        let(:client) { Ably::Rest::Client.new(client_options.merge(key: api_key, client_id: random_str)) }
-
-        it 'uses token authentication' do
-          expect(client.auth).to be_using_token_auth
-        end
-      end
-
       context 'with a non string :client_id' do
         let(:client) { Ably::Rest::Client.new(client_options.merge(key: api_key, client_id: 1)) }
 
@@ -144,11 +136,12 @@ describe Ably::Rest::Client do
         let(:history_querystring) { history_params.map { |k, v| "#{k}=#{v}" }.join("&") }
 
         context 'with basic auth', webmock: true do
-          let(:client_options)      { default_options.merge(key: api_key) }
+          let(:client_options)      { default_options.merge(key: api_key, client_id: client_id) }
 
           let!(:get_message_history_stub) do
-            stub_request(:get, "https://#{environment}-#{Ably::Rest::Client::DOMAIN}/channels/#{channel_name}/messages?#{history_querystring}").
-              to_return(body: [], headers: { 'Content-Type' => 'application/json' })
+            stub_request(:get, "https://#{environment}-#{Ably::Rest::Client::DOMAIN}/channels/#{channel_name}/messages?#{history_querystring}")
+              .with(headers: { 'X-Ably-ClientId' => encode64(client_id) })
+              .to_return(body: [], headers: { 'Content-Type' => 'application/json' })
           end
 
           it 'sends the API key in authentication part of the secure URL (the Authorization: Basic header is not used with the Faraday HTTP library by default)' do
@@ -1091,6 +1084,8 @@ describe Ably::Rest::Client do
 
     context '#request (#RSC19*)' do
       let(:client_options) { default_options.merge(key: api_key) }
+      let(:device_id) { random_str }
+      let(:endpoint) { client.endpoint }
 
       context 'get' do
         it 'returns an HttpPaginatedResponse object' do
@@ -1130,6 +1125,71 @@ describe Ably::Rest::Client do
           end
         end
       end
+
+      context 'post', :webmock do
+        before do
+          stub_request(:delete, "#{endpoint}/push/deviceRegistrations/#{device_id}/resetUpdateToken").
+            to_return(status: 200, body: '{}', headers: { 'Content-Type' => 'application/json' })
+        end
+
+        it 'supports post' do
+          response = client.request(:delete, "push/deviceRegistrations/#{device_id}/resetUpdateToken")
+
+          expect(response).to be_success
+        end
+      end
+
+      context 'delete', :webmock do
+        before do
+          stub_request(:delete, "#{endpoint}/push/channelSubscriptions?deviceId=#{device_id}").
+            to_return(status: 200, body: '{}', headers: { 'Content-Type' => 'application/json' })
+        end
+
+        it 'supports delete' do
+          response = client.request(:delete, "/push/channelSubscriptions", { deviceId: device_id})
+
+          expect(response).to be_success
+        end
+      end
+
+      context 'patch', :webmock do
+        let(:body_params) { { 'metadata' => { 'key' => 'value' } } }
+
+        before do
+          stub_request(:patch, "#{endpoint}/push/deviceRegistrations/#{device_id}")
+            .with(body: serialize_body(body_params, protocol))
+            .to_return(status: 200, body: '{}', headers: { 'Content-Type' => 'application/json' })
+        end
+
+        it 'supports patch' do
+          response = client.request(:patch, "/push/deviceRegistrations/#{device_id}", {}, body_params)
+
+          expect(response).to be_success
+        end
+      end
+
+      context 'put', :webmock do
+        let(:body_params) do
+          {
+            'id' => random_str,
+            'platform' => 'ios',
+            'formFactor' => 'phone',
+            'metadata' => { 'key' => 'value' }
+          }
+        end
+
+        before do
+          stub_request(:put, "#{endpoint}/push/deviceRegistrations/#{device_id}")
+            .with(body: serialize_body(body_params, protocol))
+            .to_return(status: 200, body: '{}', headers: { 'Content-Type' => 'application/json' })
+        end
+
+        it 'supports put' do
+          response = client.request(:put, "/push/deviceRegistrations/#{device_id}", {}, body_params)
+
+          expect(response).to be_success
+        end
+      end
     end
 
     context 'request_id generation' do

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

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/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.4.rc
+  version: 1.1.4
 platform: ruby
 authors:
 - Lewis Marshall
 - Matthew O'Riordan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -45,42 +45,48 @@ 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: '1.0'
+        version: '0.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.55'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.55'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -143,14 +149,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '11.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '11.3'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -171,14 +177,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: rspec-retry
   requirement: !ruby/object:Gem::Requirement
@@ -225,30 +231,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     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 +320,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 +385,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 +469,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 +522,7 @@ homepage: http://github.com/ably/ably-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -523,12 +533,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      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 +584,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