forked from piotrmurach/github
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpull_requests.rb
More file actions
193 lines (171 loc) · 5.63 KB
/
Copy pathpull_requests.rb
File metadata and controls
193 lines (171 loc) · 5.63 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# encoding: utf-8
module Github
class PullRequests < API
extend AutoloadHelper
autoload_all 'github_api/pull_requests',
:Comments => 'comments'
VALID_REQUEST_PARAM_NAMES = %w[
title
body
base
head
state
issue
commit_message
mime_type
resource
].freeze
VALID_REQUEST_PARAM_VALUES = {
'state' => %w[ open closed ]
}
# Access to PullRequests::Comments API
def comments(options={}, &block)
@comments ||= ApiFactory.new('PullRequests::Comments', current_options.merge(options), &block)
end
# List pull requests
#
# = Examples
# github = Github.new :user => 'user-name', :repo => 'repo-name'
# github.pull_requests.list
# github.pull_requests.list { |req| ... }
#
# pulls = Github::PullRequests.new
# pulls.pull_requests.list 'user-name', 'repo-name'
#
def list(*args)
arguments(args, :required => [:user, :repo]) do
sift VALID_REQUEST_PARAM_NAMES
assert_values VALID_REQUEST_PARAM_VALUES
end
response = get_request("/repos/#{user}/#{repo}/pulls", arguments.params)
return response unless block_given?
response.each { |el| yield el }
end
alias :all :list
# Get a single pull request
#
# = Examples
# github = Github.new
# github.pull_requests.get 'user-name', 'repo-name', 'number'
#
# pulls = Github::PullRequests.new
# pulls.get 'user-name', 'repo-name', 'number'
#
def get(*args)
arguments(args, :required => [:user, :repo, :number])
get_request("/repos/#{user}/#{repo}/pulls/#{number}", arguments.params)
end
alias :find :get
# Create a pull request
#
# = Inputs
# * <tt>:title</tt> - Required string
# * <tt>:body</tt> - Optional string
# * <tt>:base</tt> - Required string - The branch you want your changes pulled into.
# * <tt>:head</tt> - Required string - The branch where your changes are implemented.
# note: head and base can be either a sha or a branch name.
# Typically you would namespace head with a user like this: username:branch.
# = Alternative Input
# You can also create a Pull Request from an existing Issue by passing
# an Issue number instead of <tt>title</tt> and <tt>body</tt>.
# * <tt>issue</tt> - Required number - Issue number in this repository to turn into a Pull Request.
#
# = Examples
# github = Github.new :oauth_token => '...'
# github.pull_requests.create 'user-name', 'repo-name',
# "title" => "Amazing new feature",
# "body" => "Please pull this in!",
# "head" => "octocat:new-feature",
# "base" => "master"
#
# alternatively
#
# github.pull_requests.create 'user-name', 'repo-name',
# "issue" => "5",
# "head" => "octocat:new-feature",
# "base" => "master"
#
def create(*args)
arguments(args, :required => [:user, :repo]) do
sift VALID_REQUEST_PARAM_NAMES
end
post_request("/repos/#{user}/#{repo}/pulls", arguments.params)
end
# Update a pull request
#
# = Inputs
# * <tt>:title</tt> - Optional string
# * <tt>:body</tt> - Optional string
# * <tt>:state</tt> - Optional string - State of this Pull Request. Valid values are <tt>open</tt> and <tt>closed</tt>.
#
# = Examples
# github = Github.new :oauth_token => '...'
# github.pull_requests.update 'user-name', 'repo-name', 'number'
# "title" => "Amazing new title",
# "body" => "Update body",
# "state" => "open",
#
def update(*args)
arguments(args, :required => [:user, :repo, :number]) do
sift VALID_REQUEST_PARAM_NAMES
assert_values VALID_REQUEST_PARAM_VALUES
end
patch_request("/repos/#{user}/#{repo}/pulls/#{number}", arguments.params)
end
# List commits on a pull request
#
# = Examples
# github = Github.new
# github.pull_requests.commits 'user-name', 'repo-name', 'number'
#
def commits(*args)
arguments(args, :required => [:user, :repo, :number])
response = get_request("/repos/#{user}/#{repo}/pulls/#{number}/commits",
arguments.params)
return response unless block_given?
response.each { |el| yield el }
end
# List pull requests files
#
# = Examples
# github = Github.new
# github.pull_requests.files 'user-name', 'repo-name', 'number'
#
def files(*args)
arguments(args, :required => [:user, :repo, :number])
response = get_request("/repos/#{user}/#{repo}/pulls/#{number}/files",
arguments.params)
return response unless block_given?
response.each { |el| yield el }
end
# Check if pull request has been merged
#
# = Examples
# github = Github.new
# github.pull_requests.merged? 'user-name', 'repo-name', 'number'
#
def merged?(*args)
arguments(args, :required => [:user, :repo, :number])
get_request("/repos/#{user}/#{repo}/pulls/#{number}/merge", arguments.params)
true
rescue Github::Error::NotFound
false
end
# Merge a pull request(Merge Button)
#
# = Inputs
# <tt>:commit_message</tt> - Optional string -
# The message that will be used for the merge commit
#
# = Examples
# github = Github.new
# github.pull_requests.merge 'user-name', 'repo-name', 'number'
#
def merge(*args)
arguments(args, :required => [:user, :repo, :number]) do
sift VALID_REQUEST_PARAM_NAMES
end
put_request("/repos/#{user}/#{repo}/pulls/#{number}/merge", arguments.params)
end
end # PullRequests
end # Github