Class: Ably::Rest::Client

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Modules::Conversions, Modules::HttpHelpers
Defined in:
lib/ably/rest/client.rb

Overview

A client that offers a simple stateless API to interact directly with Ably’s REST API.

Constant Summary collapse

DOMAIN =

Default Ably domain for REST

'rest.ably.io'
MAX_MESSAGE_SIZE =

See spec TO3l8

65536
MAX_FRAME_SIZE =

See spec TO3l8

524288
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

Instance Method Summary collapse

Constructor Details

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

Constructs a Ably::Rest::Client object using an Ably API key or token string.

Examples:

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

# Construct a RestClient object using a Hash object.
client = Ably::Rest::Client.new(key: 'key.id:secret', client_id: 'john')

Parameters:

  • options (Hash, String) —

    an options Hash or String 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) 


175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/ably/rest/client.rb', line 175

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) 


104
105
106
 
# File 'lib/ably/rest/client.rb', line 104

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) 


55
56
57
 
# File 'lib/ably/rest/client.rb', line 55

def agent
  @agent
end

#auth ⇒ Ably::Auth (readonly)

An Auth object.

Returns:



60
61
62
 
# File 'lib/ably/rest/client.rb', line 60

def auth
  @auth
end

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

A Ably::Rest::Channels object.

Returns:

  • (Aby::Rest::Channels) 


65
66
67
 
# File 'lib/ably/rest/client.rb', line 65

def channels
  @channels
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) 


73
74
75
 
# File 'lib/ably/rest/client.rb', line 73

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) 


77
78
79
 
# File 'lib/ably/rest/client.rb', line 77

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) 


81
82
83
 
# File 'lib/ably/rest/client.rb', line 81

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>) 


91
92
93
 
# File 'lib/ably/rest/client.rb', line 91

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



433
434
435
 
# File 'lib/ably/rest/client.rb', line 433

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) 


47
48
49
 
# File 'lib/ably/rest/client.rb', line 47

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



100
101
102
 
# File 'lib/ably/rest/client.rb', line 100

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) 


86
87
88
 
# File 'lib/ably/rest/client.rb', line 86

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) 


117
118
119
 
# File 'lib/ably/rest/client.rb', line 117

def idempotent_rest_publishing
  @idempotent_rest_publishing
end

#log_level ⇒ Logger::Severity (readonly)

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

Returns:

  • (Logger::Severity) 


69
70
71
 
# File 'lib/ably/rest/client.rb', line 69

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) 


109
110
111
 
# File 'lib/ably/rest/client.rb', line 109

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



440
441
442
 
# File 'lib/ably/rest/client.rb', line 440

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) 


125
126
127
 
# File 'lib/ably/rest/client.rb', line 125

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) 


121
122
123
 
# File 'lib/ably/rest/client.rb', line 121

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



446
447
448
449
450
451
452
453
 
# File 'lib/ably/rest/client.rb', line 446

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) 


96
97
98
 
# File 'lib/ably/rest/client.rb', line 96

def options
  @options
end

#protocol ⇒ Symbol (readonly)

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

Returns:

  • (Symbol) 


51
52
53
 
# File 'lib/ably/rest/client.rb', line 51

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



469
470
471
 
# File 'lib/ably/rest/client.rb', line 469

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



325
326
327
 
# File 'lib/ably/rest/client.rb', line 325

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)



513
514
515
516
517
518
519
 
# File 'lib/ably/rest/client.rb', line 513

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:



273
274
275
 
# File 'lib/ably/rest/client.rb', line 273

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) 


481
482
483
484
485
486
487
 
# File 'lib/ably/rest/client.rb', line 481

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) 


361
362
363
 
# File 'lib/ably/rest/client.rb', line 361

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

#device ⇒ Ably::Models::LocalDevice

Note:

This is unsupported in the Ruby library

Retrieves an object that represents the current state of the device as a target for push notifications.

Returns:

  • (Ably::Models::LocalDevice)

Raises:



420
421
422
 
# File 'lib/ably/rest/client.rb', line 420

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) 


496
497
498
499
500
501
502
503
504
505
 
# File 'lib/ably/rest/client.rb', line 496

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) 


334
335
336
 
# File 'lib/ably/rest/client.rb', line 334

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) 


343
344
345
 
# File 'lib/ably/rest/client.rb', line 343

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

#push ⇒ Ably::Rest::Push

A Push object.

Returns:



427
428
429
 
# File 'lib/ably/rest/client.rb', line 427

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) 


352
353
354
 
# File 'lib/ably/rest/client.rb', line 352

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:



463
464
465
 
# File 'lib/ably/rest/client.rb', line 463

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<>

Makes a REST request to a provided path. This is provided as a convenience for developers who wish to use REST API functionality that is either not documented or is not yet included in the public API, without having to directly handle features such as authentication, paging, fallback hosts, MsgPack and JSON support.

Parameters:

  • method (Symbol) —

    The request method to use, such as :get, :post.

  • path (String) —

    The request path.

  • params (Hash, nil) (defaults to: {}) —

    The parameters to include in the URL query of the request. The parameters depend on the endpoint being queried. See the REST API reference for the available parameters of each endpoint.

  • body (Hash, nil) (defaults to: nil) —

    The JSON body of the request.

  • headers (Hash, nil) (defaults to: {}) —

    Additional HTTP headers to include in the request.

Returns:



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/ably/rest/client.rb', line 378

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>

Queries the REST /stats API and retrieves your application’s usage statistics. Returns a Models::PaginatedResult object, containing an array of Models::Stats objects. See the Stats docs.

Parameters:

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

    the options for the stats request

Options Hash (options):

  • :start (Integer, Time) —

    The time from which stats are retrieved, specified as milliseconds since the Unix epoch. RSC6b1

  • :end (Integer, Time) —

    The time until stats are retrieved, specified as milliseconds since the Unix epoch. RSC6b1

  • :direction (Symbol) —

    The order for which stats are returned in. Valid values are backwards which orders stats from most recent to oldest, or forwards which orders stats from oldest to most recent. The default is backwards. RSC6b2

  • :limit (Integer) —

    An upper limit on the number of stats returned. The default is 100, and the maximum is 1000. RSC6b3

  • :unit (Symbol) —

    minute, hour, day or month. Based on the unit selected, the given start or end times are rounded down to the start of the relevant interval depending on the unit granularity of the query. RSC6b4

Returns:

Raises:

  • (ArgumentError) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/ably/rest/client.rb', line 290

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

Retrieves the time from the Ably service as milliseconds since the Unix epoch. Clients that do not have access to a sufficiently well maintained time source and wish to issue Ably Models::TokenRequest with a more accurate timestamp should use the #queryTime property instead of this method.

Returns:

  • (Time) —

    The time as milliseconds since the Unix epoch.



317
318
319
320
321
 
# File 'lib/ably/rest/client.rb', line 317

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



527
528
529
530
531
 
# File 'lib/ably/rest/client.rb', line 527

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