ably 0.8.7 → 0.8.8

data/lib/ably/modules/enum.rb

@@ -90,7 +90,13 @@ module Ably::Modules
           end
 
           private
-          attr_reader :by_index, :by_symbol
+          def by_index
+            @by_index
+          end
+
+          def by_symbol
+            @by_symbol
+          end
 
           # Define constants for each of the Enum values
           # e.g. define_constants(:dog) creates Enum::Dog
@@ -173,7 +179,17 @@ module Ably::Modules
         end
 
         private
-        attr_reader :name, :index, :symbol
+        def name
+          @name
+        end
+
+        def index
+          @index
+        end
+
+        def symbol
+          @symbol
+        end
 
         define_values values
       end

data/lib/ably/modules/event_emitter.rb

@@ -39,7 +39,7 @@ module Ably
 
         # Ensure @event_emitter_coerce_proc option is passed down to any classes that inherit the class with callbacks
         def inherited(subclass)
-          subclass.instance_variable_set('@event_emitter_coerce_proc', @event_emitter_coerce_proc)
+          subclass.instance_variable_set('@event_emitter_coerce_proc', @event_emitter_coerce_proc) if defined?(@event_emitter_coerce_proc)
           super
         end
       end
@@ -90,7 +90,7 @@ module Ably
           clone.
           select do |proc_hash|
             if proc_hash[:unsafe]
-              proc_hash[:emit_proc].call *args
+              proc_hash[:emit_proc].call(*args)
             else
               safe_yield proc_hash[:emit_proc], *args
             end
@@ -133,7 +133,7 @@ module Ably
       def proc_for_block(block, options = {})
         {
           emit_proc: Proc.new do |*args|
-            block.call *args
+            block.call(*args)
             true if options[:delete_once_run]
           end,
           block: block,

data/lib/ably/modules/safe_deferrable.rb

@@ -59,7 +59,7 @@ module Ably::Modules
 
     private
     def safe_deferrable_block(*args)
-      yield *args
+      yield(*args)
     rescue StandardError => e
       message = "An exception in a Deferrable callback was caught. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
       if defined?(:logger) && logger.respond_to?(:error)

data/lib/ably/modules/safe_yield.rb

@@ -13,7 +13,7 @@ module Ably::Modules
     private
 
     def safe_yield(block, *args)
-      block.call *args
+      block.call(*args)
     rescue StandardError => e
       message = "An exception in an external block was caught. #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}"
       safe_yield_log_error message
@@ -23,7 +23,7 @@ module Ably::Modules
       if defined?(:logger) && logger.respond_to?(:error)
         return logger.error message
       end
-    rescue StandardError => e
+    rescue StandardError
       fallback_logger.error message
     end
 

data/lib/ably/modules/state_emitter.rb

@@ -82,21 +82,21 @@ module Ably::Modules
 
         success_wrapper = Proc.new do
           yield
-          off &success_wrapper
-          off &failure_wrapper if failure_wrapper
+          off(&success_wrapper)
+          off(&failure_wrapper) if failure_wrapper
         end
 
         failure_wrapper = proc do |*args|
-          failure_block.call *args
-          off &success_wrapper
-          off &failure_wrapper
+          failure_block.call(*args)
+          off(&success_wrapper)
+          off(&failure_wrapper)
         end if failure_block
 
         Array(target_states).each do |target_state|
           safe_unsafe_method options[:unsafe], :once, target_state, &success_wrapper
 
           safe_unsafe_method options[:unsafe], :once_state_changed do |*args|
-            failure_wrapper.call *args unless state == target_state
+            failure_wrapper.call(*args) unless state == target_state
           end if failure_block
         end
       end
@@ -119,8 +119,8 @@ module Ably::Modules
       raise ArgumentError, 'Block required' unless block_given?
 
       once_block = proc do |*args|
-        off *self.class::STATE.map, &once_block
-        yield *args
+        off(*self.class::STATE.map, &once_block)
+        yield(*args)
       end
 
       safe_unsafe_method options[:unsafe], :once, *self.class::STATE.map, &once_block

data/lib/ably/modules/statesman_monkey_patch.rb

@@ -5,7 +5,7 @@ module Ably::Modules
     # This can be removed once https://github.com/gocardless/statesman/issues/95 is solved
     def before_transition(options = nil, &block)
       arrayify_transition(options) do |options_without_from_array|
-        super *options_without_from_array, &block
+        super(*options_without_from_array, &block)
       end
     end
 
@@ -13,7 +13,7 @@ module Ably::Modules
     # This can be removed once https://github.com/gocardless/statesman/issues/95 is solved
     def after_transition(options = nil, &block)
       arrayify_transition(options) do |options_without_from_array|
-        super *options_without_from_array, &block
+        super(*options_without_from_array, &block)
       end
     end
 

data/lib/ably/modules/uses_state_machine.rb

@@ -59,7 +59,9 @@ module Ably::Modules
     def_delegators :state_machine, :can_transition_to?
 
     private
-    attr_reader :state_machine
+    def state_machine
+      @state_machine
+    end
 
     def_delegators :state_machine, :exception_for_state_change_to
 
@@ -85,7 +87,7 @@ module Ably::Modules
 
     module ClassMethods
       def emits_klass
-        @emits_klass ||= if @emits_klass_name
+        @emits_klass ||= if defined?(@emits_klass_name) && @emits_klass_name
           get_const(@emits_klass_name)
         end
       end

data/lib/ably/realtime.rb

@@ -1,5 +1,6 @@
 require 'eventmachine'
 require 'websocket/driver'
+require 'em-http-request'
 
 require 'ably/modules/event_emitter'
 

data/lib/ably/realtime/auth.rb

@@ -189,9 +189,13 @@ module Ably
       private
       # The synchronous Auth class instanced by the Rest client
       # @return [Ably::Auth]
-      attr_reader :auth_sync
+      def auth_sync
+        @auth_sync
+      end
 
-      attr_reader :client
+      def client
+        @client
+      end
     end
   end
 end

data/lib/ably/realtime/channel.rb

@@ -294,7 +294,9 @@ module Ably
       private :change_state
 
       private
-      attr_reader :queue
+      def queue
+        @queue
+      end
 
       def setup_event_handlers
         __incoming_msgbus__.subscribe(:message) do |message|
@@ -323,7 +325,7 @@ module Ably
           end
         end
 
-        queue.push *messages
+        queue.push(*messages)
 
         if attached?
           process_queue
@@ -385,8 +387,8 @@ module Ably
       end
 
       def create_message(message)
-        Ably::Models::Message(message.dup).tap do |message|
-          message.encode self
+        Ably::Models::Message(message.dup).tap do |msg|
+          msg.encode self
         end
       end
 

data/lib/ably/realtime/channel/channel_manager.rb

@@ -94,8 +94,14 @@ module Ably::Realtime
       end
 
       private
+      def channel
+        @channel
+      end
+
+      def connection
+        @connection
+      end
 
-      attr_reader :channel, :connection
       def_delegators :channel, :can_transition_to?
 
       # If the connection has not previously connected, connect now

data/lib/ably/realtime/client.rb

@@ -90,13 +90,13 @@ module Ably
         @auth                  = Ably::Realtime::Auth.new(self)
         @channels              = Ably::Realtime::Channels.new(self)
         @connection            = Ably::Realtime::Connection.new(self, options)
-        @echo_messages         = @rest_client.options.fetch(:echo_messages, true) == false ? false : true
-        @queue_messages        = @rest_client.options.fetch(:queue_messages, true) == false ? false : true
-        @custom_realtime_host  = @rest_client.options[:realtime_host] || @rest_client.options[:ws_host]
-        @auto_connect          = @rest_client.options.fetch(:auto_connect, true) == false ? false : true
-        @recover               = @rest_client.options[:recover]
+        @echo_messages         = rest_client.options.fetch(:echo_messages, true) == false ? false : true
+        @queue_messages        = rest_client.options.fetch(:queue_messages, true) == false ? false : true
+        @custom_realtime_host  = rest_client.options[:realtime_host] || rest_client.options[:ws_host]
+        @auto_connect          = rest_client.options.fetch(:auto_connect, true) == false ? false : true
+        @recover               = rest_client.options[:recover]
 
-        raise ArgumentError, "Recovery key is invalid" if @recover && !@recover.match(Connection::RECOVER_REGEX)
+        raise ArgumentError, "Recovery key '#{recover}' is invalid" if recover && !recover.match(Connection::RECOVER_REGEX)
       end
 
       # Return a {Ably::Realtime::Channel Realtime Channel} for the given name
@@ -150,11 +150,6 @@ module Ably
         endpoint_for_host(custom_realtime_host || [environment, DOMAIN].compact.join('-'))
       end
 
-
-      def connection
-        @connection
-      end
-
       # (see Ably::Rest::Client#register_encoder)
       def register_encoder(encoder)
         rest_client.register_encoder encoder
@@ -176,7 +171,7 @@ module Ably
       # @return [URI::Generic] Fallback endpoint used to connect to the realtime Ably service. Note, after each connection attempt, a new random {Ably::FALLBACK_HOSTS fallback host} is used
       # @api private
       def fallback_endpoint
-        unless @fallback_endpoints
+        unless defined?(@fallback_endpoints) && @fallback_endpoints
           @fallback_endpoints = Ably::FALLBACK_HOSTS.shuffle.map { |fallback_host| endpoint_for_host(fallback_host) }
         end
 

data/lib/ably/realtime/client/incoming_message_dispatcher.rb

@@ -13,7 +13,13 @@ module Ably::Realtime
       end
 
       private
-      attr_reader :client, :connection
+      def client
+        @client
+      end
+
+      def connection
+        @connection
+      end
 
       def channels
         client.channels
@@ -144,6 +150,7 @@ module Ably::Realtime
       def process_connected_message(protocol_message)
         if client.auth.token_client_id_allowed?(protocol_message.connection_details.client_id)
           client.auth.configure_client_id protocol_message.connection_details.client_id
+          client.connection.set_connection_details protocol_message.connection_details
           connection.transition_state_machine :connected, reason: protocol_message.error, protocol_message: protocol_message
         else
           reason = Ably::Exceptions::IncompatibleClientId.new("Client ID '#{protocol_message.connection_details.client_id}' specified by the server is incompatible with the library's configured client ID '#{client.client_id}'", 400, 40012)
@@ -195,7 +202,7 @@ module Ably::Realtime
 
       def subscribe_to_incoming_protocol_messages
         connection.__incoming_protocol_msgbus__.subscribe(:protocol_message) do |*args|
-          dispatch_protocol_message *args
+          dispatch_protocol_message(*args)
         end
       end
     end

data/lib/ably/realtime/client/outgoing_message_dispatcher.rb

@@ -17,7 +17,13 @@ module Ably::Realtime
       end
 
       private
-      attr_reader :client, :connection
+      def client
+        @client
+      end
+
+      def connection
+        @connection
+      end
 
       def can_send_messages?
         connection.connected? || connection.closing?

data/lib/ably/realtime/connection.rb

@@ -58,7 +58,7 @@ module Ably
       ensure_state_machine_emits 'Ably::Models::ConnectionStateChange'
 
       # Expected format for a connection recover key
-      RECOVER_REGEX = /^(?<recover>[\w-]+):(?<connection_serial>\-?\w+)$/
+      RECOVER_REGEX = /^(?<recover>[\w!-]+):(?<connection_serial>\-?\w+)$/
 
       # Defaults for automatic connection recovery and timeouts
       DEFAULTS = {
@@ -84,6 +84,10 @@ module Ably
       # @return [Ably::Models::ErrorInfo,Ably::Exceptions::BaseAblyException]
       attr_reader :error_reason
 
+      # Connection details of the currently established connection
+      # @return [Ably::Models::ConnectionDetails]
+      attr_reader :details
+
       # {Ably::Realtime::Client} associated with this connection
       # @return [Ably::Realtime::Client]
       attr_reader :client
@@ -178,12 +182,12 @@ module Ably
 
           once(:connected) do
             deferrable.succeed
-            off &fail_callback
+            off(&fail_callback)
           end
 
           once(:failed, :closed, :closing) do
             deferrable.fail
-            off &succeed_callback
+            off(&succeed_callback)
           end
         end
       end
@@ -356,10 +360,10 @@ module Ably
       # @api private
       def send_protocol_message(protocol_message)
         add_message_serial_if_ack_required_to(protocol_message) do
-          Ably::Models::ProtocolMessage.new(protocol_message, logger: logger).tap do |protocol_message|
-            add_message_to_outgoing_queue protocol_message
-            notify_message_dispatcher_of_new_message protocol_message
-            logger.debug("Connection: Prot msg queued =>: #{protocol_message.action} #{protocol_message}")
+          Ably::Models::ProtocolMessage.new(protocol_message, logger: logger).tap do |message|
+            add_message_to_outgoing_queue message
+            notify_message_dispatcher_of_new_message message
+            logger.debug("Connection: Prot msg queued =>: #{message.action} #{message}")
           end
         end
       end
@@ -437,6 +441,11 @@ module Ably
         @error_reason = nil
       end
 
+      # @api private
+      def set_connection_details(connection_details)
+        @details = connection_details
+      end
+
       # Executes registered callbacks for a successful connection resume event
       # @api private
       def resumed
@@ -476,7 +485,9 @@ module Ably
       # A connection serial guarantees the server has received the message and is thus used for connection
       # recovery and resumes.
       # @return [Integer] starting at -1 indicating no messages sent, 0 when the first message is sent
-      attr_reader :client_serial
+      def client_serial
+        @client_serial
+      end
 
       def resume_callbacks
         @resume_callbacks ||= []

data/lib/ably/realtime/connection/connection_manager.rb

@@ -1,3 +1,5 @@
+require 'ably/rest/middleware/exceptions'
+
 module Ably::Realtime
   class Connection
     # ConnectionManager is responsible for all actions relating to underlying connection and transports,
@@ -10,12 +12,13 @@ module Ably::Realtime
     class ConnectionManager
       # Error codes from the server that can potentially be resolved
       RESOLVABLE_ERROR_CODES = {
-        token_expired: 40140
+        token_expired: Ably::Rest::Middleware::Exceptions::TOKEN_EXPIRED_CODE
       }
 
       def initialize(connection)
-        @connection = connection
-        @timers     = Hash.new { |hash, key| hash[key] = [] }
+        @connection     = connection
+        @timers         = Hash.new { |hash, key| hash[key] = [] }
+        @renewing_token = false
 
         connection.unsafe_on(:closed) do
           connection.reset_resume_info
@@ -58,7 +61,7 @@ module Ably::Realtime
         end
 
         logger.debug "ConnectionManager: Setting up automatic connection timeout timer for #{realtime_request_timeout}s"
-        create_timeout_timer_whilst_in_state(:connect, realtime_request_timeout) do
+        create_timeout_timer_whilst_in_state(:connecting, realtime_request_timeout) do
           connection_opening_failed Ably::Exceptions::ConnectionTimeout.new("Connection to Ably timed out after #{realtime_request_timeout}s", nil, 80014)
         end
       end
@@ -123,7 +126,7 @@ module Ably::Realtime
       def close_connection
         connection.send_protocol_message(action: Ably::Models::ProtocolMessage::ACTION.Close)
 
-        create_timeout_timer_whilst_in_state(:close, realtime_request_timeout) do
+        create_timeout_timer_whilst_in_state(:closing, realtime_request_timeout) do
           force_close_connection if connection.closing?
         end
       end
@@ -153,7 +156,7 @@ module Ably::Realtime
         return unless can_retry_connection? # do not always reattempt connection or change state as client may be re-authorising
 
         if error.kind_of?(Ably::Models::ErrorInfo)
-          if error.code == RESOLVABLE_ERROR_CODES.fetch(:token_expired)
+          if RESOLVABLE_ERROR_CODES.fetch(:token_expired).include?(error.code)
             next_state = get_next_retry_state_info
             logger.debug "ConnectionManager: Transport disconnected because of token expiry, pausing #{next_state.fetch(:pause)}s before reattempting to connect"
             EventMachine.add_timer(next_state.fetch(:pause)) { renew_token_and_reconnect error }
@@ -181,7 +184,7 @@ module Ably::Realtime
           logger.debug "ConnectionManager: Transport disconnected whilst connection in #{connection.state} state"
         end
 
-        if error.kind_of?(Ably::Models::ErrorInfo) && error.code != RESOLVABLE_ERROR_CODES.fetch(:token_expired)
+        if error.kind_of?(Ably::Models::ErrorInfo) && !RESOLVABLE_ERROR_CODES.fetch(:token_expired).include?(error.code)
           connection.emit :error, error
           logger.error "ConnectionManager: Error in Disconnected ProtocolMessage received from the server - #{error}"
         end
@@ -213,11 +216,15 @@ module Ably::Realtime
       end
 
       private
-      attr_reader :connection
+      def connection
+        @connection
+      end
 
       # Timers used to manage connection state, for internal use by the client library
       # @return [Hash]
-      attr_reader :timers
+      def timers
+        @timers
+      end
 
       def transport
         connection.transport