Class: Github::Client::Repos::Commits

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

Constant Summary collapse

VALID_COMMITS_OPTIONS =
%w[
  sha
  path
  author
  since
  until
].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

#compare(*args) ⇒ Object

Note:

Both :base and :head can be either branch names in :repo or

Compares two commits

branch names in other repositories in the same network as :repo. For the latter case, use the format user:branch:

Examples:

github = Github.new
github.repos.commits.compare 'user-name', 'repo-name', 'v0.4.8', 'master'

72
73
74
75
76
# File 'lib/github_api/client/repos/commits.rb', line 72

def compare(*args)
  arguments(args, required: [:user, :repo, :base, :head])

  get_request("/repos/#{arguments.user}/#{arguments.repo}/compare/#{arguments.base}...#{arguments.head}", arguments.params)
end

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

Gets a single commit

Examples:

github = Github.new
github.repos.commits.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6'

54
55
56
57
58
# File 'lib/github_api/client/repos/commits.rb', line 54

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

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

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

List commits on a repository

Examples:

github = Github.new
github.repos.commits.list 'user-name', 'repo-name', sha: '...'
github.repos.commits.list 'user-name', 'repo-name', sha: '...' { |commit| ... }

Parameters:


36
37
38
39
40
41
42
43
44
# File 'lib/github_api/client/repos/commits.rb', line 36

def list(*args)
  arguments(args, required: [:user, :repo]) do
    permit VALID_COMMITS_OPTIONS
  end

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