ably-rest 0.8.5 → 0.8.6

data/lib/submodules/ably-ruby/spec/acceptance/rest/presence_spec.rb

@@ -76,7 +76,7 @@ describe Ably::Rest::Presence do
           end
           let!(:get_stub) {
             query_params = query_options.map { |k, v| "#{k}=#{v}" }.join('&')
-            stub_request(:get, "#{endpoint}/channels/#{CGI.escape(channel_name)}/presence?#{query_params}").
+            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence?#{query_params}").
               to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
           }
           let(:channel_name) { random_str }
@@ -200,7 +200,7 @@ describe Ably::Rest::Presence do
         context 'limit options', :webmock do
           let!(:history_stub) {
             query_params = history_options.map { |k, v| "#{k}=#{v}" }.join('&')
-            stub_request(:get, "#{endpoint}/channels/#{CGI.escape(channel_name)}/presence/history?#{query_params}").
+            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?#{query_params}").
               to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
           }
 
@@ -240,7 +240,7 @@ describe Ably::Rest::Presence do
               }
               let!(:history_stub) {
                 query_params = history_options.map { |k, v| "#{k}=#{v}" }.join('&')
-                stub_request(:get, "#{endpoint}/channels/#{CGI.escape(channel_name)}/presence/history?#{query_params}").
+                stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?#{query_params}").
                   to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
               }
 
@@ -347,7 +347,7 @@ describe Ably::Rest::Presence do
 
         context '#get' do
           let!(:get_stub)   {
-            stub_request(:get, "#{endpoint}/channels/#{CGI.escape(channel_name)}/presence?limit=100").
+            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence?limit=100").
               to_return(:body => serialized_encoded_message, :headers => { 'Content-Type' => content_type })
           }
 
@@ -364,7 +364,7 @@ describe Ably::Rest::Presence do
 
         context '#history' do
           let!(:history_stub)   {
-            stub_request(:get, "#{endpoint}/channels/#{CGI.escape(channel_name)}/presence/history?direction=backwards&limit=100").
+            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?direction=backwards&limit=100").
               to_return(:body => serialized_encoded_message, :headers => { 'Content-Type' => content_type })
           }
 
@@ -394,7 +394,7 @@ describe Ably::Rest::Presence do
         context '#get' do
           let(:client_options) { default_options.merge(log_level: :fatal) }
           let!(:get_stub)   {
-            stub_request(:get, "#{endpoint}/channels/#{CGI.escape(channel_name)}/presence?limit=100").
+            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence?limit=100").
               to_return(:body => serialized_encoded_message_with_invalid_encoding, :headers => { 'Content-Type' => content_type })
           }
           let(:presence_message) { presence.get.items.first }
@@ -418,7 +418,7 @@ describe Ably::Rest::Presence do
         context '#history' do
           let(:client_options) { default_options.merge(log_level: :fatal) }
           let!(:history_stub)   {
-            stub_request(:get, "#{endpoint}/channels/#{CGI.escape(channel_name)}/presence/history?direction=backwards&limit=100").
+            stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?direction=backwards&limit=100").
               to_return(:body => serialized_encoded_message_with_invalid_encoding, :headers => { 'Content-Type' => content_type })
           }
           let(:presence_message) { presence.history.items.first }

data/lib/submodules/ably-ruby/spec/acceptance/rest/time_spec.rb

@@ -10,6 +10,16 @@ describe Ably::Rest::Client, '#time' do
       it 'should return the service time as a Time object' do
         expect(client.time).to be_within(2).of(Time.now)
       end
+
+      context 'with reconfigured HTTP timeout' do
+        let(:client) do
+          Ably::Rest::Client.new(http_request_timeout: 0.0001, key: api_key, environment: environment, protocol: protocol)
+        end
+
+        it 'should raise a timeout exception' do
+          expect { client.time }.to raise_error Ably::Exceptions::ConnectionTimeout
+        end
+      end
     end
   end
 end

data/lib/submodules/ably-ruby/spec/shared/client_initializer_behaviour.rb

@@ -74,13 +74,13 @@ shared_examples 'a client initializer' 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/)
+        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
-    let(:default_options) { { key: 'appid.keyuid:keysecret' } }
+    let(:default_options) { { key: 'appid.keyuid:keysecret', auto_connect: false } }
     let(:client_options)  { default_options }
 
     context 'key only' do
@@ -94,7 +94,7 @@ shared_examples 'a client initializer' do
     end
 
     context 'key_name and key_secret', api_private: true do
-      let(:client_options) { { key_name: 'id', key_secret: 'secret' } }
+      let(:client_options) { { key_name: 'id', key_secret: 'secret', auto_connect: false } }
 
       it 'constructs a key' do
         expect(subject.auth.key).to eql('id:secret')
@@ -102,6 +102,10 @@ shared_examples 'a client initializer' do
     end
 
     context 'with a string key instead of options hash' do
+      before do
+        allow_any_instance_of(subject.class).to receive(:auto_connect).and_return(false)
+      end
+
       let(:client_options) { 'app.key:secret' }
 
       it 'sets the key' do
@@ -122,31 +126,35 @@ shared_examples 'a client initializer' do
     end
 
     context 'with a string token key instead of options hash' do
+      before do
+        allow_any_instance_of(subject.class).to receive(:auto_connect).and_return(false)
+      end
+
       let(:client_options) { 'app.kjhkasjhdsakdh127g7g1271' }
 
       it 'sets the token' do
-        expect(subject.auth.token).to eql(client_options)
+        expect(subject.auth.current_token_details.token).to eql(client_options)
       end
     end
 
     context 'with token' do
-      let(:client_options) { { token: 'token' } }
+      let(:client_options) { { token: 'token', auth_connect: false } }
 
       it 'sets the token' do
-        expect(subject.auth.token).to eql('token')
+        expect(subject.auth.current_token_details.token).to eql('token')
       end
     end
 
     context 'with token_details' do
-      let(:client_options) { { token_details: Ably::Models::TokenDetails.new(token: 'token') } }
+      let(:client_options) { { token_details: Ably::Models::TokenDetails.new(token: 'token'), auto_connect: false } }
 
       it 'sets the token' do
-        expect(subject.auth.token).to eql('token')
+        expect(subject.auth.current_token_details.token).to eql('token')
       end
     end
 
     context 'with token_params' do
-      let(:client_options) { { token_params: { ttl: 777, client_id: 'john' }, token: 'token' } }
+      let(:client_options) { { token_params: { ttl: 777, client_id: 'john' }, token: 'token', auto_connect: false } }
 
       it 'configures the default token_params' do
         expect(subject.auth.token_params.fetch(:ttl)).to eql(777)
@@ -155,12 +163,16 @@ shared_examples 'a client initializer' do
     end
 
     context 'endpoint' do
+      before do
+        allow_any_instance_of(subject.class).to receive(:auto_connect).and_return(false)
+      end
+
       it 'defaults to production' do
         expect(subject.endpoint.to_s).to eql("#{protocol}s://#{subdomain}.ably.io")
       end
 
       context 'with environment option' do
-        let(:client_options) { default_options.merge(environment: 'sandbox') }
+        let(:client_options) { default_options.merge(environment: 'sandbox', auto_connect: false) }
 
         it 'uses an alternate endpoint' do
           expect(subject.endpoint.to_s).to eql("#{protocol}s://sandbox-#{subdomain}.ably.io")
@@ -168,7 +180,7 @@ shared_examples 'a client initializer' do
       end
 
       context 'with rest_host option' do
-        let(:client_options) { default_options.merge(rest_host: 'custom-rest.host.com') }
+        let(:client_options) { default_options.merge(rest_host: 'custom-rest.host.com', auto_connect: false) }
 
         it 'uses an alternate endpoint for REST clients' do
           skip 'does not apply as testing a Realtime client' unless rest?
@@ -177,7 +189,7 @@ shared_examples 'a client initializer' do
       end
 
       context 'with realtime_host option' do
-        let(:client_options) { default_options.merge(realtime_host: 'custom-realtime.host.com') }
+        let(:client_options) { default_options.merge(realtime_host: 'custom-realtime.host.com', auto_connect: false) }
 
         it 'uses an alternate endpoint for Realtime clients' do
           skip 'does not apply as testing a REST client' if rest?
@@ -186,7 +198,7 @@ shared_examples 'a client initializer' do
       end
 
       context 'with port option and non-TLS connections' do
-        let(:client_options) { default_options.merge(port: 999, tls: false) }
+        let(:client_options) { default_options.merge(port: 999, tls: false, auto_connect: false) }
 
         it 'uses the custom port for non-TLS requests' do
           expect(subject.endpoint.to_s).to include(":999")
@@ -194,7 +206,7 @@ shared_examples 'a client initializer' do
       end
 
       context 'with tls_port option and a TLS connection' do
-        let(:client_options) { default_options.merge(tls_port: 666, tls: true) }
+        let(:client_options) { default_options.merge(tls_port: 666, tls: true, auto_connect: false) }
 
         it 'uses the custom port for TLS requests' do
           expect(subject.endpoint.to_s).to include(":666")
@@ -203,8 +215,12 @@ shared_examples 'a client initializer' do
     end
 
     context 'tls' do
+      before do
+        allow_any_instance_of(subject.class).to receive(:auto_connect).and_return(false)
+      end
+
       context 'set to false' do
-        let(:client_options) { default_options.merge(tls: false) }
+        let(:client_options) { default_options.merge(tls: false, auto_connect: false) }
 
         it 'uses plain text' do
           expect(subject.use_tls?).to eql(false)
@@ -221,6 +237,10 @@ shared_examples 'a client initializer' do
     end
 
     context 'logger' do
+      before do
+        allow_any_instance_of(subject.class).to receive(:auto_connect).and_return(false)
+      end
+
       context 'default' do
         it 'uses Ruby Logger' do
           expect(subject.logger.logger).to be_a(::Logger)
@@ -232,7 +252,7 @@ shared_examples 'a client initializer' do
       end
 
       context 'with log_level :none' do
-        let(:client_options) { default_options.merge(log_level: :none) }
+        let(:client_options) { default_options.merge(log_level: :none, auto_connect: false) }
 
         it 'silences all logging with a NilLogger' do
           expect(subject.logger.logger.class).to eql(Ably::Models::NilLogger)
@@ -250,7 +270,7 @@ shared_examples 'a client initializer' do
             def_delegators :@logger, :fatal, :error, :warn, :info, :debug, :level, :level=
           end
         end
-        let(:client_options) { default_options.merge(logger: custom_logger.new, log_level: Logger::DEBUG) }
+        let(:client_options) { default_options.merge(logger: custom_logger.new, log_level: Logger::DEBUG, auto_connect: false) }
 
         it 'uses the custom logger' do
           expect(subject.logger.logger.class).to eql(custom_logger)
@@ -264,6 +284,10 @@ shared_examples 'a client initializer' do
   end
 
   context 'delegators' do
+    before do
+      allow_any_instance_of(subject.class).to receive(:auto_connect).and_return(false)
+    end
+
     let(:client_options) { 'app.key:secret' }
 
     it 'delegates :client_id to .auth' do

data/lib/submodules/ably-ruby/spec/spec_helper.rb

@@ -12,6 +12,7 @@ require 'webmock/rspec'
 require 'ably'
 
 require 'support/api_helper'
+require 'support/debug_failure_helper'
 require 'support/private_api_formatter'
 require 'support/protocol_helper'
 require 'support/random_helper'

data/lib/submodules/ably-ruby/spec/support/debug_failure_helper.rb

@@ -0,0 +1,16 @@
+RSpec.configure do |config|
+  config.before(:example) do
+    @log_output = []
+    %w(fatal error warn info debug).each do |method_name|
+      allow_any_instance_of(Ably::Logger).to receive(method_name.to_sym).and_wrap_original do |method, *args|
+        @log_output << "#{Time.now.strftime('%H:%M:%S.%L')} [\e[33m#{method_name}\e[0m] #{args[0]}"
+        method.call(*args)
+      end
+    end
+  end
+
+  config.after(:example) do |example|
+    exception = example.exception
+    puts "\n#{'-'*34}\n\e[36mVerbose Ably log from test failure\e[0m\n#{'-'*34}\n#{@log_output.join("\n")}\n\n" if exception
+  end
+end

data/lib/submodules/ably-ruby/spec/unit/models/connection_details_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::ConnectionDetails do
+  include Ably::Modules::Conversions
+
+  subject { Ably::Models::ConnectionDetails }
+
+  it_behaves_like 'a model', with_simple_attributes: %w(client_id connection_key max_message_size max_frame_size max_inbound_rate) do
+    let(:model_args) { [] }
+  end
+
+  context 'attributes' do
+    let(:connection_state_ttl_ms) { 5_000 }
+
+    context '#connection_state_ttl' do
+      subject { Ably::Models::ConnectionDetails.new({ connection_state_ttl: connection_state_ttl_ms }) }
+
+      it 'retrieves attribute :connection_state_ttl and converts it from ms to s' do
+        expect(subject.connection_state_ttl).to eql(connection_state_ttl_ms / 1000)
+      end
+    end
+  end
+
+  context '==' do
+    let(:attributes) { { client_id: 'unique' } }
+
+    it 'is true when attributes are the same' do
+      connection_details = -> { Ably::Models::ConnectionDetails.new(attributes) }
+      expect(connection_details.call).to eq(connection_details.call)
+    end
+
+    it 'is false when attributes are not the same' do
+      expect(Ably::Models::ConnectionDetails.new(client_id: '1')).to_not eq(Ably::Models::ConnectionDetails.new(client_id: '2'))
+    end
+
+    it 'is false when class type differs' do
+      expect(Ably::Models::ConnectionDetails.new(client_id: '1')).to_not eq(nil)
+    end
+  end
+
+  context 'ConnectionDetails conversion methods', :api_private do
+    context 'with a ConnectionDetails object' do
+      let(:details) { Ably::Models::ConnectionDetails.new(client_id: random_str) }
+
+      it 'returns the ConnectionDetails object' do
+        expect(Ably::Models::ConnectionDetails(details)).to eql(details)
+      end
+    end
+
+    context 'with a JSON object' do
+      let(:client_id) { random_str }
+      let(:details_json) { { client_id: client_id } }
+
+      it 'returns a new ConnectionDetails object from the JSON' do
+        expect(Ably::Models::ConnectionDetails(details_json).client_id).to eql(client_id)
+      end
+    end
+  end
+end

data/lib/submodules/ably-ruby/spec/unit/models/protocol_message_spec.rb

@@ -284,6 +284,51 @@ describe Ably::Models::ProtocolMessage do
         expect(protocol_message.presence.first.data).to eql('test')
       end
     end
+
+    context '#connection_details' do
+      let(:connection_details) { protocol_message.connection_details }
+
+      context 'with a JSON value' do
+        let(:protocol_message) { new_protocol_message(connectionDetails: { clientId: '1', connectionKey: 'key' }) }
+
+        it 'contains a ConnectionDetails object' do
+          expect(connection_details).to be_a(Ably::Models::ConnectionDetails)
+        end
+
+        it 'contains the attributes from the JSON connectionDetails' do
+          expect(connection_details.client_id).to eql('1')
+          expect(connection_details.connection_key).to eql('key')
+        end
+      end
+
+      context 'without a JSON value' do
+        let(:protocol_message) { new_protocol_message({}) }
+
+        it 'contains an empty ConnectionDetails object' do
+          expect(connection_details).to be_a(Ably::Models::ConnectionDetails)
+          expect(connection_details.client_id).to eql(nil)
+          expect(connection_details.connection_key).to eql(nil)
+        end
+      end
+    end
+
+    context '#connection_key' do
+      context 'existing only in #connection_details.connection_key' do
+        let(:protocol_message) { new_protocol_message(connectionDetails: { connectionKey: 'key' }) }
+
+        it 'is returned' do
+          expect(protocol_message.connection_key).to eql('key')
+        end
+      end
+
+      context 'existing in both #connection_key and #connection_details.connection_key' do
+        let(:protocol_message) { new_protocol_message(connectionKey: 'deprecated', connectionDetails: { connectionKey: 'key' }) }
+
+        it 'returns #connection_details.connection_key as #connection_key will be deprecated > 0.8' do
+          expect(protocol_message.connection_key).to eql('key')
+        end
+      end
+    end
   end
 
   context '#to_json', :api_private do

data/lib/submodules/ably-ruby/spec/unit/modules/event_emitter_spec.rb

@@ -7,7 +7,9 @@ describe Ably::Modules::EventEmitter do
     Class.new do
       include Ably::Modules::EventEmitter
       configure_event_emitter callback_opts
-      def logger; end
+      def logger
+        @logger ||= Ably::Models::NilLogger.new
+      end
     end
   end
   let(:obj) { double('example') }

data/lib/submodules/ably-ruby/spec/unit/realtime/channel_spec.rb

@@ -68,9 +68,10 @@ describe Ably::Realtime::Channel do
 
   describe '#publish name argument' do
     let(:encoded_value) { random_str.encode(encoding) }
+    let(:message) { instance_double('Ably::Models::Message', client_id: nil) }
 
     before do
-      allow(subject).to receive(:create_message).and_return('message_stubbed')
+      allow(subject).to receive(:create_message).and_return(message)
       allow(subject).to receive(:attach).and_return(:true)
     end
 
@@ -78,7 +79,7 @@ describe Ably::Realtime::Channel do
       let(:encoding) { Encoding::UTF_8 }
 
       it 'is permitted' do
-        expect(subject.publish(encoded_value, 'data')).to eql('message_stubbed')
+        expect(subject.publish(encoded_value, 'data')).to eql(message)
       end
     end
 
@@ -86,7 +87,7 @@ describe Ably::Realtime::Channel do
       let(:encoding) { Encoding::SHIFT_JIS }
 
       it 'is permitted' do
-        expect(subject.publish(encoded_value, 'data')).to eql('message_stubbed')
+        expect(subject.publish(encoded_value, 'data')).to eql(message)
       end
     end
 
@@ -94,7 +95,7 @@ describe Ably::Realtime::Channel do
       let(:encoding) { Encoding::ASCII_8BIT }
 
       it 'is permitted' do
-        expect(subject.publish(encoded_value, 'data')).to eql('message_stubbed')
+        expect(subject.publish(encoded_value, 'data')).to eql(message)
       end
     end
 
@@ -110,7 +111,7 @@ describe Ably::Realtime::Channel do
       let(:encoded_value) { nil }
 
       it 'is permitted' do
-        expect(subject.publish(encoded_value, 'data')).to eql('message_stubbed')
+        expect(subject.publish(encoded_value, 'data')).to eql(message)
       end
     end
   end