ably-pubsub-core 0.0.1.pre → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfde17dfbe0fdf4231002551f59c0640790f5dbc9c9ffbae01494cd96289136c
-  data.tar.gz: aaaa739481288c462335970bbb82b6244fd28d93fd6f9d65f35bb2f1c9c753e8
+  metadata.gz: 56f7d1d6dadea1c1ac1f9c4b71d0cd24ed32377413656387cb0caaab28f24675
+  data.tar.gz: bc390317b2eb7d61889163f263338b47acde921f51273918f782560475e1a8ec
 SHA512:
-  metadata.gz: 0f16bb38d800bae45523d42c8fad9eba0fda282d4c4f199b907ded1bc7ce08c4d4a2efd0c1b8375c8d92b9db6be7439189cb68e61cde72bcc66be7f9ae4d8a10
-  data.tar.gz: 96e428f0903e4411d14073130dac860501c51d58bc0b2a684a9a2b68a5a4e7fccb451412bdbb2b55aed76b358ea95ba4456c1558ae3922ed6b1b0c6e77a7bdae
+  metadata.gz: 7e962e44c31361de7d343cd88013a9be3bc772c944a80af3372ec387965ae17cd133c11ca66fe1bc81f0d2d9fd2eb8ac7a424b5d6ffec394c6a89ee21b204a0b
+  data.tar.gz: 7ed83f9bcf06222c7a204728e113e5c6406d79ac9841c2ee2c742157e9c2388b748eef4a6f43a06e861af269a531b8b88a7d35b5c4531ab0e8336cfc1d0421d1

data/lib/ably/auth.rb

@@ -2,7 +2,7 @@ require 'json'
 require 'faraday'
 require 'securerandom'
 
-require 'ably/rest/middleware/external_exceptions'
+require 'ably/pubsub/http/middleware/external_exceptions'
 
 module Ably
   # Creates Ably {Ably::Models::TokenRequest} objects and obtains Ably Tokens from Ably to subsequently issue to less trusted clients.
@@ -45,7 +45,7 @@ module Ably
 
     # Creates an Auth object
     #
-    # @param [Ably::Rest::Client] client  {Ably::Rest::Client} this Auth object uses
+    # @param [Ably::PubSub::Http::Client] client  {Ably::PubSub::Http::Client} this Auth object uses
     # @param [Hash] token_params the token params used as a default for future token requests
     # @param [Hash] auth_options the authentication options used as a default future token requests
     # @option (see #request_token)
@@ -123,7 +123,7 @@ module Ably
     #
     # @example
     #    # will issue a simple token request using basic auth
-    #    client = Ably::Rest::Client.new(key: 'key.id:secret')
+    #    client = Ably::PubSub::Server.create_http_client(key: 'key.id:secret')
     #    token_details = client.auth.authorize
     #
     #    # will use token request from block to authorize if not already authorized
@@ -214,7 +214,7 @@ module Ably
     #
     # @example
     #    # simple token request using basic auth
-    #    client = Ably::Rest::Client.new(key: 'key.id:secret')
+    #    client = Ably::PubSub::Server.create_http_client(key: 'key.id:secret')
     #    token_details = client.auth.request_token
     #
     #    # token request with token params
@@ -759,7 +759,7 @@ module Ably
         setup_outgoing_middleware builder
 
         # Raise exceptions if response code is invalid
-        builder.use Ably::Rest::Middleware::ExternalExceptions
+        builder.use Ably::PubSub::Http::Middleware::ExternalExceptions
 
         setup_incoming_middleware builder, logger
 

data/lib/ably/exceptions.rb

@@ -165,5 +165,10 @@ module Ably
     class InvalidTokenRequest < BaseAblyException; end
 
     class PushNotificationsNotSupported < BaseAblyException; end
+
+    # A client class was constructed directly rather than through the factory function of
+    # an Ably per-side package. The package a client is created from is what declares the
+    # client's side to the platform, so a directly constructed client declares none.
+    class DirectConstructionNotSupported < BaseAblyException; end
   end
 end

data/lib/ably/internal.rb

@@ -0,0 +1,115 @@
+module Ably
+  # Construction entry points for Ably's own per-side packages: +ably-pubsub-server+, and
+  # any future device-side package, plus endpoint resolution shared by the clients.
+  #
+  # Applications must not use this module. It carries no compatibility guarantee and may
+  # change in any release, including a patch. Use the factory functions of the package you
+  # installed — see {Ably::PubSub::Server} in the +ably-pubsub-server+ gem.
+  #
+  # The client classes refuse direct construction ({Ably::PubSub::Http::Client.new} and
+  # {Ably::PubSub::Realtime::Client.new} raise {Ably::Exceptions::DirectConstructionNotSupported}),
+  # because the package a client is created from is what declares the client's side to the
+  # platform and a directly constructed client declares none. These entry points are how a
+  # per-side package constructs the client it has stamped its side onto.
+  module Internal
+    # Prefix of an +:endpoint+ value that selects a non-production routing policy, such as +nonprod:sandbox+
+    NONPROD_ENDPOINT_PREFIX = 'nonprod:'.freeze
+    NONPROD_ROOT_DOMAIN = 'ably-nonprod.net'.freeze
+    NONPROD_FALLBACK_DOMAIN = 'ably-realtime-nonprod.com'.freeze
+    private_constant :NONPROD_ENDPOINT_PREFIX, :NONPROD_ROOT_DOMAIN, :NONPROD_FALLBACK_DOMAIN
+
+    class << self
+      # Constructs an {Ably::PubSub::Http::Client}, bypassing the direct-construction refusal.
+      #
+      # @param options [Hash, String] as accepted by {Ably::PubSub::Http::Client#initialize}
+      # @return [Ably::PubSub::Http::Client]
+      # @api private
+      def create_http_client(options)
+        construct(Ably::PubSub::Http::Client, options)
+      end
+
+      # Constructs an {Ably::PubSub::Realtime::Client}, bypassing the direct-construction refusal.
+      #
+      # @param options [Hash, String] as accepted by {Ably::PubSub::Realtime::Client#initialize}
+      # @return [Ably::PubSub::Realtime::Client]
+      # @api private
+      def create_realtime_client(options)
+        construct(Ably::PubSub::Realtime::Client, options)
+      end
+
+      # Builds the error raised when a client is constructed directly. Shared so the
+      # refusals on the client classes and on the Ably::PubSub::Http /
+      # Ably::PubSub::Realtime convenience aliases all speak with one voice.
+      #
+      # @param subject [String] the unsupported call, e.g. +"Ably::PubSub::Http::Client.new"+
+      # @param factory [String] the supported call to use instead
+      # @return [Ably::Exceptions::DirectConstructionNotSupported]
+      # @api private
+      def direct_construction_error(subject, factory)
+        Ably::Exceptions::DirectConstructionNotSupported.new <<~MSG
+          #{subject} is not supported: Ably clients cannot be constructed directly.
+
+          Use the factory function of the Ably package you installed, for example:
+            #{factory}   # ably-pubsub-server
+
+          The package a client is created from is what declares the client's side to the
+          platform. A directly constructed client declares none, so the platform cannot
+          classify it for MAU billing.
+        MSG
+      end
+
+      # Returns the primary domain for the given +:endpoint+ client option value
+      #
+      # @spec REC1b2, REC1b3, REC1b4
+      # @param endpoint [String] a routing policy name such as +main+, a +nonprod:[id]+ routing policy, or a hostname
+      # @return [String]
+      # @api private
+      def primary_domain(endpoint)
+        return endpoint if hostname_endpoint?(endpoint)
+
+        if nonprod_endpoint?(endpoint)
+          "#{nonprod_endpoint_id(endpoint)}.realtime.#{NONPROD_ROOT_DOMAIN}"
+        else
+          "#{endpoint}.realtime.#{Ably::PROD_ROOT_DOMAIN}"
+        end
+      end
+
+      # Returns the default fallback domains for the given +:endpoint+ client option value
+      #
+      # @spec REC2c1, REC2c2, REC2c3, REC2c4
+      # @param endpoint [String] a routing policy name such as +main+, a +nonprod:[id]+ routing policy, or a hostname
+      # @return [Array<String>] empty when +endpoint+ is a hostname
+      # @api private
+      def fallback_domains(endpoint)
+        return [] if hostname_endpoint?(endpoint)
+
+        if nonprod_endpoint?(endpoint)
+          Ably::FALLBACK_IDS.map { |id| "#{nonprod_endpoint_id(endpoint)}.#{id}.fallback.#{NONPROD_FALLBACK_DOMAIN}" }
+        else
+          Ably::FALLBACK_IDS.map { |id| "#{endpoint}.#{id}.fallback.#{Ably::PROD_FALLBACK_DOMAIN}" }
+        end
+      end
+
+      private
+
+      # +allocate+ skips the class's overridden +new+, so +initialize+ has to be invoked
+      # explicitly. Every client instance in the library is built through here.
+      def construct(klass, options)
+        klass.allocate.tap { |client| client.send(:initialize, options) }
+      end
+
+      # @spec REC1b2
+      def hostname_endpoint?(endpoint)
+        endpoint.include?('.') || endpoint.include?('::') || endpoint == 'localhost'
+      end
+
+      def nonprod_endpoint?(endpoint)
+        endpoint.start_with?(NONPROD_ENDPOINT_PREFIX)
+      end
+
+      def nonprod_endpoint_id(endpoint)
+        endpoint.delete_prefix(NONPROD_ENDPOINT_PREFIX)
+      end
+    end
+  end
+end

data/lib/ably/logger.rb

@@ -1,12 +1,12 @@
 module Ably
   # Logger unifies logging for #debug, #info, #warn, #error, and #fatal messages.
   # A new Ably client uses this Logger and sets the appropriate log level.
-  # A custom Logger can be configured when instantiating the client, refer to the {Ably::Rest::Client} and {Ably::Realtime::Client} documentation
+  # A custom Logger can be configured when instantiating the client, refer to the {Ably::PubSub::Http::Client} and {Ably::PubSub::Realtime::Client} documentation
   #
   class Logger
     extend Forwardable
 
-    # @param client        [Ably::Rest::Client,Ably::Realtime::Client] Rest or Realtime Ably client
+    # @param client        [Ably::PubSub::Http::Client,Ably::PubSub::Realtime::Client] Rest or Realtime Ably client
     # @param log_level     [Integer] {http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html Ruby Logger} log level
     # @param custom_logger [nil,Object] A custom logger can optionally be used instead of the,
     #                      however it must provide a {http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html Ruby Logger} compatible interface.
@@ -83,7 +83,7 @@ module Ably
     end
 
     def realtime?
-      defined?(Ably::Realtime::Client) && client.kind_of?(Ably::Realtime::Client)
+      defined?(Ably::PubSub::Realtime::Client) && client.kind_of?(Ably::PubSub::Realtime::Client)
     end
 
     def default_logger

data/lib/ably/models/channel_details.rb

@@ -14,7 +14,7 @@ module Ably::Models
     end
   end
 
-  # Contains the details of a {Ably::Models::Rest::Channel} or {Ably::Models::Realtime::Channel} object
+  # Contains the details of a {Ably::PubSub::Http::Channel} or {Ably::PubSub::Realtime::Channel} object
   # such as its ID and {Ably::Models::ChannelStatus}.
   #
   class ChannelDetails

data/lib/ably/models/channel_metrics.rb

@@ -14,7 +14,7 @@ module Ably::Models
     end
   end
 
-  # Contains the metrics associated with a {Ably::Models::Rest::Channel} or {Ably::Models::Realtime::Channel},
+  # Contains the metrics associated with a {Ably::PubSub::Http::Channel} or {Ably::PubSub::Realtime::Channel},
   # such as the number of publishers, subscribers and connections it has.
   #
   # @spec CHM1

data/lib/ably/models/channel_occupancy.rb

@@ -14,7 +14,7 @@ module Ably::Models
     end
   end
 
-  # Contains the metrics of a {Ably::Models::Rest::Channel} or {Ably::Models::Realtime::Channel} object.
+  # Contains the metrics of a {Ably::PubSub::Http::Channel} or {Ably::PubSub::Realtime::Channel} object.
   #
   # @spec CHO1
   #

data/lib/ably/models/channel_state_change.rb

@@ -1,5 +1,5 @@
 module Ably::Models
-  # Contains state change information emitted by {Ably::Rest::Channel} and {Ably::Realtime::Channel} objects.
+  # Contains state change information emitted by {Ably::PubSub::Http::Channel} and {Ably::PubSub::Realtime::Channel} objects.
   #
   class ChannelStateChange
     include Ably::Modules::ModelCommon
@@ -21,31 +21,31 @@ module Ably::Models
       raise ArgumentError, e
     end
 
-    # The new current {Ably::Realtime::Channel::STATE}.
+    # The new current {Ably::PubSub::Realtime::Channel::STATE}.
     #
     # @spec RTL2a, RTL2b
     #
-    # @return [Ably::Realtime::Channel::STATE]
+    # @return [Ably::PubSub::Realtime::Channel::STATE]
     #
     def current
       @hash_object[:current]
     end
 
-    # The previous state. For the {Ably::Realtime::Channel::EVENT}(:update) event, this is equal to the current {Ably::Realtime::Channel::STATE}.
+    # The previous state. For the {Ably::PubSub::Realtime::Channel::EVENT}(:update) event, this is equal to the current {Ably::PubSub::Realtime::Channel::STATE}.
     #
     # @spec RTL2a, RTL2b
     #
-    # @return [Ably::Realtime::Channel::EVENT]
+    # @return [Ably::PubSub::Realtime::Channel::EVENT]
     #
     def previous
       @hash_object[:previous]
     end
 
-    # The event that triggered this {Ably::Realtime::Channel::STATE} change.
+    # The event that triggered this {Ably::PubSub::Realtime::Channel::STATE} change.
     #
     # @spec TH5
     #
-    # @return [Ably::Realtime::Channel::STATE]
+    # @return [Ably::PubSub::Realtime::Channel::STATE]
     #
     def event
       @hash_object[:event]

data/lib/ably/models/channel_status.rb

@@ -14,7 +14,7 @@ module Ably::Models
     end
   end
 
-  # Contains the status of a {Ably::Models::Rest::Channel} or {Ably::Models::Realtime::Channel} object
+  # Contains the status of a {Ably::PubSub::Http::Channel} or {Ably::PubSub::Realtime::Channel} object
   # such as whether it is active and its {Ably::Models::ChannelOccupancy}.
   #
   # @spec CHS1

data/lib/ably/models/cipher_params.rb

@@ -17,7 +17,7 @@ module Ably::Models
     end
   end
 
-  # Sets the properties to configure encryption for a {Ably::Models::Rest::Channel} or {Ably::Models::Realtime::Channel} object.
+  # Sets the properties to configure encryption for a {Ably::PubSub::Http::Channel} or {Ably::PubSub::Realtime::Channel} object.
   #
   class CipherParams
     include Ably::Modules::ModelCommon

data/lib/ably/models/connection_details.rb

@@ -14,8 +14,8 @@ module Ably::Models
     end
   end
 
-  # Contains any constraints a client should adhere to and provides additional metadata about a {Ably::Realtime::Connection},
-  # such as if a request to {Ably::Realtime::Client#publish} a message that exceeds the maximum message size should be rejected immediately without communicating with Ably.
+  # Contains any constraints a client should adhere to and provides additional metadata about a {Ably::PubSub::Realtime::Connection},
+  # such as if a request to {Ably::PubSub::Realtime::Client#publish} a message that exceeds the maximum message size should be rejected immediately without communicating with Ably.
   #
   class ConnectionDetails
     include Ably::Modules::ModelCommon

data/lib/ably/models/connection_state_change.rb

@@ -1,5 +1,5 @@
 module Ably::Models
-  # Contains {Ably::Models::ConnectionState} change information emitted by the {Ably::Realtime::Connection} object.
+  # Contains {Ably::Models::ConnectionState} change information emitted by the {Ably::PubSub::Realtime::Connection} object.
   #
   class ConnectionStateChange
     include Ably::Modules::ModelCommon
@@ -21,21 +21,21 @@ module Ably::Models
       raise ArgumentError, e
     end
 
-    # The new {Ably::Realtime::Connection::STATE}.
+    # The new {Ably::PubSub::Realtime::Connection::STATE}.
     #
     # @spec TA2
     #
-    # @return [Ably::Realtime::Connection::STATE]
+    # @return [Ably::PubSub::Realtime::Connection::STATE]
     #
     def current
       @hash_object[:current]
     end
 
-    # The event that triggered this {Ably::Realtime::Connection::EVENT} change.
+    # The event that triggered this {Ably::PubSub::Realtime::Connection::EVENT} change.
     #
     # @spec TA5
     #
-    # @return [Ably::Realtime::Connection::STATE]
+    # @return [Ably::PubSub::Realtime::Connection::STATE]
     #
     def event
       @hash_object[:event]
@@ -46,7 +46,7 @@ module Ably::Models
     #
     # @spec TA2
     #
-    # @return [Ably::Realtime::Connection::STATE]
+    # @return [Ably::PubSub::Realtime::Connection::STATE]
     #
     def previous
       @hash_object[:previous]

data/lib/ably/models/http_paginated_response.rb

@@ -1,13 +1,13 @@
 require 'ably/models/paginated_result'
 
 module Ably::Models
-  # HTTP respones object from Rest#request object
+  # HTTP response object from Ably::PubSub::Http::Client#request
   # Wraps any Ably HTTP response that supports paging and provides methods to iterate through
   # the pages using {#first}, {#next}, {#has_next?} and {#last?}
 
   class HttpPaginatedResponse < PaginatedResult
     # Retrieve the first page of results.
-    # When used as part of the {Ably::Realtime} library, it will return a {Ably::Util::SafeDeferrable} object,
+    # When used as part of the {Ably::PubSub::Realtime} library, it will return a {Ably::Util::SafeDeferrable} object,
     #   and allows an optional success callback block to be provided.
     #
     # @return [HttpPaginatedResponse,Ably::Util::SafeDeferrable]
@@ -20,7 +20,7 @@ module Ably::Models
     end
 
     # Retrieve the next page of results.
-    # When used as part of the {Ably::Realtime} library, it will return a {Ably::Util::SafeDeferrable} object,
+    # When used as part of the {Ably::PubSub::Realtime} library, it will return a {Ably::Util::SafeDeferrable} object,
     #   and allows an optional success callback block to be provided.
     #
     # @return [HttpPaginatedResponse,Ably::Util::SafeDeferrable]

data/lib/ably/models/message.rb

@@ -25,7 +25,21 @@ module Ably::Models
     include Ably::Modules::Conversions
     include Ably::Modules::Encodeable
     include Ably::Modules::ModelCommon
-    include Ably::Modules::SafeDeferrable if defined?(Ably::Realtime)
+    include Ably::Modules::SafeDeferrable if defined?(Ably::PubSub::Realtime)
+    extend Ably::Modules::Enum
+
+    # Describes the possible actions for a message.
+    #
+    # @spec TM5
+    #
+    ACTION = ruby_enum('ACTION',
+      :message_create,    # 0
+      :message_update,    # 1
+      :message_delete,    # 2
+      :meta,              # 3
+      :message_summary,   # 4
+      :message_append,    # 5
+    )
 
     # Statically register a default set of encoders for this class
     Ably::Models::MessageEncoders.register_default_encoders self
@@ -129,10 +143,63 @@ module Ably::Models
       end
     end
 
+    # The action type of this message.
+    #
+    # @spec TM2j
+    #
+    # @return [ACTION, nil]
+    #
+    def action
+      ACTION(attributes[:action]) if attributes[:action]
+    end
+
+    # An opaque string that uniquely identifies the message within a channel.
+    #
+    # @spec TM2r
+    #
+    # @return [String, nil]
+    #
+    def serial
+      attributes[:serial]
+    end
+
+    # Version information about this message.
+    #
+    # @spec TM2s
+    #
+    # @return [Hash, nil]
+    #
+    def version
+      attributes[:version]
+    end
+
+    # Timestamp of when the message was created.
+    #
+    # @return [Time, nil]
+    #
+    def created_at
+      as_time_from_epoch(attributes[:created_at]) if attributes[:created_at]
+    end
+
+    # Timestamp of when the message was last updated.
+    #
+    # @return [Time, nil]
+    #
+    def updated_at
+      as_time_from_epoch(attributes[:updated_at]) if attributes[:updated_at]
+    end
+
     def attributes
       @attributes
     end
 
+    # Return a JSON ready object from the underlying #attributes using Ably naming conventions for keys
+    def as_json(*args)
+      attributes.dup.tap do |message|
+        message['action'] = action.to_i if attributes[:action]
+      end.as_json.reject { |key, val| val.nil? }
+    end
+
     def to_json(*args)
       as_json(*args).tap do |message|
         decode_binary_data_before_to_json message
@@ -212,7 +279,7 @@ module Ably::Models
     end
 
     def set_attributes_object(new_attributes)
-      @attributes = IdiomaticRubyWrapper(new_attributes.clone, stop_at: [:data, :extras])
+      @attributes = IdiomaticRubyWrapper(new_attributes.clone, stop_at: [:data, :extras, :version])
     end
 
     def logger

data/lib/ably/models/message_operation.rb

@@ -0,0 +1,53 @@
+module Ably::Models
+  # Represents the operation metadata for update, delete, or append message operations.
+  #
+  # @spec MOP
+  #
+  class MessageOperation
+    include Ably::Modules::ModelCommon
+
+    # @param attributes [Hash]
+    # @option attributes [String] :client_id The client ID of the user performing the operation (MOP2a)
+    # @option attributes [String] :description An optional human-readable description of the operation (MOP2b)
+    # @option attributes [Hash]   :metadata Arbitrary key-value metadata for the operation (MOP2c)
+    #
+    def initialize(attributes = {})
+      @hash_object = IdiomaticRubyWrapper(attributes || {}, stop_at: [:metadata])
+      @hash_object.freeze
+    end
+
+    # The client ID of the user performing the operation.
+    #
+    # @spec MOP2a
+    #
+    # @return [String, nil]
+    #
+    def client_id
+      attributes[:client_id]
+    end
+
+    # An optional human-readable description of the operation.
+    #
+    # @spec MOP2b
+    #
+    # @return [String, nil]
+    #
+    def description
+      attributes[:description]
+    end
+
+    # Arbitrary key-value metadata for the operation.
+    #
+    # @spec MOP2c
+    #
+    # @return [Hash, nil]
+    #
+    def metadata
+      attributes[:metadata]
+    end
+
+    def attributes
+      @hash_object
+    end
+  end
+end

data/lib/ably/models/paginated_result.rb

@@ -4,7 +4,7 @@ module Ably::Models
   # that indicates the relative queries available to the PaginatedResult object.
   #
   class PaginatedResult
-    include Ably::Modules::AsyncWrapper if defined?(Ably::Realtime)
+    include Ably::Modules::AsyncWrapper if defined?(Ably::PubSub::Realtime)
 
     # Contains the current page of results; for example, an array of {Ably::Models::Message} or {Ably::Models::PresenceMessage} objects
     # for a channel history request.
@@ -59,7 +59,7 @@ module Ably::Models
 
     # Retrieve the next page of results.
     #
-    # When used as part of the {Ably::Realtime} library, it will return a {Ably::Util::SafeDeferrable} object,
+    # When used as part of the {Ably::PubSub::Realtime} library, it will return a {Ably::Util::SafeDeferrable} object,
     # and allows an optional success callback block to be provided.
     #
     # @spec TG4

data/lib/ably/models/presence_message.rb

@@ -24,7 +24,7 @@ module Ably::Models
     include Ably::Modules::Conversions
     include Ably::Modules::Encodeable
     include Ably::Modules::ModelCommon
-    include Ably::Modules::SafeDeferrable if defined?(Ably::Realtime)
+    include Ably::Modules::SafeDeferrable if defined?(Ably::PubSub::Realtime)
     extend Ably::Modules::Enum
 
     # Describes the possible actions members in the presence set can emit.

data/lib/ably/models/protocol_message.rb

@@ -36,7 +36,7 @@ module Ably::Models
   class ProtocolMessage
     include Ably::Modules::ModelCommon
     include Ably::Modules::Encodeable
-    include Ably::Modules::SafeDeferrable if defined?(Ably::Realtime)
+    include Ably::Modules::SafeDeferrable if defined?(Ably::PubSub::Realtime)
     extend Ably::Modules::Enum
 
     # Actions which are sent by the Ably Realtime API
@@ -171,6 +171,19 @@ module Ably::Models
       @params ||= attributes[:params].to_h
     end
 
+    # The res field from ACK protocol messages (protocol v5+), containing publish results.
+    # Each entry corresponds to an ACK'd ProtocolMessage and contains a serials array
+    # with one entry per message in that ProtocolMessage.
+    #
+    # @spec TR4s
+    #
+    # @return [Array, nil]
+    #
+    # @api private
+    def res
+      attributes[:res]
+    end
+
     def flags
       Integer(attributes[:flags])
     rescue TypeError

data/lib/ably/models/publish_result.rb

@@ -0,0 +1,32 @@
+module Ably::Models
+  # Contains the result of a publish operation.
+  #
+  # @spec RSL1n
+  #
+  class PublishResult
+    include Ably::Modules::ModelCommon
+
+    # @param attributes [Hash]
+    # @option attributes [Array<String, nil>] :serials An array of nullable strings corresponding 1:1
+    #   to the published messages. Each serial identifies the message on the channel.
+    #
+    def initialize(attributes = {})
+      @hash_object = IdiomaticRubyWrapper(attributes || {}, stop_at: [:serials])
+      @hash_object.freeze
+    end
+
+    # An array of serial strings (or nil entries), corresponding 1:1 to the published messages.
+    #
+    # @spec RSL1n
+    #
+    # @return [Array<String, nil>]
+    #
+    def serials
+      attributes[:serials] || []
+    end
+
+    def attributes
+      @hash_object
+    end
+  end
+end