ably 1.2.2 → 1.2.4

data/lib/ably/modules/event_emitter.rb

@@ -46,9 +46,12 @@ module Ably
 
       # On receiving an event matching the event_name, call the provided block
       #
+      # @spec RTE4
+      #
       # @param [Array<String>] event_names event name
       #
       # @return [void]
+      #
       def on(*event_names, &block)
         add_callback event_names, proc_for_block(block)
       end
@@ -62,9 +65,12 @@ module Ably
 
       # On receiving an event maching the event_name, call the provided block only once and remove the registered callback
       #
+      # @spec RTE4
+      #
       # @param [Array<String>] event_names event name
       #
       # @return [void]
+      #
       def once(*event_names, &block)
         add_callback event_names, proc_for_block(block, delete_once_run: true)
       end
@@ -76,7 +82,11 @@ module Ably
         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`
+      # Emits an event, calling registered listeners with the given event name and any other given arguments.
+      # If an exception is raised in any of the listeners, the exception is caught by the EventEmitter and the exception is logged to the Ably logger.
+      #
+      # @spec RTE6
+      #
       def emit(event_name, *args)
         [callbacks_any, callbacks[callbacks_event_coerced(event_name)]].each do |callback_arr|
           callback_arr.clone.
@@ -97,9 +107,12 @@ module Ably
       # If a block is provided, only callbacks matching that block signature will be removed.
       # If block is not provided, all callbacks matching the event_name will be removed.
       #
+      # @spec RTE5
+      #
       # @param [Array<String>] event_names event name
       #
       # @return [void]
+      #
       def off(*event_names, &block)
         off_internal(false, *event_names, &block)
       end

data/lib/ably/modules/model_common.rb

@@ -15,6 +15,7 @@ module Ably::Modules
     # Provide a normal Hash accessor to the underlying raw message object
     #
     # @return [Object]
+    #
     def [](key)
       attributes[key]
     end
@@ -25,13 +26,17 @@ module Ably::Modules
     end
 
     # Return a JSON ready object from the underlying #attributes using Ably naming conventions for keys
+    #
     # @return [Hash]
+    #
     def as_json(*args)
       attributes.as_json.reject { |key, val| val.nil? }
     end
 
     # Stringify the JSON representation of this object from the underlying #attributes
+    #
     # @return [String]
+    #
     def to_json(*args)
       as_json.to_json(*args)
     end

data/lib/ably/modules/state_emitter.rb

@@ -35,6 +35,7 @@ module Ably::Modules
     # Current state {Ably::Modules::Enum}
     #
     # @return [Symbol] state
+    #
     def state
       STATE(@state)
     end
@@ -42,6 +43,7 @@ module Ably::Modules
     # Evaluates if check_state matches current state
     #
     # @return [Boolean]
+    #
     def state?(check_state)
       state == check_state
     end

data/lib/ably/modules/state_machine.rb

@@ -20,6 +20,7 @@ module Ably::Modules
     # * log state change failures to {Logger}
     #
     # @return [void]
+    #
     def transition_state(state, *args)
       unless result = transition_to(state.to_sym, *args)
         exception = exception_for_state_change_to(state)
@@ -29,16 +30,19 @@ module Ably::Modules
     end
 
     # @return [Statesman History Object]
+    #
     def previous_transition
       history[-2]
     end
 
     # @return [Symbol]
+    #
     def previous_state
       previous_transition.to_state if previous_transition
     end
 
     # @return [Ably::Exceptions::InvalidStateChange]
+    #
     def exception_for_state_change_to(state)
       error_message = "#{self.class}: Unable to transition from #{current_state} => #{state}"
       Ably::Exceptions::InvalidStateChange.new(error_message, nil, Ably::Exceptions::Codes::CHANNEL_OPERATION_FAILED_INVALID_CHANNEL_STATE)

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

@@ -1,14 +1,21 @@
 module Ably::Realtime
   class Channel
-    # Represents properties of a channel and its state
+    # Describes the properties of the channel state.
     class ChannelProperties
       # {Ably::Realtime::Channel} this object associated with
+      #
       # @return [Ably::Realtime::Channel]
+      #
       attr_reader :channel
 
-      # Contains the last channelSerial received in an ATTACHED ProtocolMesage for the channel, see RTL15a
+      # Starts unset when a channel is instantiated, then updated with the channelSerial from each
+      # {Ably::Realtime::Channel::STATE.Attached} event that matches the channel.
+      # Used as the value for {Ably::Realtime::Channel#history}.
+      #
+      # @spec CP2a
       #
       # @return [String]
+      #
       attr_reader :attach_serial
 
       def initialize(channel)

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

@@ -5,7 +5,9 @@ module Ably::Realtime
       private
 
       # Prepare and queue messages on the connection queue immediately
+      #
       # @return [Ably::Util::SafeDeferrable]
+      #
       def enqueue_messages_on_connection(client, raw_messages, channel_name, channel_options = {})
         messages = Array(raw_messages).map do |raw_msg|
           create_message(client, raw_msg, channel_options).tap do |message|

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

@@ -1,10 +1,6 @@
 module Ably::Realtime
   class Channel
-    # A push channel used for push notifications
-    # Each PushChannel maps to exactly one Realtime Channel
-    #
-    # @!attribute [r] channel
-    #   @return [Ably::Realtime::Channel] Underlying channel object
+    # Enables devices to subscribe to push notifications for a channel.
     #
     class PushChannel
       attr_reader :channel
@@ -18,35 +14,46 @@ module Ably::Realtime
         "<PushChannel: name=#{channel.name}>"
       end
 
-      # Subscribe local device for push notifications on this channel
+      # Subscribes the device to push notifications for the channel.
+      #
+      # @spec RSH7a
       #
       # @note This is unsupported in the Ruby library
       def subscribe_device(*args)
         raise_unsupported
       end
 
-      # Subscribe all devices registered to this client's authenticated client_id for push notifications on this channel
+      # Subscribes all devices associated with the current device's clientId to push notifications for the channel.
+      #
+      # @spec RSH7b
       #
       # @note This is unsupported in the Ruby library
       def subscribe_client_id(*args)
         raise_unsupported
       end
 
-      # Unsubscribe local device for push notifications on this channel
+      # Unsubscribes the device from receiving push notifications for the channel.
+      #
+      # @spec RSH7c
       #
       # @note This is unsupported in the Ruby library
       def unsubscribe_device(*args)
         raise_unsupported
       end
 
-      # Unsubscribe all devices registered to this client's authenticated client_id for push notifications on this channel
+      # Unsubscribes all devices associated with the current device's clientId from receiving push notifications for the channel.
+      #
+      # @spec RSH7d
       #
       # @note This is unsupported in the Ruby library
       def unsubscribe_client_id(*args)
         raise_unsupported
       end
 
-      # Get list of subscriptions on this channel for this device or authenticate client_id
+      # Retrieves all push subscriptions for the channel. Subscriptions can be filtered using a params object.
+      # Returns a {Ably::Models::PaginatedResult} object containing an array of {Ably::Models::PushChannelSubscription} objects.
+      #
+      # @spec RSH7e
       #
       # @note This is unsupported in the Ruby library
       def get_subscriptions(*args)

data/lib/ably/realtime/channel.rb

@@ -2,10 +2,8 @@ require 'ably/realtime/channel/publisher'
 
 module Ably
   module Realtime
-    # The Channel class represents a Channel belonging to this application.
-    # The Channel instance allows messages to be published and
-    # received, and controls the lifecycle of this instance's
-    # attachment to the channel.
+    # Enables messages to be published and subscribed to. Also enables historic messages to be retrieved and provides
+    # access to the {Ably::Realtime::Channel} object of a channel.
     #
     # Channels will always be in one of the following states:
     #
@@ -18,15 +16,17 @@ module Ably
     #
     # Note that the states are available as Enum-like constants:
     #
-    #   Channel::STATE.Initialized
-    #   Channel::STATE.Attaching
-    #   Channel::STATE.Attached
-    #   Channel::STATE.Detaching
-    #   Channel::STATE.Detached
-    #   Channel::STATE.Failed
-    #
-    # @!attribute [r] state
-    #   @return {Ably::Realtime::Connection::STATE} channel state
+    #   Channel::STATE.Initialized  The channel has been initialized but no attach has yet been attempted.
+    #   Channel::STATE.Attaching    An attach has been initiated by sending a request to Ably.
+    #                               This is a transient state, followed either by a transition to ATTACHED, SUSPENDED, or FAILED.
+    #   Channel::STATE.Attached     The attach has succeeded. In the ATTACHED state a client may publish and subscribe to messages, or be present on the channel.
+    #   Channel::STATE.Detaching    A detach has been initiated on an ATTACHED channel by sending a request to Ably.
+    #                               This is a transient state, followed either by a transition to DETACHED or FAILED.
+    #   Channel::STATE.Detached     The channel, having previously been ATTACHED, has been detached by the user.
+    #   Channel::STATE.Suspended    The channel, having previously been ATTACHED, has lost continuity, usually due to
+    #                               the client being disconnected from Ably for longer than two minutes. It will automatically attempt to reattach as soon as connectivity is restored.
+    #   Channel::STATE.Failed       An indefinite failure condition. This state is entered if a channel error
+    #                               has been received from the Ably service, such as an attempt to attach without the necessary access rights.
     #
     class Channel
       include Ably::Modules::Conversions
@@ -38,7 +38,10 @@ module Ably
       extend Ably::Modules::Enum
       extend Forwardable
 
-      # ChannelState
+      # The current {Abbly::Realtime::Channel::STATE} of the channel.
+      #
+      # @spec RTL2b
+      #
       # The permited states for this channel
       STATE = ruby_enum('STATE',
         :initialized,
@@ -50,8 +53,13 @@ module Ably
         :failed
       )
 
-      # ChannelEvent
+      # Describes the events emitted by a {Ably::Rest::Channel} or {Ably::Realtime::Channel} object.
+      # An event is either an UPDATE or a {Ably::Rest::Channel::STATE}.
+      #
       # The permitted channel events that are emitted for this channel
+      #
+      # @spec RTL2g
+      #
       EVENT = ruby_enum('EVENT',
         STATE.to_sym_arr + [:update]
       )
@@ -64,15 +72,18 @@ module Ably
       MAX_PROTOCOL_MESSAGE_BATCH_SIZE = 50
 
       # {Ably::Realtime::Client} associated with this channel
+      #
       # @return [Ably::Realtime::Client]
+      #
       # @api private
       attr_reader :client
 
-      # Channel name
+      # The channel name.
       # @return [String]
       attr_reader :name
 
-      # Push channel used for push notification
+      # A {Ably::Realtime::Channel::PushChannel} object.
+      #
       # @return [Ably::Realtime::Channel::PushChannel]
       attr_reader :push
 
@@ -80,11 +91,15 @@ module Ably
       # @return [Hash]
       attr_reader :options
 
-      # Properties of a channel and its state
+      # A {Ably::Realtime::Channel::ChannelProperties} object.
+      #
+      # @spec CP1, RTL15
+      #
       # @return [{Ably::Realtime::Channel::ChannelProperties}]
       attr_reader :properties
 
-      # When a channel failure occurs this attribute contains the Ably Exception
+      # An {Ably::Models::ErrorInfo} object describing the last error which occurred on the channel, if any.
+      # @spec RTL4e
       # @return [Ably::Models::ErrorInfo,Ably::Exceptions::BaseAblyException]
       attr_reader :error_reason
 
@@ -94,11 +109,12 @@ module Ably
       attr_reader :manager
 
       # Flag that specifies whether channel is resuming attachment(reattach) or is doing a 'clean attach' RTL4j1
-      # @return [Bolean]
+      # @return [Boolean]
       # @api private
       attr_reader :attach_resume
 
-      # ChannelOptions params attrribute (#RTL4k)
+      # Optional channel parameters that configure the behavior of the channel.
+      # @spec RTL4k1
       # return [Hash]
       def_delegators :options, :params
 
@@ -127,9 +143,11 @@ module Ably
         setup_presence
       end
 
-      # Publish one or more messages to the channel.
+      # Publish a message to the channel. A callback may optionally be passed in to this call to be notified of success
+      # or failure of the operation. When publish is called with this client library, it won't attempt to implicitly
+      # attach to the channel.
       #
-      # When publishing a message, if the channel is not attached, the channel is implicitly attached
+      # @spec RTL6i
       #
       # @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
@@ -195,9 +213,11 @@ module Ably
         end
       end
 
-      # Subscribe to messages matching providing event name, or all messages if event name not provided.
+      # Registers a listener for messages on this channel. The caller supplies a listener function, which is called
+      # each time one or more messages arrives on the channel. A callback may optionally be passed in to this call
+      # to be notified of success or failure of the channel {Ably::Realtime::Channel#attach} operation.
       #
-      # When subscribing to messages, if the channel is not attached, the channel is implicitly attached
+      # @spec RTL7a
       #
       # @param names [String] The event name of the message to subscribe to if provided.  Defaults to all events.
       # @yield [Ably::Models::Message] For each message received, the block is called
@@ -209,8 +229,9 @@ module Ably
         super
       end
 
-      # Unsubscribe the matching block for messages matching providing event name, or all messages if event name not provided.
-      # If a block is not provided, all subscriptions will be unsubscribed
+      # Deregisters the given listener for the specified event name(s). This removes an earlier event-specific subscription.
+      #
+      # @spec RTL8a
       #
       # @param names [String] The event name of the message to subscribe to if provided.  Defaults to all events.
       #
@@ -220,9 +241,15 @@ module Ably
         super
       end
 
-      # Attach to this channel, and call the block if provided when attached.
-      # Attaching to a channel is implicit in when a message is published or #subscribe is called, so it is uncommon
-      # to need to call attach explicitly.
+      # Attach to this channel ensuring the channel is created in the Ably system and all messages published on
+      # the channel are received by any channel listeners registered using {Ably::Realtime::Channel#subscribe}.
+      # Any resulting channel state change will be emitted to any listeners registered using the {Ably::Modules::EventEmitter#on}
+      # or {Ably::Modules::EventEmitter#once} methods. A callback may optionally be passed in to this call to be notified
+      # of success or failure of the operation. As a convenience, attach() is called implicitly
+      # if {Ably::Realtime::Channel#subscribe} for the channel is called, or {Ably::Realtime::Presence#enter}
+      # or {Ably::Realtime::Presence#subscribe} are called on the {Ably::Realtime::Presence} object for this channel.
+      #
+      # @spec RTL4d
       #
       # @yield [Ably::Realtime::Channel] Block is called as soon as this channel is in the Attached state
       # @return [Ably::Util::SafeDeferrable] Deferrable that supports both success (callback) and failure (errback) callback
@@ -245,7 +272,12 @@ module Ably
         deferrable_for_state_change_to(STATE.Attached, &success_block)
       end
 
-      # Detach this channel, and call the block if provided when in a Detached or Failed state
+      # Detach from this channel. Any resulting channel state change is emitted to any listeners registered using
+      # the {Ably::Modules::EventEmitter#on} or {Ably::Modules::EventEmitter#once} methods. A callback may optionally
+      # be passed in to this call to be notified of success or failure of the operation. Once all clients globally
+      # have detached from the channel, the channel will be released in the Ably service within two minutes.
+      #
+      # @spec RTL5e
       #
       # @yield [Ably::Realtime::Channel] Block is called as soon as this channel is in the Detached or Failed state
       # @return [Ably::Util::SafeDeferrable] Deferrable that supports both success (callback) and failure (errback) callback
@@ -274,9 +306,9 @@ module Ably
         deferrable_for_state_change_to(STATE.Detached, &success_block)
       end
 
-      # Presence object for this Channel.  This controls this client's
-      # presence on the channel and may also be used to obtain presence information
-      # and change events for other members of the channel.
+      # A {Ably::Realtime::Presence} object.
+      #
+      # @spec RTL9
       #
       # @return {Ably::Realtime::Presence}
       #
@@ -284,14 +316,15 @@ module Ably
         @presence
       end
 
-      # Return the message history of the channel
+      # Retrieves a {Ably::Models::PaginatedResult} object, containing an array of historical
+      # {Ably::Models::Message} objects for the channel. If the channel is configured to persist messages,
+      # then messages can be retrieved from history for up to 72 hours in the past. If not, messages can only
+      # be retrieved from history for up to two minutes in the past.
       #
-      # If the channel is attached, you can retrieve messages published on the channel before the
-      # channel was attached with the option <tt>until_attach: true</tt>.  This is useful when a developer
-      # wishes to display historical messages with the guarantee that no messages have been missed since attach.
+      # @spec RSL2a
       #
-      # @param (see Ably::Rest::Channel#history)
-      # @option options (see Ably::Rest::Channel#history)
+      # @param (see {Ably::Rest::Channel#history})
+      # @option options (see {Ably::Rest::Channel#history})
       # @option options [Boolean]  :until_attach  When true, the history request will be limited only to messages published before this channel was attached. Channel must be attached
       #
       # @yield [Ably::Models::PaginatedResult<Ably::Models::Message>] First {Ably::Models::PaginatedResult page} of {Ably::Models::Message} objects accessible with {Ably::Models::PaginatedResult#items #items}.
@@ -312,8 +345,8 @@ module Ably
         end
       end
 
-      # @!attribute [r] __incoming_msgbus__
       # @return [Ably::Util::PubSub] Client library internal channel incoming message bus
+      #
       # @api private
       def __incoming_msgbus__
         @__incoming_msgbus__ ||= Ably::Util::PubSub.new(
@@ -321,7 +354,11 @@ module Ably
         )
       end
 
-      # Sets or updates the stored channel options. (#RTL16)
+      # Sets the {Ably::Models::ChannelOptions} for the channel.
+      # An optional callback may be provided to notify of the success or failure of the operation.
+      #
+      # @spec 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)

data/lib/ably/realtime/channels.rb

@@ -5,28 +5,29 @@ module Ably
       include Ably::Modules::ChannelsCollection
 
       # @return [Ably::Realtime::Channels]
+      #
       def initialize(client)
         super client, Ably::Realtime::Channel
       end
 
-      # @!method get(name, channel_options = {})
       # Return a {Ably::Realtime::Channel} for the given name
       #
       # @param name [String] The name of the channel
       # @param channel_options [Hash, Ably::Models::ChannelOptions] A hash of options or a {Ably::Models::ChannelOptions}
-      # @return [Ably::Realtime::Channel}
+      #
+      # @return [Ably::Realtime::Channel]
       #
       def get(*args)
         super
       end
 
-      # @!method fetch(name, &missing_block)
       # Return a {Ably::Realtime::Channel} for the given name if it exists, else the block will be called.
       # This method is intentionally similar to {http://ruby-doc.org/core-2.1.3/Hash.html#method-i-fetch Hash#fetch} providing a simple way to check if a channel exists or not without creating one
       #
       # @param name [String] The name of the channel
       # @yield [options] (optional) if a missing_block is passed to this method and no channel exists matching the name, this block is called
       # @yieldparam [String] name of the missing channel
+      #
       # @return [Ably::Realtime::Channel]
       #
       def fetch(*args)

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

@@ -121,23 +121,15 @@ module Ably::Realtime
             presence.manager.sync_process_messages protocol_message.channel_serial, protocol_message.presence
 
           when ACTION.Presence
-            if protocol_message.has_correct_message_size?
-              presence = get_channel(protocol_message.channel).presence
-              protocol_message.presence.each do |presence_message|
-                presence.__incoming_msgbus__.publish :presence, presence_message
-              end
-            else
-              logger.fatal Ably::Exceptions::ProtocolError.new("Not published. Channel message limit exceeded #{protocol_message.message_size} bytes", 400, Ably::Exceptions::Codes::UNABLE_TO_RECOVER_CHANNEL_MESSAGE_LIMIT_EXCEEDED).message
+            presence = get_channel(protocol_message.channel).presence
+            protocol_message.presence.each do |presence_message|
+              presence.__incoming_msgbus__.publish :presence, presence_message
             end
 
           when ACTION.Message
-            if protocol_message.has_correct_message_size?
-              channel = get_channel(protocol_message.channel)
-              protocol_message.messages.each do |message|
-                channel.__incoming_msgbus__.publish :message, message
-              end
-            else
-              logger.fatal Ably::Exceptions::ProtocolError.new("Not published. Channel message limit exceeded #{protocol_message.message_size} bytes", 400, Ably::Exceptions::Codes::UNABLE_TO_RECOVER_CHANNEL_MESSAGE_LIMIT_EXCEEDED).message
+            channel = get_channel(protocol_message.channel)
+            protocol_message.messages.each do |message|
+              channel.__incoming_msgbus__.publish :message, message
             end
 
           when ACTION.Auth