Class: BitBucket::Client::Repos::Changesets
- Defined in:
- lib/bitbucket_rest_api/client/repos/changesets.rb
Constant Summary collapse
- REQUIRED_COMMENT_PARAMS =
%w[ body changeset_id line path position ].freeze
Constants included from Validations
Constants included from Validations::Token
Validations::Token::TOKEN_REQUIRED, Validations::Token::TOKEN_REQUIRED_REGEXP
Constants included from BitBucket::Constants
BitBucket::Constants::ACCEPT, BitBucket::Constants::ACCEPT_CHARSET, BitBucket::Constants::CACHE_CONTROL, BitBucket::Constants::CONTENT_LENGTH, BitBucket::Constants::CONTENT_TYPE, BitBucket::Constants::DATE, BitBucket::Constants::ETAG, BitBucket::Constants::LOCATION, BitBucket::Constants::META_FIRST, BitBucket::Constants::META_LAST, BitBucket::Constants::META_NEXT, BitBucket::Constants::META_PREV, BitBucket::Constants::META_REL, BitBucket::Constants::PARAM_PAGE, BitBucket::Constants::PARAM_START_PAGE, BitBucket::Constants::QUERY_STR_SEP, BitBucket::Constants::RATELIMIT_LIMIT, BitBucket::Constants::RATELIMIT_REMAINING, BitBucket::Constants::SERVER, BitBucket::Constants::USER_AGENT
Instance Attribute Summary
Attributes inherited from API
Instance Method Summary collapse
-
#get(user_name, repo_name, sha, params = {}) ⇒ Object
(also: #find)
Gets a single changeset.
-
#list(user_name, repo_name, params = {}) ⇒ Object
(also: #all)
List changesets on a repository.
Methods inherited from API
#_merge_user_into_params!, #_merge_user_repo_into_params!, #_update_user_repo_params, #api_methods_in, #append_arguments, #arguments, extract_class_name, inherited, #initialize, #method_missing, namespace, #process_basic_auth, #set, #set_api_client, #setup, #with, #yield_or_eval
Methods included from BitBucket::ClassMethods
#configuration, #configure, #require_all
Methods included from Normalizer
Methods included from ParameterFilter
Methods included from Validations::Required
Methods included from Validations::Token
Methods included from Validations::Format
Methods included from Validations::Presence
Methods included from Request::Verbs
#delete_request, #get_request, #options_request, #patch_request, #post_request, #put_request
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
#get(user_name, repo_name, sha, params = {}) ⇒ Object Also known as: find
Gets a single changeset
Examples
@bitbucket = BitBucket.new
@bitbucket.repos.changesets.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6')
44 45 46 47 48 49 50 51 |
# File 'lib/bitbucket_rest_api/client/repos/changesets.rb', line 44 def get(user_name, repo_name, sha, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of sha normalize! params get_request("/repositories/#{user}/#{repo.downcase}/changesets/#{sha}", params) end |
#list(user_name, repo_name, params = {}) ⇒ Object Also known as: all
List changesets on a repository
Parameters
-
:limit
Optional integer. An integer representing how many changesets to return. You can specify a limit between 0 and 50. -
:start
Optional string. A hash value representing the earliest node to start with.
Examples
bitbucket = BitBucket.new
bitbucket.repos.changesets.list 'user-name', 'repo-name', :start => '...'
bitbucket.repos.changesets.list 'user-name', 'repo-name', :start => '...' { |changeset| ... }
26 27 28 29 30 31 32 33 34 35 |
# File 'lib/bitbucket_rest_api/client/repos/changesets.rb', line 26 def list(user_name, repo_name, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? normalize! params filter! %w[ limit start], params response = get_request("/repositories/#{user}/#{repo.downcase}/changesets", params) return response unless block_given? response.each { |el| yield el } end |