Module: Twitter::REST::OAuth

Includes:
Utils
Included in:
API
Defined in:
lib/twitter/rest/oauth.rb

Constant Summary

Constants included from Utils

Utils::DEFAULT_CURSOR

Instance Method Summary collapse

Methods included from Utils

flat_pmap, pmap

Instance Method Details

#invalidate_token(access_token, options = {}) ⇒ String

Allows a registered application to revoke an issued OAuth 2 Bearer Token by presenting its client credentials.

Parameters:

  • access_token (String) —

    The bearer token to revoke.

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

    A customizable set of options.

Returns:

  • (String) —

    The invalidated token. token_type should be nil.

Raises:

See Also:

Rate Limited?:

  • No

Authentication:

  • Required



44
45
46
47
48
 
# File 'lib/twitter/rest/oauth.rb', line 44

def invalidate_token(access_token, options = {})
  options = options.dup
  options[:access_token] = access_token
  perform_post("/oauth2/invalidate_token", options)[:access_token]
end

#reverse_token ⇒ String

Allows a registered application to revoke an issued OAuth 2 Bearer Token by presenting its client credentials.

Returns:

  • (String) —

    The token string.

Raises:

See Also:

Rate Limited?:

  • No

Authentication:

  • Required



57
58
59
60
61
62
 
# File 'lib/twitter/rest/oauth.rb', line 57

def reverse_token
  options = {x_auth_mode: "reverse_auth"}
  url = "https://api.twitter.com/oauth/request_token"
  auth_header = Twitter::Headers.new(self, :post, url, options).oauth_auth_header.to_s
  HTTP.headers(authorization: auth_header).post(url, params: options).to_s
end

#token(options = {}) ⇒ String Also known as: bearer_token

Allows a registered application to obtain an OAuth 2 Bearer Token, which can be used to make API requests on an application's own behalf, without a user context.

Only one bearer token may exist outstanding for an application, and repeated requests to this method will yield the same already-existent token until it has been invalidated.

Examples:

Generate a Bearer Token

client = Twitter::REST::Client.new(consumer_key: 'abc', consumer_secret: 'def')
bearer_token = client.token

Parameters:

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

    A customizable set of options.

Returns:

  • (String) —

    The Bearer token.

Raises:

See Also:

Rate Limited?:

  • No

Authentication:

  • Required



24
25
26
27
28
29
30
31
32
 
# File 'lib/twitter/rest/oauth.rb', line 24

def token(options = {})
  options = options.dup
  options[:bearer_token_request] = true
  options[:grant_type] ||= "client_credentials"
  url = "https://api.twitter.com/oauth2/token"
  headers = Twitter::Headers.new(self, :post, url, options).request_headers
  response = HTTP.headers(headers).post(url, form: options)
  response.parse["access_token"]
end