Class: Github::Client::Authorizations::App

Inherits:
Github::Client::Authorizations show all
Defined in:
lib/github_api/client/authorizations/app.rb

Constant Summary

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Constants included from Github::Constants

Github::Constants::ACCEPT, Github::Constants::ACCEPTED_OAUTH_SCOPES, Github::Constants::ACCEPT_CHARSET, Github::Constants::CACHE_CONTROL, Github::Constants::CONTENT_LENGTH, Github::Constants::CONTENT_TYPE, Github::Constants::DATE, Github::Constants::ETAG, Github::Constants::HEADER_LAST, Github::Constants::HEADER_LINK, Github::Constants::HEADER_NEXT, Github::Constants::LOCATION, Github::Constants::META_FIRST, Github::Constants::META_LAST, Github::Constants::META_NEXT, Github::Constants::META_PREV, Github::Constants::META_REL, Github::Constants::OAUTH_SCOPES, Github::Constants::PARAM_PAGE, Github::Constants::PARAM_PER_PAGE, Github::Constants::PARAM_START_PAGE, Github::Constants::RATELIMIT_LIMIT, Github::Constants::RATELIMIT_REMAINING, Github::Constants::RATELIMIT_RESET, Github::Constants::SERVER, Github::Constants::USER_AGENT

Instance Attribute Summary

Attributes inherited from API

#current_options

Instance Method Summary collapse

Methods inherited from Github::Client::Authorizations

#get, #list, #update

Methods inherited from API

after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #execute, extend_with_actions, extra_methods, #extract_basic_auth, extract_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, request_methods, root!, #run_callbacks, #set, #yield_or_eval

Methods included from Github::ClassMethods

#configuration, #configure, #require_all

Methods included from RateLimit

#ratelimit, #ratelimit_remaining, #ratelimit_reset

Methods included from Request::Verbs

#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request

Methods included from MimeType

#lookup_media, #parse

Methods included from Authorization

#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token

Constructor Details

This class inherits a constructor from Github::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Github::API

Instance Method Details

#check(*args) ⇒ Object

Check if an access token is a valid authorization for an application

Examples:

github = Github.new basic_auth: "client_id:client_secret"
github.oauth.app.check 'client_id', 'access-token'

43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/github_api/client/authorizations/app.rb', line 43

def check(*args)
  raise_authentication_error unless authenticated?
  params = arguments(args, required: [:client_id, :access_token]).params

  if arguments.client_id
    begin
      get_request("/applications/#{arguments.client_id}/tokens/#{arguments.access_token}", params)
    rescue Github::Error::NotFound => e
      nil
    end
  else
    raise raise_app_authentication_error
  end
end

#create(*args) ⇒ Object

Get-or-create an authorization for a specific app

Examples:

github = Github.new
github.oauth.app.create 'client-id', client_secret: '...'

See Also:


25
26
27
28
29
30
31
32
33
34
# File 'lib/github_api/client/authorizations/app.rb', line 25

def create(*args)
  raise_authentication_error unless authenticated?
  arguments(args, required: [:client_id])

  if arguments.client_id
    put_request("/authorizations/clients/#{arguments.client_id}", arguments.params)
  else
    raise raise_app_authentication_error
  end
end

#delete(*args) ⇒ Object Also known as: remove, revoke

Revoke all authorizations for an application

Revoke an authorization for an application

Examples:

github = Github.new basic_auth: "client_id:client_secret"
github.oauth.app.delete 'client-id'
github = Github.new basic_auth: "client_id:client_secret"
github.oauth.app.delete 'client-id', 'access-token'

71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/github_api/client/authorizations/app.rb', line 71

def delete(*args)
  raise_authentication_error unless authenticated?
  params = arguments(args, required: [:client_id]).params

  if arguments.client_id
    if access_token = (params.delete('access_token') || args[1])
      delete_request("/applications/#{arguments.client_id}/tokens/#{access_token}", params)
    else
      # Revokes all tokens
      delete_request("/applications/#{arguments.client_id}/tokens", params)
    end
  else
    raise raise_app_authentication_error
  end
end