ably 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a4a37e1a1ac2bddad5dadd6b97b77dbc93acc76
-  data.tar.gz: 69ebb5298665efbf1ad4d9255b76cd8c581b27e5
+  metadata.gz: 85089829c198d66df277d8b4c675497c3632ed88
+  data.tar.gz: c6a05542c8c35adce99763b651290cb3e5fbf472
 SHA512:
-  metadata.gz: a0566f39324a88f7d00efea0292fd04af77b423581df8e920127a425b22328464035fc36f678fdebe40c2b4fb68b8f653e86c7b1a29ad14a0086f138acc582cb
-  data.tar.gz: ef77958e46559356a6db5929ec630c69ab1d398916e20d82c10a2836ef73d834fcc5020a8809a3f56f2efa44132bd58b77cdf385e804f51187ced597962be016
+  metadata.gz: b13264f6a68b29dcb4ccd0f7bc87af4df57cfb9d685bd7f87ebda5bef3c7679a437dd2ee5f967e0eb2385ab3659588784b32ae6f39520931723e1407d9471b2a
+  data.tar.gz: 5d5f15f00cce1ddced2188d2e3c5a8c3f1b36a719d281b54738eded944db6127e5546df65048118935d35ee6ea8b588ceab2cadb4f8ac66d0998a609e5aaba54

data/CHANGELOG.md

@@ -1,11 +1,17 @@
 # Change Log
 
-## [v0.8.3](https://github.com/ably/ably-ruby/tree/v0.8.3)
+## [Unreleased](https://github.com/ably/ably-ruby/tree/HEAD)
 
-[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.2...v0.8.3)
+[Full Changelog](https://github.com/ably/ably-ruby/compare/v0.8.2...HEAD)
 
 **Implemented enhancements:**
 
+- Add compatibility support for default Crypto params [\#53](https://github.com/ably/ably-ruby/issues/53)
+
+- EventEmitter on connection [\#52](https://github.com/ably/ably-ruby/issues/52)
+
+- Add test for connectionId attribute for a message sent over REST [\#50](https://github.com/ably/ably-ruby/issues/50)
+
 - Implement :queue\_messages option [\#36](https://github.com/ably/ably-ruby/issues/36)
 
 - Check that a non 200-299 status code for REST requests uses fallback hosts [\#35](https://github.com/ably/ably-ruby/issues/35)
@@ -32,6 +38,10 @@
 
 **Merged pull requests:**
 
+- Spec update to fix a number of issues [\#60](https://github.com/ably/ably-ruby/pull/60) ([mattheworiordan](https://github.com/mattheworiordan))
+
+- Allow clientId to be provided on init if using externally created token [\#58](https://github.com/ably/ably-ruby/pull/58) ([SimonWoolf](https://github.com/SimonWoolf))
+
 - Separate token params for auth [\#57](https://github.com/ably/ably-ruby/pull/57) ([mattheworiordan](https://github.com/mattheworiordan))
 
 - Ensure files are required in a consistent order [\#51](https://github.com/ably/ably-ruby/pull/51) ([SimonWoolf](https://github.com/SimonWoolf))
@@ -182,4 +192,4 @@
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/lib/ably/auth.rb

@@ -74,7 +74,7 @@ module Ably
         raise ArgumentError, 'key is missing. Either an API key, token, or token auth method must be provided'
       end
 
-      if has_client_id?
+      if has_client_id? && !token_creatable_externally?
         raise ArgumentError, 'client_id cannot be provided without a complete API key. Key name & Secret is needed to authenticate with Ably and obtain a token' unless api_key_present?
         ensure_utf_8 :client_id, client_id
       end

data/lib/ably/exceptions.rb

@@ -58,6 +58,9 @@ module Ably
     # Connection Timeout accessing Realtime or REST service
     class ConnectionTimeout < ConnectionError; end
 
+    # Transport closed unexpectedly
+    class TransportClosed < ConnectionError; end
+
     # Connection closed unexpectedly
     class ConnectionClosed < ConnectionError; end
 

data/lib/ably/models/channel_state_change.rb

@@ -0,0 +1,41 @@
+module Ably::Models
+  # ChannelStateChange is a class that is emitted by the {Ably::Realtime::Channel} object
+  # when a state change occurs
+  #
+  # @!attribute [r] current
+  #   @return [Connection::STATE] Current connection state
+  # @!attribute [r] previous
+  #   @return [Connection::STATE] Previous connection state
+  # @!attribute [r] reason
+  #   @return [Ably::Models::ErrorInfo] Object describing the reason for a state change when not initiated by the consumer of the client library
+  #
+  class ChannelStateChange
+    include Ably::Modules::ModelCommon
+
+    def initialize(hash_object)
+      unless (hash_object.keys - [:current, :previous, :reason, :protocol_message]).empty?
+        raise ArgumentError, 'Invalid attributes, expecting :current, :previous, :reason'
+      end
+
+      @hash_object = {
+        current: hash_object.fetch(:current),
+        previous: hash_object.fetch(:previous),
+        retry_in: hash_object[:retry_in],
+        reason: hash_object[:reason],
+        protocol_message: hash_object[:protocol_message]
+      }
+    rescue KeyError => e
+      raise ArgumentError, e
+    end
+
+    %w(current previous reason protocol_message).each do |attribute|
+      define_method attribute do
+        @hash_object[attribute.to_sym]
+      end
+    end
+
+    def to_s
+      "ChannelStateChange: current state #{current}, previous state #{previous}"
+    end
+  end
+end

data/lib/ably/models/connection_state_change.rb

@@ -0,0 +1,43 @@
+module Ably::Models
+  # ConnectionStateChange is a class that is emitted by the {Ably::Realtime::Connection} object
+  # when a state change occurs
+  #
+  # @!attribute [r] current
+  #   @return [Connection::STATE] Current connection state
+  # @!attribute [r] previous
+  #   @return [Connection::STATE] Previous connection state
+  # @!attribute [r] retry_in
+  #   @return [Integer] Time in seconds until the connection will reattempt to connect when in the +:disconnected+ or +:suspended+ state
+  # @!attribute [r] reason
+  #   @return [Ably::Models::ErrorInfo] Object describing the reason for a state change when not initiated by the consumer of the client library
+  #
+  class ConnectionStateChange
+    include Ably::Modules::ModelCommon
+
+    def initialize(hash_object)
+      unless (hash_object.keys - [:current, :previous, :retry_in, :reason, :protocol_message]).empty?
+        raise ArgumentError, 'Invalid attributes, expecting :current, :previous, :retry_in, :reason'
+      end
+
+      @hash_object = {
+        current: hash_object.fetch(:current),
+        previous: hash_object.fetch(:previous),
+        retry_in: hash_object[:retry_in],
+        reason: hash_object[:reason],
+        protocol_message: hash_object[:protocol_message]
+      }
+    rescue KeyError => e
+      raise ArgumentError, e
+    end
+
+    %w(current previous retry_in reason protocol_message).each do |attribute|
+      define_method attribute do
+        @hash_object[attribute.to_sym]
+      end
+    end
+
+    def to_s
+      "ConnectionStateChange: current state #{current}, previous state #{previous}"
+    end
+  end
+end

data/lib/ably/models/message.rb

@@ -131,7 +131,7 @@ module Ably::Models
     end
 
     def logger
-      return logger if logger
+      return @logger if @logger
       protocol_message.logger if protocol_message
     end
   end

data/lib/ably/models/presence_message.rb

@@ -154,7 +154,7 @@ module Ably::Models
     end
 
     def logger
-      return logger if logger
+      return @logger if @logger
       protocol_message.logger if protocol_message
     end
   end

data/lib/ably/models/protocol_message.rb

@@ -226,7 +226,8 @@ module Ably::Models
       !action_enum || (ack_required? && !has_serial?)
     end
 
-    private
+    # @!attribute [r] logger
+    # @api private
     attr_reader :logger
   end
 end

data/lib/ably/modules/state_emitter.rb

@@ -141,7 +141,10 @@ module Ably::Modules
     #
     def deferrable_for_state_change_to(target_state)
       Ably::Util::SafeDeferrable.new(logger).tap do |deferrable|
-        once_or_if(target_state, else: proc { |*args| deferrable.fail self, *args }) do
+        fail_proc = Proc.new do |state_change|
+          deferrable.fail self, state_change.reason
+        end
+        once_or_if(target_state, else: fail_proc) do
           yield self if block_given?
           deferrable.succeed self
         end

data/lib/ably/modules/uses_state_machine.rb

@@ -13,8 +13,8 @@ module Ably::Modules
     #
     # @return [Boolean] true if new_state can be transitioned to by state machine
     # @api private
-    def transition_state_machine(new_state, emit_object = nil)
-      state_machine.transition_state(new_state, emit_object)
+    def transition_state_machine(new_state, emit_params = {})
+      state_machine.transition_state(new_state, emit_object(new_state, emit_params))
     end
 
     # Call #transition_to! on the StateMachine
@@ -22,8 +22,8 @@ module Ably::Modules
     #
     # @return [void]
     # @api private
-    def transition_state_machine!(new_state, emit_object = nil)
-      state_machine.transition_to!(new_state, emit_object)
+    def transition_state_machine!(new_state, emit_params = {})
+      state_machine.transition_to!(new_state, emit_object(new_state, emit_params))
     end
 
     # Provides an internal method for this object's state to match the StateMachine's current state.
@@ -70,5 +70,29 @@ module Ably::Modules
         logger.debug "#{self.class.name}: Transitioned to #{state_machine.current_state}"
       end
     end
+
+    def emit_object(new_state, emit_params)
+      if self.class.emits_klass
+        self.class.emits_klass.new((emit_params || {}).merge(current: STATE(new_state), previous: STATE(state_machine.current_state)))
+      else
+        emit_params
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def emits_klass
+        @emits_klass ||= if @emits_klass_name
+          Object.const_get @emits_klass_name
+        end
+      end
+
+      def ensure_state_machine_emits(klass)
+        @emits_klass_name = klass
+      end
+    end
   end
 end

data/lib/ably/realtime/channel.rb

@@ -46,6 +46,7 @@ module Ably
       )
       include Ably::Modules::StateEmitter
       include Ably::Modules::UsesStateMachine
+      ensure_state_machine_emits 'Ably::Models::ChannelStateChange'
 
       # Max number of messages to bundle in a single ProtocolMessage
       MAX_PROTOCOL_MESSAGE_BATCH_SIZE = 50
@@ -106,6 +107,7 @@ module Ably
       #
       # @param name [String, Array<Ably::Models::Message|Hash>, nil]   The event name of the message to publish, or an Array of [Ably::Model::Message] objects or [Hash] objects with +:name+ and +:data+ pairs
       # @param data [String, ByteArray, nil]   The message payload unless an Array of [Ably::Model::Message] objects passed in the first argument
+      # @param attributes [Hash, nil]   Optional additional message attributes such as :client_id or :connection_id, applied when name attribute is nil or a string
       #
       # @yield [Ably::Models::Message,Array<Ably::Models::Message>] On success, will call the block with the {Ably::Models::Message} if a single message is publishde, or an Array of {Ably::Models::Message} when multiple messages are published
       # @return [Ably::Util::SafeDeferrable] Deferrable that supports both success (callback) and failure (errback) callbacks
@@ -136,7 +138,7 @@ module Ably
       #     puts "#{message.name} was not received, error #{error.message}"
       #   end
       #
-      def publish(name, data = nil, &success_block)
+      def publish(name, data = nil, attributes = {}, &success_block)
         raise Ably::Exceptions::ChannelInactive.new('Cannot publish messages on a detached channel') if detached? || detaching?
         raise Ably::Exceptions::ChannelInactive.new('Cannot publish messages on a failed channel') if failed?
 
@@ -149,7 +151,7 @@ module Ably
         else
           ensure_utf_8 :name, name, allow_nil: true
           ensure_supported_payload data
-          [{ name: name, data: data }]
+          [{ name: name, data: data }.merge(attributes)]
         end
 
         queue_messages(messages).tap do |deferrable|
@@ -190,7 +192,9 @@ module Ably
       # @return [Ably::Util::SafeDeferrable] Deferrable that supports both success (callback) and failure (errback) callback
       #
       def attach(&success_block)
-        raise Ably::Exceptions::InvalidStateChange.new("Cannot ATTACH channel when the connection is in a closed, suspended or failed state. Connection state: #{connection.state}") if connection.closing? || connection.closed? || connection.suspended? || connection.failed?
+        if connection.closing? || connection.closed? || connection.suspended? || connection.failed?
+          raise Ably::Exceptions::InvalidStateChange.new("Cannot ATTACH channel when the connection is in a closed, suspended or failed state. Connection state: #{connection.state}")
+        end
 
         transition_state_machine :attaching if can_transition_to?(:attaching)
         deferrable_for_state_change_to(STATE.Attached, &success_block)
@@ -285,6 +289,10 @@ module Ably
         client.logger
       end
 
+      # As we are using a state machine, do not allow change_state to be used
+      # #transition_state_machine must be used instead
+      private :change_state
+
       private
       attr_reader :queue
 

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

@@ -27,7 +27,7 @@ module Ably::Realtime
       # Commence attachment
       def detach(error = nil)
         if connection.closed? || connection.connecting? || connection.suspended?
-          channel.transition_state_machine :detached, error
+          channel.transition_state_machine :detached, reason: error
         elsif can_transition_to?(:detached)
           send_detach_protocol_message
         end
@@ -51,7 +51,7 @@ module Ably::Realtime
 
       # Detach a channel as a result of an error
       def suspend(error)
-        channel.transition_state_machine! :detaching, error
+        channel.transition_state_machine! :detaching, reason: error
       end
 
       # When a channel is no longer attached or has failed,
@@ -118,6 +118,22 @@ module Ably::Realtime
         )
       end
 
+      # Any message sent before an ACK/NACK was received on the previous transport
+      # needs to be resent to the Ably service so that a subsequent ACK/NACK is received.
+      # It is up to Ably to ensure that duplicate messages are not retransmitted on the channel
+      # base on the serial numbers
+      #
+      # @api private
+      def resend_pending_message_ack_queue
+        connection.__pending_message_ack_queue__.delete_if do |protocol_message|
+          if protocol_message.channel == channel.name
+            connection.__outgoing_message_queue__ << protocol_message
+            connection.__outgoing_protocol_msgbus__.publish :protocol_message
+            true
+          end
+        end
+      end
+
       def setup_connection_event_handlers
         connection.unsafe_on(:closed) do
           channel.transition_state_machine :detaching if can_transition_to?(:detaching)
@@ -125,15 +141,19 @@ module Ably::Realtime
 
         connection.unsafe_on(:suspended) do |error|
           if can_transition_to?(:detaching)
-            channel.transition_state_machine :detaching, Ably::Exceptions::ConnectionSuspended.new('Connection suspended', nil, 80002, error)
+            channel.transition_state_machine :detaching, reason: Ably::Exceptions::ConnectionSuspended.new('Connection suspended', nil, 80002, error)
           end
         end
 
         connection.unsafe_on(:failed) do |error|
           if can_transition_to?(:failed)
-            channel.transition_state_machine :failed, Ably::Exceptions::ConnectionFailed.new('Connection failed', nil, 80002, error)
+            channel.transition_state_machine :failed, reason: Ably::Exceptions::ConnectionFailed.new('Connection failed', nil, 80002, error)
           end
         end
+
+        connection.unsafe_on(:connected) do |error|
+          resend_pending_message_ack_queue
+        end
       end
 
       def logger

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

@@ -35,39 +35,48 @@ module Ably::Realtime
       end
 
       before_transition(to: [:attached]) do |channel, current_transition|
-        channel.manager.attached current_transition.metadata
+        channel.manager.attached current_transition.metadata.protocol_message
       end
 
       after_transition(to: [:detaching]) do |channel, current_transition|
-        channel.manager.detach current_transition.metadata
+        err = error_from_state_change(current_transition)
+        channel.manager.detach err
       end
 
       after_transition(to: [:detached]) do |channel, current_transition|
-        channel.manager.fail_messages_awaiting_ack nil_unless_error(current_transition.metadata)
-        channel.manager.emit_error current_transition.metadata if is_error_type?(current_transition.metadata)
+        err = error_from_state_change(current_transition)
+        channel.manager.fail_messages_awaiting_ack err
+        channel.manager.emit_error err if err
       end
 
       after_transition(to: [:failed]) do |channel, current_transition|
-        channel.manager.fail_messages_awaiting_ack nil_unless_error(current_transition.metadata)
-        channel.manager.emit_error current_transition.metadata if is_error_type?(current_transition.metadata)
+        err = error_from_state_change(current_transition)
+        channel.manager.fail_messages_awaiting_ack err
+        channel.manager.emit_error err if err
       end
 
       # Transitions responsible for updating channel#error_reason
       before_transition(to: [:failed]) do |channel, current_transition|
-        channel.set_failed_channel_error_reason current_transition.metadata if is_error_type?(current_transition.metadata)
+        err = error_from_state_change(current_transition)
+        channel.set_failed_channel_error_reason err if err
       end
 
       before_transition(to: [:attached, :detached]) do |channel, current_transition|
-        if is_error_type?(current_transition.metadata)
-          channel.set_failed_channel_error_reason current_transition.metadata
+        err = error_from_state_change(current_transition)
+        if err
+          channel.set_failed_channel_error_reason err
         else
           # Attached & Detached are "healthy" final states so reset the error reason
           channel.clear_error_reason
         end
       end
 
-      def self.nil_unless_error(error_object)
-        error_object if is_error_type?(error_object)
+      def self.error_from_state_change(current_transition)
+        # ChannelStateChange object is always passed in current_transition metadata object
+        connection_state_change = current_transition.metadata
+        # Reason attribute contains errors
+        err = connection_state_change && connection_state_change.reason
+        err if is_error_type?(err)
       end
 
       private

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

@@ -68,10 +68,10 @@ module Ably::Realtime
 
           when ACTION.Connect
           when ACTION.Connected
-            connection.transition_state_machine :connected, protocol_message unless connection.connected?
+            connection.transition_state_machine :connected, reason: protocol_message.error, protocol_message: protocol_message unless connection.connected?
 
           when ACTION.Disconnect, ACTION.Disconnected
-            connection.transition_state_machine :disconnected, protocol_message.error unless connection.disconnected?
+            connection.transition_state_machine :disconnected, reason: protocol_message.error unless connection.disconnected?
 
           when ACTION.Close
           when ACTION.Closed
@@ -87,7 +87,7 @@ module Ably::Realtime
           when ACTION.Attach
           when ACTION.Attached
             get_channel(protocol_message.channel).tap do |channel|
-              channel.transition_state_machine :attached, protocol_message unless channel.attached?
+              channel.transition_state_machine :attached, reason: protocol_message.error, protocol_message: protocol_message unless channel.attached?
             end
 
           when ACTION.Detach
@@ -125,7 +125,7 @@ module Ably::Realtime
       def dispatch_channel_error(protocol_message)
         logger.warn "Channel Error message received: #{protocol_message.error}"
         if !protocol_message.has_message_serial?
-          get_channel(protocol_message.channel).transition_state_machine :failed, protocol_message.error
+          get_channel(protocol_message.channel).transition_state_machine :failed, reason: protocol_message.error
         else
           logger.fatal "Cannot process ProtocolMessage as not yet implemented: #{protocol_message}"
         end