Class: Github::Repos::Keys

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

Constant Summary collapse

VALID_KEY_OPTIONS = 
%w[ title key ].freeze

Constants included from Github::Request

Github::Request::METHODS, Github::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 Github::RateLimit

#ratelimit, #ratelimit_remaining

Methods included from Github::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 key

Inputs

  • :title - Required string.

  • :key - Required string.

Examples

github = Github.new
github.repos.keys.create 'user-name', 'repo-name',
  "title" => "octocat@octomac",
  "key" =>  "ssh-rsa AAA..."



52
53
54
55
56
57
58
59
 
# File 'lib/github_api/repos/keys.rb', line 52

def create(*args)
  arguments(args, :required => [:user, :repo]) do
    sift VALID_KEY_OPTIONS
    assert_required VALID_KEY_OPTIONS
  end

  post_request("/repos/#{user}/#{repo}/keys", arguments.params)
end

#delete(*args) ⇒ Object

Delete key

Examples

github = Github.new
github.repos.keys.delete 'user-name', 'repo-name', 'key-id'



88
89
90
91
92
93
 
# File 'lib/github_api/repos/keys.rb', line 88

def delete(*args)
  arguments(args, :required => [:user, :repo, :key_id])
  params = arguments.params

  delete_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
end

#edit(*args) ⇒ Object

Edit a key

Inputs

  • :title - Required string.

  • :key - Required string.

Examples

github = Github.new
github.repos.keys.edit 'user-name', 'repo-name',
  "title" => "octocat@octomac",
  "key" =>  "ssh-rsa AAA..."



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

def edit(*args)
  arguments(args, :required => [:user, :repo, :key_id]) do
    sift VALID_KEY_OPTIONS
  end
  params = arguments.params

  patch_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
end

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

Get a key

Examples

github = Github.new
github.repos.keys.get 'user-name', 'repo-name', 'key-id'



33
34
35
36
37
 
# File 'lib/github_api/repos/keys.rb', line 33

def get(*args)
  arguments(args, :required => [:user, :repo, :key_id])

  get_request("/repos/#{user}/#{repo}/keys/#{key_id}", arguments.params)
end

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

List deploy keys

Examples

github = Github.new
github.repos.keys.list 'user-name', 'repo-name'
github.repos.keys.list 'user-name', 'repo-name' { |key| ... }

keys = Github::Repos::Keys.new user: 'user-name', repo: 'repo-name'
keys.list



18
19
20
21
22
23
24
 
# File 'lib/github_api/repos/keys.rb', line 18

def list(*args)
  arguments(args, :required => [:user, :repo])

  response = get_request("/repos/#{user}/#{repo}/keys", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end