Class: Assembla::Client::Users::Keys

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

Constant Summary collapse

VALID_KEY_PARAM_NAMES = 
%w[ title key read_only ].freeze
VALID_REQUEST_PARAM_VALUES = 
{
  'read_only' => [ true, false ],
}

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 public key for the authenticated user

Examples:

assembla = Assembla.new oauth_token: '...'
assembla.users.keys.create ssh_key: {title: "buildbot@mac", key: "ssh-rsa AAA..."}

Parameters:

  • params (Hash)
  • [String] (Hash) —

    a customizable set of options



55
56
57
58
59
60
61
 
# File 'lib/assembla_api/client/users/keys.rb', line 55

def create(*args)
  arguments(args) do
    permit VALID_KEY_PARAM_NAMES, recursive: true
    assert_values VALID_REQUEST_PARAM_VALUES
  end
  post_request("/user/ssh_keys", arguments.params)
end

#delete(*args) ⇒ Object

Delete a public key for the authenticated user

Examples:

assembla = Assembla.new oauth_token: '...'
assembla.users.keys.delete 571


92
93
94
95
 
# File 'lib/assembla_api/client/users/keys.rb', line 92

def delete(*args)
  arguments(args, required: [:id])
  delete_request("/user/ssh_keys/#{arguments.id}", arguments.params)
end

#edit(*args) ⇒ Object

Update a public key for the authenticated user

Examples:

assembla = Assembla.new oauth_token: '...'
assembla.users.keys.update 571, "title": "buildbot@mac",
  "key": "ssh-rsa AAA..."

Parameters:

  • params (Hash)
  • [String] (Hash) —

    a customizable set of options



77
78
79
80
81
82
83
 
# File 'lib/assembla_api/client/users/keys.rb', line 77

def edit(*args)
  arguments(args, required: [:id]) do
    permit VALID_KEY_PARAM_NAMES, recursive: true
    assert_values VALID_REQUEST_PARAM_VALUES
  end
  put_request("/user/ssh_keys/#{arguments.id}", arguments.params)
end

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

Get a single pulic key for the authenticated user

Examples:

assembla = Assembla.new oauth_token: '...'
assembla.users.keys.get 571


36
37
38
39
 
# File 'lib/assembla_api/client/users/keys.rb', line 36

def get(*args)
  arguments(args, required: [:id])
  get_request("/user/ssh_keys/#{arguments.id}", arguments.params)
end

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

List public keys for the authenticated user

Examples:

assembla = Assembla.new oauth_token: '...'
assembla.users.keys.list
assembla.users.keys.list { |key| ... }

Returns:



21
22
23
24
25
26
 
# File 'lib/assembla_api/client/users/keys.rb', line 21

def list(*args)
  params = arguments(args).params
  response = get_request("/user/ssh_keys", params)
  return response unless block_given?
  response.each { |el| yield el }
end