Class: Github::Client::Users::Keys

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

Constant Summary collapse

VALID_KEY_PARAM_NAMES =
%w[ title key ].freeze

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

#create(*args) ⇒ Object

Create a public key for the authenticated user

Examples:

github = Github.new oauth_token: '...'
github.users.keys.create "title": "[email protected]", "key": "ssh-rsa AAA..."

Parameters:

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

    a customizable set of options


62
63
64
65
66
67
# File 'lib/github_api/client/users/keys.rb', line 62

def create(*args)
  arguments(args) do
    permit VALID_KEY_PARAM_NAMES
  end
  post_request("/user/keys", arguments.params)
end

#delete(*args) ⇒ Object

Delete a public key for the authenticated user

Examples:

github = Github.new oauth_token: '...'
github.users.keys.delete 'key-id'

97
98
99
100
# File 'lib/github_api/client/users/keys.rb', line 97

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

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

Get a single pulic key for the authenticated user

Examples:

github = Github.new oauth_token: '...'
github.users.keys.get 'key-id'

43
44
45
46
# File 'lib/github_api/client/users/keys.rb', line 43

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

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

List public keys for the authenticated user

List public keys for the specified user

Examples:

github = Github.new oauth_token: '...'
github.users.keys.list
github.users.keys.list { |key| ... }
github.users.keys.list user: 'user-name'
github.users.keys.list user: 'user-name' { |key| ... }

Returns:


24
25
26
27
28
29
30
31
32
33
# File 'lib/github_api/client/users/keys.rb', line 24

def list(*args)
  params = arguments(args).params
  response = if (user = params.delete('user'))
    get_request("/users/#{user}/keys", params)
  else
    get_request("/user/keys", params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end

#update(*args) ⇒ Object

Update a public key for the authenticated user

Examples:

github = Github.new oauth_token: '...'
github.users.keys.update 'key-id', "title": "[email protected]",
  "key": "ssh-rsa AAA..."

Parameters:

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

    a customizable set of options


83
84
85
86
87
88
# File 'lib/github_api/client/users/keys.rb', line 83

def update(*args)
  arguments(args, required: [:id]) do
    permit VALID_KEY_PARAM_NAMES
  end
  patch_request("/user/keys/#{arguments.id}", arguments.params)
end