Class: Gista::TokenRequest

Inherits:

ApiRequest

• Object
• ApiRequest
• Gista::TokenRequest

Defined in:

lib/gista/token_request.rb

Overview

Request to the Github API to authorize with a username and password and acquire an OAuth token, which can be stored and re-used for password-less authorization.

Examples:

Request a token

credentials = OpenStruct.new(username: 'foo', password: 'bar')
TokenRequest.new(credentials).fetch('token')

See Also:

• http://developer.github.com/v3/oauth/#scopes

Constant Summary

Constants inherited from ApiRequest

ApiRequest::CONTENT_TYPE, ApiRequest::OPEN_TIMEOUT, ApiRequest::PORT, ApiRequest::READ_TIMEOUT, ApiRequest::URL

Instance Attribute Summary

• #credentials ⇒ #username, #password readonly

  An object that contains a username and password.

Instance Method Summary

• #initialize(credentials) ⇒ TokenRequest constructor

  A new instance of TokenRequest.

Methods inherited from ApiRequest

#fetch

Constructor Details

#initialize(credentials) ⇒ TokenRequest

Returns a new instance of TokenRequest.

# File 'lib/gista/token_request.rb', line 18

def initialize(credentials)
  @credentials = credentials
end

Instance Attribute Details

#credentials ⇒ #username, #password (readonly)

An object that contains a username and password

Returns:

• (#username, #password)

See Also:

• LoginPrompt

# File 'lib/gista/token_request.rb', line 16

def credentials
  @credentials
end