Parent

Class/Module Index [+]

Quicksearch

Github::Client::Authorizations

OAuth Authorizations API

Public Instance Methods

all(*args) click to toggle source
Alias for: list
create(*args) click to toggle source

Create a new authorization

@param [Hash] params @option params [Array] :scopes

A list of scopes that this authorization is in.

@option params [String] :note

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

@option params [String] :note_url

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

@option params [String] :client_id

The 20 character OAuth app client key for which to create the token.

@option params [String] :client_secret

The 40 character OAuth app client secret for which to create the token.

@example

github = Github.new basic_auth: 'login:password'
github.oauth.create
  "scopes" => ["public_repo"]

@api public

# File lib/github_api/client/authorizations.rb, line 80
def create(*args)
  raise_authentication_error unless authenticated?
  arguments(args) do
    permit VALID_AUTH_PARAM_NAMES
  end

  post_request('/authorizations', arguments.params)
end
delete(*args) click to toggle source

Delete an authorization

@see developer.github.com/v3/oauth_authorizations/#delete-an-authorization

@example

github.oauth.delete 'authorization-id'

@api public

# File lib/github_api/client/authorizations.rb, line 126
def delete(*args)
  raise_authentication_error unless authenticated?
  arguments(args, required: [:id])

  delete_request("/authorizations/#{arguments.id}", arguments.params)
end
Also aliased as: remove
edit(*args) click to toggle source
Alias for: update
find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Get a single authorization

@see developer.github.com/v3/oauth_authorizations/#get-a-single-authorization

@example

github = Github.new basic_auth: 'login:password'
github.oauth.get 'authorization-id'

@return [ResponseWrapper]

@api public

# File lib/github_api/client/authorizations.rb, line 52
def get(*args)
  raise_authentication_error unless authenticated?
  arguments(args, required: [:id])

  get_request("/authorizations/#{arguments.id}", arguments.params)
end
Also aliased as: find
list(*args) click to toggle source

List authorizations

@see developer.github.com/v3/oauth_authorizations/#list-your-authorizations

@example

github = Github.new basic_auth: 'login:password'
github.oauth.list
github.oauth.list { |auth| ... }

@api public

# File lib/github_api/client/authorizations.rb, line 31
def list(*args)
  raise_authentication_error unless authenticated?
  arguments(args)

  response = get_request('/authorizations', arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all
remove(*args) click to toggle source
Alias for: delete
update(*args) click to toggle source

Update an existing authorization

@param [Hash] inputs @option inputs [Array] :scopes

Optional array - A list of scopes that this authorization is in.

@option inputs [Array] :add_scopes

Optional array - A list of scopes to add to this authorization.

@option inputs [Array] :remove_scopes

Optional array - A list of scopes to remove from this authorization.

@option inputs [String] :note

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

@optoin inputs [String] :note_url

Optional string - A URL to remind you what the OAuth token is for.

@example

github = Github.new basic_auth: 'login:password'
github.oauth.update "authorization-id", add_scopes: ["repo"]

@api public

# File lib/github_api/client/authorizations.rb, line 108
def update(*args)
  raise_authentication_error unless authenticated?
  arguments(args, required: [:id]) do
    permit VALID_AUTH_PARAM_NAMES
  end

  patch_request("/authorizations/#{arguments.id}", arguments.params)
end
Also aliased as: edit

Protected Instance Methods

raise_authentication_error() click to toggle source
# File lib/github_api/client/authorizations.rb, line 136
def raise_authentication_error
  raise ArgumentError, 'You can only access your own tokens' +
    ' via Basic Authentication'
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.