Class: BitBucket::Repos::Changesets

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

Constant Summary collapse

REQUIRED_COMMENT_PARAMS = 
%w[
  body
  changeset_id
  line
  path
  position
].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

#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')



43
44
45
46
47
48
49
50
 
# File 'lib/bitbucket_rest_api/repos/changesets.rb', line 43

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("/1.0/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| ... }



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

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("/1.0/repositories/#{user}/#{repo.downcase}/changesets", params)
  return response unless block_given?
  response.each { |el| yield el }
end