Class: Ably::Rest::Client

Inherits:

Object

Object
Ably::Rest::Client

show all

Extended by:: Forwardable

Includes:: Modules::Conversions, Modules::HttpHelpers

Defined in:: lib/submodules/ably-ruby/lib/ably/rest/client.rb

Overview

Client for the Ably REST API

Constant Summary collapse

DOMAIN = Default Ably domain for REST

'rest.ably.io'

MAX_MESSAGE_SIZE = See spec TO3l8

MAX_FRAME_SIZE = See spec TO3l8

HTTP_DEFAULTS = Configuration for HTTP timeouts and HTTP request reattempts to fallback hosts

{
  open_timeout:       4,
  request_timeout:    10,
  max_retry_duration: 15,
  max_retry_count:    3
}.freeze

FALLBACK_RETRY_TIMEOUT =

10 * 60

FARADAY_CLIENT_OR_SERVER_ERRORS = Faraday 1.0 introduced new error types, however we want to support Faraday <1 too which only used Faraday::ClientError

if defined?(Faraday::ParsingError)
  [Faraday::ClientError, Faraday::ServerError, Faraday::ConnectionFailed, Faraday::SSLError, Faraday::ParsingError]
else
  Faraday::ClientError
end

Instance Attribute Summary collapse

#add_request_ids ⇒ Boolean readonly

Whether the Client has to add a random identifier to the path of a request.
#agent ⇒ String readonly

Client agent i.e.
#auth ⇒ Ably::Auth readonly

Auth authentication object configured for this connection.
#auth_options ⇒ Hash readonly

Auth options configured for this client.
#channels ⇒ Aby::Rest::Channels readonly

The collection of Channels that have been created.
#client_id ⇒ String readonly

A client ID, used for identifying this client for presence purposes.
#custom_host ⇒ String, Nil readonly

The custom host that is being used if it was provided with the option :rest_host when the Client was created.
#custom_port ⇒ Integer, Nil readonly

The custom port for non-TLS requests if it was provided with the option :port when the Client was created.
#custom_tls_port ⇒ Integer, Nil readonly

The custom TLS port for TLS requests if it was provided with the option :tls_port when the Client was created.
#encoders ⇒ Array<Ably::Models::MessageEncoder::Base> readonly private

The registered encoders that are used to encode and decode message payloads.
#endpoint ⇒ URI::Generic readonly

Default Ably REST endpoint used for all requests.
#environment ⇒ String readonly

Custom environment to use such as 'sandbox' when testing the client library against an alternate Ably environment.
#fallback_hosts ⇒ Object readonly

The list of fallback hosts to be used by this client if empty or nil then fallback host functionality is disabled.
#http_defaults ⇒ Hash readonly

The immutable configured HTTP defaults for this client.
#idempotent_rest_publishing ⇒ Boolean readonly

True when idempotent publishing is enabled for all messages published via REST.
#log_level ⇒ Logger::Severity readonly

Log level configured for this Client.
#log_retries_as_info ⇒ Boolean readonly private

Retries are logged by default to warn and error.
#logger ⇒ Logger readonly

The Logger for this client.
#max_frame_size ⇒ Integer readonly

Max frame size (TO2, TO3l8) by default (524288 bytes) 512KiB.
#max_message_size ⇒ Integer readonly

Max message size (TO2, TO3l8) by default (65536 bytes) 64KiB.
#mime_type ⇒ String readonly

Mime type used for HTTP requests.
#options ⇒ Hash readonly private

The additional options passed to this Client's #initialize method not available as attributes of this class.
#protocol ⇒ Symbol readonly

The protocol configured for this client, either binary `:msgpack` or text based `:json`.
#protocol_binary? ⇒ Boolean readonly

True of the transport #protocol communicates with Ably with a binary protocol.
#use_tls? ⇒ Boolean readonly

True if client is configured to use TLS for all Ably communication.

Instance Method Summary collapse

#auth_request_timeout ⇒ Object private

Allowable duration for an external auth request For REST client this defaults to request_timeout For Realtime clients this defaults to 250ms less than the realtime_request_timeout ensuring an auth failure will be triggered before the realtime request timeout fires which would lead to a misleading error message (connection timeout as opposed to auth request timeout).
#channel(name, channel_options = {}) ⇒ Ably::Rest::Channel

Return a REST Channel for the given name.
#connection(options = {}) ⇒ Faraday::Connection private

Connection used to make HTTP requests.
#delete(path, params, options = {}) ⇒ Faraday::Response private

Perform an HTTP DELETE request to the API using configured authentication.
#device ⇒ Ably::Models::LocalDevice

The local device detilas.
#fallback_connection ⇒ Faraday::Connection private

Fallback connection used to make HTTP requests.
#get(path, params = {}, options = {}) ⇒ Faraday::Response private

Perform an HTTP GET request to the API using configured authentication.
#initialize(options) ⇒ Ably::Rest::Client constructor

Creates a Rest Client and configures the Auth object for the connection.
#post(path, params, options = {}) ⇒ Faraday::Response private

Perform an HTTP POST request to the API using configured authentication.
#push ⇒ Ably::Rest::Push

Push notification object for publishing and managing push notifications.
#put(path, params, options = {}) ⇒ Faraday::Response private

Perform an HTTP PUT request to the API using configured authentication.
#register_encoder(encoder, options = {}) ⇒ void private

Register a message encoder and decoder that implements Ably::Models::MessageEncoders::Base interface.
#request(method, path, params = {}, body = nil, headers = {}, options = {}) ⇒ Ably::Models::HttpPaginatedResponse<>

Perform an HTTP request to the Ably API This is a convenience for customers who wish to use bleeding edge REST API functionality that is either not documented or is not included in the API for our client libraries.
#stats(options = {}) ⇒ Ably::Models::PaginatedResult<Ably::Models::Stats>

Retrieve the Stats for the application.
#time ⇒ Time

Retrieve the Ably service time.
#using_preferred_fallback_host? ⇒ nil, String

If the primary host endpoint fails, and a subsequent fallback host succeeds, the fallback host that succeeded is used for ClientOption fallback_retry_timeout seconds to avoid retries to known failing hosts for a short period of time.

Constructor Details

#initialize(options) ⇒ `Ably::Rest::Client`

Creates a Rest Client and configures the Auth object for the connection.

Examples:

# create a new client authenticating with basic auth
client = Ably::Rest::Client.new('key.id:secret')

# create a new client and configure a client ID used for presence
client = Ably::Rest::Client.new(key: 'key.id:secret', client_id: 'john')

Parameters:

options (Hash, String) —

an options Hash used to configure the client and the authentication, or String with an API key or Token ID

Options Hash (options):

:tls (Boolean) — default: true —

When false, TLS is disabled. Please note Basic Auth is disallowed without TLS as secrets cannot be transmitted over unsecured connections.
:key (String) —

API key comprising the key name and key secret in a single string
:token (String) —

Token string or Models::TokenDetails used to authenticate requests
:token_details (String) —

Models::TokenDetails used to authenticate requests
:use_token_auth (Boolean) —

Will force Basic Auth if set to false, and Token auth if set to true
:environment (String) —

Specify 'sandbox' when testing the client library against an alternate Ably environment
:protocol (Symbol) — default: :msgpack —

Protocol used to communicate with Ably, :json and :msgpack currently supported
:use_binary_protocol (Boolean) — default: true —

When true will use the MessagePack binary protocol, when false it will use JSON encoding. This option will overide :protocol option
:log_level (Logger::Severity, Symbol) — default: Logger::WARN —

Log level for the standard Logger that outputs to STDOUT. Can be set to :fatal (Logger::FATAL), :error (Logger::ERROR), :warn (Logger::WARN), :info (Logger::INFO), :debug (Logger::DEBUG) or :none
:logger (Logger) —

A custom logger can be used however it must adhere to the Ruby Logger interface, see www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html
:client_id (String) —

client ID identifying this connection to other clients
:auth_url (String) —

a URL to be used to GET or POST a set of token request params, to obtain a signed token request
:auth_headers (Hash) —

a set of application-specific headers to be added to any request made to the auth_url
:auth_params (Hash) —

a set of application-specific query params to be added to any request made to the auth_url
:auth_method (Symbol) — default: :get —

HTTP method to use with auth_url, must be either :get or :post
:auth_callback (Proc) —

when provided, the Proc will be called with the token params hash as the first argument, whenever a new token is required. The Proc should return a token string, Models::TokenDetails or JSON equivalent, Models::TokenRequest or JSON equivalent
:query_time (Boolean) —

when true will query the Ably system for the current time instead of using the local time
:default_token_params (Hash) —

convenience to pass in token_params that will be used as a default for all token requests. See Auth#create_token_request
:http_open_timeout (Integer) — default: 4 seconds —

timeout in seconds for opening an HTTP connection for all HTTP requests
:http_request_timeout (Integer) — default: 10 seconds —

timeout in seconds for any single complete HTTP request and response
:http_max_retry_count (Integer) — default: 3 —

maximum number of fallback host retries for HTTP requests that fail due to network issues or server problems
:http_max_retry_duration (Integer) — default: 15 seconds —

maximum elapsed time in which fallback host retries for HTTP requests will be attempted i.e. if the first default host attempt takes 5s, and then the subsequent fallback retry attempt takes 7s, no further fallback host attempts will be made as the total elapsed time of 12s exceeds the default 10s limit
:fallback_hosts_use_default (Boolean) — default: false —

When true, forces the user of fallback hosts even if a non-default production endpoint is being used
:fallback_hosts (Array<String>) —

When an array of fallback hosts are provided, these fallback hosts are always used if a request fails to the primary endpoint. If an empty array is provided, the fallback host functionality is disabled
:fallback_retry_timeout (Integer) — default: 600 seconds —

amount of time in seconds a REST client will continue to use a working fallback host when the primary fallback host has previously failed
:add_request_ids (Boolean) — default: false —

When true, adds a unique request_id to each request sent to Ably servers. This is handy when reporting issues, because you can refer to a specific request.
:idempotent_rest_publishing (Boolean) — default: false if ver < 1.2 —

When true, idempotent publishing is enabled for all messages published via REST
:max_message_size (Integer) — default: 65536 bytes —

Maximum size of all messages when publishing via REST publish()
:max_frame_size (Integer) — default: 524288 bytes —

Maximum size of frame

Raises:

(ArgumentError)

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 176

def initialize(options)
  raise ArgumentError, 'Options Hash is expected' if options.nil?

  options = options.clone
  if options.kind_of?(String)
    options = if options.match(Auth::API_KEY_REGEX)
      { key: options }
    else
      { token: options }
    end
  end

  @agent               = options.delete(:agent) || Ably::AGENT
  @realtime_client     = options.delete(:realtime_client)
  @tls                 = options.delete(:tls) == false ? false : true
  @environment         = options.delete(:environment) # nil is production
  @environment         = nil if [:production, 'production'].include?(@environment)
  @protocol            = options.delete(:protocol) || :msgpack
  @debug_http          = options.delete(:debug_http)
  @log_level           = options.delete(:log_level) || ::Logger::WARN
  @custom_logger       = options.delete(:logger)
  @custom_host         = options.delete(:rest_host)
  @custom_port         = options.delete(:port)
  @custom_tls_port     = options.delete(:tls_port)
  @add_request_ids     = options.delete(:add_request_ids)
  @log_retries_as_info = options.delete(:log_retries_as_info)
  @max_message_size    = options.delete(:max_message_size) || MAX_MESSAGE_SIZE
  @max_frame_size      = options.delete(:max_frame_size) || MAX_FRAME_SIZE

  if (@idempotent_rest_publishing = options.delete(:idempotent_rest_publishing)).nil?
    @idempotent_rest_publishing = Ably::PROTOCOL_VERSION.to_f > 1.1
  end

  if options[:fallback_hosts_use_default] && options[:fallback_hosts]
    raise ArgumentError, "fallback_hosts_use_default cannot be set to try when fallback_hosts is also provided"
  end
  @fallback_hosts = case
  when options.delete(:fallback_hosts_use_default)
    Ably::FALLBACK_HOSTS
  when options_fallback_hosts = options.delete(:fallback_hosts)
    options_fallback_hosts
  when custom_host || options[:realtime_host] || custom_port || custom_tls_port
    []
  when environment
    CUSTOM_ENVIRONMENT_FALLBACKS_SUFFIXES.map { |host| "#{environment}#{host}" }
  else
    Ably::FALLBACK_HOSTS
  end

  options[:fallback_retry_timeout] ||= FALLBACK_RETRY_TIMEOUT

  # Take option keys prefixed with `http_`, remove the http_ and
  # check if the option exists in HTTP_DEFAULTS.  If so, update http_defaults
  @http_defaults = HTTP_DEFAULTS.dup
  options.each do |key, val|
    if http_key = key[/^http_(.+)/, 1]
      # Typhoeus converts decimal durations to milliseconds, so 0.0001 timeout is treated as 0 (no timeout)
      val = 0.001 if val.kind_of?(Numeric) && (val > 0) && (val < 0.001)
      @http_defaults[http_key.to_sym] = val if val && @http_defaults.has_key?(http_key.to_sym)
    end
  end
  @http_defaults.freeze

  if @log_level == :none
    @custom_logger = Ably::Models::NilLogger.new
  else
    @log_level = ::Logger.const_get(log_level.to_s.upcase) if log_level.kind_of?(Symbol) || log_level.kind_of?(String)
  end

  options.delete(:use_binary_protocol).tap do |use_binary_protocol|
    if use_binary_protocol == true
      @protocol = :msgpack
    elsif use_binary_protocol == false
      @protocol = :json
    end
  end
  raise ArgumentError, 'Protocol is invalid.  Must be either :msgpack or :json' unless [:msgpack, :json].include?(@protocol)

  token_params = options.delete(:default_token_params) || {}
  @options = options
  init_auth_options = options.select do |key, _|
    Auth::AUTH_OPTIONS_KEYS.include?(key.to_s)
  end

  @auth     = Auth.new(self, token_params, init_auth_options)
  @channels = Ably::Rest::Channels.new(self)
  @encoders = []

  options.freeze

  initialize_default_encoders
end

Instance Attribute Details

#add_request_ids ⇒ `Boolean` (readonly)

Whether the Ably::Rest::Client has to add a random identifier to the path of a request

Returns:

(Boolean)



107
108
109

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 107

def add_request_ids
  @add_request_ids
end

#agent ⇒ `String` (readonly)

Client agent i.e. `example-gem/1.2.0 ably-ruby/1.1.5 ruby/3.1.1`

Returns:

(String)



60
61
62

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 60

def agent
  @agent
end

#auth ⇒ `Ably::Auth` (readonly)

Auth authentication object configured for this connection

Returns:

(Ably::Auth)



64
65
66

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 64

def auth
  @auth
end

#auth_options ⇒ `Hash` (readonly)

Returns Auth options configured for this client.

Returns:

(Hash) —

Auth options configured for this client

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 20

class Client
  include Ably::Modules::Conversions
  include Ably::Modules::HttpHelpers
  extend Forwardable

  # Default Ably domain for REST
  DOMAIN = 'rest.ably.io'

  MAX_MESSAGE_SIZE = 65536 # See spec TO3l8
  MAX_FRAME_SIZE = 524288 # See spec TO3l8

  # Configuration for HTTP timeouts and HTTP request reattempts to fallback hosts
  HTTP_DEFAULTS = {
    open_timeout:       4,
    request_timeout:    10,
    max_retry_duration: 15,
    max_retry_count:    3
  }.freeze

  FALLBACK_RETRY_TIMEOUT = 10 * 60

  # Faraday 1.0 introduced new error types, however we want to support Faraday <1 too which only used Faraday::ClientError
  FARADAY_CLIENT_OR_SERVER_ERRORS = if defined?(Faraday::ParsingError)
    [Faraday::ClientError, Faraday::ServerError, Faraday::ConnectionFailed, Faraday::SSLError, Faraday::ParsingError]
  else
    Faraday::ClientError
  end

  def_delegators :auth, :client_id, :auth_options

  # Custom environment to use such as 'sandbox' when testing the client library against an alternate Ably environment
  # @return [String]
  attr_reader :environment

  # The protocol configured for this client, either binary `:msgpack` or text based `:json`
  # @return [Symbol]
  attr_reader :protocol

  # Client agent i.e. `example-gem/1.2.0 ably-ruby/1.1.5 ruby/3.1.1`
  # @return [String]
  attr_reader :agent

  # {Ably::Auth} authentication object configured for this connection
  # @return [Ably::Auth]
  attr_reader :auth

  # The collection of {Ably::Rest::Channel}s that have been created
  # @return [Aby::Rest::Channels]
  attr_reader :channels

  # Log level configured for this {Client}
  # @return [Logger::Severity]
  attr_reader :log_level

  # The custom host that is being used if it was provided with the option +:rest_host+ when the {Client} was created
  # @return [String,Nil]
  attr_reader :custom_host

  # The custom port for non-TLS requests if it was provided with the option +:port+ when the {Client} was created
  # @return [Integer,Nil]
  attr_reader :custom_port

  # The custom TLS port for TLS requests if it was provided with the option +:tls_port+ when the {Client} was created
  # @return [Integer,Nil]
  attr_reader :custom_tls_port

  # The immutable configured HTTP defaults for this client.
  # See {#initialize} for the configurable HTTP defaults prefixed with +http_+
  # @return [Hash]
  attr_reader :http_defaults

  # The registered encoders that are used to encode and decode message payloads
  # @return [Array<Ably::Models::MessageEncoder::Base>]
  # @api private
  attr_reader :encoders

  # The additional options passed to this Client's #initialize method not available as attributes of this class
  # @return [Hash]
  # @api private
  attr_reader :options

  # The list of fallback hosts to be used by this client
  # if empty or nil then fallback host functionality is disabled
  attr_reader :fallback_hosts

  # Whether the {Client} has to add a random identifier to the path of a request
  # @return [Boolean]
  attr_reader :add_request_ids

  # Retries are logged by default to warn and error. When true, retries are logged at info level
  # @return [Boolean]
  # @api private
  attr_reader :log_retries_as_info

  # True when idempotent publishing is enabled for all messages published via REST.
  # When this feature is enabled, the client library will add a unique ID to every published message (without an ID)
  # ensuring any failed published attempts (due to failures such as HTTP requests failing mid-flight) that are
  # automatically retried will not result in duplicate messages being published to the Ably platform.
  # Note: This is a beta unsupported feature!
  # @return [Boolean]
  attr_reader :idempotent_rest_publishing

  # Max message size (TO2, TO3l8) by default (65536 bytes) 64KiB
  # @return [Integer]
  attr_reader :max_message_size

  # Max frame size (TO2, TO3l8) by default (524288 bytes) 512KiB
  # @return [Integer]
  attr_reader :max_frame_size

  # Creates a {Ably::Rest::Client Rest Client} and configures the {Ably::Auth} object for the connection.
  #
  # @param [Hash,String] options an options Hash used to configure the client and the authentication, or String with an API key or Token ID
  # @option options [Boolean]                 :tls                 (true) When false, TLS is disabled. Please note Basic Auth is disallowed without TLS as secrets cannot be transmitted over unsecured connections.
  # @option options [String]                  :key                 API key comprising the key name and key secret in a single string
  # @option options [String]                  :token               Token string or {Models::TokenDetails} used to authenticate requests
  # @option options [String]                  :token_details       {Models::TokenDetails} used to authenticate requests
  # @option options [Boolean]                 :use_token_auth      Will force Basic Auth if set to false, and Token auth if set to true
  # @option options [String]                  :environment         Specify 'sandbox' when testing the client library against an alternate Ably environment
  # @option options [Symbol]                  :protocol            (:msgpack) Protocol used to communicate with Ably, :json and :msgpack currently supported
  # @option options [Boolean]                 :use_binary_protocol (true) When true will use the MessagePack binary protocol, when false it will use JSON encoding. This option will overide :protocol option
  # @option options [Logger::Severity,Symbol] :log_level           (Logger::WARN) Log level for the standard Logger that outputs to STDOUT. Can be set to :fatal (Logger::FATAL), :error (Logger::ERROR), :warn (Logger::WARN), :info (Logger::INFO), :debug (Logger::DEBUG) or :none
  # @option options [Logger]                  :logger              A custom logger can be used however it must adhere to the Ruby Logger interface, see http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html
  # @option options [String]                  :client_id           client ID identifying this connection to other clients
  # @option options [String]                  :auth_url            a URL to be used to GET or POST a set of token request params, to obtain a signed token request
  # @option options [Hash]                    :auth_headers        a set of application-specific headers to be added to any request made to the +auth_url+
  # @option options [Hash]                    :auth_params         a set of application-specific query params to be added to any request made to the +auth_url+
  # @option options [Symbol]                  :auth_method         (:get) HTTP method to use with +auth_url+, must be either +:get+ or +:post+
  # @option options [Proc]                    :auth_callback       when provided, the Proc will be called with the token params hash as the first argument, whenever a new token is required.
  #                                                                The Proc should return a token string, {Ably::Models::TokenDetails} or JSON equivalent, {Ably::Models::TokenRequest} or JSON equivalent
  # @option 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 options [Hash]                    :default_token_params   convenience to pass in +token_params+ that will be used as a default for all token requests. See {Auth#create_token_request}
  #
  # @option options [Integer]                 :http_open_timeout       (4 seconds) timeout in seconds for opening an HTTP connection for all HTTP requests
  # @option options [Integer]                 :http_request_timeout    (10 seconds) timeout in seconds for any single complete HTTP request and response
  # @option options [Integer]                 :http_max_retry_count    (3) maximum number of fallback host retries for HTTP requests that fail due to network issues or server problems
  # @option options [Integer]                 :http_max_retry_duration (15 seconds) maximum elapsed time in which fallback host retries for HTTP requests will be attempted i.e. if the first default host attempt takes 5s, and then the subsequent fallback retry attempt takes 7s, no further fallback host attempts will be made as the total elapsed time of 12s exceeds the default 10s limit
  #
  # @option options [Boolean]                 :fallback_hosts_use_default  (false) When true, forces the user of fallback hosts even if a non-default production endpoint is being used
  # @option options [Array<String>]           :fallback_hosts              When an array of fallback hosts are provided, these fallback hosts are always used if a request fails to the primary endpoint. If an empty array is provided, the fallback host functionality is disabled
  # @option options [Integer]                 :fallback_retry_timeout     (600 seconds) amount of time in seconds a REST client will continue to use a working fallback host when the primary fallback host has previously failed
  #
  # @option options [Boolean]                 :add_request_ids             (false) When true, adds a unique request_id to each request sent to Ably servers. This is handy when reporting issues, because you can refer to a specific request.
  # @option options [Boolean]                 :idempotent_rest_publishing  (false if ver < 1.2) When true, idempotent publishing is enabled for all messages published via REST
  # @option options [Integer]                 :max_message_size            (65536 bytes) Maximum size of all messages when publishing via REST publish()
  # @option options [Integer]                 :max_frame_size              (524288 bytes) Maximum size of frame
  #
  # @return [Ably::Rest::Client]
  #
  # @example
  #    # create a new client authenticating with basic auth
  #    client = Ably::Rest::Client.new('key.id:secret')
  #
  #    # create a new client and configure a client ID used for presence
  #    client = Ably::Rest::Client.new(key: 'key.id:secret', client_id: 'john')
  #
  def initialize(options)
    raise ArgumentError, 'Options Hash is expected' if options.nil?

    options = options.clone
    if options.kind_of?(String)
      options = if options.match(Auth::API_KEY_REGEX)
        { key: options }
      else
        { token: options }
      end
    end

    @agent               = options.delete(:agent) || Ably::AGENT
    @realtime_client     = options.delete(:realtime_client)
    @tls                 = options.delete(:tls) == false ? false : true
    @environment         = options.delete(:environment) # nil is production
    @environment         = nil if [:production, 'production'].include?(@environment)
    @protocol            = options.delete(:protocol) || :msgpack
    @debug_http          = options.delete(:debug_http)
    @log_level           = options.delete(:log_level) || ::Logger::WARN
    @custom_logger       = options.delete(:logger)
    @custom_host         = options.delete(:rest_host)
    @custom_port         = options.delete(:port)
    @custom_tls_port     = options.delete(:tls_port)
    @add_request_ids     = options.delete(:add_request_ids)
    @log_retries_as_info = options.delete(:log_retries_as_info)
    @max_message_size    = options.delete(:max_message_size) || MAX_MESSAGE_SIZE
    @max_frame_size      = options.delete(:max_frame_size) || MAX_FRAME_SIZE

    if (@idempotent_rest_publishing = options.delete(:idempotent_rest_publishing)).nil?
      @idempotent_rest_publishing = Ably::PROTOCOL_VERSION.to_f > 1.1
    end

    if options[:fallback_hosts_use_default] && options[:fallback_hosts]
      raise ArgumentError, "fallback_hosts_use_default cannot be set to try when fallback_hosts is also provided"
    end
    @fallback_hosts = case
    when options.delete(:fallback_hosts_use_default)
      Ably::FALLBACK_HOSTS
    when options_fallback_hosts = options.delete(:fallback_hosts)
      options_fallback_hosts
    when custom_host || options[:realtime_host] || custom_port || custom_tls_port
      []
    when environment
      CUSTOM_ENVIRONMENT_FALLBACKS_SUFFIXES.map { |host| "#{environment}#{host}" }
    else
      Ably::FALLBACK_HOSTS
    end

    options[:fallback_retry_timeout] ||= FALLBACK_RETRY_TIMEOUT

    # Take option keys prefixed with `http_`, remove the http_ and
    # check if the option exists in HTTP_DEFAULTS.  If so, update http_defaults
    @http_defaults = HTTP_DEFAULTS.dup
    options.each do |key, val|
      if http_key = key[/^http_(.+)/, 1]
        # Typhoeus converts decimal durations to milliseconds, so 0.0001 timeout is treated as 0 (no timeout)
        val = 0.001 if val.kind_of?(Numeric) && (val > 0) && (val < 0.001)
        @http_defaults[http_key.to_sym] = val if val && @http_defaults.has_key?(http_key.to_sym)
      end
    end
    @http_defaults.freeze

    if @log_level == :none
      @custom_logger = Ably::Models::NilLogger.new
    else
      @log_level = ::Logger.const_get(log_level.to_s.upcase) if log_level.kind_of?(Symbol) || log_level.kind_of?(String)
    end

    options.delete(:use_binary_protocol).tap do |use_binary_protocol|
      if use_binary_protocol == true
        @protocol = :msgpack
      elsif use_binary_protocol == false
        @protocol = :json
      end
    end
    raise ArgumentError, 'Protocol is invalid.  Must be either :msgpack or :json' unless [:msgpack, :json].include?(@protocol)

    token_params = options.delete(:default_token_params) || {}
    @options = options
    init_auth_options = options.select do |key, _|
      Auth::AUTH_OPTIONS_KEYS.include?(key.to_s)
    end

    @auth     = Auth.new(self, token_params, init_auth_options)
    @channels = Ably::Rest::Channels.new(self)
    @encoders = []

    options.freeze

    initialize_default_encoders
  end

  # Return a REST {Ably::Rest::Channel} for the given name
  #
  # @param (see Ably::Rest::Channels#get)
  #
  # @return (see Ably::Rest::Channels#get)
  def channel(name, channel_options = {})
    channels.get(name, channel_options)
  end

  # Retrieve the Stats for the application
  #
  # @param [Hash] options the options for the stats request
  # @option options [Integer,Time] :start      Ensure earliest time or millisecond since epoch for any stats retrieved is +:start+
  # @option options [Integer,Time] :end        Ensure latest time or millisecond since epoch for any stats retrieved is +:end+
  # @option options [Symbol]       :direction  +:forwards+ or +:backwards+, defaults to +:backwards+
  # @option options [Integer]      :limit      Maximum number of messages to retrieve up to 1,000, defaults to 100
  # @option options [Symbol]       :unit       `:minute`, `:hour`, `:day` or `:month`. Defaults to `:minute`
  #
  # @return [Ably::Models::PaginatedResult<Ably::Models::Stats>] An Array of Stats
  #
  def stats(options = {})
    options = {
      :direction => :backwards,
      :unit      => :minute,
      :limit     => 100
    }.merge(options)

    [:start, :end].each { |option| options[option] = as_since_epoch(options[option]) if options.has_key?(option) }
    raise ArgumentError, ":end must be equal to or after :start" if options[:start] && options[:end] && (options[:start] > options[:end])

    paginated_options = {
      coerce_into: 'Ably::Models::Stats'
    }

    url = '/stats'
    response = get(url, options)

    Ably::Models::PaginatedResult.new(response, url, self, paginated_options)
  end

  # Retrieve the Ably service time
  #
  # @return [Time] The time as reported by the Ably service
  def time
    response = get('/time', {}, send_auth_header: false)

    as_time_from_epoch(response.body.first)
  end

  # @!attribute [r] use_tls?
  # @return [Boolean] True if client is configured to use TLS for all Ably communication
  def use_tls?
    @tls == true
  end

  # Perform an HTTP GET request to the API using configured authentication
  #
  # @return [Faraday::Response]
  #
  # @api private
  def get(path, params = {}, options = {})
    raw_request(:get, path, params, options)
  end

  # Perform an HTTP POST request to the API using configured authentication
  #
  # @return [Faraday::Response]
  #
  # @api private
  def post(path, params, options = {})
    raw_request(:post, path, params, options)
  end

  # Perform an HTTP PUT request to the API using configured authentication
  #
  # @return [Faraday::Response]
  #
  # @api private
  def put(path, params, options = {})
    raw_request(:put, path, params, options)
  end

  # Perform an HTTP DELETE request to the API using configured authentication
  #
  # @return [Faraday::Response]
  #
  # @api private
  def delete(path, params, options = {})
    raw_request(:delete, path, params, options)
  end

  # Perform an HTTP request to the Ably API
  # This is a convenience for customers who wish to use bleeding edge REST API functionality
  # that is either not documented or is not included in the API for our client libraries.
  # The REST client library provides a function to issue HTTP requests to the Ably endpoints
  # with all the built in functionality of the library such as authentication, paging,
  # fallback hosts, MsgPack and JSON support etc.
  #
  # @param method  [Symbol]    The HTTP method symbol such as +:get+, +:post+, +:put+
  # @param path    [String]    The path of the URL such +/channel/foo/publish+
  # @param params  [Hash, nil] Optional querystring params
  # @param body    [Hash, nil] Optional body for the POST or PUT request, must be nil or a JSON-like object
  # @param headers [Hash, nil] Optional additional headers
  #
  # @return [Ably::Models::HttpPaginatedResponse<>]
  def request(method, path, params = {}, body = nil, headers = {}, options = {})
    raise "Method #{method.to_s.upcase} not supported" unless %i(get put patch post delete).include?(method.to_sym)

    response = case method.to_sym
    when :get, :delete
      reauthorize_on_authorization_failure do
        send_request(method, path, params, headers: headers)
      end
    when :post, :patch, :put
      if body.to_json.bytesize > max_frame_size
        raise Ably::Exceptions::MaxFrameSizeExceeded.new("Maximum frame size exceeded #{max_frame_size} bytes.")
      end
      path_with_params = Addressable::URI.new
      path_with_params.query_values = params || {}
      query = path_with_params.query
      reauthorize_on_authorization_failure do
        send_request(method, "#{path}#{"?#{query}" unless query.nil? || query.empty?}", body, headers: headers)
      end
    end

    paginated_options = {
      async_blocking_operations: options.delete(:async_blocking_operations),
    }

    Ably::Models::HttpPaginatedResponse.new(response, path, self, paginated_options)

  rescue Exceptions::ResourceMissing, Exceptions::ForbiddenRequest, Exceptions::ResourceMissing => e
    response = Models::HttpPaginatedResponse::ErrorResponse.new(e.status, e.code, e.message)
    Models::HttpPaginatedResponse.new(response, path, self)
  rescue Exceptions::TokenExpired, Exceptions::UnauthorizedRequest => e
    response = Models::HttpPaginatedResponse::ErrorResponse.new(e.status, e.code, e.message)
    Models::HttpPaginatedResponse.new(response, path, self)
  rescue Exceptions::InvalidRequest, Exceptions::ServerError => e
    response = Models::HttpPaginatedResponse::ErrorResponse.new(e.status, e.code, e.message)
    Models::HttpPaginatedResponse.new(response, path, self)
  end

  # The local device detilas
  # @return [Ably::Models::LocalDevice]
  #
  # @note This is unsupported in the Ruby library
  def device
    raise Ably::Exceptions::PushNotificationsNotSupported, 'This device does not support receiving or subscribing to push notifications. The local device object is not unavailable'
  end

  # Push notification object for publishing and managing push notifications
  # @return [Ably::Rest::Push]
  def push
    @push ||= Push.new(self)
  end

  # @!attribute [r] endpoint
  # @return [URI::Generic] Default Ably REST endpoint used for all requests
  def endpoint
    endpoint_for_host(custom_host || [@environment, DOMAIN].compact.join('-'))
  end

  # @!attribute [r] logger
  # @return [Logger] The {Ably::Logger} for this client.
  #                  Configure the log_level with the `:log_level` option, refer to {Client#initialize}
  def logger
    @logger ||= Ably::Logger.new(self, log_level, @custom_logger)
  end

  # @!attribute [r] mime_type
  # @return [String] Mime type used for HTTP requests
  def mime_type
    case protocol
    when :json
      'application/json'
    else
      'application/x-msgpack'
    end
  end

  # Register a message encoder and decoder that implements Ably::Models::MessageEncoders::Base interface.
  # Message encoders are used to encode and decode message payloads automatically.
  # @note Encoders and decoders are processed in the order they are added so the first encoder will be given priority when encoding and decoding
  #
  # @param [Ably::Models::MessageEncoders::Base] encoder
  # @return [void]
  #
  # @api private
  def register_encoder(encoder, options = {})
    encoders << Ably::Models::MessageEncoders.encoder_from(encoder, options)
  end

  # @!attribute [r] protocol_binary?
  # @return [Boolean] True of the transport #protocol communicates with Ably with a binary protocol
  def protocol_binary?
    protocol == :msgpack
  end

  # Connection used to make HTTP requests
  #
  # @param [Hash] options
  # @option options [Boolean] :use_fallback when true, one of the fallback connections is used randomly, see the default {Ably::FALLBACK_HOSTS}
  #
  # @return [Faraday::Connection]
  #
  # @api private
  def connection(options = {})
    if options[:use_fallback]
      fallback_connection
    else
      @connection ||= Faraday.new(endpoint.to_s, connection_options)
    end
  end

  # Fallback connection used to make HTTP requests.
  # Note, each request uses a random and then subsequent random {Ably::FALLBACK_HOSTS fallback hosts}
  # are used (unless custom fallback hosts are provided with fallback_hosts)
  #
  # @return [Faraday::Connection]
  #
  # @api private
  def fallback_connection
    unless defined?(@fallback_connections) && @fallback_connections
      @fallback_connections = fallback_hosts.shuffle.map { |host| Faraday.new(endpoint_for_host(host).to_s, connection_options) }
    end
    @fallback_index ||= 0

    @fallback_connections[@fallback_index % @fallback_connections.count].tap do
      @fallback_index += 1
    end
  end

  # Allowable duration for an external auth request
  # For REST client this defaults to request_timeout
  # For Realtime clients this defaults to 250ms less than the realtime_request_timeout
  #   ensuring an auth failure will be triggered before the realtime request timeout fires
  #   which would lead to a misleading error message (connection timeout as opposed to auth request timeout)
  # @api private
  def auth_request_timeout
    if @realtime_client
      @realtime_client.connection.defaults.fetch(:realtime_request_timeout) - 0.25
    else
      http_defaults.fetch(:request_timeout)
    end
  end

  # If the primary host endpoint fails, and a subsequent fallback host succeeds, the fallback
  #   host that succeeded is used for +ClientOption+ +fallback_retry_timeout+ seconds to avoid
  #   retries to known failing hosts for a short period of time.
  # See https://github.com/ably/docs/pull/554, spec id #RSC15f
  #
  # @return [nil, String]  Returns nil (falsey) if the primary host is being used, or the currently used host if a fallback host is currently preferred
  def using_preferred_fallback_host?
    if preferred_fallback_connection && (preferred_fallback_connection.fetch(:expires_at) > Time.now)
      preferred_fallback_connection.fetch(:connection_object).host
    end
  end

  private

  attr_reader :preferred_fallback_connection

  # See #using_preferred_fallback_host? for context
  def set_preferred_fallback_connection(connection)
    @preferred_fallback_connection = if connection == @connection
      # If the succeeded connection is in fact the primary connection (tried after a failed fallback)
      #   then clear the preferred fallback connection
      nil
    else
      {
        expires_at: Time.now + options.fetch(:fallback_retry_timeout),
        connection_object: connection,
      }
    end
  end

  def get_preferred_fallback_connection_object
    preferred_fallback_connection.fetch(:connection_object) if using_preferred_fallback_host?
  end

  def raw_request(method, path, params = {}, options = {})
    options = options.clone
    if options.delete(:disable_automatic_reauthorize) == true
      send_request(method, path, params, options)
    else
      reauthorize_on_authorization_failure do
        send_request(method, path, params, options)
      end
    end
  end

  # Sends HTTP request to connection end point
  # Connection failures will automatically be reattempted until thresholds are met
  def send_request(method, path, params, options)
    max_retry_count    = http_defaults.fetch(:max_retry_count)
    max_retry_duration = http_defaults.fetch(:max_retry_duration)
    requested_at       = Time.now
    retry_count        = 0
    retry_sequence_id  = nil
    request_id         = SecureRandom.urlsafe_base64(10) if add_request_ids

    preferred_fallback_connection_for_first_request = get_preferred_fallback_connection_object

    begin
      use_fallback = can_fallback_to_alternate_ably_host? && (retry_count > 0)

      conn = if preferred_fallback_connection_for_first_request
        case retry_count
        when 0
          preferred_fallback_connection_for_first_request
        when 1
          # Ensure the root host is used first if the preferred fallback fails, see #RSC15f
          connection(use_fallback: false)
        end
      end || connection(use_fallback: use_fallback) # default to normal connection selection process if not preferred connection set

      conn.send(method, path, params) do |request|
        if add_request_ids
          request.params[:request_id] = request_id
          request.options.context = {} if request.options.context.nil?
          request.options.context[:request_id] = request_id
        end
        if options[:qs_params]
          request.params.merge!(options[:qs_params])
        end
        unless options[:send_auth_header] == false
          request.headers[:authorization] = auth.auth_header

          options[:headers].to_h.merge(auth.extra_auth_headers).map do |key, val|
            request.headers[key] = val
          end
        end
      end.tap do
        if retry_count > 0
          retry_log_severity = log_retries_as_info ? :info : :warn
          logger.public_send(retry_log_severity) do
            "Ably::Rest::Client - Request SUCCEEDED after #{retry_count} #{retry_count > 1 ? 'retries' : 'retry' } for" \
            " #{method} #{path} #{params} (seq ##{retry_sequence_id}, time elapsed #{(Time.now.to_f - requested_at.to_f).round(2)}s)"
          end
          set_preferred_fallback_connection conn
        end
      end

    rescue *([Faraday::TimeoutError, Ably::Exceptions::ServerError] + FARADAY_CLIENT_OR_SERVER_ERRORS) => error
      retry_sequence_id ||= SecureRandom.urlsafe_base64(4)
      time_passed = Time.now - requested_at

      if can_fallback_to_alternate_ably_host? && (retry_count < max_retry_count) && (time_passed <= max_retry_duration)
        retry_count += 1
        retry_log_severity = log_retries_as_info ? :info : :warn
        logger.public_send(retry_log_severity) { "Ably::Rest::Client - Retry #{retry_count} for #{method} #{path} #{params} as initial attempt failed (seq ##{retry_sequence_id}): #{error}" }
        retry
      end

      retry_log_severity = log_retries_as_info ? :info : :error
      logger.public_send(retry_log_severity) do
        "Ably::Rest::Client - Request FAILED after #{retry_count} #{retry_count > 1 ? 'retries' : 'retry' } for" \
        " #{method} #{path} #{params} (seq ##{retry_sequence_id}, time elapsed #{(Time.now.to_f - requested_at.to_f).round(2)}s)"
      end

      case error
        when Faraday::TimeoutError
          raise Ably::Exceptions::ConnectionTimeout.new(error.message, nil, Ably::Exceptions::Codes::CONNECTION_TIMED_OUT, error, { request_id: request_id })
        when *FARADAY_CLIENT_OR_SERVER_ERRORS
          # request_id is also available in the request context
          raise Ably::Exceptions::ConnectionError.new(error.message, nil, Ably::Exceptions::Codes::CONNECTION_FAILED, error, { request_id: request_id })
        else
          raise error
      end
    end
  end

  def reauthorize_on_authorization_failure
    yield
  rescue Ably::Exceptions::TokenExpired => e
    if auth.token_renewable?
      auth.authorize
      yield
    else
      raise e
    end
  end

  def endpoint_for_host(host)
    port = if use_tls?
      custom_tls_port
    else
      custom_port
    end

    raise ArgumentError, "Custom port must be an Integer or nil" if port && !port.kind_of?(Integer)

    options = {
      scheme: use_tls? ? 'https' : 'http',
      host:   host
    }
    options.merge!(port: port) if port

    URI::Generic.build(options)
  end

  # Return a Hash of connection options to initiate the Faraday::Connection with
  #
  # @return [Hash]
  def connection_options
    @connection_options ||= {
      builder: middleware,
      headers: {
        content_type:       mime_type,
        accept:             mime_type,
        user_agent:         user_agent,
        'X-Ably-Version' => Ably::PROTOCOL_VERSION,
        'Ably-Agent'     => agent
      },
      request: {
        open_timeout: http_defaults.fetch(:open_timeout),
        timeout:      http_defaults.fetch(:request_timeout)
      }
    }
  end

  # Return a Faraday middleware stack to initiate the Faraday::RackBuilder with
  #
  # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
  def middleware
    @middleware ||= Faraday::RackBuilder.new do |builder|
      setup_outgoing_middleware builder

      # Raise exceptions if response code is invalid
      builder.use Ably::Rest::Middleware::Exceptions

      setup_incoming_middleware builder, logger, fail_if_unsupported_mime_type: true

      # Set Faraday's HTTP adapter with support for HTTP/2
      builder.adapter :typhoeus, http_version: :httpv2_0
    end
  end

  def can_fallback_to_alternate_ably_host?
    fallback_hosts && !fallback_hosts.empty?
  end

  def initialize_default_encoders
    Ably::Models::MessageEncoders.register_default_encoders self, binary_protocol: protocol == :msgpack
  end
end

#channels ⇒ `Aby::Rest::Channels` (readonly)

The collection of Ably::Rest::Channels that have been created

Returns:

(Aby::Rest::Channels)



68
69
70

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 68

def channels
  @channels
end

#client_id ⇒ `String` (readonly)

Returns A client ID, used for identifying this client for presence purposes.

Returns:

(String) —

A client ID, used for identifying this client for presence purposes

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 20

class Client
  include Ably::Modules::Conversions
  include Ably::Modules::HttpHelpers
  extend Forwardable

  # Default Ably domain for REST
  DOMAIN = 'rest.ably.io'

  MAX_MESSAGE_SIZE = 65536 # See spec TO3l8
  MAX_FRAME_SIZE = 524288 # See spec TO3l8

  # Configuration for HTTP timeouts and HTTP request reattempts to fallback hosts
  HTTP_DEFAULTS = {
    open_timeout:       4,
    request_timeout:    10,
    max_retry_duration: 15,
    max_retry_count:    3
  }.freeze

  FALLBACK_RETRY_TIMEOUT = 10 * 60

  # Faraday 1.0 introduced new error types, however we want to support Faraday <1 too which only used Faraday::ClientError
  FARADAY_CLIENT_OR_SERVER_ERRORS = if defined?(Faraday::ParsingError)
    [Faraday::ClientError, Faraday::ServerError, Faraday::ConnectionFailed, Faraday::SSLError, Faraday::ParsingError]
  else
    Faraday::ClientError
  end

  def_delegators :auth, :client_id, :auth_options

  # Custom environment to use such as 'sandbox' when testing the client library against an alternate Ably environment
  # @return [String]
  attr_reader :environment

  # The protocol configured for this client, either binary `:msgpack` or text based `:json`
  # @return [Symbol]
  attr_reader :protocol

  # Client agent i.e. `example-gem/1.2.0 ably-ruby/1.1.5 ruby/3.1.1`
  # @return [String]
  attr_reader :agent

  # {Ably::Auth} authentication object configured for this connection
  # @return [Ably::Auth]
  attr_reader :auth

  # The collection of {Ably::Rest::Channel}s that have been created
  # @return [Aby::Rest::Channels]
  attr_reader :channels

  # Log level configured for this {Client}
  # @return [Logger::Severity]
  attr_reader :log_level

  # The custom host that is being used if it was provided with the option +:rest_host+ when the {Client} was created
  # @return [String,Nil]
  attr_reader :custom_host

  # The custom port for non-TLS requests if it was provided with the option +:port+ when the {Client} was created
  # @return [Integer,Nil]
  attr_reader :custom_port

  # The custom TLS port for TLS requests if it was provided with the option +:tls_port+ when the {Client} was created
  # @return [Integer,Nil]
  attr_reader :custom_tls_port

  # The immutable configured HTTP defaults for this client.
  # See {#initialize} for the configurable HTTP defaults prefixed with +http_+
  # @return [Hash]
  attr_reader :http_defaults

  # The registered encoders that are used to encode and decode message payloads
  # @return [Array<Ably::Models::MessageEncoder::Base>]
  # @api private
  attr_reader :encoders

  # The additional options passed to this Client's #initialize method not available as attributes of this class
  # @return [Hash]
  # @api private
  attr_reader :options

  # The list of fallback hosts to be used by this client
  # if empty or nil then fallback host functionality is disabled
  attr_reader :fallback_hosts

  # Whether the {Client} has to add a random identifier to the path of a request
  # @return [Boolean]
  attr_reader :add_request_ids

  # Retries are logged by default to warn and error. When true, retries are logged at info level
  # @return [Boolean]
  # @api private
  attr_reader :log_retries_as_info

  # True when idempotent publishing is enabled for all messages published via REST.
  # When this feature is enabled, the client library will add a unique ID to every published message (without an ID)
  # ensuring any failed published attempts (due to failures such as HTTP requests failing mid-flight) that are
  # automatically retried will not result in duplicate messages being published to the Ably platform.
  # Note: This is a beta unsupported feature!
  # @return [Boolean]
  attr_reader :idempotent_rest_publishing

  # Max message size (TO2, TO3l8) by default (65536 bytes) 64KiB
  # @return [Integer]
  attr_reader :max_message_size

  # Max frame size (TO2, TO3l8) by default (524288 bytes) 512KiB
  # @return [Integer]
  attr_reader :max_frame_size

  # Creates a {Ably::Rest::Client Rest Client} and configures the {Ably::Auth} object for the connection.
  #
  # @param [Hash,String] options an options Hash used to configure the client and the authentication, or String with an API key or Token ID
  # @option options [Boolean]                 :tls                 (true) When false, TLS is disabled. Please note Basic Auth is disallowed without TLS as secrets cannot be transmitted over unsecured connections.
  # @option options [String]                  :key                 API key comprising the key name and key secret in a single string
  # @option options [String]                  :token               Token string or {Models::TokenDetails} used to authenticate requests
  # @option options [String]                  :token_details       {Models::TokenDetails} used to authenticate requests
  # @option options [Boolean]                 :use_token_auth      Will force Basic Auth if set to false, and Token auth if set to true
  # @option options [String]                  :environment         Specify 'sandbox' when testing the client library against an alternate Ably environment
  # @option options [Symbol]                  :protocol            (:msgpack) Protocol used to communicate with Ably, :json and :msgpack currently supported
  # @option options [Boolean]                 :use_binary_protocol (true) When true will use the MessagePack binary protocol, when false it will use JSON encoding. This option will overide :protocol option
  # @option options [Logger::Severity,Symbol] :log_level           (Logger::WARN) Log level for the standard Logger that outputs to STDOUT. Can be set to :fatal (Logger::FATAL), :error (Logger::ERROR), :warn (Logger::WARN), :info (Logger::INFO), :debug (Logger::DEBUG) or :none
  # @option options [Logger]                  :logger              A custom logger can be used however it must adhere to the Ruby Logger interface, see http://www.ruby-doc.org/stdlib-3.1.1/libdoc/logger/rdoc/Logger.html
  # @option options [String]                  :client_id           client ID identifying this connection to other clients
  # @option options [String]                  :auth_url            a URL to be used to GET or POST a set of token request params, to obtain a signed token request
  # @option options [Hash]                    :auth_headers        a set of application-specific headers to be added to any request made to the +auth_url+
  # @option options [Hash]                    :auth_params         a set of application-specific query params to be added to any request made to the +auth_url+
  # @option options [Symbol]                  :auth_method         (:get) HTTP method to use with +auth_url+, must be either +:get+ or +:post+
  # @option options [Proc]                    :auth_callback       when provided, the Proc will be called with the token params hash as the first argument, whenever a new token is required.
  #                                                                The Proc should return a token string, {Ably::Models::TokenDetails} or JSON equivalent, {Ably::Models::TokenRequest} or JSON equivalent
  # @option 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 options [Hash]                    :default_token_params   convenience to pass in +token_params+ that will be used as a default for all token requests. See {Auth#create_token_request}
  #
  # @option options [Integer]                 :http_open_timeout       (4 seconds) timeout in seconds for opening an HTTP connection for all HTTP requests
  # @option options [Integer]                 :http_request_timeout    (10 seconds) timeout in seconds for any single complete HTTP request and response
  # @option options [Integer]                 :http_max_retry_count    (3) maximum number of fallback host retries for HTTP requests that fail due to network issues or server problems
  # @option options [Integer]                 :http_max_retry_duration (15 seconds) maximum elapsed time in which fallback host retries for HTTP requests will be attempted i.e. if the first default host attempt takes 5s, and then the subsequent fallback retry attempt takes 7s, no further fallback host attempts will be made as the total elapsed time of 12s exceeds the default 10s limit
  #
  # @option options [Boolean]                 :fallback_hosts_use_default  (false) When true, forces the user of fallback hosts even if a non-default production endpoint is being used
  # @option options [Array<String>]           :fallback_hosts              When an array of fallback hosts are provided, these fallback hosts are always used if a request fails to the primary endpoint. If an empty array is provided, the fallback host functionality is disabled
  # @option options [Integer]                 :fallback_retry_timeout     (600 seconds) amount of time in seconds a REST client will continue to use a working fallback host when the primary fallback host has previously failed
  #
  # @option options [Boolean]                 :add_request_ids             (false) When true, adds a unique request_id to each request sent to Ably servers. This is handy when reporting issues, because you can refer to a specific request.
  # @option options [Boolean]                 :idempotent_rest_publishing  (false if ver < 1.2) When true, idempotent publishing is enabled for all messages published via REST
  # @option options [Integer]                 :max_message_size            (65536 bytes) Maximum size of all messages when publishing via REST publish()
  # @option options [Integer]                 :max_frame_size              (524288 bytes) Maximum size of frame
  #
  # @return [Ably::Rest::Client]
  #
  # @example
  #    # create a new client authenticating with basic auth
  #    client = Ably::Rest::Client.new('key.id:secret')
  #
  #    # create a new client and configure a client ID used for presence
  #    client = Ably::Rest::Client.new(key: 'key.id:secret', client_id: 'john')
  #
  def initialize(options)
    raise ArgumentError, 'Options Hash is expected' if options.nil?

    options = options.clone
    if options.kind_of?(String)
      options = if options.match(Auth::API_KEY_REGEX)
        { key: options }
      else
        { token: options }
      end
    end

    @agent               = options.delete(:agent) || Ably::AGENT
    @realtime_client     = options.delete(:realtime_client)
    @tls                 = options.delete(:tls) == false ? false : true
    @environment         = options.delete(:environment) # nil is production
    @environment         = nil if [:production, 'production'].include?(@environment)
    @protocol            = options.delete(:protocol) || :msgpack
    @debug_http          = options.delete(:debug_http)
    @log_level           = options.delete(:log_level) || ::Logger::WARN
    @custom_logger       = options.delete(:logger)
    @custom_host         = options.delete(:rest_host)
    @custom_port         = options.delete(:port)
    @custom_tls_port     = options.delete(:tls_port)
    @add_request_ids     = options.delete(:add_request_ids)
    @log_retries_as_info = options.delete(:log_retries_as_info)
    @max_message_size    = options.delete(:max_message_size) || MAX_MESSAGE_SIZE
    @max_frame_size      = options.delete(:max_frame_size) || MAX_FRAME_SIZE

    if (@idempotent_rest_publishing = options.delete(:idempotent_rest_publishing)).nil?
      @idempotent_rest_publishing = Ably::PROTOCOL_VERSION.to_f > 1.1
    end

    if options[:fallback_hosts_use_default] && options[:fallback_hosts]
      raise ArgumentError, "fallback_hosts_use_default cannot be set to try when fallback_hosts is also provided"
    end
    @fallback_hosts = case
    when options.delete(:fallback_hosts_use_default)
      Ably::FALLBACK_HOSTS
    when options_fallback_hosts = options.delete(:fallback_hosts)
      options_fallback_hosts
    when custom_host || options[:realtime_host] || custom_port || custom_tls_port
      []
    when environment
      CUSTOM_ENVIRONMENT_FALLBACKS_SUFFIXES.map { |host| "#{environment}#{host}" }
    else
      Ably::FALLBACK_HOSTS
    end

    options[:fallback_retry_timeout] ||= FALLBACK_RETRY_TIMEOUT

    # Take option keys prefixed with `http_`, remove the http_ and
    # check if the option exists in HTTP_DEFAULTS.  If so, update http_defaults
    @http_defaults = HTTP_DEFAULTS.dup
    options.each do |key, val|
      if http_key = key[/^http_(.+)/, 1]
        # Typhoeus converts decimal durations to milliseconds, so 0.0001 timeout is treated as 0 (no timeout)
        val = 0.001 if val.kind_of?(Numeric) && (val > 0) && (val < 0.001)
        @http_defaults[http_key.to_sym] = val if val && @http_defaults.has_key?(http_key.to_sym)
      end
    end
    @http_defaults.freeze

    if @log_level == :none
      @custom_logger = Ably::Models::NilLogger.new
    else
      @log_level = ::Logger.const_get(log_level.to_s.upcase) if log_level.kind_of?(Symbol) || log_level.kind_of?(String)
    end

    options.delete(:use_binary_protocol).tap do |use_binary_protocol|
      if use_binary_protocol == true
        @protocol = :msgpack
      elsif use_binary_protocol == false
        @protocol = :json
      end
    end
    raise ArgumentError, 'Protocol is invalid.  Must be either :msgpack or :json' unless [:msgpack, :json].include?(@protocol)

    token_params = options.delete(:default_token_params) || {}
    @options = options
    init_auth_options = options.select do |key, _|
      Auth::AUTH_OPTIONS_KEYS.include?(key.to_s)
    end

    @auth     = Auth.new(self, token_params, init_auth_options)
    @channels = Ably::Rest::Channels.new(self)
    @encoders = []

    options.freeze

    initialize_default_encoders
  end

  # Return a REST {Ably::Rest::Channel} for the given name
  #
  # @param (see Ably::Rest::Channels#get)
  #
  # @return (see Ably::Rest::Channels#get)
  def channel(name, channel_options = {})
    channels.get(name, channel_options)
  end

  # Retrieve the Stats for the application
  #
  # @param [Hash] options the options for the stats request
  # @option options [Integer,Time] :start      Ensure earliest time or millisecond since epoch for any stats retrieved is +:start+
  # @option options [Integer,Time] :end        Ensure latest time or millisecond since epoch for any stats retrieved is +:end+
  # @option options [Symbol]       :direction  +:forwards+ or +:backwards+, defaults to +:backwards+
  # @option options [Integer]      :limit      Maximum number of messages to retrieve up to 1,000, defaults to 100
  # @option options [Symbol]       :unit       `:minute`, `:hour`, `:day` or `:month`. Defaults to `:minute`
  #
  # @return [Ably::Models::PaginatedResult<Ably::Models::Stats>] An Array of Stats
  #
  def stats(options = {})
    options = {
      :direction => :backwards,
      :unit      => :minute,
      :limit     => 100
    }.merge(options)

    [:start, :end].each { |option| options[option] = as_since_epoch(options[option]) if options.has_key?(option) }
    raise ArgumentError, ":end must be equal to or after :start" if options[:start] && options[:end] && (options[:start] > options[:end])

    paginated_options = {
      coerce_into: 'Ably::Models::Stats'
    }

    url = '/stats'
    response = get(url, options)

    Ably::Models::PaginatedResult.new(response, url, self, paginated_options)
  end

  # Retrieve the Ably service time
  #
  # @return [Time] The time as reported by the Ably service
  def time
    response = get('/time', {}, send_auth_header: false)

    as_time_from_epoch(response.body.first)
  end

  # @!attribute [r] use_tls?
  # @return [Boolean] True if client is configured to use TLS for all Ably communication
  def use_tls?
    @tls == true
  end

  # Perform an HTTP GET request to the API using configured authentication
  #
  # @return [Faraday::Response]
  #
  # @api private
  def get(path, params = {}, options = {})
    raw_request(:get, path, params, options)
  end

  # Perform an HTTP POST request to the API using configured authentication
  #
  # @return [Faraday::Response]
  #
  # @api private
  def post(path, params, options = {})
    raw_request(:post, path, params, options)
  end

  # Perform an HTTP PUT request to the API using configured authentication
  #
  # @return [Faraday::Response]
  #
  # @api private
  def put(path, params, options = {})
    raw_request(:put, path, params, options)
  end

  # Perform an HTTP DELETE request to the API using configured authentication
  #
  # @return [Faraday::Response]
  #
  # @api private
  def delete(path, params, options = {})
    raw_request(:delete, path, params, options)
  end

  # Perform an HTTP request to the Ably API
  # This is a convenience for customers who wish to use bleeding edge REST API functionality
  # that is either not documented or is not included in the API for our client libraries.
  # The REST client library provides a function to issue HTTP requests to the Ably endpoints
  # with all the built in functionality of the library such as authentication, paging,
  # fallback hosts, MsgPack and JSON support etc.
  #
  # @param method  [Symbol]    The HTTP method symbol such as +:get+, +:post+, +:put+
  # @param path    [String]    The path of the URL such +/channel/foo/publish+
  # @param params  [Hash, nil] Optional querystring params
  # @param body    [Hash, nil] Optional body for the POST or PUT request, must be nil or a JSON-like object
  # @param headers [Hash, nil] Optional additional headers
  #
  # @return [Ably::Models::HttpPaginatedResponse<>]
  def request(method, path, params = {}, body = nil, headers = {}, options = {})
    raise "Method #{method.to_s.upcase} not supported" unless %i(get put patch post delete).include?(method.to_sym)

    response = case method.to_sym
    when :get, :delete
      reauthorize_on_authorization_failure do
        send_request(method, path, params, headers: headers)
      end
    when :post, :patch, :put
      if body.to_json.bytesize > max_frame_size
        raise Ably::Exceptions::MaxFrameSizeExceeded.new("Maximum frame size exceeded #{max_frame_size} bytes.")
      end
      path_with_params = Addressable::URI.new
      path_with_params.query_values = params || {}
      query = path_with_params.query
      reauthorize_on_authorization_failure do
        send_request(method, "#{path}#{"?#{query}" unless query.nil? || query.empty?}", body, headers: headers)
      end
    end

    paginated_options = {
      async_blocking_operations: options.delete(:async_blocking_operations),
    }

    Ably::Models::HttpPaginatedResponse.new(response, path, self, paginated_options)

  rescue Exceptions::ResourceMissing, Exceptions::ForbiddenRequest, Exceptions::ResourceMissing => e
    response = Models::HttpPaginatedResponse::ErrorResponse.new(e.status, e.code, e.message)
    Models::HttpPaginatedResponse.new(response, path, self)
  rescue Exceptions::TokenExpired, Exceptions::UnauthorizedRequest => e
    response = Models::HttpPaginatedResponse::ErrorResponse.new(e.status, e.code, e.message)
    Models::HttpPaginatedResponse.new(response, path, self)
  rescue Exceptions::InvalidRequest, Exceptions::ServerError => e
    response = Models::HttpPaginatedResponse::ErrorResponse.new(e.status, e.code, e.message)
    Models::HttpPaginatedResponse.new(response, path, self)
  end

  # The local device detilas
  # @return [Ably::Models::LocalDevice]
  #
  # @note This is unsupported in the Ruby library
  def device
    raise Ably::Exceptions::PushNotificationsNotSupported, 'This device does not support receiving or subscribing to push notifications. The local device object is not unavailable'
  end

  # Push notification object for publishing and managing push notifications
  # @return [Ably::Rest::Push]
  def push
    @push ||= Push.new(self)
  end

  # @!attribute [r] endpoint
  # @return [URI::Generic] Default Ably REST endpoint used for all requests
  def endpoint
    endpoint_for_host(custom_host || [@environment, DOMAIN].compact.join('-'))
  end

  # @!attribute [r] logger
  # @return [Logger] The {Ably::Logger} for this client.
  #                  Configure the log_level with the `:log_level` option, refer to {Client#initialize}
  def logger
    @logger ||= Ably::Logger.new(self, log_level, @custom_logger)
  end

  # @!attribute [r] mime_type
  # @return [String] Mime type used for HTTP requests
  def mime_type
    case protocol
    when :json
      'application/json'
    else
      'application/x-msgpack'
    end
  end

  # Register a message encoder and decoder that implements Ably::Models::MessageEncoders::Base interface.
  # Message encoders are used to encode and decode message payloads automatically.
  # @note Encoders and decoders are processed in the order they are added so the first encoder will be given priority when encoding and decoding
  #
  # @param [Ably::Models::MessageEncoders::Base] encoder
  # @return [void]
  #
  # @api private
  def register_encoder(encoder, options = {})
    encoders << Ably::Models::MessageEncoders.encoder_from(encoder, options)
  end

  # @!attribute [r] protocol_binary?
  # @return [Boolean] True of the transport #protocol communicates with Ably with a binary protocol
  def protocol_binary?
    protocol == :msgpack
  end

  # Connection used to make HTTP requests
  #
  # @param [Hash] options
  # @option options [Boolean] :use_fallback when true, one of the fallback connections is used randomly, see the default {Ably::FALLBACK_HOSTS}
  #
  # @return [Faraday::Connection]
  #
  # @api private
  def connection(options = {})
    if options[:use_fallback]
      fallback_connection
    else
      @connection ||= Faraday.new(endpoint.to_s, connection_options)
    end
  end

  # Fallback connection used to make HTTP requests.
  # Note, each request uses a random and then subsequent random {Ably::FALLBACK_HOSTS fallback hosts}
  # are used (unless custom fallback hosts are provided with fallback_hosts)
  #
  # @return [Faraday::Connection]
  #
  # @api private
  def fallback_connection
    unless defined?(@fallback_connections) && @fallback_connections
      @fallback_connections = fallback_hosts.shuffle.map { |host| Faraday.new(endpoint_for_host(host).to_s, connection_options) }
    end
    @fallback_index ||= 0

    @fallback_connections[@fallback_index % @fallback_connections.count].tap do
      @fallback_index += 1
    end
  end

  # Allowable duration for an external auth request
  # For REST client this defaults to request_timeout
  # For Realtime clients this defaults to 250ms less than the realtime_request_timeout
  #   ensuring an auth failure will be triggered before the realtime request timeout fires
  #   which would lead to a misleading error message (connection timeout as opposed to auth request timeout)
  # @api private
  def auth_request_timeout
    if @realtime_client
      @realtime_client.connection.defaults.fetch(:realtime_request_timeout) - 0.25
    else
      http_defaults.fetch(:request_timeout)
    end
  end

  # If the primary host endpoint fails, and a subsequent fallback host succeeds, the fallback
  #   host that succeeded is used for +ClientOption+ +fallback_retry_timeout+ seconds to avoid
  #   retries to known failing hosts for a short period of time.
  # See https://github.com/ably/docs/pull/554, spec id #RSC15f
  #
  # @return [nil, String]  Returns nil (falsey) if the primary host is being used, or the currently used host if a fallback host is currently preferred
  def using_preferred_fallback_host?
    if preferred_fallback_connection && (preferred_fallback_connection.fetch(:expires_at) > Time.now)
      preferred_fallback_connection.fetch(:connection_object).host
    end
  end

  private

  attr_reader :preferred_fallback_connection

  # See #using_preferred_fallback_host? for context
  def set_preferred_fallback_connection(connection)
    @preferred_fallback_connection = if connection == @connection
      # If the succeeded connection is in fact the primary connection (tried after a failed fallback)
      #   then clear the preferred fallback connection
      nil
    else
      {
        expires_at: Time.now + options.fetch(:fallback_retry_timeout),
        connection_object: connection,
      }
    end
  end

  def get_preferred_fallback_connection_object
    preferred_fallback_connection.fetch(:connection_object) if using_preferred_fallback_host?
  end

  def raw_request(method, path, params = {}, options = {})
    options = options.clone
    if options.delete(:disable_automatic_reauthorize) == true
      send_request(method, path, params, options)
    else
      reauthorize_on_authorization_failure do
        send_request(method, path, params, options)
      end
    end
  end

  # Sends HTTP request to connection end point
  # Connection failures will automatically be reattempted until thresholds are met
  def send_request(method, path, params, options)
    max_retry_count    = http_defaults.fetch(:max_retry_count)
    max_retry_duration = http_defaults.fetch(:max_retry_duration)
    requested_at       = Time.now
    retry_count        = 0
    retry_sequence_id  = nil
    request_id         = SecureRandom.urlsafe_base64(10) if add_request_ids

    preferred_fallback_connection_for_first_request = get_preferred_fallback_connection_object

    begin
      use_fallback = can_fallback_to_alternate_ably_host? && (retry_count > 0)

      conn = if preferred_fallback_connection_for_first_request
        case retry_count
        when 0
          preferred_fallback_connection_for_first_request
        when 1
          # Ensure the root host is used first if the preferred fallback fails, see #RSC15f
          connection(use_fallback: false)
        end
      end || connection(use_fallback: use_fallback) # default to normal connection selection process if not preferred connection set

      conn.send(method, path, params) do |request|
        if add_request_ids
          request.params[:request_id] = request_id
          request.options.context = {} if request.options.context.nil?
          request.options.context[:request_id] = request_id
        end
        if options[:qs_params]
          request.params.merge!(options[:qs_params])
        end
        unless options[:send_auth_header] == false
          request.headers[:authorization] = auth.auth_header

          options[:headers].to_h.merge(auth.extra_auth_headers).map do |key, val|
            request.headers[key] = val
          end
        end
      end.tap do
        if retry_count > 0
          retry_log_severity = log_retries_as_info ? :info : :warn
          logger.public_send(retry_log_severity) do
            "Ably::Rest::Client - Request SUCCEEDED after #{retry_count} #{retry_count > 1 ? 'retries' : 'retry' } for" \
            " #{method} #{path} #{params} (seq ##{retry_sequence_id}, time elapsed #{(Time.now.to_f - requested_at.to_f).round(2)}s)"
          end
          set_preferred_fallback_connection conn
        end
      end

    rescue *([Faraday::TimeoutError, Ably::Exceptions::ServerError] + FARADAY_CLIENT_OR_SERVER_ERRORS) => error
      retry_sequence_id ||= SecureRandom.urlsafe_base64(4)
      time_passed = Time.now - requested_at

      if can_fallback_to_alternate_ably_host? && (retry_count < max_retry_count) && (time_passed <= max_retry_duration)
        retry_count += 1
        retry_log_severity = log_retries_as_info ? :info : :warn
        logger.public_send(retry_log_severity) { "Ably::Rest::Client - Retry #{retry_count} for #{method} #{path} #{params} as initial attempt failed (seq ##{retry_sequence_id}): #{error}" }
        retry
      end

      retry_log_severity = log_retries_as_info ? :info : :error
      logger.public_send(retry_log_severity) do
        "Ably::Rest::Client - Request FAILED after #{retry_count} #{retry_count > 1 ? 'retries' : 'retry' } for" \
        " #{method} #{path} #{params} (seq ##{retry_sequence_id}, time elapsed #{(Time.now.to_f - requested_at.to_f).round(2)}s)"
      end

      case error
        when Faraday::TimeoutError
          raise Ably::Exceptions::ConnectionTimeout.new(error.message, nil, Ably::Exceptions::Codes::CONNECTION_TIMED_OUT, error, { request_id: request_id })
        when *FARADAY_CLIENT_OR_SERVER_ERRORS
          # request_id is also available in the request context
          raise Ably::Exceptions::ConnectionError.new(error.message, nil, Ably::Exceptions::Codes::CONNECTION_FAILED, error, { request_id: request_id })
        else
          raise error
      end
    end
  end

  def reauthorize_on_authorization_failure
    yield
  rescue Ably::Exceptions::TokenExpired => e
    if auth.token_renewable?
      auth.authorize
      yield
    else
      raise e
    end
  end

  def endpoint_for_host(host)
    port = if use_tls?
      custom_tls_port
    else
      custom_port
    end

    raise ArgumentError, "Custom port must be an Integer or nil" if port && !port.kind_of?(Integer)

    options = {
      scheme: use_tls? ? 'https' : 'http',
      host:   host
    }
    options.merge!(port: port) if port

    URI::Generic.build(options)
  end

  # Return a Hash of connection options to initiate the Faraday::Connection with
  #
  # @return [Hash]
  def connection_options
    @connection_options ||= {
      builder: middleware,
      headers: {
        content_type:       mime_type,
        accept:             mime_type,
        user_agent:         user_agent,
        'X-Ably-Version' => Ably::PROTOCOL_VERSION,
        'Ably-Agent'     => agent
      },
      request: {
        open_timeout: http_defaults.fetch(:open_timeout),
        timeout:      http_defaults.fetch(:request_timeout)
      }
    }
  end

  # Return a Faraday middleware stack to initiate the Faraday::RackBuilder with
  #
  # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
  def middleware
    @middleware ||= Faraday::RackBuilder.new do |builder|
      setup_outgoing_middleware builder

      # Raise exceptions if response code is invalid
      builder.use Ably::Rest::Middleware::Exceptions

      setup_incoming_middleware builder, logger, fail_if_unsupported_mime_type: true

      # Set Faraday's HTTP adapter with support for HTTP/2
      builder.adapter :typhoeus, http_version: :httpv2_0
    end
  end

  def can_fallback_to_alternate_ably_host?
    fallback_hosts && !fallback_hosts.empty?
  end

  def initialize_default_encoders
    Ably::Models::MessageEncoders.register_default_encoders self, binary_protocol: protocol == :msgpack
  end
end

#custom_host ⇒ `String`, `Nil` (readonly)

The custom host that is being used if it was provided with the option :rest_host when the Ably::Rest::Client was created

Returns:

(String, Nil)



76
77
78

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 76

def custom_host
  @custom_host
end

#custom_port ⇒ `Integer`, `Nil` (readonly)

The custom port for non-TLS requests if it was provided with the option :port when the Ably::Rest::Client was created

Returns:

(Integer, Nil)



80
81
82

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 80

def custom_port
  @custom_port
end

#custom_tls_port ⇒ `Integer`, `Nil` (readonly)

The custom TLS port for TLS requests if it was provided with the option :tls_port when the Ably::Rest::Client was created

Returns:

(Integer, Nil)



84
85
86

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 84

def custom_tls_port
  @custom_tls_port
end

#encoders ⇒ `Array<Ably::Models::MessageEncoder::Base>` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The registered encoders that are used to encode and decode message payloads

Returns:

(Array<Ably::Models::MessageEncoder::Base>)



94
95
96

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 94

def encoders
  @encoders
end

#endpoint ⇒ `URI::Generic` (readonly)

Returns Default Ably REST endpoint used for all requests.

Returns:

(URI::Generic) —

Default Ably REST endpoint used for all requests



427
428
429

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 427

def endpoint
  endpoint_for_host(custom_host || [@environment, DOMAIN].compact.join('-'))
end

#environment ⇒ `String` (readonly)

Custom environment to use such as 'sandbox' when testing the client library against an alternate Ably environment

Returns:

(String)



52
53
54

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 52

def environment
  @environment
end

#fallback_hosts ⇒ `Object` (readonly)

The list of fallback hosts to be used by this client if empty or nil then fallback host functionality is disabled



103
104
105

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 103

def fallback_hosts
  @fallback_hosts
end

#http_defaults ⇒ `Hash` (readonly)

The immutable configured HTTP defaults for this client. See #initialize for the configurable HTTP defaults prefixed with http_

Returns:

(Hash)



89
90
91

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 89

def http_defaults
  @http_defaults
end

#idempotent_rest_publishing ⇒ `Boolean` (readonly)

True when idempotent publishing is enabled for all messages published via REST. When this feature is enabled, the client library will add a unique ID to every published message (without an ID) ensuring any failed published attempts (due to failures such as HTTP requests failing mid-flight) that are automatically retried will not result in duplicate messages being published to the Ably platform. Note: This is a beta unsupported feature!

Returns:

(Boolean)



120
121
122

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 120

def idempotent_rest_publishing
  @idempotent_rest_publishing
end

#log_level ⇒ `Logger::Severity` (readonly)

Log level configured for this Ably::Rest::Client

Returns:

(Logger::Severity)



72
73
74

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 72

def log_level
  @log_level
end

#log_retries_as_info ⇒ `Boolean` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Retries are logged by default to warn and error. When true, retries are logged at info level

Returns:

(Boolean)



112
113
114

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 112

def log_retries_as_info
  @log_retries_as_info
end

#logger ⇒ `Logger` (readonly)

Returns The Logger for this client. Configure the log_level with the `:log_level` option, refer to #initialize.

Returns:

(Logger) —

The Logger for this client. Configure the log_level with the `:log_level` option, refer to #initialize



434
435
436

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 434

def logger
  @logger ||= Ably::Logger.new(self, log_level, @custom_logger)
end

#max_frame_size ⇒ `Integer` (readonly)

Max frame size (TO2, TO3l8) by default (524288 bytes) 512KiB

Returns:

(Integer)



128
129
130

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 128

def max_frame_size
  @max_frame_size
end

#max_message_size ⇒ `Integer` (readonly)

Max message size (TO2, TO3l8) by default (65536 bytes) 64KiB

Returns:

(Integer)



124
125
126

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 124

def max_message_size
  @max_message_size
end

#mime_type ⇒ `String` (readonly)

Returns Mime type used for HTTP requests.

Returns:

(String) —

Mime type used for HTTP requests

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 440

def mime_type
  case protocol
  when :json
    'application/json'
  else
    'application/x-msgpack'
  end
end

#options ⇒ `Hash` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The additional options passed to this Client's #initialize method not available as attributes of this class

Returns:

(Hash)



99
100
101

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 99

def options
  @options
end

#protocol ⇒ `Symbol` (readonly)

The protocol configured for this client, either binary `:msgpack` or text based `:json`

Returns:

(Symbol)



56
57
58

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 56

def protocol
  @protocol
end

#protocol_binary? ⇒ `Boolean` (readonly)

Returns True of the transport #protocol communicates with Ably with a binary protocol.

Returns:

(Boolean) —

True of the transport #protocol communicates with Ably with a binary protocol



463
464
465

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 463

def protocol_binary?
  protocol == :msgpack
end

#use_tls? ⇒ `Boolean` (readonly)

Returns True if client is configured to use TLS for all Ably communication.

Returns:

(Boolean) —

True if client is configured to use TLS for all Ably communication



320
321
322

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 320

def use_tls?
  @tls == true
end

Instance Method Details

#auth_request_timeout ⇒ `Object`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Allowable duration for an external auth request For REST client this defaults to request_timeout For Realtime clients this defaults to 250ms less than the realtime_request_timeout

ensuring an auth failure will be triggered before the realtime request timeout fires
which would lead to a misleading error message (connection timeout as opposed to auth request timeout)

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 507

def auth_request_timeout
  if @realtime_client
    @realtime_client.connection.defaults.fetch(:realtime_request_timeout) - 0.25
  else
    http_defaults.fetch(:request_timeout)
  end
end

#channel(name, channel_options = {}) ⇒ `Ably::Rest::Channel`

Return a REST Ably::Rest::Channel for the given name

Parameters:

name (String) —

The name of the channel
channel_options (Hash) (defaults to: {}) —

Channel options, currently reserved for Encryption options

Returns:

(Ably::Rest::Channel)



274
275
276

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 274

def channel(name, channel_options = {})
  channels.get(name, channel_options)
end

#connection(options = {}) ⇒ `Faraday::Connection`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Connection used to make HTTP requests

Parameters:

options (Hash) (defaults to: {})

Options Hash (options):

:use_fallback (Boolean) —

when true, one of the fallback connections is used randomly, see the default FALLBACK_HOSTS

Returns:

(Faraday::Connection)

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 475

def connection(options = {})
  if options[:use_fallback]
    fallback_connection
  else
    @connection ||= Faraday.new(endpoint.to_s, connection_options)
  end
end

#delete(path, params, options = {}) ⇒ `Faraday::Response`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Perform an HTTP DELETE request to the API using configured authentication

Returns:

(Faraday::Response)



356
357
358

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 356

def delete(path, params, options = {})
  raw_request(:delete, path, params, options)
end

#device ⇒ `Ably::Models::LocalDevice`

Note:

This is unsupported in the Ruby library

The local device detilas

Returns:

(Ably::Models::LocalDevice)

Raises:

(Ably::Exceptions::PushNotificationsNotSupported)



415
416
417

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 415

def device
  raise Ably::Exceptions::PushNotificationsNotSupported, 'This device does not support receiving or subscribing to push notifications. The local device object is not unavailable'
end

#fallback_connection ⇒ `Faraday::Connection`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Fallback connection used to make HTTP requests. Note, each request uses a random and then subsequent random fallback hosts are used (unless custom fallback hosts are provided with fallback_hosts)

Returns:

(Faraday::Connection)

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 490

def fallback_connection
  unless defined?(@fallback_connections) && @fallback_connections
    @fallback_connections = fallback_hosts.shuffle.map { |host| Faraday.new(endpoint_for_host(host).to_s, connection_options) }
  end
  @fallback_index ||= 0

  @fallback_connections[@fallback_index % @fallback_connections.count].tap do
    @fallback_index += 1
  end
end

#get(path, params = {}, options = {}) ⇒ `Faraday::Response`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Perform an HTTP GET request to the API using configured authentication

Returns:

(Faraday::Response)



329
330
331

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 329

def get(path, params = {}, options = {})
  raw_request(:get, path, params, options)
end

#post(path, params, options = {}) ⇒ `Faraday::Response`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Perform an HTTP POST request to the API using configured authentication

Returns:

(Faraday::Response)



338
339
340

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 338

def post(path, params, options = {})
  raw_request(:post, path, params, options)
end

#push ⇒ `Ably::Rest::Push`

Push notification object for publishing and managing push notifications

Returns:

(Ably::Rest::Push)



421
422
423

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 421

def push
  @push ||= Push.new(self)
end

#put(path, params, options = {}) ⇒ `Faraday::Response`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Perform an HTTP PUT request to the API using configured authentication

Returns:

(Faraday::Response)



347
348
349

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 347

def put(path, params, options = {})
  raw_request(:put, path, params, options)
end

#register_encoder(encoder, options = {}) ⇒ `void`

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Note:

Encoders and decoders are processed in the order they are added so the first encoder will be given priority when encoding and decoding

This method returns an undefined value.

Register a message encoder and decoder that implements Ably::Models::MessageEncoders::Base interface. Message encoders are used to encode and decode message payloads automatically.

Parameters:

encoder (Ably::Models::MessageEncoders::Base)



457
458
459

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 457

def register_encoder(encoder, options = {})
  encoders << Ably::Models::MessageEncoders.encoder_from(encoder, options)
end

#request(method, path, params = {}, body = nil, headers = {}, options = {}) ⇒ `Ably::Models::HttpPaginatedResponse<>`

Perform an HTTP request to the Ably API This is a convenience for customers who wish to use bleeding edge REST API functionality that is either not documented or is not included in the API for our client libraries. The REST client library provides a function to issue HTTP requests to the Ably endpoints with all the built in functionality of the library such as authentication, paging, fallback hosts, MsgPack and JSON support etc.

Parameters:

method (Symbol) —

The HTTP method symbol such as :get, :post, :put
path (String) —

The path of the URL such /channel/foo/publish
params (Hash, nil) (defaults to: {}) —

Optional querystring params
body (Hash, nil) (defaults to: nil) —

Optional body for the POST or PUT request, must be nil or a JSON-like object
headers (Hash, nil) (defaults to: {}) —

Optional additional headers

Returns:

(Ably::Models::HttpPaginatedResponse<>)

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 374

def request(method, path, params = {}, body = nil, headers = {}, options = {})
  raise "Method #{method.to_s.upcase} not supported" unless %i(get put patch post delete).include?(method.to_sym)

  response = case method.to_sym
  when :get, :delete
    reauthorize_on_authorization_failure do
      send_request(method, path, params, headers: headers)
    end
  when :post, :patch, :put
    if body.to_json.bytesize > max_frame_size
      raise Ably::Exceptions::MaxFrameSizeExceeded.new("Maximum frame size exceeded #{max_frame_size} bytes.")
    end
    path_with_params = Addressable::URI.new
    path_with_params.query_values = params || {}
    query = path_with_params.query
    reauthorize_on_authorization_failure do
      send_request(method, "#{path}#{"?#{query}" unless query.nil? || query.empty?}", body, headers: headers)
    end
  end

  paginated_options = {
    async_blocking_operations: options.delete(:async_blocking_operations),
  }

  Ably::Models::HttpPaginatedResponse.new(response, path, self, paginated_options)

rescue Exceptions::ResourceMissing, Exceptions::ForbiddenRequest, Exceptions::ResourceMissing => e
  response = Models::HttpPaginatedResponse::ErrorResponse.new(e.status, e.code, e.message)
  Models::HttpPaginatedResponse.new(response, path, self)
rescue Exceptions::TokenExpired, Exceptions::UnauthorizedRequest => e
  response = Models::HttpPaginatedResponse::ErrorResponse.new(e.status, e.code, e.message)
  Models::HttpPaginatedResponse.new(response, path, self)
rescue Exceptions::InvalidRequest, Exceptions::ServerError => e
  response = Models::HttpPaginatedResponse::ErrorResponse.new(e.status, e.code, e.message)
  Models::HttpPaginatedResponse.new(response, path, self)
end

#stats(options = {}) ⇒ `Ably::Models::PaginatedResult<Ably::Models::Stats>`

Retrieve the Stats for the application

Parameters:

options (Hash) (defaults to: {}) —

the options for the stats request

Options Hash (options):

:start (Integer, Time) —

Ensure earliest time or millisecond since epoch for any stats retrieved is :start
:end (Integer, Time) —

Ensure latest time or millisecond since epoch for any stats retrieved is :end
:direction (Symbol) —

:forwards or :backwards, defaults to :backwards
:limit (Integer) —

Maximum number of messages to retrieve up to 1,000, defaults to 100
:unit (Symbol) —

`:minute`, `:hour`, `:day` or `:month`. Defaults to `:minute`

Returns:

(Ably::Models::PaginatedResult<Ably::Models::Stats>) —

An Array of Stats

Raises:

(ArgumentError)

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 289

def stats(options = {})
  options = {
    :direction => :backwards,
    :unit      => :minute,
    :limit     => 100
  }.merge(options)

  [:start, :end].each { |option| options[option] = as_since_epoch(options[option]) if options.has_key?(option) }
  raise ArgumentError, ":end must be equal to or after :start" if options[:start] && options[:end] && (options[:start] > options[:end])

  paginated_options = {
    coerce_into: 'Ably::Models::Stats'
  }

  url = '/stats'
  response = get(url, options)

  Ably::Models::PaginatedResult.new(response, url, self, paginated_options)
end

#time ⇒ `Time`

Retrieve the Ably service time

Returns:

(Time) —

The time as reported by the Ably service

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 312

def time
  response = get('/time', {}, send_auth_header: false)

  as_time_from_epoch(response.body.first)
end

#using_preferred_fallback_host? ⇒ `nil`, `String`

If the primary host endpoint fails, and a subsequent fallback host succeeds, the fallback

host that succeeded is used for +ClientOption+ +fallback_retry_timeout+ seconds to avoid
retries to known failing hosts for a short period of time.

See github.com/ably/docs/pull/554, spec id #RSC15f

Returns:

(nil, String) —

Returns nil (falsey) if the primary host is being used, or the currently used host if a fallback host is currently preferred

# File 'lib/submodules/ably-ruby/lib/ably/rest/client.rb', line 521

def using_preferred_fallback_host?
  if preferred_fallback_connection && (preferred_fallback_connection.fetch(:expires_at) > Time.now)
    preferred_fallback_connection.fetch(:connection_object).host
  end
end

Class: Ably::Rest::Client

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Ably::Rest::Client

Instance Attribute Details

#add_request_ids ⇒ Boolean (readonly)

#agent ⇒ String (readonly)

#auth ⇒ Ably::Auth (readonly)

#auth_options ⇒ Hash (readonly)

#channels ⇒ Aby::Rest::Channels (readonly)

#client_id ⇒ String (readonly)

#custom_host ⇒ String, Nil (readonly)

#custom_port ⇒ Integer, Nil (readonly)

#custom_tls_port ⇒ Integer, Nil (readonly)

#encoders ⇒ Array<Ably::Models::MessageEncoder::Base> (readonly)

#endpoint ⇒ URI::Generic (readonly)

#environment ⇒ String (readonly)

#fallback_hosts ⇒ Object (readonly)

#http_defaults ⇒ Hash (readonly)

#idempotent_rest_publishing ⇒ Boolean (readonly)

#log_level ⇒ Logger::Severity (readonly)

#log_retries_as_info ⇒ Boolean (readonly)

#logger ⇒ Logger (readonly)

#max_frame_size ⇒ Integer (readonly)

#max_message_size ⇒ Integer (readonly)

#mime_type ⇒ String (readonly)

#options ⇒ Hash (readonly)

#protocol ⇒ Symbol (readonly)

#protocol_binary? ⇒ Boolean (readonly)

#use_tls? ⇒ Boolean (readonly)

Instance Method Details

#auth_request_timeout ⇒ Object

#channel(name, channel_options = {}) ⇒ Ably::Rest::Channel

#connection(options = {}) ⇒ Faraday::Connection

#delete(path, params, options = {}) ⇒ Faraday::Response

#device ⇒ Ably::Models::LocalDevice

#fallback_connection ⇒ Faraday::Connection

#get(path, params = {}, options = {}) ⇒ Faraday::Response

#post(path, params, options = {}) ⇒ Faraday::Response

#push ⇒ Ably::Rest::Push

#put(path, params, options = {}) ⇒ Faraday::Response

#register_encoder(encoder, options = {}) ⇒ void

#request(method, path, params = {}, body = nil, headers = {}, options = {}) ⇒ Ably::Models::HttpPaginatedResponse<>

#stats(options = {}) ⇒ Ably::Models::PaginatedResult<Ably::Models::Stats>

#time ⇒ Time

#using_preferred_fallback_host? ⇒ nil, String

#initialize(options) ⇒ `Ably::Rest::Client`

#add_request_ids ⇒ `Boolean` (readonly)

#agent ⇒ `String` (readonly)

#auth ⇒ `Ably::Auth` (readonly)

#auth_options ⇒ `Hash` (readonly)

#channels ⇒ `Aby::Rest::Channels` (readonly)

#client_id ⇒ `String` (readonly)

#custom_host ⇒ `String`, `Nil` (readonly)

#custom_port ⇒ `Integer`, `Nil` (readonly)

#custom_tls_port ⇒ `Integer`, `Nil` (readonly)

#encoders ⇒ `Array<Ably::Models::MessageEncoder::Base>` (readonly)

#endpoint ⇒ `URI::Generic` (readonly)

#environment ⇒ `String` (readonly)

#fallback_hosts ⇒ `Object` (readonly)

#http_defaults ⇒ `Hash` (readonly)

#idempotent_rest_publishing ⇒ `Boolean` (readonly)

#log_level ⇒ `Logger::Severity` (readonly)

#log_retries_as_info ⇒ `Boolean` (readonly)

#logger ⇒ `Logger` (readonly)

#max_frame_size ⇒ `Integer` (readonly)

#max_message_size ⇒ `Integer` (readonly)

#mime_type ⇒ `String` (readonly)

#options ⇒ `Hash` (readonly)

#protocol ⇒ `Symbol` (readonly)

#protocol_binary? ⇒ `Boolean` (readonly)

#use_tls? ⇒ `Boolean` (readonly)

#auth_request_timeout ⇒ `Object`

#channel(name, channel_options = {}) ⇒ `Ably::Rest::Channel`

#connection(options = {}) ⇒ `Faraday::Connection`

#delete(path, params, options = {}) ⇒ `Faraday::Response`

#device ⇒ `Ably::Models::LocalDevice`

#fallback_connection ⇒ `Faraday::Connection`

#get(path, params = {}, options = {}) ⇒ `Faraday::Response`

#post(path, params, options = {}) ⇒ `Faraday::Response`

#push ⇒ `Ably::Rest::Push`

#put(path, params, options = {}) ⇒ `Faraday::Response`

#register_encoder(encoder, options = {}) ⇒ `void`

#request(method, path, params = {}, body = nil, headers = {}, options = {}) ⇒ `Ably::Models::HttpPaginatedResponse<>`

#stats(options = {}) ⇒ `Ably::Models::PaginatedResult<Ably::Models::Stats>`

#time ⇒ `Time`

#using_preferred_fallback_host? ⇒ `nil`, `String`