.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Net::GitHub::V2 3pm" .TH Net::GitHub::V2 3pm "2012-03-30" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::GitHub::V2 \- Perl Interface for github.com (V2) .SH "SYNOPSIS" .IX Header "SYNOPSIS" Prefer: .PP .Vb 1 \& use Net::GitHub; \& \& my $github = Net::GitHub\->new( \& version => 2, # optional, default as 2 \& owner => \*(Aqfayland\*(Aq, repo => \*(Aqperl\-net\-github\*(Aq \& ); .Ve .PP Or: .PP .Vb 1 \& use Net::GitHub::V2; \& \& # for http://github.com/fayland/perl\-net\-github/tree/master \& my $github = Net::GitHub::V2\->new( owner => \*(Aqfayland\*(Aq, repo => \*(Aqperl\-net\-github\*(Aq ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\s-1NOTE:\s0 \fBGithub will terminate \s-1API\s0 v1 and \s-1API\s0 v2 on May 1st, 2012\fR .PP .PP For those \fB(authentication required)\fR, you must set login and token (in ). If no login and token are provided, your \fB.gitconfig\fR will be loaded: if the github.user and github.token keys are defined, they will be used. .PP .Vb 4 \& my $github = Net::GitHub::V2\->new( \& owner => \*(Aqfayland\*(Aq, repo => \*(Aqperl\-net\-github\*(Aq, \& login => \*(Aqfayland\*(Aq, token => \*(Aq54b5197d7f92f52abc5c7149b313cf51\*(Aq, # faked \& ); .Ve .PP If you want to work with private repo, you can set \fBalways_Authorization\fR. .PP To disable call rate limiting (e.g. if your account is whitelisted), set \&\fBapi_throttle\fR to 0. .PP By default, error responses are propagated to the user as they are received from the \s-1API\s0. By switching \fBthrow_errors\fR on you can make the be turned into exceptions instead, so that you don't have to check for error response after every call. .PP .Vb 7 \& my $github = Net::GitHub::V2\->new( \& owner => \*(Aqfayland\*(Aq, repo => \*(Aqperl\-net\-github\*(Aq, \& login => \*(Aqfayland\*(Aq, token => \*(Aq54b5197d7f92f52abc5c7149b313cf51\*(Aq, # faked \& always_Authorization => 1, \& api_throttle => 0, \& throw_errors => 0, \& ); .Ve .SH "METHODS" .IX Header "METHODS" .SS "repos" .IX Subsection "repos" .Vb 2 \& $github\->repos\->create( \*(Aqsandbox3\*(Aq, \*(AqSandbox desc\*(Aq, \*(Aqhttp://fayland.org/\*(Aq, 1 ); \& $github\->repos\->show(); .Ve .PP Net::GitHub::V2::Repositories .SS "user" .IX Subsection "user" .Vb 2 \& my $followers = $github\->user\->followers(); \& $github\->user\->update( name => \*(AqFayland Lam\*(Aq ); .Ve .PP Net::GitHub::V2::Users .SS "commit" .IX Subsection "commit" .Vb 3 \& my $commits = $github\->commit\->branch(); \& my $commits = $github\->commit\->file( \*(Aqmaster\*(Aq, \*(Aqlib/Net/GitHub.pm\*(Aq ); \& my $co_detail = $github\->commit\->show( $sha1 ); .Ve .PP Net::GitHub::V2::Commits .SS "issue" .IX Subsection "issue" .Vb 3 \& my $issues = $github\->issue\->list(\*(Aqopen\*(Aq); \& my $issue = $github\->issue\->open( \*(AqBug title\*(Aq, \*(AqBug detail\*(Aq ); \& $github\->issue\->close( $number ); .Ve .PP Net::GitHub::V2::Issues .SS "object" .IX Subsection "object" .Vb 3 \& my $tree = $github\->obj_tree( $tree_sha1 ); # alias object\->tree \& my $blob = $github\->obj_blob( $tree_sha1, \*(Aqlib/Net/GitHub.pm\*(Aq ); # alias object\->blob \& my $raw = $github\->obj_raw( $sha1 ); # alias object\->raw .Ve .PP Net::GitHub::V2::Object .SS "network" .IX Subsection "network" .Vb 2 \& $github\->network_meta; # alias \->network\->network_meta \& $github\->network_data_chunk( $net_hash ); # alias network\->network_data_chunk .Ve .PP Net::GitHub::V2::Network .SS "organization" .IX Subsection "organization" .Vb 2 \& my $organization = $github\->organization\->organizations(\*(Aqgithub\*(Aq); \& my $teams = $github\->organization\->teams(\*(AqPerlChina\*(Aq); .Ve .PP Net::GitHub::V2::Organizations .SS "pull_request" .IX Subsection "pull_request" .Vb 1 \& my $pull = $github\->pull_request\->pull_request(); .Ve .PP Net::GitHub::V2::PullRequest .SH "SEE ALSO" .IX Header "SEE ALSO" Any::Moose .SH "AUTHOR" .IX Header "AUTHOR" Fayland Lam, \f(CW\*(C`\*(C'\fR .PP More on Changes .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2009\-2011 Fayland Lam, all rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.