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
|
package Pithub::Repos::Releases;
our $AUTHORITY = 'cpan:PLU';
our $VERSION = '0.01043';
# ABSTRACT: Github v3 Repo Releases API
use Moo;
use Carp qw( croak );
use Pithub::Repos::Releases::Assets ();
extends 'Pithub::Base';
sub assets {
return shift->_create_instance( Pithub::Repos::Releases::Assets::, @_ );
}
sub list {
my ( $self, %args ) = @_;
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'GET',
path => sprintf(
'/repos/%s/%s/releases', delete $args{user}, delete $args{repo}
),
%args,
);
}
sub get {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: release_id' unless $args{release_id};
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'GET',
path => sprintf(
'/repos/%s/%s/releases/%d', delete $args{user},
delete $args{repo}, delete $args{release_id}
),
%args,
);
}
sub create {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: data (hashref)'
unless ref $args{data} eq 'HASH';
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'POST',
path => sprintf(
'/repos/%s/%s/releases', delete $args{user}, delete $args{repo}
),
%args,
);
}
sub update {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: release_id' unless $args{release_id};
croak 'Missing key in parameters: data (hashref)'
unless ref $args{data} eq 'HASH';
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'PATCH',
path => sprintf(
'/repos/%s/%s/releases/%d', delete $args{user},
delete $args{repo}, delete $args{release_id}
),
%args,
);
}
sub delete {
my ( $self, %args ) = @_;
croak 'Missing key in parameters: release_id' unless $args{release_id};
$self->_validate_user_repo_args( \%args );
return $self->request(
method => 'DELETE',
path => sprintf(
'/repos/%s/%s/releases/%d', delete $args{user},
delete $args{repo}, delete $args{release_id}
),
%args,
);
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Pithub::Repos::Releases - Github v3 Repo Releases API
=head1 VERSION
version 0.01043
=head1 METHODS
=head2 assets
Provides access to L<Pithub::Repos::Releases::Assets>.
=head2 list
=over
=item *
List releases for a repository.
GET /repos/:owner/:repo/releases
Examples:
my $r = Pithub::Repos::Releases->new;
my $result = $r->get(
repo => 'Pithub',
user => 'plu',
);
=back
=head2 get
=over
=item *
Get a single release.
GET /repos/:owner/:repo/releases/:id
Examples:
my $r = Pithub::Repos::Releases->new;
my $result = $r->get(
repo => 'Pithub',
user => 'plu',
release_id => 1,
);
=back
=head2 create
=over
=item *
Create a release.
POST /repos/:user/:repo/releases
Examples:
my $r = Pithub::Repos::Releases->new;
my $result = $r->create(
user => 'plu',
repo => 'Pithub',
data => {
tag_name => 'v1.0.0',
target_commitish => 'master',
name => 'v1.0.0',
body => 'Description of the release',
draft => JSON::MaybeXS::false(), # or alternative below
prerelease => JSON::MaybeXS::false(), # or alternative below
generate_release_notes => JSON::MaybeXS::false(), # or alternative below
}
);
Booleans:
Several of the attributes B<require> boolean values in the request that is sent
to GitHub. Zero (0) and one (1) are integers and will not be encoded correctly
in the JSON encoded request.
There are numerous options for your call to Pithub::Repos::Releases->create.
=over
=item JSON::MaybeXS
Add the following to your code before the call to Pithub::Repos::Releases->create.
require JSON::MaybeXS;
Then use the following values for the booleans:
JSON::MaybeXS::true()
JSON::MaybeXS::false()
=item Cpanel::JSON::XS
Add the following to your code before the call to Pithub::Repos::Releases->create.
require Cpanel::JSON::XS;
Then use the following values for the booleans:
Cpanel::JSON::XS::true
Cpanel::JSON::XS::false
=item JSON::PP
Add the following to your code before the call to Pithub::Repos::Releases->create.
require JSON::PP;
Then use the following values for the booleans:
$JSON::PP::true
$JSON::PP::false
=back
=back
=head2 update
=over
=item *
Edit a release.
PATCH /repos/:user/:repo/releases/:id
Examples:
my $r = Pithub::Repos::Releases->new;
my $result = $r->update(
user => 'plu',
repo => 'Pithub',
release_id => 1,
data => {
tag_name => 'v1.0.0',
target_commitish => 'master',
name => 'v1.0.0',
body => 'Description of the release',
draft => 0,
prerelease => 0,
}
);
=back
=head2 delete
=over
=item *
Delete a release.
DELETE /repos/:user/:repo/releases:id
Examples:
my $r = Pithub::Repos::Releases->new;
my $result = $r->delete(
user => 'plu',
repo => 'Pithub',
release_id => 1,
);
=back
=head1 AUTHOR
Johannes Plunien <plu@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 by Johannes Plunien.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
