Class: BitBucket::Repos::PullRequest

Inherits:
API
  • Object
show all
Defined in:
lib/bitbucket_rest_api/repos/pull_request.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

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

#activity(user_name, repo_name, pull_request_id, params = {}) ⇒ Object 



115
116
117
118
119
120
121
122
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 115

def activity(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/activity", params)
  return response unless block_given?
end

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



105
106
107
108
109
110
111
112
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 105

def all_activity(user_name, repo_name, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/activity", params)
  return response unless block_given?
end

#approve(user_name, repo_name, pull_request_id, params = {}) ⇒ Object 



77
78
79
80
81
82
83
84
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 77

def approve(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:post, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/approve", params)
  return response unless block_given?
end

#comment(user_name, repo_name, pull_request_id, comment_id, params = {}) ⇒ Object 



151
152
153
154
155
156
157
158
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 151

def comment(user_name, repo_name, pull_request_id, comment_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/comments/#{comment_id}", params)
  return response unless block_given?
end

#comments(user_name, repo_name, pull_request_id, params = {}) ⇒ Object 



142
143
144
145
146
147
148
149
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 142

def comments(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/comments", params)
  return response unless block_given?
end

#commits(user_name, repo_name, pull_request_id, params = {}) ⇒ Object 



68
69
70
71
72
73
74
75
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 68

def commits(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/commits", params)
  return response unless block_given?
end

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



50
51
52
53
54
55
56
57
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 50

def create(user_name, repo_name, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:post, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests", params)
  return response unless block_given?
end

#decline(user_name, repo_name, pull_request_id, params = {}) ⇒ Object 



133
134
135
136
137
138
139
140
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 133

def decline(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:post, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/decline", params)
  return response unless block_given?
end

#delete_approval(user_name, repo_name, pull_request_id, params = {}) ⇒ Object 



86
87
88
89
90
91
92
93
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 86

def delete_approval(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:delete, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/approve", params)
  return response unless block_given?
end

#diff(user_name, repo_name, pull_request_id, params = {}) ⇒ Object 



95
96
97
98
99
100
101
102
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 95

def diff(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/diff", params)
  return response unless block_given?
end

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



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

def get(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:get, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}", params)
  return response unless block_given?
end

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

List pull requests

Examples

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



13
14
15
16
17
18
19
20
21
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 13

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

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

#merge(user_name, repo_name, pull_request_id, params = {}) ⇒ Object 



124
125
126
127
128
129
130
131
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 124

def merge(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:post, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/merge", params)
  return response unless block_given?
end

#participants(user_name, repo_name, pull_request_id, params = {}) ⇒ Object

List pull request participants

Examples

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



31
32
33
34
35
36
37
38
39
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 31

def participants(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = get_request("/1.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}/participants", params)
  return response unless block_given?
  response.each { |el| yield el }
end

#update(user_name, repo_name, pull_request_id, params = {}) ⇒ Object 



59
60
61
62
63
64
65
66
 
# File 'lib/bitbucket_rest_api/repos/pull_request.rb', line 59

def update(user_name, repo_name, pull_request_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  response = request(:put, "/2.0/repositories/#{user}/#{repo.downcase}/pullrequests/#{pull_request_id}", params)
  return response unless block_given?
end