Class: Nimbu::Endpoints::Authorizations

Inherits:
Nimbu::Endpoint show all
Defined in:
lib/nimbu-api/endpoints/authorizations.rb

Constant Summary collapse

VALID_AUTH_PARAM_NAMES = 
%w[
  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

Connection::ALLOWED_OPTIONS

Instance Attribute Summary

Attributes inherited from Nimbu::Endpoint

#current_options

Attributes included from Authentication

#scopes

Instance Method Summary collapse

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"]



60
61
62
63
64
65
66
67
 
# File 'lib/nimbu-api/endpoints/authorizations.rb', line 60

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'



97
98
99
100
101
102
 
# File 'lib/nimbu-api/endpoints/authorizations.rb', line 97

def delete(*args)
  require_authentication
  arguments(args, :required => [:authorization_id])

  delete_request("/authorizations/#{authorization_id}", arguments.params)
end

#get(*args) ⇒ Object Also known as: find

Get a single authorization

Examples

nimbu = Nimbu.new :basic_auth => 'login:password'
nimbu.oauth.get 'authorization-id'



40
41
42
43
44
45
 
# File 'lib/nimbu-api/endpoints/authorizations.rb', line 40

def get(*args)
  require_authentication
  arguments(args, :required => [:authorization_id])

  get_request("/authorizations/#{authorization_id}", arguments.params)
end

#list(*args) ⇒ Object Also known as: all

List authorizations

Examples

nimbu = Nimbu.new :basic_auth => 'login:password'
nimbu.oauth.list
nimbu.oauth.list { |auth| ... }



24
25
26
27
28
29
30
31
 
# File 'lib/nimbu-api/endpoints/authorizations.rb', line 24

def list(*args)
  require_authentication
  arguments(args)

  response = get_request("/authorizations", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
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"],



82
83
84
85
86
87
88
89
 
# File 'lib/nimbu-api/endpoints/authorizations.rb', line 82

def update(*args)
  require_authentication
  arguments(args, :required => [:authorization_id]) do
    sift VALID_AUTH_PARAM_NAMES
  end

  patch_request("/authorizations/#{authorization_id}", arguments.params)
end