ably-rest 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 006c13b2408ff07c78159727a7e0bbd1a2eea9ab
-  data.tar.gz: 691848a554d61eb6c785cc7515f169e36bed8241
+  metadata.gz: 610101b34de5bd5283cda560a5aff2d115842529
+  data.tar.gz: 499b0a8ec74ab12356b7e8e94330f13283670458
 SHA512:
-  metadata.gz: 5ef3a684409bf54433d1c81b76da2555e6aa885dc547e4c11c8e4e94f24adf25c56cc84a2613f5d8b11c03294126a5b03b826a6a744820e1765b7eb4433eebf5
-  data.tar.gz: 562e4212388a59f3b53e699ff1933a1d02563b3c62af75370919c8dba10b984013e43a38bc73a33b364fe65952537d02d96eb77b30953e2c1df9d81382caf7fa
+  metadata.gz: 650f6502ebfd7dd5f3183cb1bb42f98be067145859a4e3d39a692e1abb38c3dbf18cd0b363a6d21a586321c04288900c63b914625e5a082436e9f8c8220c1bdd
+  data.tar.gz: f5926a4f1d213782974e1c5cd79ac4cb12c6dac941eafb7d8de2a6f49cc6c9e25b4e028de177d6da4ee40ba230d1d0062b8bda289b39d437f9015600c9c56d54

data/ably-rest.gemspec

@@ -48,7 +48,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'webmock', '~> 2.0'
 
-  unless RUBY_VERSION.match(/^1/)
+  if RUBY_VERSION.match(/^1/)
+    spec.add_development_dependency 'public_suffix', '~> 1.4.6' # Later versions do not support Ruby 1.9
+  else
+    spec.add_development_dependency 'coveralls'
     spec.add_development_dependency 'pry'
     spec.add_development_dependency 'pry-byebug'
   end

data/lib/submodules/ably-ruby/ably.gemspec

@@ -40,11 +40,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'webmock', '~> 2.0'
 
-  unless RUBY_VERSION.match(/^1/)
+  if RUBY_VERSION.match(/^1/)
+    spec.add_development_dependency 'public_suffix', '~> 1.4.6' # Later versions do not support Ruby 1.9
+  else
     spec.add_development_dependency 'coveralls'
-  end
-
-  unless RUBY_VERSION.match(/^1/)
     spec.add_development_dependency 'pry'
     spec.add_development_dependency 'pry-byebug'
   end

data/lib/submodules/ably-ruby/lib/ably/models/message_encoders/base.rb

@@ -96,7 +96,8 @@ module Ably::Models::MessageEncoders
   end
 
   # @api private
-  def self.register_default_encoders(client, binary_protocol: false)
+  def self.register_default_encoders(client, options = {})
+    binary_protocol = !!options[:binary_protocol]
     client.register_encoder Ably::Models::MessageEncoders::Utf8
     client.register_encoder Ably::Models::MessageEncoders::Json
     client.register_encoder Ably::Models::MessageEncoders::Cipher

data/lib/submodules/ably-ruby/lib/ably/modules/event_emitter.rb

@@ -50,18 +50,14 @@ module Ably
       #
       # @return [void]
       def on(*event_names, &block)
-        event_names.each do |event_name|
-          callbacks[callbacks_event_coerced(event_name)] << proc_for_block(block)
-        end
+        add_callback event_names, proc_for_block(block)
       end
 
       # Equivalent of {#on} but any exception raised in a block will bubble up and cause this client library to fail.
       # This method should only be used internally by the client library.
       # @api private
       def unsafe_on(*event_names, &block)
-        event_names.each do |event_name|
-          callbacks[callbacks_event_coerced(event_name)] << proc_for_block(block, unsafe: true)
-        end
+        add_callback event_names, proc_for_block(block, unsafe: true)
       end
 
       # On receiving an event maching the event_name, call the provided block only once and remove the registered callback
@@ -70,24 +66,20 @@ module Ably
       #
       # @return [void]
       def once(*event_names, &block)
-        event_names.each do |event_name|
-          callbacks[callbacks_event_coerced(event_name)] << proc_for_block(block, delete_once_run: true)
-        end
+        add_callback event_names, proc_for_block(block, delete_once_run: true)
       end
 
       # Equivalent of {#once} but any exception raised in a block will bubble up and cause this client library to fail.
       # This method should only be used internally by the client library.
       # @api private
       def unsafe_once(*event_names, &block)
-        event_names.each do |event_name|
-          callbacks[callbacks_event_coerced(event_name)] << proc_for_block(block, delete_once_run: true, unsafe: true)
-        end
+        add_callback event_names, proc_for_block(block, delete_once_run: true, unsafe: true)
       end
 
       # Emit an event with event_name that will in turn call all matching callbacks setup with `on`
       def emit(event_name, *args)
-        callbacks[callbacks_event_coerced(event_name)].
-          clone.
+        [callbacks_any, callbacks[callbacks_event_coerced(event_name)]].each do |callback_arr|
+          callback_arr.clone.
           select do |proc_hash|
             if proc_hash[:unsafe]
               proc_hash[:emit_proc].call(*args)
@@ -95,8 +87,9 @@ module Ably
               safe_yield proc_hash[:emit_proc], *args
             end
           end.each do |callback|
-            callbacks[callbacks_event_coerced(event_name)].delete callback
+            callback_arr.delete callback
           end
+        end
       end
 
       # Remove all callbacks for event_name.
@@ -121,6 +114,14 @@ module Ably
             callbacks[callbacks_event_coerced(event_name)].clear
           end
         end
+
+        if event_names.empty?
+          if block_given?
+            callbacks_any.delete_if { |proc_hash| proc_hash[:block] == block }
+          else
+            callbacks_any.clear
+          end
+        end
       end
 
       private
@@ -128,6 +129,16 @@ module Ably
         klass.extend ClassMethods
       end
 
+      def add_callback(event_names, proc_block)
+        if event_names.empty?
+          callbacks_any << proc_block
+        else
+          event_names.each do |event_name|
+            callbacks[callbacks_event_coerced(event_name)] << proc_block
+          end
+        end
+      end
+
       # Create a Hash with a proc that calls the provided block and returns true if option :delete_once_run is set to true.
       # #emit automatically deletes any blocks that return true thus allowing a block to be run once
       def proc_for_block(block, options = {})
@@ -145,6 +156,10 @@ module Ably
         @callbacks ||= Hash.new { |hash, key| hash[key] = [] }
       end
 
+      def callbacks_any
+        @callbacks_any ||= []
+      end
+
       def callbacks_event_coerced(event_name)
         if self.class.event_emitter_coerce_proc
           self.class.event_emitter_coerce_proc.call(event_name)

data/lib/submodules/ably-ruby/lib/ably/realtime/client.rb

@@ -1,3 +1,5 @@
+require 'uri'
+
 module Ably
   module Realtime
     # Client for the Ably Realtime API
@@ -68,6 +70,9 @@ module Ably
       #
       # @param (see Ably::Rest::Client#initialize)
       # @option options (see Ably::Rest::Client#initialize)
+      # @option options [Proc]                    :auth_callback       when provided, the Proc will be called with the token params hash as the first argument, whenever a new token is required.
+      #                                                                Whilst the proc is called synchronously, it does not block the EventMachine reactor as it is run in a separate thread.
+      #                                                                The Proc should return a token string, {Ably::Models::TokenDetails} or JSON equivalent, {Ably::Models::TokenRequest} or JSON equivalent
       # @option options [Boolean] :queue_messages If false, this disables the default behaviour whereby the library queues messages on a connection in the disconnected or connecting states
       # @option options [Boolean] :echo_messages  If false, prevents messages originating from this connection being echoed back on the same connection
       # @option options [String]  :recover        When a recover option is specified a connection inherits the state of a previous connection that may have existed under a different instance of the Realtime library, please refer to the API documentation for further information on connection state recovery

data/lib/submodules/ably-ruby/lib/ably/rest.rb

@@ -3,12 +3,12 @@ require 'ably/rest/channels'
 require 'ably/rest/client'
 require 'ably/rest/presence'
 
+require 'ably/models/message_encoders/base'
+
 Dir.glob(File.expand_path("models/*.rb", File.dirname(__FILE__))).each do |file|
   require file
 end
 
-require 'ably/models/message_encoders/base'
-
 module Ably
   # Rest provides the top-level class to be instanced for the Ably Rest library
   #

data/lib/submodules/ably-ruby/lib/ably/rest/client.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 require 'json'
 require 'logger'
+require 'uri'
 
 require 'ably/rest/middleware/exceptions'
 

data/lib/submodules/ably-ruby/lib/ably/version.rb

@@ -1,5 +1,5 @@
 module Ably
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
   PROTOCOL_VERSION = '0.9'
 
   # Allow a variant to be configured for all instances of this client library

data/lib/submodules/ably-ruby/spec/acceptance/realtime/auth_spec.rb

@@ -186,6 +186,35 @@ describe Ably::Realtime::Auth, :event_machine do
           end
         end
 
+        context 'with auth_callback blocking' do
+          let(:rest_auth_client) { Ably::Rest::Client.new(default_options.merge(key: api_key)) }
+          let(:client_options)   { default_options.merge(auth_callback: auth_callback) }
+          let(:pause)            { 5 }
+
+          context 'with a slow auth callback response' do
+            let(:auth_callback) do
+              Proc.new do
+                sleep pause
+                rest_auth_client.auth.request_token
+              end
+            end
+
+            it 'asynchronously authenticates' do
+              timers_called = 0
+              block = Proc.new do
+                timers_called += 1
+                EventMachine.add_timer(0.5, &block)
+              end
+              block.call
+              client.connect
+              client.connection.on(:connected) do
+                expect(timers_called).to be >= (pause-1) / 0.5
+                stop_reactor
+              end
+            end
+          end
+        end
+
         context 'when implicitly called, with an explicit ClientOptions client_id' do
           let(:client_id)        { random_str }
           let(:client_options)   { default_options.merge(auth_callback: Proc.new { auth_token_object }, client_id: client_id, log_level: :none) }

data/lib/submodules/ably-ruby/spec/acceptance/realtime/connection_spec.rb

@@ -1278,6 +1278,22 @@ describe Ably::Realtime::Connection, :event_machine do
     end
 
     context 'connection state change' do
+      # See https://github.com/ably/ably-ruby/issues/103
+      it 'emits event to all and single subscribers' do
+        connected_emitted = []
+        block = Proc.new do |state_change|
+          if state_change.current == :connected
+            connected_emitted << state_change
+            EventMachine.add_timer(0.5) do
+              expect(connected_emitted.length).to eql(2)
+              stop_reactor
+            end
+          end
+        end
+        connection.on(&block)
+        connection.on(:connected, &block)
+      end
+
       it 'emits a ConnectionStateChange object' do
         connection.on(:connected) do |connection_state_change|
           expect(connection_state_change).to be_a(Ably::Models::ConnectionStateChange)

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

@@ -128,17 +128,34 @@ describe Ably::Modules::EventEmitter do
   end
 
   context '#on' do
-    it 'calls the block every time an event is emitted only' do
-      block_called = 0
-      subject.on('event') { block_called += 1 }
-      3.times { subject.emit 'event', 'data' }
-      expect(block_called).to eql(3)
+    context 'with event specified' do
+      it 'calls the block every time an event is emitted only' do
+        block_called = 0
+        subject.on('event') { block_called += 1 }
+        3.times { subject.emit 'event', 'data' }
+        expect(block_called).to eql(3)
+      end
+
+      it 'catches exceptions in the provided block, logs the error and continues' do
+        expect(subject.logger).to receive(:error).with(/Intentional exception/)
+        subject.on(:event) { raise 'Intentional exception' }
+        subject.emit :event
+      end
     end
 
-    it 'catches exceptions in the provided block, logs the error and continues' do
-      expect(subject.logger).to receive(:error).with(/Intentional exception/)
-      subject.on(:event) { raise 'Intentional exception' }
-      subject.emit :event
+    context 'with no event specified' do
+      it 'calls the block every time an event is emitted only' do
+        block_called = 0
+        subject.on { block_called += 1 }
+        3.times { subject.emit 'event', 'data' }
+        expect(block_called).to eql(3)
+      end
+
+      it 'catches exceptions in the provided block, logs the error and continues' do
+        expect(subject.logger).to receive(:error).with(/Intentional exception/)
+        subject.on { raise 'Intentional exception' }
+        subject.emit :event
+      end
     end
   end
 
@@ -157,25 +174,50 @@ describe Ably::Modules::EventEmitter do
   end
 
   context '#once' do
-    it 'calls the block the first time an event is emitted only' do
-      block_called = 0
-      subject.once('event') { block_called += 1 }
-      3.times { subject.emit 'event', 'data' }
-      expect(block_called).to eql(1)
-    end
+    context 'with event specified' do
+      it 'calls the block the first time an event is emitted only' do
+        block_called = 0
+        subject.once('event') { block_called += 1 }
+        3.times { subject.emit 'event', 'data' }
+        expect(block_called).to eql(1)
+      end
 
-    it 'does not remove other blocks after it is called' do
-      block_called = 0
-      subject.once('event') { block_called += 1 }
-      subject.on('event')   { block_called += 1 }
-      3.times { subject.emit 'event', 'data' }
-      expect(block_called).to eql(4)
+      it 'does not remove other blocks after it is called' do
+        block_called = 0
+        subject.once('event') { block_called += 1 }
+        subject.on('event')   { block_called += 1 }
+        3.times { subject.emit 'event', 'data' }
+        expect(block_called).to eql(4)
+      end
+
+      it 'catches exceptions in the provided block, logs the error and continues' do
+        expect(subject.logger).to receive(:error).with(/Intentional exception/)
+        subject.once(:event) { raise 'Intentional exception' }
+        subject.emit :event
+      end
     end
 
-    it 'catches exceptions in the provided block, logs the error and continues' do
-      expect(subject.logger).to receive(:error).with(/Intentional exception/)
-      subject.once(:event) { raise 'Intentional exception' }
-      subject.emit :event
+    context 'with no event specified' do
+      it 'calls the block the first time an event is emitted only' do
+        block_called = 0
+        subject.once { block_called += 1 }
+        3.times { subject.emit 'event', 'data' }
+        expect(block_called).to eql(1)
+      end
+
+      it 'does not remove other blocks after it is called' do
+        block_called = 0
+        subject.once { block_called += 1 }
+        subject.on   { block_called += 1 }
+        3.times { subject.emit 'event', 'data' }
+        expect(block_called).to eql(4)
+      end
+
+      it 'catches exceptions in the provided block, logs the error and continues' do
+        expect(subject.logger).to receive(:error).with(/Intentional exception/)
+        subject.once { raise 'Intentional exception' }
+        subject.emit :event
+      end
     end
   end
 
@@ -196,41 +238,57 @@ describe Ably::Modules::EventEmitter do
   context '#off' do
     let(:callback) { Proc.new { |msg| obj.received_message msg } }
 
-    before do
-      subject.on(:message, &callback)
-    end
-
-    after do
-      subject.emit :message, msg
-    end
+    context 'with event specified in on handler' do
+      before do
+        subject.on(:message, &callback)
+      end
 
-    context 'with event names as arguments' do
-      it 'deletes matching callbacks' do
-        expect(obj).to_not receive(:received_message).with(msg)
-        subject.off(:message, &callback)
+      after do
+        subject.emit :message, msg
       end
 
-      it 'deletes all callbacks if not block given' do
-        expect(obj).to_not receive(:received_message).with(msg)
-        subject.off(:message)
+      context 'with event names as arguments' do
+        it 'deletes matching callbacks' do
+          expect(obj).to_not receive(:received_message).with(msg)
+          subject.off(:message, &callback)
+        end
+
+        it 'deletes all callbacks if not block given' do
+          expect(obj).to_not receive(:received_message).with(msg)
+          subject.off(:message)
+        end
+
+        it 'continues if the block does not exist' do
+          expect(obj).to receive(:received_message).with(msg)
+          subject.off(:message) { true }
+        end
       end
 
-      it 'continues if the block does not exist' do
-        expect(obj).to receive(:received_message).with(msg)
-        subject.off(:message) { true }
+      context 'without any event names' do
+        it 'deletes all matching callbacks' do
+          expect(obj).to_not receive(:received_message).with(msg)
+          subject.off(&callback)
+        end
+
+        it 'deletes all callbacks if not block given' do
+          expect(obj).to_not receive(:received_message).with(msg)
+          subject.off
+        end
       end
     end
 
-    context 'without any event names' do
-      it 'deletes all matching callbacks' do
-        expect(obj).to_not receive(:received_message).with(msg)
-        subject.off(&callback)
-      end
+    it 'removes handler added with no event specified' do
+      subject.on(&callback)
+      expect(obj).to_not receive(:received_message).with(msg)
+      subject.off(&callback)
+      subject.emit :message, msg
+    end
 
-      it 'deletes all callbacks if not block given' do
-        expect(obj).to_not receive(:received_message).with(msg)
-        subject.off
-      end
+    it 'leaves handler when event specified' do
+      subject.on(&callback)
+      expect(obj).to receive(:received_message).with(msg)
+      subject.off(:foo, &callback)
+      subject.emit :message, msg
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ably-rest
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement