class Rallio::AccessToken

Represents an access token object as it comes from Rallio.

@!attribute [rw] access_token

@return [String] actual access token string

@!attribute [rw] user_id

@return [Integer] unique id for user

@!attribute [rw] expires_at

@return [DateTime, nil] expiration DateTime or nil if access token never expires

@!attribute [rw] scopes

@return [String] list of oauth scopes for the access token

Public Class Methods

create(user_id:) click to toggle source

Creates new access token for user_id.

NOTE: These tokens do not expire so it is suggested (recommended) that the token be cached and reused whenever possible.

@param user_id [Integer] @return [Rallio::AccessToken]

# File lib/rallio/access_token.rb, line 25
def self.create(user_id:)
  response = self.post("/users/#{user_id}/access_tokens", headers: app_credentials)
  new response.parsed_response
end

Public Instance Methods

destroy() click to toggle source

Destroys access_token

@return [true, nil] true if successful or nil

# File lib/rallio/access_token.rb, line 33
def destroy
  headers = { 'Authorization' => "Bearer #{access_token}" }
  self.class.delete('/access_token', headers: headers)
  true
end