ably-rest 1.1.2 → 1.2.2

data/lib/submodules/ably-ruby/UPDATING.md

@@ -0,0 +1,30 @@
+# Upgrade / Migration Guide
+
+## Version 1.1.8 to 1.2.0
+
+### Notable Changes
+This release is all about channel options. Here is the full [changelog](https://github.com/ably/ably-ruby/blob/main/CHANGELOG.md)
+
+* Channel options were extracted into a seperate model [ChannelOptions](https://github.com/ably/ably-ruby/blob/main/lib/ably/models/channel_options.rb). However it's still backward campatible with `Hash` and you don't need to do make any adjustments to your code
+
+* The `ChannelOptions` class now supports `:params`, `:modes` and `:cipher` as options. Previously only `:cipher` was available
+
+* The client `:idempotent_rest_publishing` option is `true` by default. Previously `:idempotent_rest_publishing` was `false` by default.
+
+### Breaking Changes
+
+* Changing channel options with `Channels#get` is now deprecated in favor of explicit options change
+
+  1. If channel state is attached or attaching an exception will be raised
+  2. Otherwise the library will emit a warning
+
+For example, the following code
+```
+  client.channels.get(channel_name, new_channel_options)
+```
+
+Should be changed to:
+```
+  channel = client.channels.get(channel_name)
+  channel.options = new_channel_options
+```

data/lib/submodules/ably-ruby/ably.gemspec

@@ -20,38 +20,31 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'eventmachine', '~> 1.2.6'
   spec.add_runtime_dependency 'em-http-request', '~> 1.1'
-  spec.add_runtime_dependency 'statesman', '~> 1.0.0'
-  spec.add_runtime_dependency 'faraday', '~> 0.12'
-  spec.add_runtime_dependency 'excon', '~> 0.55'
-
-  if RUBY_VERSION.match(/^1\./)
-    spec.add_runtime_dependency 'json', '< 2.0'
-  else
-    spec.add_runtime_dependency 'json'
-  end
+  spec.add_runtime_dependency 'statesman', '~> 9.0'
+  spec.add_runtime_dependency 'faraday', '~> 2.2'
+  spec.add_runtime_dependency 'faraday-typhoeus', '~> 0.2.0'
+  spec.add_runtime_dependency 'typhoeus', '~> 1.4'
+  spec.add_runtime_dependency 'json'
   spec.add_runtime_dependency 'websocket-driver', '~> 0.7'
   spec.add_runtime_dependency 'msgpack', '>= 1.3.0'
   spec.add_runtime_dependency 'addressable', '>= 2.0.0'
 
-  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'redcarpet', '~> 3.3'
-  spec.add_development_dependency 'rspec', '~> 3.3.0' # version lock, see config.around(:example, :event_machine) in event_machine_helper.rb
+  spec.add_development_dependency 'rspec', '~> 3.11.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.5.1'
   spec.add_development_dependency 'rspec-retry', '~> 0.6'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'rspec-instafail', '~> 1.0'
   spec.add_development_dependency 'bundler', '>= 1.3.0'
+  spec.add_development_dependency 'webmock', '~> 3.11'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
+  spec.add_development_dependency 'parallel_tests', '~> 3.8'
+  spec.add_development_dependency 'pry', '~> 0.14.1'
+  spec.add_development_dependency 'pry-byebug', '~> 3.8.0'
 
-  if RUBY_VERSION.match(/^1\./)
-    spec.add_development_dependency 'public_suffix', '~> 1.4.6' # Later versions do not support Ruby 1.9
-    spec.add_development_dependency 'webmock', '2.2'
-    spec.add_development_dependency 'parallel_tests', '~> 2.9.0'
-  else
-    spec.add_development_dependency 'webmock', '~> 2.2'
-    spec.add_development_dependency 'coveralls'
-    spec.add_development_dependency 'parallel_tests', '~> 2.22'
-    if !RUBY_VERSION.match(/^2\.[0123]/)
-      spec.add_development_dependency 'pry'
-      spec.add_development_dependency 'pry-byebug'
-    end
+  if RUBY_VERSION.match(/^3\./)
+    spec.add_development_dependency 'webrick', '~> 1.7.0'
   end
 end

data/lib/submodules/ably-ruby/lib/ably/agent.rb

@@ -0,0 +1,3 @@
+module Ably
+  AGENT = "ably-ruby/#{Ably::VERSION} ruby/#{RUBY_VERSION}"
+end

data/lib/submodules/ably-ruby/lib/ably/auth.rb

@@ -5,9 +5,9 @@ require 'securerandom'
 require 'ably/rest/middleware/external_exceptions'
 
 module Ably
-  # 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
   #
-  # 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
   #   @return [String] The provided client ID, used for identifying this client for presence purposes
@@ -35,7 +35,7 @@ module Ably
 
     API_KEY_REGEX = /^[\w-]{2,}\.[\w-]{2,}:[\w-]{2,}$/
 
-    # Supported AuthOption keys, see https://www.ably.io/documentation/realtime/types#auth-options
+    # Supported AuthOption keys, see https://www.ably.com/docs/realtime/types#auth-options
     # TODO: Review client_id usage embedded incorrectly within AuthOptions.
     #       This is legacy code to configure a client with a client_id from the ClientOptions
     # TODO: Review inclusion of use_token_auth, ttl, token_params in auth options
@@ -103,7 +103,6 @@ module Ably
       end
 
       if has_client_id? && !token_creatable_externally? && !token_option
-        raise ArgumentError, 'client_id cannot be provided without a complete API key or means to authenticate. An API key is needed to automatically authenticate with Ably and obtain a token' unless api_key_present?
         @client_id = ensure_utf_8(:client_id, client_id) if client_id
       end
 
@@ -278,7 +277,7 @@ module Ably
     #
     # @param [Hash] token_params the token params used in the token request
     # @option token_params [String]  :client_id     A client ID to associate with this token. The generated token may be used to authenticate as this +client_id+
-    # @option token_params [Integer] :ttl           validity time in seconds for the requested {Ably::Models::TokenDetails}.  Limits may apply, see {https://www.ably.io/documentation/other/authentication}
+    # @option token_params [Integer] :ttl           validity time in seconds for the requested {Ably::Models::TokenDetails}.  Limits may apply, see {https://www.ably.com/docs/general/authentication}
     # @option token_params [Hash]    :capability    canonicalised representation of the resource paths and associated operations
     # @option token_params [Time]    :timestamp     the time of the request
     # @option token_params [String]  :nonce         an unquoted, unescaped random string of at least 16 characters
@@ -286,7 +285,7 @@ module Ably
     # @param [Hash] auth_options the authentication options for the token request
     # @option auth_options [String]  :key           API key comprising the key name and key secret in a single string
     # @option auth_options [String]  :client_id     client ID identifying this connection to other clients (will use +client_id+ specified when library was instanced if provided)
-    # @option auth_options [Boolean] :query_time    when true will query the {https://www.ably.io Ably} system for the current time instead of using the local time
+    # @option auth_options [Boolean] :query_time    when true will query the {https://www.ably.com Ably} system for the current time instead of using the local time
     # @option auth_options [Hash]    :token_params  convenience to pass in +token_params+ within the +auth_options+ argument, especially useful when setting default token_params in the client constructor
     #
     # @return [Models::TokenRequest]
@@ -377,7 +376,7 @@ module Ably
     # True when Token Auth is being used to authenticate with Ably
     def using_token_auth?
       return options[:use_token_auth] if options.has_key?(:use_token_auth)
-      !!(token_option || current_token_details || has_client_id? || token_creatable_externally?)
+      !!(token_option || current_token_details || token_creatable_externally?)
     end
 
     def client_id
@@ -408,6 +407,17 @@ module Ably
       end
     end
 
+    # Extra headers that may be used during authentication
+    #
+    # @return [Hash] headers
+    def extra_auth_headers
+      if client_id && using_basic_auth?
+        { 'X-Ably-ClientId' => Base64.urlsafe_encode64(client_id) }
+      else
+        {}
+      end
+    end
+
     # Auth params used in URI endpoint for Realtime connections
     # Will reauthorize implicitly if required and capable
     #
@@ -500,11 +510,11 @@ module Ably
     end
 
     def authorize_when_necessary
-      if current_token_details && !current_token_details.expired?
+      if current_token_details && !current_token_details.expired?(from: current_time)
         return current_token_details
-      else
-        authorize
       end
+
+      authorize
     end
 
     # Returns the current device clock time unless the

data/lib/submodules/ably-ruby/lib/ably/exceptions.rb

@@ -5,7 +5,7 @@ module Ably
     TOKEN_EXPIRED_CODE = 40140..40149
 
     # Base Ably exception class that contains status and code values used by Ably
-    # Refer to https://github.com/ably/ably-common/blob/master/protocol/errors.json
+    # Refer to https://github.com/ably/ably-common/blob/main/protocol/errors.json
     #
     # @!attribute [r] message
     #   @return [String] Error message from Ably
@@ -52,6 +52,12 @@ module Ably
       end
     end
 
+    # Maximum frame size exceeded TO3l9
+    class MaxFrameSizeExceeded < BaseAblyException; end
+
+    # Maximum message size exceeded TO3l8
+    class MaxMessageSizeExceeded < BaseAblyException; end
+
     # An invalid request was received by Ably
     class InvalidRequest < BaseAblyException; end
 
@@ -116,7 +122,7 @@ module Ably
     class InvalidState < BaseAblyException; end
 
     # A generic Ably exception taht supports a status & code.
-    # See https://github.com/ably/ably-common/blob/master/protocol/errors.json for a list of Ably errors
+    # See https://github.com/ably/ably-common/blob/main/protocol/errors.json for a list of Ably errors
     class Standard < BaseAblyException; end
 
     # The HTTP request has returned a 500 error

data/lib/submodules/ably-ruby/lib/ably/logger.rb

@@ -7,9 +7,9 @@ module Ably
     extend Forwardable
 
     # @param client        [Ably::Rest::Client,Ably::Realtime::Client] Rest or Realtime Ably client
-    # @param log_level     [Integer] {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger} log level
+    # @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-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger} compatible interface.
+    #                      however it must provide a {http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html Ruby Logger} compatible interface.
     #
     def initialize(client, log_level, custom_logger = nil)
       @client        = client
@@ -24,7 +24,7 @@ module Ably
       @log_mutex = Mutex.new
     end
 
-    # The logger used by this class, defaults to {http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html Ruby Logger}
+    # The logger used by this class, defaults to {http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html Ruby Logger}
     # @return {Object,Logger}
     attr_reader :logger
 
@@ -32,7 +32,7 @@ module Ably
     # @return {nil,Object}
     attr_reader :custom_logger
 
-    # The log level ranging from DEBUG to FATAL, refer to http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html
+    # The log level ranging from DEBUG to FATAL, refer to http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html
     # @return {Integer}
     attr_reader :log_level
 

data/lib/submodules/ably-ruby/lib/ably/models/channel_details.rb

@@ -0,0 +1,59 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelDetails} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelDetails]
+  def self.ChannelDetails(attributes)
+    case attributes
+    when ChannelDetails
+      return attributes
+    else
+      ChannelDetails.new(attributes)
+    end
+  end
+
+  # ChannelDetails is a type that represents information for a channel including channelId, name, status and occupancy (CHD1)
+  #
+  class ChannelDetails
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    # The attributes of ChannelDetails (CHD2)
+    #
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    # Initialize a new ChannelDetails
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+    end
+
+    # The identifier of the channel (CHD2a)
+    #
+    # @return [String]
+    #
+    def channel_id
+      attributes[:channel_id]
+    end
+
+    # The identifier of the channel (CHD2a)
+    #
+    # @return [String]
+    #
+    def name
+      attributes[:name]
+    end
+
+    # The status of the channel (CHD2b)
+    #
+    # @return [Ably::Models::ChannelStatus, nil]
+    #
+    def status
+      Ably::Models::ChannelStatus(attributes[:status])
+    end
+  end
+end

data/lib/submodules/ably-ruby/lib/ably/models/channel_metrics.rb

@@ -0,0 +1,84 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelMetrics} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelMetrics]
+  def self.ChannelMetrics(attributes)
+    case attributes
+    when ChannelMetrics
+      return attributes
+    else
+      ChannelMetrics.new(attributes)
+    end
+  end
+
+  # ChannelMetrics is a type that contains the count of publishers and subscribers, connections and presenceConnections,
+  # presenceMembers and presenceSubscribers (CHM1)
+  #
+  class ChannelMetrics
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    # The attributes of ChannelMetrics (CHM2)
+    #
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    # Initialize a new ChannelMetrics
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+    end
+
+    # The total number of connections to the channel (CHM2a)
+    #
+    # @return [Integer]
+    #
+    def connections
+      attributes[:connections]
+    end
+
+    # The total number of presence connections to the channel (CHM2b)
+    #
+    # @return [Integer]
+    #
+    def presence_connections
+      attributes[:presence_connections]
+    end
+
+    # The total number of presence members for the channel (CHM2c)
+    #
+    # @return [Integer]
+    #
+    def presence_members
+      attributes[:presence_members]
+    end
+
+    # The total number of presence subscribers for the channel (CHM2d)
+    #
+    # @return [Integer]
+    #
+    def presence_subscribers
+      attributes[:presence_subscribers]
+    end
+
+    # The total number of publishers to the channel (CHM2e)
+    #
+    # @return [Integer]
+    #
+    def publishers
+      attributes[:publishers]
+    end
+
+    # The total number of subscribers to the channel (CHM2f)
+    #
+    # @return [Integer]
+    #
+    def subscribers
+      attributes[:subscribers]
+    end
+  end
+end

data/lib/submodules/ably-ruby/lib/ably/models/channel_occupancy.rb

@@ -0,0 +1,43 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelOccupancy} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelOccupancy]
+  def self.ChannelOccupancy(attributes)
+    case attributes
+    when ChannelOccupancy
+      return attributes
+    else
+      ChannelOccupancy.new(attributes)
+    end
+  end
+
+  # Type that contain channel metrics (CHO1)
+  #
+  class ChannelOccupancy
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    # The attributes of ChannelOccupancy (CH02)
+    #
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    # Initialize a new ChannelOccupancy
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+    end
+
+    # Metrics object (CHO2a)
+    #
+    # @return [Ably::Models::ChannelMetrics, nil]
+    #
+    def metrics
+      Ably::Models::ChannelMetrics(attributes[:metrics])
+    end
+  end
+end

data/lib/submodules/ably-ruby/lib/ably/models/channel_options.rb

@@ -0,0 +1,97 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelOptions} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelOptions]
+  def self.ChannelOptions(attributes)
+    case attributes
+    when ChannelOptions
+      return attributes
+    else
+      ChannelOptions.new(attributes)
+    end
+  end
+
+  # Represents options of a channel
+  class ChannelOptions
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    MODES = ruby_enum('MODES',
+      presence: 0,
+      publish: 1,
+      subscribe: 2,
+      presence_subscribe: 3
+    )
+
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    def_delegators :attributes, :fetch, :size, :empty?
+    # Initialize a new ChannelOptions
+    #
+    # @option params [Hash] (TB2c) params (for realtime client libraries only) a  of key/value pairs
+    # @option modes [Hash] modes (for realtime client libraries only) an array of ChannelMode
+    # @option cipher [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.
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+
+      attributes[:modes] = modes.to_a.map { |mode| Ably::Models::ChannelOptions::MODES[mode] } if modes
+      attributes[:cipher] = Ably::Models::CipherParams(cipher) if cipher
+      attributes.clone
+    end
+
+    # @!attribute cipher
+    #
+    # @return [CipherParams]
+    def cipher
+      attributes[:cipher]
+    end
+
+    # @!attribute params
+    #
+    # @return [Hash]
+    def params
+      attributes[:params].to_h
+    end
+
+    # @!attribute modes
+    #
+    # @return [Array<ChannelOptions::MODES>]
+    def modes
+      attributes[:modes]
+    end
+
+    # Converts modes to a bitfield that coresponds to ProtocolMessage#flags
+    #
+    # @return [Integer]
+    def modes_to_flags
+      modes.map { |mode| Ably::Models::ProtocolMessage::ATTACH_FLAGS_MAPPING[mode.to_sym] }.reduce(:|)
+    end
+
+    # @return [Hash]
+    # @api private
+    def set_params(hash)
+      attributes[:params] = hash
+    end
+
+    # Sets modes from ProtocolMessage#flags
+    #
+    # @return [Array<ChannelOptions::MODES>]
+    # @api private
+    def set_modes_from_flags(flags)
+      return unless flags
+
+      message_modes = MODES.select do |mode|
+        flag = Ably::Models::ProtocolMessage::ATTACH_FLAGS_MAPPING[mode.to_sym]
+        flags & flag == flag
+      end
+
+      attributes[:modes] = message_modes.map { |mode| Ably::Models::ChannelOptions::MODES[mode] }
+    end
+  end
+end

data/lib/submodules/ably-ruby/lib/ably/models/channel_status.rb

@@ -0,0 +1,53 @@
+module Ably::Models
+  # Convert token details argument to a {ChannelStatus} object
+  #
+  # @param attributes (see #initialize)
+  #
+  # @return [ChannelStatus]
+  def self.ChannelStatus(attributes)
+    case attributes
+    when ChannelStatus
+      return attributes
+    else
+      ChannelStatus.new(attributes)
+    end
+  end
+
+  # ChannelStatus is a type that contains status and occupancy for a channel (CHS1)
+  #
+  class ChannelStatus
+    extend Ably::Modules::Enum
+    extend Forwardable
+    include Ably::Modules::ModelCommon
+
+    # The attributes of ChannelStatus (CHS2)
+    #
+    attr_reader :attributes
+
+    alias_method :to_h, :attributes
+
+    # Initialize a new ChannelStatus
+    #
+    def initialize(attrs)
+      @attributes = IdiomaticRubyWrapper(attrs.clone)
+    end
+
+    # Represents if the channel is active (CHS2a)
+    #
+    # @return [Boolean]
+    #
+    def is_active
+      attributes[:isActive]
+    end
+    alias_method :active?, :is_active
+    alias_method :is_active?, :is_active
+
+    # Occupancy ChannelOccupancy – occupancy is an object containing the metrics for the channel (CHS2b)
+    #
+    # @return [Ably::Models::ChannelOccupancy, nil]
+    #
+    def occupancy
+      Ably::Models::ChannelOccupancy(attributes[:occupancy])
+    end
+  end
+end

data/lib/submodules/ably-ruby/lib/ably/models/connection_details.rb

@@ -21,6 +21,12 @@ module Ably::Models
   class ConnectionDetails
     include Ably::Modules::ModelCommon
 
+    # Max message size
+    MAX_MESSAGE_SIZE = 65536 # See spec TO3l8
+
+    # Max frame size
+    MAX_FRAME_SIZE = 524288 # See spec TO3l9
+
     # @param attributes [Hash]
     # @option attributes [String]    :client_id             contains the client ID assigned to the connection
     # @option attributes [String]    :connection_key        the connection secret key string that is used to resume a connection and its state
@@ -38,6 +44,8 @@ module Ably::Models
           self.attributes[duration_field] = (self.attributes[duration_field].to_f / 1000).round
         end
       end
+      self.attributes[:max_message_size] ||= MAX_MESSAGE_SIZE
+      self.attributes[:max_frame_size] ||= MAX_FRAME_SIZE
       self.attributes.freeze
     end
 

data/lib/submodules/ably-ruby/lib/ably/models/delta_extras.rb

@@ -0,0 +1,29 @@
+module Ably::Models
+  #
+  # @!attribute [r] from
+  #   @return [String] The id of the message the delta was generated from
+  # @!attribute [r] format
+  #   @return [String] The delta format. Only vcdiff is supported as at API version 1.2
+  #
+  class DeltaExtras
+    include Ably::Modules::ModelCommon
+
+    # The id of the message the delta was generated from.
+    # @return [String, nil]
+    #
+    attr_reader :from
+
+    # The delta format.
+    # @return [String, nil]
+    #
+    attr_reader :format
+
+    def initialize(attributes = {})
+      @from, @format = IdiomaticRubyWrapper((attributes || {}), stop_at: [:from, :format]).attributes.values_at(:from, :format)
+    end
+
+    def to_json(*args)
+      as_json(args).to_json
+    end
+  end
+end

data/lib/submodules/ably-ruby/lib/ably/models/device_details.rb

@@ -27,7 +27,7 @@ module Ably::Models
   # @!attribute [r] form_factor
   #   @return [String] Device form factor such as phone, tablet, watch
   # @!attribute [r] client_id
-  #   @return [String] The authenticated client identifier for this device. See {https://www.ably.io/documentation/general/authentication#identified-clients auth documentation}.
+  #   @return [String] The authenticated client identifier for this device. See {https://www.ably.com/docs/general/authentication#identified-clients auth documentation}.
   # @!attribute [r] metadata
   #   @return [Hash] Arbitrary metadata that can be associated with a device
   # @!attribute [r] device_secret

data/lib/submodules/ably-ruby/lib/ably/models/error_info.rb

@@ -27,6 +27,10 @@ module Ably::Models
   #   @return [Integer] Ably error code (see ably-common/protocol/errors.json)
   # @!attribute [r] status
   #   @return [Integer] HTTP Status Code corresponding to this error, where applicable
+  # @!attribute [r] request_id
+  #   @return [Integer] HTTP RequestId corresponding to this error, where applicable (#RSC7c)
+  # @!attribute [r] cause
+  #   @return [Integer] HTTP Status Code corresponding to this error, where applicable (#TI1)
   # @!attribute [r] attributes
   #   @return [Hash] Access the protocol message Hash object ruby'fied to use symbolized keys
   #
@@ -38,7 +42,7 @@ module Ably::Models
       @hash_object     = IdiomaticRubyWrapper(hash_object.clone.freeze)
     end
 
-    %w(message code href status_code).each do |attribute|
+    %w(message code href status_code request_id cause).each do |attribute|
       define_method attribute do
         attributes[attribute.to_sym]
       end
@@ -52,7 +56,7 @@ module Ably::Models
     def to_s
       error_href = href || (code ? "https://help.ably.io/error/#{code}" : '')
       see_msg = " -> see #{error_href} for help" unless message.to_s.include?(error_href.to_s)
-      "<Error: #{message} (code: #{code}, http status: #{status})>#{see_msg}"
+      "<Error: #{message} (code: #{code}, http status: #{status} request_id: #{request_id} cause: #{cause})>#{see_msg}"
     end
   end
 end

data/lib/submodules/ably-ruby/lib/ably/models/idiomatic_ruby_wrapper.rb

@@ -94,6 +94,10 @@ module Ably::Models
       attributes.size
     end
 
+    def empty?
+      attributes.empty?
+    end
+
     def keys
       map { |key, value| key }
     end