Class: Github::Users::Keys

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

Constant Summary collapse

VALID_KEY_PARAM_NAMES = 
%w[ title key ].freeze

Constants included from Request

Request::METHODS, Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

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

Constants included from MimeType

MimeType::MEDIA_LOOKUP

Instance Attribute Summary

Attributes inherited from API

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

Methods inherited from API

#api_methods_in, #append_arguments, #arguments, inherited, #initialize, #method_missing, #process_basic_auth, #set, #setup, #with, #yield_or_eval

Methods included from RateLimit

#ratelimit, #ratelimit_remaining

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

Inputs

  • :title - Required string

  • :key - Required string. sha key

Examples

github = Github.new oauth_token: '...'
github.users.keys.create "title": "octocat@octomac", "key": "ssh-rsa AAA..."



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

def create(*args)
  arguments(args) do
    sift 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'



86
87
88
89
 
# File 'lib/github_api/users/keys.rb', line 86

def delete(*args)
  arguments(args, :required => [:key_id])
  delete_request("/user/keys/#{key_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'



39
40
41
42
 
# File 'lib/github_api/users/keys.rb', line 39

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

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

List public keys for the authenticated user

Examples

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

List public keys for the specified user

Examples

github.users.keys.list user: 'user-name'
github.users.keys.list user: 'user-name' { |key| ... }



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/github_api/users/keys.rb', line 21

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

Inputs

  • :title - Required string

  • :key - Required string. sha key

Examples

github = Github.new oauth_token: '...'
github.users.keys.update 'key-id', "title": "octocat@octomac",
  "key": "ssh-rsa AAA..."



73
74
75
76
77
78
 
# File 'lib/github_api/users/keys.rb', line 73

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