Class: BitBucket::Repos::DefaultReviewers

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

Constant Summary

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

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

#add(user_name, repo_name, reviewer_username, params = {}) ⇒ Object

Add a user to the default-reviewers list for the repo

Examples

bitbucket = BitBucket.new
bitbucket.repos.default_reviewers.add 'user-name', 'repo-name', 'reviewer-username'



41
42
43
44
45
46
 
# File 'lib/bitbucket_rest_api/repos/default_reviewers.rb', line 41

def add(user_name, repo_name, reviewer_username, params = {})
  update_and_validate_user_repo_params(user_name, repo_name)
  normalize! params

  put_request("/2.0/repositories/#{user_name}/#{repo_name}/default-reviewers/#{reviewer_username}", params)
end

#get(user_name, repo_name, reviewer_username, params = {}) ⇒ Object

Get a default reviewer’s info

Examples

bitbucket = BitBucket.new
bitbucket.repos.default_reviewers.get 'user-name', 'repo-name', 'reviewer-username'



28
29
30
31
32
33
 
# File 'lib/bitbucket_rest_api/repos/default_reviewers.rb', line 28

def get(user_name, repo_name, reviewer_username, params = {})
  update_and_validate_user_repo_params(user_name, repo_name)
  normalize! params

  get_request("/2.0/repositories/#{user_name}/#{repo_name}/default-reviewers/#{reviewer_username}", params)
end

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

List default reviewers

Examples

bitbucket = BitBucket.new
bitbucket.repos.default_reviewers.list 'user-name', 'repo-name'
bitbucket.repos.default_reviewers.list 'user-name', 'repo-name' { |reviewer| ... }



11
12
13
14
15
16
17
18
19
 
# File 'lib/bitbucket_rest_api/repos/default_reviewers.rb', line 11

def list(user_name, repo_name, params = {})
  update_and_validate_user_repo_params(user_name, repo_name)
  normalize! params

  response = get_request("/2.0/repositories/#{user_name}/#{repo_name}/default-reviewers", params)
  return response unless block_given?

  response.each { |el| yield el }
end

#remove(user_name, repo_name, reviewer_username, params = {}) ⇒ Object

Remove a user from the default-reviewers list for the repo

Examples

bitbucket = BitBucket.new
bitbucket.repos.default_reviewers.remove 'user-name', 'repo-name', 'reviewer-username'



54
55
56
57
58
 
# File 'lib/bitbucket_rest_api/repos/default_reviewers.rb', line 54

def remove(user_name, repo_name, reviewer_username, params = {})
  update_and_validate_user_repo_params(user_name, repo_name)
  normalize! params
  delete_request("/2.0/repositories/#{user_name}/#{repo_name}/default-reviewers/#{reviewer_username}", params)
end