Module: Octokit::Client::Authorizations

Included in:
Octokit::Client
Defined in:
lib/octokit/client/authorizations.rb

Overview

Methods for the Authorizations API

Instance Method Summary collapse

Instance Method Details

#authorization(number, options = {}) ⇒ Sawyer::Resource

Get a single authorization for the authenticated user.

You can only access your own tokens, and only through Basic Authentication.

Examples:

Show authorization for user ctshryock's Travis auth

client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
client.authorization(999999)

Returns:

  • (Sawyer::Resource)

    A single authorization for the authenticated user

See Also:


34
35
36
# File 'lib/octokit/client/authorizations.rb', line 34

def authorization(number, options = {})
  get "authorizations/#{number}", options
end

#authorizations(options = {}) ⇒ Array<Sawyer::Resource>

List the authenticated user's authorizations

API for users to manage their own tokens. You can only access your own tokens, and only through Basic Authentication.

Examples:

List authorizations for user ctshryock

client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
client.authorizations

Returns:

  • (Array<Sawyer::Resource>)

    A list of authorizations for the authenticated user

See Also:


20
21
22
# File 'lib/octokit/client/authorizations.rb', line 20

def authorizations(options = {})
  paginate 'authorizations', options
end

#authorize_url(app_id = client_id, options = {}) ⇒ String

Get the URL to authorize a user for an application via the web flow

Examples:

@client.authorize_url('xxxx')

Parameters:

  • app_id (String) (defaults to: client_id)

    Client Id we received when our application was registered with GitHub.

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

    a customizable set of options

Options Hash (options):

  • :redirect_uri (String)

    The url to redirect to after authorizing.

  • :scope (String)

    The scopes to request from the user.

  • :state (String)

    A random string to protect against CSRF.

Returns:

  • (String)

    The url to redirect the user to authorize.

See Also:


165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# File 'lib/octokit/client/authorizations.rb', line 165

def authorize_url(app_id = client_id, options = {})
  opts = options.dup
  if app_id.to_s.empty?
    raise Octokit::ApplicationCredentialsRequired, "client_id required"
  end
  authorize_url = opts.delete(:endpoint) || Octokit.web_endpoint
  authorize_url << "login/oauth/authorize?client_id=#{app_id}"

  require 'cgi'
  opts.each do |key, value|
    authorize_url << "&#{key}=#{CGI.escape value}"
  end

  authorize_url
end

#create_authorization(options = {}) ⇒ Sawyer::Resource

Create an authorization for the authenticated user.

You can create your own tokens, and only through Basic Authentication.

Examples:

Create a new authorization for user ctshryock's project Zoidberg

client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
client.create_authorization({:scopes => ["public_repo", "gist"], :note => "Why not Zoidberg?", :note_url=> "https://en.wikipedia.org/wiki/Zoidberg"})

Create a new OR return an existing authorization to be used by a specific client for user ctshryock's project Zoidberg

client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
client.create_authorization({:idempotent => true, :client_id => 'xxxx', :client_secret => 'yyyy', :scopes => ["user"]})

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • :scopes (Array)

    A list of scopes that this authorization is in.

  • :note (String)

    A note to remind you what the OAuth token is for.

  • :note_url (String)

    A URL to remind you what app the OAuth token is for.

  • :idempotent (Boolean)

    If true, will return an existing authorization if one has already been created.

  • :client_id (String)

    Client Id we received when our application was registered with GitHub.

  • :client_secret (String)

    Client Secret we received when our application was registered with GitHub.

Returns:

  • (Sawyer::Resource)

    A single authorization for the authenticated user

See Also:


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/octokit/client/authorizations.rb', line 61

def create_authorization(options = {})
  # Technically we can omit scopes as GitHub has a default, however the
  # API will reject us if we send a POST request with an empty body.
  options = options.dup
  if options.delete :idempotent
    client_id, client_secret = fetch_client_id_and_secret(options)
    raise ArgumentError.new("Client ID and Secret required for idempotent authorizations") unless client_id && client_secret

    # Remove the client_id from the body otherwise
    # this will result in a 422.
    options.delete(:client_id)

    if (fingerprint = options.delete(:fingerprint))
      put "authorizations/clients/#{client_id}/#{fingerprint}", options.merge(:client_secret => client_secret)
    else
      put "authorizations/clients/#{client_id}", options.merge(:client_secret => client_secret)
    end

  else
    post 'authorizations', options
  end
end

#delete_authorization(number, options = {}) ⇒ Boolean

Delete an authorization for the authenticated user.

You can delete your own tokens, and only through Basic Authentication.

Examples:

Delete an authorization

client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
client.delete_authorization(999999)

Parameters:

  • number (Number)

    An existing Authorization ID

Returns:

  • (Boolean)

    Success

See Also:


118
119
120
# File 'lib/octokit/client/authorizations.rb', line 118

def delete_authorization(number, options = {})
  boolean_from_response :delete, "authorizations/#{number}", options
end

#revoke_all_application_authorizations(options = {}) ⇒ Boolean

Deprecated.

Revoke all tokens for an app

Applications can revoke all of their tokens in a single request

Returns:

  • (Boolean)

    false


149
150
151
152
# File 'lib/octokit/client/authorizations.rb', line 149

def revoke_all_application_authorizations(options = {})
  octokit_warn("Deprecated: If you need to revoke all tokens for your application, you can do so via the settings page for your application.")
  false
end

#scopes(token = @access_token, options = {}) ⇒ Array<String>

Check scopes for a token

Parameters:

  • token (String) (defaults to: @access_token)

    GitHub OAuth token

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

    Header params for request

Returns:

  • (Array<String>)

    OAuth scopes

Raises:

  • (ArgumentError)

See Also:


128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/octokit/client/authorizations.rb', line 128

def scopes(token = @access_token, options = {})
  options= options.dup
  raise ArgumentError.new("Access token required") if token.nil?

  auth = { "Authorization" => "token #{token}" }
  headers = (options.delete(:headers) || {}).merge(auth)

  agent.call(:get, "user", :headers => headers).
    headers['X-OAuth-Scopes'].
    to_s.
    split(',').
    map(&:strip).
    sort
end

#update_authorization(number, options = {}) ⇒ Sawyer::Resource

Update an authorization for the authenticated user.

You can update your own tokens, but only through Basic Authentication.

Examples:

Update the authorization for user ctshryock's project Zoidberg

client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
client.update_authorization(999999, {:add_scopes => ["gist", "repo"], :note => "Why not Zoidberg possibly?"})

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • :scopes (Array)

    Replace the authorization scopes with these.

  • :add_scopes (Array)

    A list of scopes to add to this authorization.

  • :remove_scopes (Array)

    A list of scopes to remove from this authorization.

  • :note (String)

    A note to remind you what the OAuth token is for.

  • :note_url (String)

    A URL to remind you what app the OAuth token is for.

Returns:

  • (Sawyer::Resource)

    A single (updated) authorization for the authenticated user

See Also:


102
103
104
# File 'lib/octokit/client/authorizations.rb', line 102

def update_authorization(number, options = {})
  patch "authorizations/#{number}", options
end