Class: Github::Repos::Commits

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

Constant Summary collapse

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

#compare(*args) ⇒ Object

Compares two commits

Examples

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



63
64
65
66
67
68
 
# File 'lib/github_api/repos/commits.rb', line 63

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

  get_request("/repos/#{user}/#{repo}/compare/#{base}...#{head}", 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')



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

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

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

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

List commits on a repository

Parameters

  • :sha Optional string. Sha or branch to start listing commits from.

  • :path Optional string. Only commits containing this file path will be returned.

  • :author GitHub login, name, or email by which to filter by commit author.

  • :since Optional string. Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • :until Optional string. Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

Examples

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



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/github_api/repos/commits.rb', line 27

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

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