Class: Nimbu::Endpoints::Authorizations
- Inherits:
-
Nimbu::Endpoint
- Object
- Nimbu::Endpoint
- Nimbu::Endpoints::Authorizations
- Defined in:
- lib/nimbu-api/endpoints/authorizations.rb
Constant Summary collapse
- VALID_AUTH_PARAM_NAMES =
["scopes", "add_scopes", "remove_scopes", "note", "note_url", "client_id", "client_secret",].freeze
Constants included from Request
Request::METHODS, Request::METHODS_WITH_BODIES
Constants included from Utils::Constants
Utils::Constants::ACCEPT, Utils::Constants::ACCEPTED_OAUTH_SCOPES, Utils::Constants::ACCEPT_CHARSET, Utils::Constants::CACHE_CONTROL, Utils::Constants::CONTENT_LENGTH, Utils::Constants::CONTENT_TYPE, Utils::Constants::DATE, Utils::Constants::ETAG, Utils::Constants::HEADER_LAST, Utils::Constants::HEADER_LINK, Utils::Constants::HEADER_NEXT, Utils::Constants::LOCATION, Utils::Constants::META_FIRST, Utils::Constants::META_LAST, Utils::Constants::META_NEXT, Utils::Constants::META_PREV, Utils::Constants::META_REL, Utils::Constants::NIMBU_SITE, Utils::Constants::OAUTH_SCOPES, Utils::Constants::PARAM_PAGE, Utils::Constants::PARAM_PER_PAGE, Utils::Constants::PARAM_START_PAGE, Utils::Constants::RATELIMIT_LIMIT, Utils::Constants::RATELIMIT_REMAINING, Utils::Constants::SERVER, Utils::Constants::USER_AGENT
Constants included from Connection
Instance Attribute Summary
Attributes inherited from Nimbu::Endpoint
Attributes included from Authentication
Instance Method Summary collapse
-
#create(*args) ⇒ Object
Create a new authorization.
-
#delete(*args) ⇒ Object
(also: #remove)
Delete an authorization.
-
#get(*args) ⇒ Object
(also: #find)
Get a single authorization.
-
#list(*args, &block) ⇒ Object
(also: #all)
List authorizations.
-
#update(*args) ⇒ Object
(also: #edit)
Update an existing authorization.
Methods inherited from Nimbu::Endpoint
#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval
Methods included from Request
#delete_request, #get_request, #patch_request, #post_request, #put_request, #request
Methods included from Connection
#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack
Methods included from Authentication
#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token
Constructor Details
This class inherits a constructor from Nimbu::Endpoint
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Nimbu::Endpoint
Instance Method Details
#create(*args) ⇒ Object
Create a new authorization
Inputs
-
:scopes
- Optional array - A list of scopes that this authorization is in. -
:note
- Optional string - A note to remind you what the OAuth token is for. -
:note_url
- Optional string - A URL to remind you what the OAuth token is for.
Examples
nimbu = Nimbu.new :basic_auth => 'login:password'
nimbu.oauth.create
"scopes" => ["public_repo"]
53 54 55 56 57 58 59 60 |
# File 'lib/nimbu-api/endpoints/authorizations.rb', line 53 def create(*args) require_authentication arguments(args) do sift(VALID_AUTH_PARAM_NAMES) end post_request("/authorizations", arguments.params) end |
#delete(*args) ⇒ Object Also known as: remove
Delete an authorization
Examples
nimbu.oauth.delete 'authorization-id'
90 91 92 93 94 95 |
# File 'lib/nimbu-api/endpoints/authorizations.rb', line 90 def delete(*args) require_authentication arguments(args, required: [:authorization_id]) delete_request("/authorizations/#{}", arguments.params) end |
#get(*args) ⇒ Object Also known as: find
33 34 35 36 37 38 |
# File 'lib/nimbu-api/endpoints/authorizations.rb', line 33 def get(*args) require_authentication arguments(args, required: [:authorization_id]) get_request("/authorizations/#{}", arguments.params) end |
#list(*args, &block) ⇒ Object Also known as: all
List authorizations
Examples
nimbu = Nimbu.new :basic_auth => 'login:password'
nimbu.oauth.list
nimbu.oauth.list { |auth| ... }
17 18 19 20 21 22 23 24 |
# File 'lib/nimbu-api/endpoints/authorizations.rb', line 17 def list(*args, &block) require_authentication arguments(args) response = get_request("/authorizations", arguments.params) return response unless block_given? response.each(&block) end |
#update(*args) ⇒ Object Also known as: edit
Update an existing authorization
Inputs
-
:scopes
- Optional array - A list of scopes that this authorization is in. -
:add_scopes
- Optional array - A list of scopes to add to this authorization. -
:remove_scopes
- Optional array - A list of scopes to remove from this authorization. -
:note
- Optional string - A note to remind you what the OAuth token is for. -
:note_url
- Optional string - A URL to remind you what the OAuth token is for.
Examples
nimbu = Nimbu.new :basic_auth => 'login:password'
nimbu.oauth.update "authorization-id", "add_scopes" => ["repo"],
75 76 77 78 79 80 81 82 |
# File 'lib/nimbu-api/endpoints/authorizations.rb', line 75 def update(*args) require_authentication arguments(args, required: [:authorization_id]) do sift(VALID_AUTH_PARAM_NAMES) end patch_request("/authorizations/#{}", arguments.params) end |