Class: Ably::Models::TokenRequest

Inherits:
Object
  • Object
show all
Includes:
Ably::Modules::ModelCommon
Defined in:
lib/ably/models/token_request.rb

Overview

TokenRequest is a class that stores the attributes of a token request

Ruby Time objects are supported in place of Ably ms since epoch time fields. However, if a numeric is provided it must always be expressed in milliseconds as the Ably API always uses milliseconds for time fields.

Instance Attribute Summary collapse

Attributes included from Ably::Modules::ModelCommon

#hash

Instance Method Summary collapse

Methods included from Ably::Modules::ModelCommon

#==, #[], #as_json, included, #to_json, #to_s

Methods included from Ably::Modules::MessagePack

#to_msgpack

Constructor Details

#initialize(attributes = {}) ⇒ TokenRequest

Returns a new instance of TokenRequest.

Parameters:

  • attributes (defaults to: {})

Options Hash (attributes):

  • :ttl (Integer)

    requested time to live for the token in milliseconds

  • :timestamp (Time, Integer)

    the timestamp of this request in milliseconds or as a Time

  • :key_name (String)

    API key name of the key against which this request is made

  • :capability (String)

    JSON stringified capability of the token

  • :client_id (String)

    client ID to associate with this token

  • :nonce (String)

    an opaque nonce string of at least 16 characters

  • :mac (String)

    the Message Authentication Code for this request


34
35
36
37
38
39
40
# File 'lib/ably/models/token_request.rb', line 34

def initialize(attributes = {})
  @hash_object = IdiomaticRubyWrapper(attributes.clone)
  if self.attributes[:timestamp].kind_of?(Time)
    self.attributes[:timestamp] = (self.attributes[:timestamp].to_f * 1000).round
  end
  self.attributes.freeze
end

Instance Attribute Details

#attributesHash (readonly)

Returns the token request Hash object ruby'fied to use symbolized keys.

Returns:

  • (Hash)

    the token request Hash object ruby'fied to use symbolized keys


115
116
117
# File 'lib/ably/models/token_request.rb', line 115

def attributes
  @hash_object
end

#capabilityHash (readonly)

Returns capability of the token. If the token request is successful, the capability of the returned token will be the intersection of this capability with the capability of the issuing key.

Returns:

  • (Hash)

    capability of the token. If the token request is successful, the capability of the returned token will be the intersection of this capability with the capability of the issuing key.


61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/ably/models/token_request.rb', line 61

def capability
  capability_val = attributes.fetch(:capability) { raise Ably::Exceptions::InvalidTokenRequest, 'Capability is missing' }

  case capability_val
  when Hash
    capability_val
  when Ably::Models::IdiomaticRubyWrapper
    capability_val.as_json
  else
    JSON.parse(attributes.fetch(:capability))
  end
end

#client_idString (readonly)

Returns the client ID to associate with this token. The generated token may be used to authenticate as this clientId.

Returns:

  • (String)

    the client ID to associate with this token. The generated token may be used to authenticate as this clientId.


77
78
79
# File 'lib/ably/models/token_request.rb', line 77

def client_id
  attributes[:client_id]
end

#key_nameString (readonly)

Returns API key name of the key against which this request is made. An API key is made up of an API key name and secret delimited by a :.

Returns:

  • (String)

    API key name of the key against which this request is made. An API key is made up of an API key name and secret delimited by a :


44
45
46
# File 'lib/ably/models/token_request.rb', line 44

def key_name
  attributes.fetch(:key_name) { raise Ably::Exceptions::InvalidTokenRequest, 'Key name is missing' }
end

#macString (readonly)

Returns the Message Authentication Code for this request. See the Ably Authentication documentation for more details.

Returns:


102
103
104
# File 'lib/ably/models/token_request.rb', line 102

def mac
  attributes.fetch(:mac) { raise Ably::Exceptions::InvalidTokenRequest, 'MAC is missing' }
end

#nonceString (readonly)

Returns an opaque nonce string of at least 16 characters to ensure uniqueness of this request. Any subsequent request using the same nonce will be rejected.

Returns:

  • (String)

    an opaque nonce string of at least 16 characters to ensure uniqueness of this request. Any subsequent request using the same nonce will be rejected.


95
96
97
# File 'lib/ably/models/token_request.rb', line 95

def nonce
  attributes.fetch(:nonce) { raise Ably::Exceptions::InvalidTokenRequest, 'Nonce is missing' }
end

#timestampTime (readonly)

Returns the timestamp of this request. Timestamps, in conjunction with the nonce, are used to prevent token requests from being replayed. Timestamp when sent to Ably is in milliseconds.

Returns:

  • (Time)

    the timestamp of this request. Timestamps, in conjunction with the nonce, are used to prevent token requests from being replayed. Timestamp when sent to Ably is in milliseconds.


86
87
88
89
# File 'lib/ably/models/token_request.rb', line 86

def timestamp
  timestamp_val = attributes.fetch(:timestamp) { raise Ably::Exceptions::InvalidTokenRequest, 'Timestamp is missing' }
  as_time_from_epoch(timestamp_val, granularity: :ms)
end

#ttlInteger (readonly)

Returns requested time to live for the token in seconds. If the token request is successful, the TTL of the returned token will be less than or equal to this value depending on application settings and the attributes of the issuing key. TTL when sent to Ably is in milliseconds.

Returns:

  • (Integer)

    requested time to live for the token in seconds. If the token request is successful, the TTL of the returned token will be less than or equal to this value depending on application settings and the attributes of the issuing key. TTL when sent to Ably is in milliseconds.


53
54
55
# File 'lib/ably/models/token_request.rb', line 53

def ttl
  attributes.fetch(:ttl) / 1000
end

Instance Method Details

#persistedObject

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.

Requests that the token is always persisted


109
110
111
# File 'lib/ably/models/token_request.rb', line 109

def persisted
  attributes[:persisted]
end