Class: Github::Client::Repos::Keys

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

Constant Summary

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 Also known as: add

Create a key

Examples:

github = Github.new
github.repos.keys.create 'user-name', 'repo-name',
  title: "[email protected]",
  key:  "ssh-rsa AAA..."

Parameters:

  • :user (String)
  • :repo (String)
  • params (Hash)

See Also:


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

def create(*args)
  arguments(args, required: [:user, :repo])

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

#delete(*args) ⇒ Object Also known as: remove

Delete key

Examples:

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

Parameters:

  • :user (String)
  • :repo (String)
  • :id (Integer)

See Also:


95
96
97
98
99
# File 'lib/github_api/client/repos/keys.rb', line 95

def delete(*args)
  arguments(args, required: [:user, :repo, :id])

  delete_request("/repos/#{arguments.user}/#{arguments.repo}/keys/#{arguments.id}", arguments.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'

Parameters:

  • :user (String)
  • :repo (String)
  • :id (Integer)

See Also:


45
46
47
48
49
# File 'lib/github_api/client/repos/keys.rb', line 45

def get(*args)
  arguments(args, required: [:user, :repo, :id])

  get_request("/repos/#{arguments.user}/#{arguments.repo}/keys/#{arguments.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

Parameters:

  • :user (String)
  • String (String :repo)

    :repo

See Also:


22
23
24
25
26
27
28
29
# File 'lib/github_api/client/repos/keys.rb', line 22

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

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