Class OAuth2::AccessToken
In: lib/oauth2/access_token.rb
Parent: Object

Methods

[]   delete   expired?   expires?   from_hash   from_kvform   get   headers   new   patch   post   put   refresh!   request   to_hash  

Attributes

client  [R] 
expires_at  [R] 
expires_in  [R] 
options  [RW] 
params  [R] 
refresh_token  [RW] 
token  [R] 

Public Class methods

from_hash(client, hash)

Initializes an AccessToken from a Hash

@param [Client] the OAuth2::Client instance @param [Hash] a hash of AccessToken property values @return [AccessToken] the initalized AccessToken

from_kvform(client, kvform)

Initializes an AccessToken from a key/value application/x-www-form-urlencoded string

@param [Client] client the OAuth2::Client instance @param [String] kvform the application/x-www-form-urlencoded string @return [AccessToken] the initalized AccessToken

new(client, token, opts = {})

Initalize an AccessToken

@param [Client] client the OAuth2::Client instance @param [String] token the Access Token value @param [Hash] opts the options to create the Access Token with @option opts [String] :refresh_token (nil) the refresh_token value @option opts [FixNum, String] :expires_in (nil) the number of seconds in which the AccessToken will expire @option opts [FixNum, String] :expires_at (nil) the epoch time in seconds in which AccessToken will expire @option opts [Symbol] :mode (:header) the transmission mode of the Access Token parameter value 

   one of :header, :body or :query

@option opts [String] :header_format (‘Bearer %s’) the string format to use for the Authorization header @option opts [String] :param_name (‘access_token’) the parameter name to use for transmission of the 

   Access Token value in :body or :query transmission mode

Public Instance methods

[](key)

Indexer to additional params present in token response

@param [String] key entry key to Hash

delete(path, opts = {}, &block)

Make a DELETE request with the Access Token

@see AccessToken#request

expired?()

Whether or not the token is expired

@return [Boolean]

expires?()

Whether or not the token expires

@return [Boolean]

get(path, opts = {}, &block)

Make a GET request with the Access Token

@see AccessToken#request

headers()

Get the headers hash (includes Authorization token)

patch(path, opts = {}, &block)

Make a PATCH request with the Access Token

@see AccessToken#request

post(path, opts = {}, &block)

Make a POST request with the Access Token

@see AccessToken#request

put(path, opts = {}, &block)

Make a PUT request with the Access Token

@see AccessToken#request

refresh!(params = {})

Refreshes the current Access Token

@return [AccessToken] a new AccessToken @note options should be carried over to the new AccessToken

request(verb, path, opts = {}, &block)

Make a request with the Access Token

@param [Symbol] verb the HTTP request method @param [String] path the HTTP URL path of the request @param [Hash] opts the options to make the request with @see Client#request

to_hash()

Convert AccessToken to a hash which can be used to rebuild itself with AccessToken.from_hash

@return [Hash] a hash of AccessToken property values

[Validate]