ably 0.8.15 → 1.0.0

data/spec/acceptance/rest/presence_spec.rb

@@ -74,7 +74,6 @@ describe Ably::Rest::Presence do
           let!(:get_stub) {
             query_params = query_options.map { |k, v| "#{k}=#{v}" }.join('&')
             stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence?#{query_params}").
-              with(basic_auth: [key_name, key_secret]).
               to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
           }
           let(:channel_name) { random_str }
@@ -196,7 +195,6 @@ describe Ably::Rest::Presence do
           let!(:history_stub) {
             query_params = history_options.map { |k, v| "#{k}=#{v}" }.join('&')
             stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?#{query_params}").
-              with(basic_auth: [user, secret]).
               to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
           }
 
@@ -237,7 +235,6 @@ describe Ably::Rest::Presence do
               let!(:history_stub) {
                 query_params = history_options.map { |k, v| "#{k}=#{v}" }.join('&')
                 stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?#{query_params}").
-                  with(basic_auth: [user, secret]).
                   to_return(:body => '{}', :headers => { 'Content-Type' => 'application/json' })
               }
 
@@ -342,7 +339,6 @@ describe Ably::Rest::Presence do
         context '#get' do
           let!(:get_stub)   {
             stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence?limit=100").
-              with(basic_auth: [user, secret]).
               to_return(:body => serialized_encoded_message, :headers => { 'Content-Type' => content_type })
           }
 
@@ -360,7 +356,6 @@ describe Ably::Rest::Presence do
         context '#history' do
           let!(:history_stub)   {
             stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?direction=backwards&limit=100").
-              with(basic_auth: [user, secret]).
               to_return(:body => serialized_encoded_message, :headers => { 'Content-Type' => content_type })
           }
 
@@ -391,7 +386,6 @@ describe Ably::Rest::Presence do
           let(:client_options) { default_options.merge(log_level: :fatal) }
           let!(:get_stub)   {
             stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence?limit=100").
-              with(basic_auth: [user, secret]).
               to_return(:body => serialized_encoded_message_with_invalid_encoding, :headers => { 'Content-Type' => content_type })
           }
           let(:presence_message) { presence.get.items.first }
@@ -405,8 +399,8 @@ describe Ably::Rest::Presence do
           end
 
           it 'logs a cipher error' do
-            expect(client.logger).to receive(:error) do |message|
-              expect(message).to match(/Cipher algorithm [\w-]+ does not match/)
+            expect(client.logger).to receive(:error) do |*args, &block|
+              expect(args.concat([block ? block.call : nil]).join(',')).to match(/Cipher algorithm [\w-]+ does not match/)
             end
             presence.get
           end
@@ -416,7 +410,6 @@ describe Ably::Rest::Presence do
           let(:client_options) { default_options.merge(log_level: :fatal) }
           let!(:history_stub)   {
             stub_request(:get, "#{endpoint}/channels/#{Addressable::URI.encode(channel_name)}/presence/history?direction=backwards&limit=100").
-              with(basic_auth: [user, secret]).
               to_return(:body => serialized_encoded_message_with_invalid_encoding, :headers => { 'Content-Type' => content_type })
           }
           let(:presence_message) { presence.history.items.first }
@@ -430,8 +423,8 @@ describe Ably::Rest::Presence do
           end
 
           it 'logs a cipher error' do
-            expect(client.logger).to receive(:error) do |message|
-              expect(message).to match(/Cipher algorithm [\w-]+ does not match/)
+            expect(client.logger).to receive(:error) do |*args, &block|
+              expect(args.concat([block ? block.call : nil]).join(',')).to match(/Cipher algorithm [\w-]+ does not match/)
             end
             presence.history
           end

data/spec/rspec_config.rb

@@ -41,7 +41,7 @@ RSpec.configure do |config|
   end
 
   if defined?(EventMachine)
-    config.before(:example) do
+    config.before(:example, :event_machine) do
       # Ensure EventMachine shutdown hooks are deregistered for every test
       EventMachine.instance_variable_set '@tails', []
     end
@@ -52,6 +52,7 @@ RSpec.configure do |config|
   if ENV['RSPEC_RETRY']
     puts 'Running tests using RSpec retry'
     config.verbose_retry = true # show retry status in spec process
+    config.display_try_failure_messages = true # show exception that triggered the try
     config.default_retry_count = 3
     config.default_sleep_interval = 2
   end

data/spec/shared/client_initializer_behaviour.rb

@@ -154,9 +154,9 @@ shared_examples 'a client initializer' do
     end
 
     context 'with token_params' do
-      let(:client_options) { { token_params: { ttl: 777, client_id: 'john' }, token: 'token', auto_connect: false } }
+      let(:client_options) { { default_token_params: { ttl: 777, client_id: 'john' }, token: 'token', auto_connect: false } }
 
-      it 'configures the default token_params' do
+      it 'configures default_token_params' do
         expect(subject.auth.token_params.fetch(:ttl)).to eql(777)
         expect(subject.auth.token_params.fetch(:client_id)).to eql('john')
       end

data/spec/shared/safe_deferrable_behaviour.rb

@@ -20,7 +20,9 @@ shared_examples 'a safe Deferrable' do
     end
 
     it 'catches exceptions in the callback and logs the error to the logger' do
-      expect(subject.send(:logger)).to receive(:error).with(/#{exception.message}/)
+      expect(subject.send(:logger)).to receive(:error) do |*args, &block|
+        expect(args.concat([block ? block.call : nil]).join(',')).to match(/#{exception.message}/)
+      end
       subject.errback do
         raise exception
       end
@@ -49,7 +51,9 @@ shared_examples 'a safe Deferrable' do
     end
 
     it 'catches exceptions in the callback and logs the error to the logger' do
-      expect(subject.send(:logger)).to receive(:error).with(/#{exception.message}/)
+      expect(subject.send(:logger)).to receive(:error) do |*args, &block|
+        expect(args.concat([block ? block.call : nil]).join(',')).to match(/#{exception.message}/)
+      end
       subject.callback do
         raise exception
       end

data/spec/spec_helper.rb

@@ -4,8 +4,10 @@ def console(message)
   puts "\033[31m[#{Time.now.strftime('%H:%M:%S.%L')}]\033[0m \033[33m#{message}\033[0m"
 end
 
-require 'coveralls'
-Coveralls.wear!
+unless RUBY_VERSION.match(/^1/)
+  require 'coveralls'
+  Coveralls.wear!
+end
 
 require 'webmock/rspec'
 

data/spec/support/debug_failure_helper.rb

@@ -1,15 +1,31 @@
 RSpec.configure do |config|
-  config.before(:example) do
+  config.before(:example) do |example|
+    next if example.metadata[:prevent_log_stubbing]
+
     @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)
+      allow_any_instance_of(Ably::Logger).to receive(method_name.to_sym).and_wrap_original do |method, *args, &block|
+        # Don't log shutdown sequence to keep log noise to a minimum
+        next if RSpec.const_defined?(:EventMachine) && RSpec::EventMachine.reactor_stopping?
+
+        prefix = "#{Time.now.strftime('%H:%M:%S.%L')} [\e[33m#{method_name}\e[0m] "
+
+        begin
+          args << block.call unless block.nil?
+          @log_output << "#{prefix}#{args.compact.join(' ')}"
+        rescue StandardError => e
+          @log_output << "#{prefix}Failed to log block - #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}}"
+        end
+
+        # Call original
+        method.call(*args, &block)
       end
     end
   end
 
   config.after(:example) do |example|
+    next if example.metadata[:prevent_log_stubbing]
+
     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

data/spec/support/event_machine_helper.rb

@@ -9,6 +9,8 @@ module RSpec
     DEFAULT_TIMEOUT = 15
 
     def run_reactor(timeout = DEFAULT_TIMEOUT)
+      @reactor_stopping = false
+
       Timeout::timeout(timeout + 0.5) do
         ::EventMachine.run do
           yield
@@ -16,7 +18,13 @@ module RSpec
       end
     end
 
+    def reactor_stopping?
+      @reactor_stopping
+    end
+
     def stop_reactor
+      mark_reactor_stopping
+
       unless realtime_clients.empty?
         realtime_clients.shift.tap do |client|
           # Ensure close appens outside of the caller as this can cause errbacks on Deferrables
@@ -45,6 +53,10 @@ module RSpec
       @realtime_clients ||= []
     end
 
+    def mark_reactor_stopping
+      @reactor_stopping = true
+    end
+
     # Allows multiple Deferrables to be passed in and calls the provided block when
     # all success callbacks have completed
     def when_all(*deferrables)
@@ -123,8 +135,27 @@ RSpec.configure do |config|
     example.run
   end
 
-  config.before(:example) do
+  config.before(:example, :event_machine) do
     # Ensure EventMachine shutdown hooks are deregistered for every test
     EventMachine.instance_variable_set '@tails', []
   end
 end
+
+module RSpec
+  module Expectations
+    module ExpectationHelper
+      class << self
+        # This is very hacky and ties into the internals of RSpec which is likely to break in future versions
+        # However, this is just a convenience to reduce log noise when the reactor is stopping
+        # i.e. debug_failure_helper logs the verbose messages generated by the libraries, however it also often
+        # catches all the shutdown messages which is unnecessary
+        alias_method :orig_handle_failure, :handle_failure
+
+        def handle_failure(*args, &block)
+          RSpec::EventMachine.mark_reactor_stopping
+          orig_handle_failure(*args, &block)
+        end
+      end
+    end
+  end
+end

data/spec/unit/auth_spec.rb

@@ -68,19 +68,12 @@ describe Ably::Auth do
   end
 
   context 'defaults' do
-    let(:one_hour)          { 60 * 60 }
-    let(:all_capabilities)  { { "*" => ["*"] } }
-
-    it 'should default TTL to 1 hour' do
-      expect(Ably::Auth::TOKEN_DEFAULTS.fetch(:ttl)).to eql(one_hour)
-    end
-
-    it 'should default capability to all' do
-      expect(Ably::Auth::TOKEN_DEFAULTS.fetch(:capability)).to eql(all_capabilities)
+    it 'should have no default TTL' do
+      expect(Ably::Auth::TOKEN_DEFAULTS[:ttl]).to be_nil
     end
 
-    it 'should have defaults for :ttl and :capability' do
-      expect(Ably::Auth::TOKEN_DEFAULTS.keys).to include(:ttl, :capability)
+    it 'should have no default capability' do
+      expect(Ably::Auth::TOKEN_DEFAULTS[:capability]).to be_nil
     end
   end
 end

data/spec/unit/logger_spec.rb

@@ -18,7 +18,9 @@ describe Ably::Logger do
 
   context 'internals', :api_private do
     it 'delegates to the logger object' do
-      expect(subject.logger).to receive(:warn).with('message')
+      expect(subject.logger).to receive(:warn) do |*args, &block|
+        expect(args.concat([block ? block.call : nil]).join(',')).to match(/message/)
+      end
       subject.warn 'message'
     end
 
@@ -138,9 +140,33 @@ describe Ably::Logger do
       end
 
       it 'delegates log messages to logger', :api_private do
-        expect(custom_logger_object).to receive(:fatal).with('message')
+        expect(custom_logger_object).to receive(:fatal) do |*args, &block|
+          expect(args.concat([block ? block.call : nil]).join(',')).to match(/message/)
+        end
         subject.fatal 'message'
       end
     end
   end
+
+  context 'with blocks', :prevent_log_stubbing do
+    it 'does not call the block unless the log level is met' do
+      log_level_blocks = []
+      subject.warn { log_level_blocks << :warn }
+      subject.info { log_level_blocks << :info }
+      subject.debug { log_level_blocks << :debug }
+      expect(log_level_blocks).to contain_exactly(:warn, :info)
+    end
+
+    context 'with an exception in the logger block' do
+      before do
+        expect(subject.logger).to receive(:error) do |*args, &block|
+        expect(args.concat([block ? block.call : nil]).join(',')).to match(/Raise an error in the block/)
+        end
+      end
+
+      it 'catches the error and continues' do
+        subject.info { raise "Raise an error in the block" }
+      end
+    end
+  end
 end

data/spec/unit/models/auth_details_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'shared/model_behaviour'
+
+describe Ably::Models::AuthDetails do
+  include Ably::Modules::Conversions
+
+  subject { Ably::Models::AuthDetails }
+
+  # Spec model items AD2*
+  it_behaves_like 'a model', with_simple_attributes: %w(access_token) do
+    let(:model_args) { [] }
+  end
+
+  context '==' do
+    let(:attributes) { { access_token: 'unique' } }
+
+    it 'is true when attributes are the same' do
+      auth_details = -> { Ably::Models::AuthDetails.new(attributes) }
+      expect(auth_details.call).to eq(auth_details.call)
+    end
+
+    it 'is false when attributes are not the same' do
+      expect(Ably::Models::AuthDetails.new(access_token: '1')).to_not eq(Ably::Models::AuthDetails.new(access_token: '2'))
+    end
+
+    it 'is false when class type differs' do
+      expect(Ably::Models::AuthDetails.new(access_token: '1')).to_not eq(nil)
+    end
+  end
+
+  context 'AuthDetails conversion methods', :api_private do
+    context 'with a AuthDetails object' do
+      let(:details) { Ably::Models::AuthDetails.new(access_token: random_str) }
+
+      it 'returns the AuthDetails object' do
+        expect(Ably::Models::AuthDetails(details)).to eql(details)
+      end
+    end
+
+    context 'with a JSON object' do
+      let(:access_token) { random_str }
+      let(:details_json) { { access_token: access_token } }
+
+      it 'returns a new AuthDetails object from the JSON' do
+        expect(Ably::Models::AuthDetails(details_json).access_token).to eql(access_token)
+      end
+    end
+  end
+end

data/spec/unit/models/channel_state_change_spec.rb

@@ -6,7 +6,7 @@ describe Ably::Models::ChannelStateChange do
 
   subject { Ably::Models::ChannelStateChange }
 
-  context '#current' do
+  context '#current (#TH1)' do
     it 'is required' do
       expect { subject.new(previous: true) }.to raise_error ArgumentError
     end
@@ -16,7 +16,7 @@ describe Ably::Models::ChannelStateChange do
     end
   end
 
-  context '#previous' do
+  context '#previous (#TH2)' do
     it 'is required' do
       expect { subject.new(current: true) }.to raise_error ArgumentError
     end
@@ -26,7 +26,17 @@ describe Ably::Models::ChannelStateChange do
     end
   end
 
-  context '#reason' do
+  context '#event (#TH5)' do
+    it 'is not required' do
+      expect { subject.new(previous: true, current: true) }.to_not raise_error
+    end
+
+    it 'is an attribute' do
+      expect(subject.new(event: unique, previous: unique, current: true).event).to eql(unique)
+    end
+  end
+
+  context '#reason (#TH3)' do
     it 'is not required' do
       expect { subject.new(previous: true, current: true) }.to_not raise_error
     end
@@ -36,6 +46,16 @@ describe Ably::Models::ChannelStateChange do
     end
   end
 
+  context '#resumed (#TH4)' do
+    it 'is false when ommitted' do
+      expect(subject.new(previous: true, current: true).resumed).to be_falsey
+    end
+
+    it 'is true when provided' do
+      expect(subject.new(previous: true, current: true, resumed: true).resumed).to be_truthy
+    end
+  end
+
   context 'invalid attributes' do
     it 'raises an argument error' do
       expect { subject.new(invalid: true, current: true, previous: true) }.to raise_error ArgumentError

data/spec/unit/models/connection_details_spec.rb

@@ -6,6 +6,7 @@ describe Ably::Models::ConnectionDetails do
 
   subject { Ably::Models::ConnectionDetails }
 
+  # Spec model items CD2*
   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
@@ -13,13 +14,23 @@ describe Ably::Models::ConnectionDetails do
   context 'attributes' do
     let(:connection_state_ttl_ms) { 5_000 }
 
-    context '#connection_state_ttl' do
+    context '#connection_state_ttl (#CD2f)' 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
+
+    let(:max_idle_interval) { 6_000 }
+
+    context '#max_idle_interval (#CD2h)' do
+      subject { Ably::Models::ConnectionDetails.new({ max_idle_interval: max_idle_interval }) }
+
+      it 'retrieves attribute :max_idle_interval and converts it from ms to s' do
+        expect(subject.max_idle_interval).to eql(max_idle_interval / 1000)
+      end
+    end
   end
 
   context '==' do