Class: Assembla::Client::Authorizations

Inherits:
API
  • Object
show all
Defined in:
lib/assembla_api/client/authorizations.rb

Overview

OAuth Authorizations API

Direct Known Subclasses

App

Defined Under Namespace

Classes: App

Constant Summary collapse

VALID_AUTH_PARAM_NAMES = 
%w[
  scopes
  add_scopes
  remove_scopes
  note
  note_url
  client_id
  client_secret
].freeze

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Constants included from Assembla::Constants

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

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

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_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, #process_basic_auth, request_methods, root!, #run_callbacks, #set, #setup, #with, #yield_or_eval

Methods included from Assembla::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 Assembla::API

Dynamic Method Handling

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

Instance Method Details

#create(*args) ⇒ Object

Create a new authorization

Examples:

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

Parameters:



81
82
83
84
85
86
87
88
 
# File 'lib/assembla_api/client/authorizations.rb', line 81

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) ⇒ Object Also known as: remove

Delete an authorization

Examples:

assembla.oauth.delete 'authorization-id'

See Also:



127
128
129
130
131
132
 
# File 'lib/assembla_api/client/authorizations.rb', line 127

def delete(*args)
  raise_authentication_error unless authenticated?
  arguments(args, required: [:id])

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

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

Get a single authorization

Examples:

assembla = Assembla.new basic_auth: 'login:password'
assembla.oauth.get 'authorization-id'

Returns:

See Also:



53
54
55
56
57
58
 
# File 'lib/assembla_api/client/authorizations.rb', line 53

def get(*args)
  raise_authentication_error unless authenticated?
  arguments(args, required: [:id])

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

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

List authorizations

Examples:

assembla = Assembla.new basic_auth: 'login:password'
assembla.oauth.list
assembla.oauth.list { |auth| ... }

See Also:



32
33
34
35
36
37
38
39
 
# File 'lib/assembla_api/client/authorizations.rb', line 32

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

#update(*args) ⇒ Object Also known as: edit

Update an existing authorization

Examples:

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

Parameters:



109
110
111
112
113
114
115
116
 
# File 'lib/assembla_api/client/authorizations.rb', line 109

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