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
|
# frozen_string_literal: true
module Octokit
class Client
# Methods for the Gists API
#
# @see https://developer.github.com/v3/gists/
module Gists
# List gists for a user or all public gists
#
# @param user [String] An optional user to filter listing
# @return [Array<Sawyer::Resource>] A list of gists
# @example Fetch all gists for defunkt
# Octokit.gists('defunkt')
# @example Fetch all public gists
# Octokit.gists
# @see https://developer.github.com/v3/gists/#list-gists
def gists(user = nil, options = {})
if user.nil?
paginate 'gists', options
else
paginate "#{User.path user}/gists", options
end
end
alias list_gists gists
# List public gists
#
# @return [Array<Sawyer::Resource>] A list of gists
# @example Fetch all public gists
# Octokit.public_gists
# @see https://developer.github.com/v3/gists/#list-gists
def public_gists(options = {})
paginate 'gists/public', options
end
# List the authenticated user’s starred gists
#
# @return [Array<Sawyer::Resource>] A list of gists
# @see https://developer.github.com/v3/gists/#list-gists
def starred_gists(options = {})
paginate 'gists/starred', options
end
# Get a single gist
#
# @param gist [String] ID of gist to fetch
# @option options [String] :sha Specific gist revision SHA
# @return [Sawyer::Resource] Gist information
# @see https://developer.github.com/v3/gists/#get-a-single-gist
# @see https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist
def gist(gist, options = {})
options = options.dup
if sha = options.delete(:sha)
get "gists/#{Gist.new(gist)}/#{sha}", options
else
get "gists/#{Gist.new(gist)}", options
end
end
# Create a gist
#
# @param options [Hash] Gist information.
# @option options [String] :description
# @option options [Boolean] :public Sets gist visibility
# @option options [Array<Hash>] :files Files that make up this gist. Keys
# should be the filename, the value a Hash with a :content key with text
# content of the Gist.
# @return [Sawyer::Resource] Newly created gist info
# @see https://developer.github.com/v3/gists/#create-a-gist
def create_gist(options = {})
post 'gists', options
end
# Edit a gist
#
# @param options [Hash] Gist information.
# @option options [String] :description
# @option options [Hash] :files Files that make up this gist. Keys
# should be the filename, the value a Hash with a :content key with text
# content of the Gist.
#
# NOTE: All files from the previous version of the
# gist are carried over by default if not included in the hash. Deletes
# can be performed by including the filename with a null hash.
# @return
# [Sawyer::Resource] Newly created gist info
# @see https://developer.github.com/v3/gists/#edit-a-gist
# @example Update a gist
# @client.edit_gist('some_id', {
# :files => {"boo.md" => {"content" => "updated stuff"}}
# })
def edit_gist(gist, options = {})
patch "gists/#{Gist.new(gist)}", options
end
# List gist commits
#
# @param gist [String] Gist ID
# @return [Array] List of commits to the gist
# @see https://developer.github.com/v3/gists/#list-gist-commits
# @example List commits for a gist
# @client.gist_commits('some_id')
def gist_commits(gist, options = {})
paginate "gists/#{Gist.new(gist)}/commits", options
end
#
# Star a gist
#
# @param gist [String] Gist ID
# @return [Boolean] Indicates if gist is starred successfully
# @see https://developer.github.com/v3/gists/#star-a-gist
def star_gist(gist, options = {})
boolean_from_response :put, "gists/#{Gist.new(gist)}/star", options
end
# Unstar a gist
#
# @param gist [String] Gist ID
# @return [Boolean] Indicates if gist is unstarred successfully
# @see https://developer.github.com/v3/gists/#unstar-a-gist
def unstar_gist(gist, options = {})
boolean_from_response :delete, "gists/#{Gist.new(gist)}/star", options
end
# Check if a gist is starred
#
# @param gist [String] Gist ID
# @return [Boolean] Indicates if gist is starred
# @see https://developer.github.com/v3/gists/#check-if-a-gist-is-starred
def gist_starred?(gist, options = {})
boolean_from_response :get, "gists/#{Gist.new(gist)}/star", options
end
# Fork a gist
#
# @param gist [String] Gist ID
# @return [Sawyer::Resource] Data for the new gist
# @see https://developer.github.com/v3/gists/#fork-a-gist
def fork_gist(gist, options = {})
post "gists/#{Gist.new(gist)}/forks", options
end
# List gist forks
#
# @param gist [String] Gist ID
# @return [Array] List of gist forks
# @see https://developer.github.com/v3/gists/#list-gist-forks
# @example List gist forks
# @client.gist_forks('some-id')
def gist_forks(gist, options = {})
paginate "gists/#{Gist.new(gist)}/forks", options
end
# Delete a gist
#
# @param gist [String] Gist ID
# @return [Boolean] Indicating success of deletion
# @see https://developer.github.com/v3/gists/#delete-a-gist
def delete_gist(gist, options = {})
boolean_from_response :delete, "gists/#{Gist.new(gist)}", options
end
# List gist comments
#
# @param gist_id [String] Gist Id.
# @return [Array<Sawyer::Resource>] Array of hashes representing comments.
# @see https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
# @example
# Octokit.gist_comments('3528ae645')
def gist_comments(gist_id, options = {})
paginate "gists/#{gist_id}/comments", options
end
# Get gist comment
#
# @param gist_id [String] Id of the gist.
# @param gist_comment_id [Integer] Id of the gist comment.
# @return [Sawyer::Resource] Hash representing gist comment.
# @see https://developer.github.com/v3/gists/comments/#get-a-single-comment
# @example
# Octokit.gist_comment('208sdaz3', 1451398)
def gist_comment(gist_id, gist_comment_id, options = {})
get "gists/#{gist_id}/comments/#{gist_comment_id}", options
end
# Create gist comment
#
# Requires authenticated client.
#
# @param gist_id [String] Id of the gist.
# @param comment [String] Comment contents.
# @return [Sawyer::Resource] Hash representing the new comment.
# @see https://developer.github.com/v3/gists/comments/#create-a-comment
# @example
# @client.create_gist_comment('3528645', 'This is very helpful.')
def create_gist_comment(gist_id, comment, options = {})
options = options.merge({ body: comment })
post "gists/#{gist_id}/comments", options
end
# Update gist comment
#
# Requires authenticated client
#
# @param gist_id [String] Id of the gist.
# @param gist_comment_id [Integer] Id of the gist comment to update.
# @param comment [String] Updated comment contents.
# @return [Sawyer::Resource] Hash representing the updated comment.
# @see https://developer.github.com/v3/gists/comments/#edit-a-comment
# @example
# @client.update_gist_comment('208sdaz3', '3528645', ':heart:')
def update_gist_comment(gist_id, gist_comment_id, comment, options = {})
options = options.merge({ body: comment })
patch "gists/#{gist_id}/comments/#{gist_comment_id}", options
end
# Delete gist comment
#
# Requires authenticated client.
#
# @param gist_id [String] Id of the gist.
# @param gist_comment_id [Integer] Id of the gist comment to delete.
# @return [Boolean] True if comment deleted, false otherwise.
# @see https://developer.github.com/v3/gists/comments/#delete-a-comment
# @example
# @client.delete_gist_comment('208sdaz3', '586399')
def delete_gist_comment(gist_id, gist_comment_id, options = {})
boolean_from_response(:delete, "gists/#{gist_id}/comments/#{gist_comment_id}", options)
end
end
end
end
|
