forked from piotrmurach/github
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathissues.rb
More file actions
232 lines (207 loc) · 7.51 KB
/
Copy pathissues.rb
File metadata and controls
232 lines (207 loc) · 7.51 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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
# encoding: utf-8
module Github
class Issues < API
extend AutoloadHelper
autoload_all 'github_api/issues',
:Assignees => 'assignees',
:Comments => 'comments',
:Events => 'events',
:Labels => 'labels',
:Milestones => 'milestones'
VALID_ISSUE_PARAM_NAMES = %w[
filter
state
labels
sort
direction
since
milestone
assignee
mentioned
title
body
resource
mime_type
].freeze
VALID_ISSUE_PARAM_VALUES = {
'filter' => %w[ assigned created mentioned subscribed ],
'state' => %w[ open closed ],
'sort' => %w[ created updated comments ],
'direction' => %w[ desc asc ],
'since' => %r{\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z}
}
# Creates new Issues API
def initialize(options = {})
super(options)
end
# Access to Issues::Assignees API
def assignees
@assignees ||= ApiFactory.new 'Issues::Assignees'
end
# Access to Issues::Comments API
def comments
@comments ||= ApiFactory.new 'Issues::Comments'
end
# Access to Issues::Events API
def events
@events ||= ApiFactory.new 'Issues::Events'
end
# Access to Issues::Comments API
def labels
@labels ||= ApiFactory.new 'Issues::Labels'
end
# Access to Issues::Comments API
def milestones
@milestones ||= ApiFactory.new 'Issues::Milestones'
end
# List your issues
#
# = Parameters
# <tt>:filter</tt>
# * <tt>assigned</tt>: Issues assigned to you (default)
# * <tt>created</tt>: Issues assigned to you (default)
# * <tt>mentioned</tt>: Issues assigned to you (default)
# * <tt>subscribed</tt>: Issues assigned to you (default)
# <tt>:state</tt> - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
# <tt>:labels</tt> - String list of comma separated Label names. Example: bug,ui,@high
# <tt>:sort</tt> - <tt>created</tt>, <tt>updated</tt>, <tt>comments</tt>, default: <tt>created</tt>
# <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
# <tt>:since</tt> - Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
#
# = Examples
# github = Github.new :oauth_token => '...'
# github.issues.list :since => '2011-04-12T12:12:12Z',
# :filter => 'created',
# :state => 'open',
# :labels => "bug,ui,bla",
# :sort => 'comments',
# :direction => 'asc'
#
def list(*args)
params = args.extract_options!
normalize! params
filter! VALID_ISSUE_PARAM_NAMES, params
# _merge_mime_type(:issue, params)
assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
response = get_request("/issues", params)
return response unless block_given?
response.each { |el| yield el }
end
alias :all :list
# List issues for a repository
#
# = Parameters
# <tt>:milestone</tt>
# * Integer Milestone number
# * <tt>none</tt> for Issues with no Milestone.
# * <tt>*</tt> for Issues with any Milestone
# <tt>:state</tt> - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
# <tt>:assignee</tt>
# * String User login
# * <tt>none</tt> for Issues with no assigned User.
# * <tt>*</tt> for Issues with any assigned User.
# <tt>:mentioned</tt> String User login
# <tt>:labels</tt> - String list of comma separated Label names. Example: bug,ui,@high
# <tt>:sort</tt> - <tt>created</tt>, <tt>updated</tt>, <tt>comments</tt>, default: <tt>created</tt>
# <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
# <tt>:since</tt> - Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
# <tt></tt>, default: <tt>due_date</tt>
# <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
#
# = Examples
# github = Github.new :user => 'user-name', :repo => 'repo-name'
# github.issues.list_repo :milestone => 1,
# :state => 'open',
# :assignee => '*',
# :mentioned => 'octocat',
# :labels => "bug,ui,bla",
# :sort => 'comments',
# :direction => 'asc'
#
def list_repo(user_name, repo_name, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo
normalize! params
filter! VALID_ISSUE_PARAM_NAMES, params
# _merge_mime_type(:issue, params)
assert_valid_values(VALID_ISSUE_PARAM_VALUES, params)
response = get_request("/repos/#{user}/#{repo}/issues", params)
return response unless block_given?
response.each { |el| yield el }
end
alias :list_repository :list_repo
# Get a single issue
#
# = Examples
# github = Github.new
# github.issues.get 'user-name', 'repo-name', 'issue-id'
#
def get(user_name, repo_name, issue_id, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo, issue_id
normalize! params
# _merge_mime_type(:issue, params)
get_request("/repos/#{user}/#{repo}/issues/#{issue_id}", params)
end
alias :find :get
# Create an issue
#
# = Inputs
# <tt>:title</tt> - Required string
# <tt>:body</tt> - Optional string
# <tt>:assignee</tt> - Optional string - Login for the user that this issue should be assigned to.
# <tt>:milestone</tt> - Optional number - Milestone to associate this issue with
# <tt>:labels</tt> - Optional array of strings - Labels to associate with this issue
# = Examples
# github = Github.new :user => 'user-name', :repo => 'repo-name'
# github.issues.create
# "title" => "Found a bug",
# "body" => "I'm having a problem with this.",
# "assignee" => "octocat",
# "milestone" => 1,
# "labels" => [
# "Label1",
# "Label2"
# ]
#
def create(user_name, repo_name, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo
normalize! params
# _merge_mime_type(:issue, params)
filter! VALID_ISSUE_PARAM_NAMES, params
assert_required_keys(%w[ title ], params)
post_request("/repos/#{user}/#{repo}/issues", params)
end
# Edit an issue
#
# = Inputs
# <tt>:title</tt> - Optional string
# <tt>:body</tt> - Optional string
# <tt>:assignee</tt> - Optional string - Login for the user that this issue should be assigned to.
# <tt>:state</tt> - Optional string - State of the issue:<tt>open</tt> or <tt>closed</tt>
# <tt>:milestone</tt> - Optional number - Milestone to associate this issue with
# <tt>:labels</tt> - Optional array of strings - Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue.
#
# = Examples
# github = Github.new
# github.issues.edit 'user-name', 'repo-name', 'issue-id'
# "title" => "Found a bug",
# "body" => "I'm having a problem with this.",
# "assignee" => "octocat",
# "milestone" => 1,
# "labels" => [
# "Label1",
# "Label2"
# ]
#
def edit(user_name, repo_name, issue_id, params={})
set :user => user_name, :repo => repo_name
assert_presence_of user, repo, issue_id
normalize! params
# _merge_mime_type(:issue, params)
filter! VALID_ISSUE_PARAM_NAMES, params
patch_request("/repos/#{user}/#{repo}/issues/#{issue_id}", params)
end
end # Issues
end # Github