ably 1.1.7 → 1.2.1

data/lib/ably/models/protocol_message.rb

@@ -3,7 +3,7 @@ module Ably::Models
   # A ProtocolMessage always relates to a single channel only, but
   # can contain multiple individual Messages or PresenceMessages.
   # ProtocolMessages are serially numbered on a connection.
-  # See the {http://docs.ably.io/client-lib-development-guide/protocol/ Ably client library developer documentation}
+  # See the {http://ably.com/docs/client-lib-development-guide/protocol/ Ably client library developer documentation}
   # for further details on the members of a ProtocolMessage
   #
   # @!attribute [r] action
@@ -11,7 +11,7 @@ module Ably::Models
   # @!attribute [r] auth
   #   @return [Ably::Models::AuthDetails] Authentication details used to perform authentication upgrades over an existing transport
   # @!attribute [r] count
-  #   @return [Integer] The count field is used for ACK and NACK actions. See {http://docs.ably.io/client-lib-development-guide/protocol/#message-acknowledgement message acknowledgement protocol}
+  #   @return [Integer] The count field is used for ACK and NACK actions. See {http://ably.com/docs/client-lib-development-guide/protocol/#message-acknowledgement message acknowledgement protocol}
   # @!attribute [r] error
   #   @return [ErrorInfo] Contains error information
   # @!attribute [r] channel
@@ -19,8 +19,6 @@ module Ably::Models
   # @!attribute [r] channel_serial
   #   @return [String] Contains a serial number for a message on the current channel
   # @!attribute [r] connection_id
-  #   @return [String] Contains a string public identifier for the connection
-  # @!attribute [r] connection_key
   #   @return [String] Contains a string private connection key used to recover this connection
   # @!attribute [r] connection_serial
   #   @return [Bignum] Contains a serial number for a message sent from the server to the client
@@ -68,6 +66,14 @@ module Ably::Models
       auth:         17
     )
 
+    ATTACH_FLAGS_MAPPING = {
+      resume: 32, # 2^5
+      presence: 65536, # 2^16
+      publish: 131072, # 2^17
+      subscribe: 262144, # 2^18
+      presence_subscribe: 524288, # 2^19
+    }
+
     # Indicates this protocol message action will generate an ACK response such as :message or :presence
     # @api private
     def self.ack_required?(for_action)
@@ -98,12 +104,6 @@ module Ably::Models
       end
     end
 
-    def connection_key
-      # connection_key in connection details takes precedence over connection_key on the ProtocolMessage
-      # connection_key in the ProtocolMessage will be deprecated in future protocol versions > 0.8
-      connection_details.connection_key || attributes[:connection_key]
-    end
-
     def id!
       raise RuntimeError, 'ProtocolMessage #id is nil' unless id
       id
@@ -193,6 +193,10 @@ module Ably::Models
       message_size <= connection_details.max_message_size
     end
 
+    def params
+      @params ||= attributes[:params].to_h
+    end
+
     def flags
       Integer(attributes[:flags])
     rescue TypeError
@@ -224,24 +228,29 @@ module Ably::Models
       flags & 16 == 16 # 2^4
     end
 
+    # @api private
+    def has_attach_resume_flag?
+      flags & ATTACH_FLAGS_MAPPING[:resume] == ATTACH_FLAGS_MAPPING[:resume] # 2^5
+    end
+
     # @api private
     def has_attach_presence_flag?
-      flags & 65536 == 65536 # 2^16
+      flags & ATTACH_FLAGS_MAPPING[:presence] == ATTACH_FLAGS_MAPPING[:presence] # 2^16
     end
 
     # @api private
     def has_attach_publish_flag?
-      flags & 131072 == 131072 # 2^17
+      flags & ATTACH_FLAGS_MAPPING[:publish] == ATTACH_FLAGS_MAPPING[:publish] # 2^17
     end
 
     # @api private
     def has_attach_subscribe_flag?
-      flags & 262144 == 262144 # 2^18
+      flags & ATTACH_FLAGS_MAPPING[:subscribe] == ATTACH_FLAGS_MAPPING[:subscribe] # 2^18
     end
 
     # @api private
     def has_attach_presence_subscribe_flag?
-      flags & 524288 == 524288 # 2^19
+      flags & ATTACH_FLAGS_MAPPING[:presence_subscribe] == ATTACH_FLAGS_MAPPING[:presence_subscribe] # 2^19
     end
 
     def connection_details

data/lib/ably/models/token_details.rb

@@ -95,10 +95,15 @@ module Ably::Models
     # Returns true if token is expired or about to expire
     # For tokens that have not got an explicit expires attribute expired? will always return true
     #
+    # @param attributes [Hash]
+    # @option attributes [Time] :from   Sets a current time from which token expires
+    #
     # @return [Boolean]
-    def expired?
+    def expired?(attributes = {})
       return false if !expires
-      expires < Time.now + TOKEN_EXPIRY_BUFFER
+
+      from = attributes[:from] || Time.now
+      expires < from + TOKEN_EXPIRY_BUFFER
     end
 
     # True if the TokenDetails was created from an opaque string i.e. no metadata exists for this token

data/lib/ably/models/token_request.rb

@@ -98,7 +98,7 @@ module Ably::Models
 
     # @!attribute [r] mac
     # @return [String]  the Message Authentication Code for this request. See the
-    #                   {https://www.ably.io/documentation Ably Authentication documentation} for more details.
+    #                   {https://www.ably.com/docs Ably Authentication documentation} for more details.
     def mac
       attributes.fetch(:mac) { raise Ably::Exceptions::InvalidTokenRequest, 'MAC is missing' }
     end

data/lib/ably/modules/ably.rb

@@ -6,7 +6,7 @@
 module Ably
   # Fallback hosts to use when a connection to rest/realtime.ably.io is not possible due to
   # network failures either at the client, between the client and Ably, within an Ably data center, or at the IO domain registrar
-  # see https://docs.ably.io/client-lib-development-guide/features/#RSC15a
+  # see https://ably.com/docs/client-lib-development-guide/features/#RSC15a
   #
   FALLBACK_DOMAIN = 'ably-realtime.com'.freeze
   FALLBACK_IDS = %w(a b c d e).freeze

data/lib/ably/modules/channels_collection.rb

@@ -13,14 +13,21 @@ module Ably::Modules
     # Return a Channel for the given name
     #
     # @param name [String] The name of the channel
-    # @param channel_options [Hash] Channel options including the encryption options
+    # @param channel_options [Hash, Ably::Models::ChannelOptions] A hash of options or a {Ably::Models::ChannelOptions}
     #
     # @return [Channel]
     #
     def get(name, channel_options = {})
       if channels.has_key?(name)
         channels[name].tap do |channel|
-          channel.update_options channel_options if channel_options && !channel_options.empty?
+          if channel_options && !channel_options.empty?
+            if channel.respond_to?(:need_reattach?) && channel.need_reattach?
+              raise_implicit_options_update
+            else
+              warn_implicit_options_update
+              channel.options = channel_options
+            end
+          end
         end
       else
         channels[name] ||= channel_klass.new(client, name, channel_options)
@@ -70,6 +77,19 @@ module Ably::Modules
     end
 
     private
+
+    def raise_implicit_options_update
+      raise ArgumentError, "You are trying to indirectly update channel options which will trigger reattachment of the channel. Please use Channel#set_options directly if you wish to continue"
+    end
+
+    def warn_implicit_options_update
+      logger.warn { "Channels#get: Using this method to update channel options is deprecated and may be removed in a future version of ably-ruby. Please use Channel#setOptions instead" }
+    end
+
+    def logger
+      client.logger
+    end
+
     def client
       @client
     end

data/lib/ably/modules/conversions.rb

@@ -115,5 +115,39 @@ module Ably::Modules
 
       raise Ably::Exceptions::UnsupportedDataType.new('Invalid data payload', 400, Ably::Exceptions::Codes::INVALID_MESSAGE_DATA_OR_ENCODING)
     end
+
+    # Converts the name, data, attributes into the array of Message objects
+    #
+    # @return [Array<Ably::Models::Message>]
+    #
+    def build_messages(name, data = nil, attributes = {})
+      return [Ably::Models::Message(ensure_supported_name_and_payload(nil, data, attributes))] if name.nil?
+
+      Array(name).map do |item|
+        Ably::Models::Message(ensure_supported_name_and_payload(item, data, attributes))
+      end
+    end
+
+    # Ensures if the first argument (name) is a String, Hash or Ably::Models::Message object,
+    # second argument (data) should be a String, Hash, Array or nil (see ensure_supported_payload() method).
+    #
+    # @return [Hash]        Contains :name, :data and other attributes
+    #
+    # (RSL1a, RSL1b)
+    #
+    def ensure_supported_name_and_payload(name, data = nil, attributes = {})
+      return name.attributes.dup if name.kind_of?(Ably::Models::Message)
+
+      payload = data
+      if (hash = name).kind_of?(Hash)
+        name, payload = hash[:name], (hash[:data] || payload)
+        attributes.merge!(hash)
+      end
+
+      name = ensure_utf_8(:name, name, allow_nil: true)
+      ensure_supported_payload payload
+
+      attributes.merge({ name: name, data: payload })
+    end
   end
 end

data/lib/ably/realtime/auth.rb

@@ -2,10 +2,10 @@ require 'ably/auth'
 
 module Ably
   module Realtime
-    # Auth is responsible for authentication with {https://www.ably.io Ably} using basic or token authentication
+    # Auth is responsible for authentication with {https://www.ably.com Ably} using basic or token authentication
     # This {Ably::Realtime::Auth Realtime::Auth} class wraps the {Ably::Auth Synchronous Ably::Auth} class in an EventMachine friendly way using Deferrables for all IO.  See {Ably::Auth Ably::Auth} for more information
     #
-    # Find out more about Ably authentication at: https://www.ably.io/documentation/general/authentication/
+    # Find out more about Ably authentication at: https://www.ably.com/docs/general/authentication/
     #
     # @!attribute [r] client_id
     #   (see Ably::Auth#client_id)

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

@@ -38,6 +38,8 @@ module Ably::Realtime
         if attached_protocol_message
           update_presence_sync_state_following_attached attached_protocol_message
           channel.properties.set_attach_serial(attached_protocol_message.channel_serial)
+          channel.options.set_modes_from_flags(attached_protocol_message.flags)
+          channel.options.set_params(attached_protocol_message.params)
         end
       end
 
@@ -64,6 +66,7 @@ module Ably::Realtime
         end
 
         channel.properties.set_attach_serial(protocol_message.channel_serial)
+        channel.options.set_modes_from_flags(protocol_message.flags)
 
         if protocol_message.has_channel_resumed_flag?
           logger.debug { "ChannelManager: Additional resumed ATTACHED message received for #{channel.state} channel '#{channel.name}'" }
@@ -199,14 +202,21 @@ module Ably::Realtime
       end
 
       def send_attach_protocol_message
-        send_state_change_protocol_message Ably::Models::ProtocolMessage::ACTION.Attach, :suspended # move to suspended
+        message_options = {}
+        message_options[:params] = channel.options.params if channel.options.params.any?
+        message_options[:flags] = channel.options.modes_to_flags if channel.options.modes
+        if channel.attach_resume
+          message_options[:flags] = message_options[:flags].to_i | Ably::Models::ProtocolMessage::ATTACH_FLAGS_MAPPING[:resume]
+        end
+
+        send_state_change_protocol_message Ably::Models::ProtocolMessage::ACTION.Attach, :suspended, message_options
       end
 
       def send_detach_protocol_message(previous_state)
         send_state_change_protocol_message Ably::Models::ProtocolMessage::ACTION.Detach, previous_state # return to previous state if failed
       end
 
-      def send_state_change_protocol_message(new_state, state_if_failed)
+      def send_state_change_protocol_message(new_state, state_if_failed, message_options = {})
         state_at_time_of_request = channel.state
         @pending_state_change_timer = EventMachine::Timer.new(realtime_request_timeout) do
           if channel.state == state_at_time_of_request
@@ -227,7 +237,8 @@ module Ably::Realtime
               next unless pending_state_change_timer
               connection.send_protocol_message(
                 action:  new_state.to_i,
-                channel: channel.name
+                channel: channel.name,
+                **message_options.to_h
               )
               resend_if_disconnected_and_connected.call
             end
@@ -237,7 +248,8 @@ module Ably::Realtime
 
         connection.send_protocol_message(
           action:  new_state.to_i,
-          channel: channel.name
+          channel: channel.name,
+          **message_options.to_h
         )
       end
 

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

@@ -26,18 +26,27 @@ module Ably::Realtime
       transition :from => :detaching,    :to => [:detached, :attaching, :attached, :failed, :suspended]
       transition :from => :detached,     :to => [:attaching, :attached, :failed]
       transition :from => :suspended,    :to => [:attaching, :attached, :detached, :failed]
-      transition :from => :failed,       :to => [:attaching]
+      transition :from => :failed,       :to => [:attaching, :initialized]
 
       after_transition do |channel, transition|
         channel.synchronize_state_with_statemachine
       end
 
+      after_transition(to: [:initialized]) do |channel|
+        channel.clear_error_reason
+      end
+
       after_transition(to: [:attaching]) do |channel|
         channel.manager.attach
       end
 
       before_transition(to: [:attached]) do |channel, current_transition|
         channel.manager.attached current_transition.metadata.protocol_message
+        channel.attach_resume!
+      end
+
+      before_transition(to: [:detaching, :failed]) do |channel, _current_transition|
+        channel.reset_attach_resume!
       end
 
       after_transition(to: [:detaching]) do |channel, current_transition|

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

@@ -22,8 +22,9 @@ module Ably::Realtime
           end
         end
 
-        if messages.sum(&:size) > Ably::Realtime::Connection::MAX_MESSAGE_SIZE
-          error = Ably::Exceptions::MaxMessageSizeExceeded.new("Message size exceeded #{Ably::Realtime::Connection::MAX_MESSAGE_SIZE} bytes.")
+        max_message_size = connection.details && connection.details.max_message_size || Ably::Models::ConnectionDetails::MAX_MESSAGE_SIZE
+        if messages.sum(&:size) > max_message_size
+          error = Ably::Exceptions::MaxMessageSizeExceeded.new("Message size exceeded #{max_message_size} bytes.")
           return Ably::Util::SafeDeferrable.new_and_fail_immediately(logger, error)
         end
 

data/lib/ably/realtime/channel.rb

@@ -36,6 +36,7 @@ module Ably
       include Ably::Modules::MessageEmitter
       include Ably::Realtime::Channel::Publisher
       extend Ably::Modules::Enum
+      extend Forwardable
 
       # ChannelState
       # The permited states for this channel
@@ -92,17 +93,25 @@ module Ably
       # @api private
       attr_reader :manager
 
+      # Flag that specifies whether channel is resuming attachment(reattach) or is doing a 'clean attach' RTL4j1
+      # @return [Bolean]
+      # @api private
+      attr_reader :attach_resume
+
+      # ChannelOptions params attrribute (#RTL4k)
+      # return [Hash]
+      def_delegators :options, :params
+
       # Initialize a new Channel object
       #
       # @param  client [Ably::Rest::Client]
       # @param  name [String] The name of the channel
-      # @param  channel_options [Hash]     Channel options, currently reserved for Encryption options
-      # @option channel_options [Hash,Ably::Models::CipherParams]   :cipher   A hash of options or a {Ably::Models::CipherParams} to configure the encryption. *:key* is required, all other options are optional.  See {Ably::Util::Crypto#initialize} for a list of +:cipher+ options
+      # @param  channel_options [Hash, Ably::Models::ChannelOptions]     A hash of options or a {Ably::Models::ChannelOptions}
       #
       def initialize(client, name, channel_options = {})
         name = ensure_utf_8(:name, name)
 
-        update_options channel_options
+        @options       = Ably::Models::ChannelOptions(channel_options)
         @client        = client
         @name          = name
         @queue         = []
@@ -112,6 +121,7 @@ module Ably
         @manager       = ChannelManager.new(self, client.connection)
         @push          = PushChannel.new(self)
         @properties    = ChannelProperties.new(self)
+        @attach_resume = false
 
         setup_event_handlers
         setup_presence
@@ -129,23 +139,31 @@ module Ably
       # @return [Ably::Util::SafeDeferrable] Deferrable that supports both success (callback) and failure (errback) callbacks
       #
       # @example
-      #   # Publish a single message
+      #   # Publish a single message form
       #   channel.publish 'click', { x: 1, y: 2 }
       #
-      #   # Publish an array of message Hashes
+      #   # Publish a single message with single Hash form
+      #   message = { name: 'click', data: { x: 1, y: 2 } }
+      #   channel.publish message
+      #
+      #   # Publish an array of message Hashes form
       #   messages = [
-      #     { name: 'click', { x: 1, y: 2 } },
-      #     { name: 'click', { x: 2, y: 3 } }
+      #     { name: 'click', data: { x: 1, y: 2 } },
+      #     { name: 'click', data: { x: 2, y: 3 } }
       #   ]
       #   channel.publish messages
       #
-      #   # Publish an array of Ably::Models::Message objects
+      #   # Publish an array of Ably::Models::Message objects form
       #   messages = [
-      #     Ably::Models::Message(name: 'click', { x: 1, y: 2 })
-      #     Ably::Models::Message(name: 'click', { x: 2, y: 3 })
+      #     Ably::Models::Message(name: 'click', data: { x: 1, y: 2 })
+      #     Ably::Models::Message(name: 'click', data: { x: 2, y: 3 })
       #   ]
       #   channel.publish messages
       #
+      #   # Publish an array of Ably::Models::Message objects form
+      #   message = Ably::Models::Message(name: 'click', data: { x: 1, y: 2 })
+      #   channel.publish message
+      #
       #   channel.publish('click', 'body') do |message|
       #     puts "#{message.name} event received with #{message.data}"
       #   end
@@ -165,13 +183,7 @@ module Ably
           return Ably::Util::SafeDeferrable.new_and_fail_immediately(logger, error)
         end
 
-        messages = if name.kind_of?(Enumerable)
-          name
-        else
-          name = ensure_utf_8(:name, name, allow_nil: true)
-          ensure_supported_payload data
-          [{ name: name, data: data }.merge(attributes)]
-        end
+        messages = build_messages(name, data, attributes) # (RSL1a, RSL1b)
 
         if messages.length > Realtime::Connection::MAX_PROTOCOL_MESSAGE_BATCH_SIZE
           error = Ably::Exceptions::InvalidRequest.new("It is not possible to publish more than #{Realtime::Connection::MAX_PROTOCOL_MESSAGE_BATCH_SIZE} messages with a single publish request.")
@@ -309,6 +321,16 @@ module Ably
         )
       end
 
+      # Sets or updates the stored channel options. (#RTL16)
+      # @param channel_options [Hash, Ably::Models::ChannelOptions]     A hash of options or a {Ably::Models::ChannelOptions}
+      # @return [Ably::Models::ChannelOptions]
+      def set_options(channel_options)
+        @options = Ably::Models::ChannelOptions(channel_options)
+
+        manager.request_reattach if need_reattach?
+      end
+      alias options= set_options
+
       # @api private
       def set_channel_error_reason(error)
         @error_reason = error
@@ -319,22 +341,32 @@ module Ably
         @error_reason = nil
       end
 
-      # @api private
-      def update_options(channel_options)
-        @options = channel_options.clone.freeze
-      end
-
       # Used by {Ably::Modules::StateEmitter} to debug state changes
       # @api private
       def logger
         client.logger
       end
 
+      # @api private
+      def attach_resume!
+        @attach_resume = true
+      end
+
+      # @api private
+      def reset_attach_resume!
+        @attach_resume = false
+      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
 
+      def need_reattach?
+        !!(attaching? || attached?) && !!(options.modes || options.params)
+      end
+
       private
+
       def setup_event_handlers
         __incoming_msgbus__.subscribe(:message) do |message|
           message.decode(client.encoders, options) do |encode_error, error_message|

data/lib/ably/realtime/channels.rb

@@ -13,7 +13,7 @@ module Ably
       # Return a {Ably::Realtime::Channel} for the given name
       #
       # @param name [String] The name of the channel
-      # @param channel_options [Hash] Channel options, currently reserved for Encryption options
+      # @param channel_options [Hash, Ably::Models::ChannelOptions] A hash of options or a {Ably::Models::ChannelOptions}
       # @return [Ably::Realtime::Channel}
       #
       def get(*args)

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

@@ -117,17 +117,17 @@ module Ably::Realtime
             EventMachine.next_tick { connection.trigger_resumed }
             resend_pending_message_ack_queue
           else
-            logger.debug { "ConnectionManager: Connection was not resumed, old connection ID #{connection.id} has been updated with new connection ID #{protocol_message.connection_id} and key #{protocol_message.connection_key}" }
+            logger.debug { "ConnectionManager: Connection was not resumed, old connection ID #{connection.id} has been updated with new connection ID #{protocol_message.connection_id} and key #{protocol_message.connection_details.connection_key}" }
             nack_messages_on_all_channels protocol_message.error
             force_reattach_on_channels protocol_message.error
           end
         else
-          logger.debug { "ConnectionManager: New connection created with ID #{protocol_message.connection_id} and key #{protocol_message.connection_key}" }
+          logger.debug { "ConnectionManager: New connection created with ID #{protocol_message.connection_id} and key #{protocol_message.connection_details.connection_key}" }
         end
 
         reattach_suspended_channels protocol_message.error
 
-        connection.configure_new protocol_message.connection_id, protocol_message.connection_key, protocol_message.connection_serial
+        connection.configure_new protocol_message.connection_id, protocol_message.connection_details.connection_key, protocol_message.connection_serial
       end
 
       # When connection is CONNECTED and receives an update
@@ -139,7 +139,7 @@ module Ably::Realtime
         # Update the connection details and any associated defaults
         connection.set_connection_details protocol_message.connection_details
 
-        connection.configure_new protocol_message.connection_id, protocol_message.connection_key, protocol_message.connection_serial
+        connection.configure_new protocol_message.connection_id, protocol_message.connection_details.connection_key, protocol_message.connection_serial
 
         state_change = Ably::Models::ConnectionStateChange.new(
           current: connection.state,
@@ -319,6 +319,15 @@ module Ably::Realtime
         end
       end
 
+      # @api private
+      def reintialize_failed_chanels
+        channels.select do |channel|
+          channel.failed?
+        end.each do |channel|
+          channel.transition_state_machine :initialized
+        end
+      end
+
       # When continuity on a connection is lost all messages
       # whether queued or awaiting an ACK must be NACK'd as we now have a new connection
       def nack_messages_on_all_channels(error)

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

@@ -36,6 +36,10 @@ module Ably::Realtime
         connection.manager.setup_transport
       end
 
+      after_transition(to: [:connecting], from: [:failed]) do |connection|
+        connection.manager.reintialize_failed_chanels
+      end
+
       after_transition(to: [:connecting], from: [:disconnected, :suspended]) do |connection|
         connection.manager.reconnect_transport
       end

data/lib/ably/realtime/connection.rb

@@ -82,9 +82,6 @@ module Ably
       # Max number of messages to bundle in a single ProtocolMessage
       MAX_PROTOCOL_MESSAGE_BATCH_SIZE = 50
 
-      # Max message size
-      MAX_MESSAGE_SIZE = 65536 # See spec TO3l8
-
       # A unique public identifier for this connection, used to identify this member in presence events and messages
       # @return [String]
       attr_reader :id