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
|
package Net::GitHub::V3;
use Any::Moose;
our $VERSION = '0.40';
our $AUTHORITY = 'cpan:FAYLAND';
with 'Net::GitHub::V3::Query';
use Net::GitHub::V3::Users;
use Net::GitHub::V3::Repos;
use Net::GitHub::V3::Issues;
use Net::GitHub::V3::PullRequests;
has '+is_main_module' => (default => 1);
has 'user' => (
is => 'rw',
isa => 'Net::GitHub::V3::Users',
lazy => 1,
default => sub {
my $self = shift;
return Net::GitHub::V3::Users->new( $self->args_to_pass );
},
);
has 'repos' => (
is => 'rw',
isa => 'Net::GitHub::V3::Repos',
lazy => 1,
predicate => 'is_repos_init',
default => sub {
my $self = shift;
return Net::GitHub::V3::Repos->new( $self->args_to_pass );
},
);
has 'issue' => (
is => 'rw',
isa => 'Net::GitHub::V3::Issues',
lazy => 1,
predicate => 'is_issue_init',
default => sub {
my $self = shift;
return Net::GitHub::V3::Issues->new( $self->args_to_pass );
},
);
has 'pull_request' => (
is => 'rw',
isa => 'Net::GitHub::V3::PullRequests',
lazy => 1,
predicate => 'is_pull_request_init',
default => sub {
my $self = shift;
return Net::GitHub::V3::PullRequests->new( $self->args_to_pass );
},
);
no Any::Moose;
__PACKAGE__->meta->make_immutable;
1;
__END__
=head1 NAME
Net::GitHub::V3 - Github API v3
=head1 SYNOPSIS
Prefer:
use Net::GitHub;
my $gh = Net::GitHub->new(
version => 3,
login => 'fayland', pass => 'mypass',
# or
# access_token => $oauth_token
);
Or:
use Net::GitHub::V3;
my $gh = Net::GitHub::V3->new(
login => 'fayland', pass => 'mypass',
# or
# access_token => $oauth_token
);
=head1 DESCRIPTION
L<http://develop.github.com/>
=head2 ATTRIBUTES
=head3 Authentication
There are two ways to authenticate through GitHub API v3:
=over 4
=item login/pass
my $gh = Net::GitHub::V3->new( login => $ENV{GITHUB_USER}, pass => $ENV{GITHUB_PASS} );
=item access_token
my $gh = Net::GitHub->new( access_token => $ENV{GITHUB_ACCESS_TOKEN} );
=back
=head3 raw_response
my $gh = Net::GitHub->new(
# login/pass or access_token
raw_response => 1
);
return raw L<HTTP::Response> object
=head3 raw_string
my $gh = Net::GitHub->new(
# login/pass or access_token
raw_string => 1
);
return L<HTTP::Response> response content as string
=head3 api_throttle
my $gh = Net::GitHub->new(
# login/pass or access_token
api_throttle => 0
);
To disable call rate limiting (e.g. if your account is whitelisted), set B<api_throttle> to 0.
=head3 RaiseError
By default, error responses are propagated to the user as they are received
from the API. By switching B<RaiseError> on you can make the be turned into
exceptions instead, so that you don't have to check for error response after
every call.
=head2 METHODS
=head3 query($method, $url, $data)
my $data = $gh->query('/user');
$gh->query('PATCH', '/user', $data);
$gh->query('DELETE', '/user/emails', [ 'myemail@somewhere.com' ]);
query API directly
=head3 set_default_user_repo
$gh->set_default_user_repo('fayland', 'perl-net-github'); # take effects for all $gh->
$gh->repos->set_default_user_repo('fayland', 'perl-net-github'); # take effects on $gh->repos
B<To ease the keyboard, we provied two ways to call any method which starts with :user/:repo>
1. SET user/repos before call methods below
$gh->set_default_user_repo('fayland', 'perl-net-github');
my @contributors = $gh->repos->contributors;
2. If it is just for once, we can pass :user, :repo before any arguments
my @contributors = $repos->contributors($user, $repo);
=head2 MODULES
=head3 user
my $user = $gh->user->show('nothingmuch');
$gh->user->update( bio => 'Just Another Perl Programmer' );
L<Net::GitHub::V3::Users>
=head3 repos
my @repos = $gh->repos->list;
my $rp = $gh->repos->create( {
"name" => "Hello-World",
"description" => "This is your first repo",
"homepage" => "https://github.com"
} );
L<Net::GitHub::V3::Repos>
=head3 issue
my @issues = $gh->issue->issues();
my $issue = $gh->issue->issue($issue_id);
L<Net::GitHub::V3::Issues>
=head3 pull_request
my @pulls = $gh->pull_request->pulls();
L<Net::GitHub::V3::PullRequests>
=head1 SEE ALSO
L<Any::Moose>, L<Pithub>
=head1 AUTHOR & COPYRIGHT & LICENSE
Refer L<Net::GitHub>
|
