Net::GitHub::V3::Query - Base Query role for Net::GitHub::V3
package Net::GitHub::V3::XXX; use Moo; with 'Net::GitHub::V3::Query';
set Authentication and call API
Either set access_token from OAuth or login:pass for Basic Authentication
http://developer.github.com/
API throttling is enabled by default, set api_throttle to 0 to disable it.
The maximum number of queries allowed per hour. 60 for anonymous users and 5,000 for authenticated users.
The number of requests remaining in the current rate limit window.
The time the current rate limit resets in UTC epoch seconds.
Query the /rate_limit API (for free) to update the cached values for rate_limit, rate_limit_remaining, rate_limit_reset
Denotes the index of the last page in the pagination
Refer Net::GitHub::V3
Calls query with next_url. See Net::GitHub::V3
query
next_url
Calls query with prev_url. See Net::GitHub::V3
prev_url
Calls query with first_url. See Net::GitHub::V3
first_url
Calls query with last_url. See Net::GitHub::V3
last_url
Adjusts next_url to be a new url in the pagination space I.E. you are jumping to a new index in the pagination
This provides an helper to iterate over APIs call using pagination, using the combo: has_next_page, next_page... for you.
The arguments can be either a scalar if the function is using a single argument, an ArrayRef when the function is using multiple arguments. You can also use one HashRef for functions supporting named parameters.
The callback function is called with a single item. The return value of the callback function can be used to stop the iteration when returning a 'false' value.
In common cases, you want to return a true value: '1'.
Sample usage:
$gh->org->iterate( 'repos', 'OrganizationName', sub { my $item = shift; print "Repo Name is $item->{name}" return 1; # if you want to continue iterating return; # use a false value when you want to interrupt the iteration } );
For internal use by the item-per-item pagination: This is a store of the state(s) for the pagination. Each entry maps the initial URL of a GitHub query to a Net::GitHub::V3::ResultSet object.
Returns the next item for the query which started at $url, or undef if there are no more items.
Terminates the item-per-item pagination for the query which started at $url.
export NG_DEBUG=1 to view the request URL
NG_DEBUG > 1 to view request/response string
Refer Net::GitHub
To install Net::GitHub, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::GitHub
CPAN shell
perl -MCPAN -e shell install Net::GitHub
For more information on module installation, please visit the detailed CPAN module installation guide.