Class: BitBucket::Repos::Commits

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

Constant Summary collapse

VALID_KEY_PARAM_NAMES = 
%w(include exclude).freeze

Constants included from Validations

Validations::VALID_API_KEYS

Constants included from Validations::Token

Validations::Token::TOKEN_REQUIRED, Validations::Token::TOKEN_REQUIRED_REGEXP

Constants included from BitBucket::Request

BitBucket::Request::METHODS, BitBucket::Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

Constants::ACCEPT, 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::PARAM_PAGE, Constants::PARAM_PER_PAGE, Constants::PARAM_START_PAGE, Constants::QUERY_STR_SEP, Constants::RATELIMIT_LIMIT, Constants::RATELIMIT_REMAINING, Constants::SERVER, Constants::USER_AGENT

Instance Method Summary collapse

Methods inherited from API

#_merge_mime_type, #_merge_user_into_params!, #_merge_user_repo_into_params!, #_update_user_repo_params, #api_methods_in, inherited, #initialize, #method_missing, #process_basic_auth, #set_api_client, #setup, #update_and_validate_user_repo_params

Methods included from Normalizer

#normalize!

Methods included from ParameterFilter

#filter!

Methods included from AutoloadHelper

#autoload_all, #lookup_constant, #register_constant

Methods included from Validations::Required

#assert_required_keys, #assert_required_values_present, #parse_values

Methods included from Validations::Token

#validates_token_for

Methods included from Validations::Format

#assert_valid_values

Methods included from Validations::Presence

#_validate_presence_of, #_validate_user_repo_params

Methods included from BitBucket::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 Authorization

#authenticated?, #authentication, #basic_authed?

Constructor Details

This class inherits a constructor from BitBucket::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class BitBucket::API

Instance Method Details

#list(user_name, repo_name, branchortag = nil, params = {}) ⇒ Object Also known as: all

Gets the commit information associated with a repository. By default, this call returns all the commits across all branches, bookmarks, and tags. The newest commit is first.

Parameters

*include - The SHA, branch, bookmark, or tag to include, for example, v10 or master. You can repeat the parameter multiple times. *exclude - The SHA, branch, bookmark, or tag to exclude, for example, v10 or master . You can repeat the parameter multiple times.

Examples

bitbucket = BitBucket.new
bitbucket.repos.commits.list 'user-name', 'repo-name'
bitbucket.repos.commits.list 'user-name', 'repo-name', 'master'
bitbucket.repos.commits.list 'user-name', 'repo-name' { |key| ... }
bitbucket.repos.commits.list 'user-name', 'repo-name', nil,
  "include" => "feature-branch",
  "exclude" =>  "master"



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

def list(user_name, repo_name, branchortag=nil, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params
  filter! VALID_KEY_PARAM_NAMES, params

  path = "/2.0/repositories/#{user}/#{repo.downcase}/commits"
  path << "/#{branchortag}" if branchortag
  response = get_request(path, params)
  return response unless block_given?
  response.each { |el| yield el }
end