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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
# frozen_string_literal: true
class Gitlab::Client
# Defines methods related to notes.
# @see https://docs.gitlab.com/ce/api/notes.html
module Notes
# Gets a list of projects notes.
#
# @example
# Gitlab.notes(5)
#
# @param [Integer] project The ID of a project.
# @option options [Integer] :page The page number.
# @option options [Integer] :per_page The number of results per page.
# @return [Array<Gitlab::ObjectifiedHash>]
def notes(project, options = {})
get("/projects/#{url_encode project}/notes", query: options)
end
# Gets a list of notes for a issue.
#
# @example
# Gitlab.issue_notes(5, 10)
#
# @param [Integer] project The ID of a project.
# @param [Integer] issue The ID of an issue.
# @option options [Integer] :page The page number.
# @option options [Integer] :per_page The number of results per page.
# @return [Array<Gitlab::ObjectifiedHash>]
def issue_notes(project, issue, options = {})
get("/projects/#{url_encode project}/issues/#{issue}/notes", query: options)
end
# Gets a list of notes for a snippet.
#
# @example
# Gitlab.snippet_notes(5, 1)
#
# @param [Integer] project The ID of a project.
# @param [Integer] snippet The ID of a snippet.
# @option options [Integer] :page The page number.
# @option options [Integer] :per_page The number of results per page.
# @return [Array<Gitlab::ObjectifiedHash>]
def snippet_notes(project, snippet, options = {})
get("/projects/#{url_encode project}/snippets/#{snippet}/notes", query: options)
end
# Gets a list of notes for a merge request.
#
# @example
# Gitlab.merge_request_notes(5, 1)
#
# @param [Integer] project The ID of a project.
# @param [Integer] merge_request The ID of a merge request.
# @option options [Integer] :page The page number.
# @option options [Integer] :per_page The number of results per page.
# @return [Array<Gitlab::ObjectifiedHash>]
def merge_request_notes(project, merge_request, options = {})
get("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes", query: options)
end
alias merge_request_comments merge_request_notes
# Gets a list of notes for an epic.
#
# @example
# Gitlab.epic_notes(5, 10)
#
# @param [Integer] project The ID of a group.
# @param [Integer] epic The ID of an epic.
# @option options [Integer] :page The page number.
# @option options [Integer] :per_page The number of results per page.
# @return [Array<Gitlab::ObjectifiedHash>]
def epic_notes(group, epic, options = {})
get("/groups/#{url_encode group}/epics/#{epic}/notes", query: options)
end
# Gets a single wall note.
#
# @example
# Gitlab.note(5, 15)
#
# @param [Integer] project The ID of a project.
# @param [Integer] id The ID of a note.
# @return [Gitlab::ObjectifiedHash]
def note(project, id)
get("/projects/#{url_encode project}/notes/#{id}")
end
# Gets a single issue note.
#
# @example
# Gitlab.issue_note(5, 10, 1)
#
# @param [Integer] project The ID of a project.
# @param [Integer] issue The ID of an issue.
# @param [Integer] id The ID of a note.
# @return [Gitlab::ObjectifiedHash]
def issue_note(project, issue, id)
get("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}")
end
# Gets a single snippet note.
#
# @example
# Gitlab.snippet_note(5, 11, 3)
#
# @param [Integer] project The ID of a project.
# @param [Integer] snippet The ID of a snippet.
# @param [Integer] id The ID of a note.
# @return [Gitlab::ObjectifiedHash]
def snippet_note(project, snippet, id)
get("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}")
end
# Gets a single merge_request note.
#
# @example
# Gitlab.merge_request_note(5, 11, 3)
#
# @param [Integer] project The ID of a project.
# @param [Integer] merge_request The ID of a merge_request.
# @param [Integer] id The ID of a note.
# @return [Gitlab::ObjectifiedHash]
def merge_request_note(project, merge_request, id)
get("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}")
end
# Creates a new wall note.
#
# @example
# Gitlab.create_note(5, 'This is a wall note!')
#
# @param [Integer, String] project The ID or name of a project.
# @param [String] body The body of a note.
# @return [Gitlab::ObjectifiedHash] Information about created note.
def create_note(project, body)
post("/projects/#{url_encode project}/notes", body: { body: body })
end
# Creates a new issue note.
#
# @example
# Gitlab.create_issue_note(6, 1, 'Adding a note to my issue.')
#
# @param [Integer, String] project The ID or name of a project.
# @param [Integer] issue The ID of an issue.
# @param [String] body The body of a note.
# @return [Gitlab::ObjectifiedHash] Information about created note.
def create_issue_note(project, issue, body)
post("/projects/#{url_encode project}/issues/#{issue}/notes", body: { body: body })
end
# Creates a new snippet note.
#
# @example
# Gitlab.create_snippet_note(3, 2, 'Look at this awesome snippet!')
#
# @param [Integer, String] project The ID or name of a project.
# @param [Integer] snippet The ID of a snippet.
# @param [String] body The body of a note.
# @return [Gitlab::ObjectifiedHash] Information about created note.
def create_snippet_note(project, snippet, body)
post("/projects/#{url_encode project}/snippets/#{snippet}/notes", body: { body: body })
end
# Creates a new note for a single merge request.
#
# @example
# Gitlab.create_merge_request_note(5, 3, 'This MR is ready for review.')
#
# @param [Integer] project The ID of a project.
# @param [Integer] merge_request The ID of a merge request.
# @param [String] body The content of a note.
def create_merge_request_note(project, merge_request, body)
post("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes", body: { body: body })
end
alias create_merge_request_comment create_merge_request_note
# Creates a new epic note.
#
# @example
# Gitlab.create_epic_note(6, 1, 'Adding a note to my epic.')
#
# @param [Integer, String] group The ID or name of a group.
# @param [Integer] epic The ID of an epic.
# @param [String] body The body of a note.
# @return [Gitlab::ObjectifiedHash] Information about created note.
def create_epic_note(group, epic, body)
post("/groups/#{url_encode group}/epics/#{epic}/notes", body: { body: body })
end
# Deletes a wall note.
#
# @example
# Gitlab.delete_note(5, 15)
#
# @param [Integer] project The ID of a project.
# @param [Integer] id The ID of a note.
# @return [Gitlab::ObjectifiedHash]
def delete_note(project, id)
delete("/projects/#{url_encode project}/notes/#{id}")
end
# Deletes an issue note.
#
# @example
# Gitlab.delete_issue_note(5, 10, 1)
#
# @param [Integer] project The ID of a project.
# @param [Integer] issue The ID of an issue.
# @param [Integer] id The ID of a note.
# @return [Gitlab::ObjectifiedHash]
def delete_issue_note(project, issue, id)
delete("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}")
end
# Deletes a snippet note.
#
# @example
# Gitlab.delete_snippet_note(5, 11, 3)
#
# @param [Integer] project The ID of a project.
# @param [Integer] snippet The ID of a snippet.
# @param [Integer] id The ID of a note.
# @return [Gitlab::ObjectifiedHash]
def delete_snippet_note(project, snippet, id)
delete("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}")
end
# Deletes a merge_request note.
#
# @example
# Gitlab.delete_merge_request_note(5, 11, 3)
#
# @param [Integer] project The ID of a project.
# @param [Integer] merge_request The ID of a merge_request.
# @param [Integer] id The ID of a note.
# @return [Gitlab::ObjectifiedHash]
def delete_merge_request_note(project, merge_request, id)
delete("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}")
end
alias delete_merge_request_comment delete_merge_request_note
# Modifies a wall note.
#
# @example
# Gitlab.edit_note(5, 15, 'This is an edited note')
#
# @param [Integer] project The ID of a project.
# @param [Integer] id The ID of a note.
# @param [String] body The content of a note.
# @return [Gitlab::ObjectifiedHash]
def edit_note(project, id, body)
put("/projects/#{url_encode project}/notes/#{id}", body: note_content(body))
end
# Modifies an issue note.
#
# @example
# Gitlab.edit_issue_note(5, 10, 1, 'This is an edited issue note')
#
# @param [Integer] project The ID of a project.
# @param [Integer] issue The ID of an issue.
# @param [Integer] id The ID of a note.
# @param [String] body The content of a note.
# @return [Gitlab::ObjectifiedHash]
def edit_issue_note(project, issue, id, body)
put("/projects/#{url_encode project}/issues/#{issue}/notes/#{id}", body: note_content(body))
end
# Modifies a snippet note.
#
# @example
# Gitlab.edit_snippet_note(5, 11, 3, 'This is an edited snippet note')
#
# @param [Integer] project The ID of a project.
# @param [Integer] snippet The ID of a snippet.
# @param [Integer] id The ID of a note.
# @param [String] body The content of a note.
# @return [Gitlab::ObjectifiedHash]
def edit_snippet_note(project, snippet, id, body)
put("/projects/#{url_encode project}/snippets/#{snippet}/notes/#{id}", body: note_content(body))
end
# Modifies a merge_request note.
#
# @example
# Gitlab.edit_merge_request_note(5, 11, 3, 'This is an edited merge request note')
#
# @param [Integer] project The ID of a project.
# @param [Integer] merge_request The ID of a merge_request.
# @param [Integer] id The ID of a note.
# @param [String] body The content of a note.
# @return [Gitlab::ObjectifiedHash]
def edit_merge_request_note(project, merge_request, id, body)
put("/projects/#{url_encode project}/merge_requests/#{merge_request}/notes/#{id}", body: note_content(body))
end
alias edit_merge_request_comment edit_merge_request_note
private
# TODO: Remove this method after a couple deprecation cycles. Replace calls with the code
# in the 'else'.
def note_content(body)
if body.is_a?(Hash)
warn 'Passing the note body as a Hash is deprecated. You should just pass the String.'
body
else
{ body: body }
end
end
end
end
|
