auto_pagination

See also: "auto_pagination" in Pithub::Result.

api_uri

Examples:

    my $users = Pithub::Users->new( api_uri => 'https://api-foo.github.com' );

    # ... is the same as ...

    my $users = Pithub::Users->new;
    $users->api_uri('https://api-foo.github.com');

jsonp_callback

See also: <http://developer.github.com/v3/#json-p-callbacks>.

Examples:

    my $p = Pithub->new( jsonp_callback => 'loadGithubData' );
    my $result = $p->users->get( user => 'plu' );
    print $result->raw_content;

The result will look like this:

    loadGithubData({
        "meta": {
            "status": 200,
            "X-RateLimit-Limit": "5000",
            "X-RateLimit-Remaining": "4661"
        },
        "data": {
            "type": "User",
            "location": "Dubai",
            "url": "https://api.github.com/users/plu",
            "login": "plu",
            "name": "Johannes Plunien",
            ...
        }
    })

Be careful: The content method will try to decode the JSON into a Perl data structure. This is not possible if the "jsonp_callback" is set:

    # calling this ...
    print $result->content;

    # ... will throw an exception like this ...
    Runtime error: malformed JSON string, neither array, object, number, string or atom,
    at character offset 0 (before "loadGithubData( ...

There are two helper methods:

• clear_jsonp_callback: reset the jsonp_callback attribute

per_page

To minimize the number of API calls to get a complete listing, this defaults to the maximum allowed by Github, which is currently 100. This may change in the future if Github changes their maximum.

Examples:

    my $users = Pithub::Users->new( per_page => 30 );

    # ... is the same as ...

    my $users = Pithub::Users->new;
    $users->per_page(30);

There are two helper methods:

• clear_per_page: reset the per_page attribute

prepare_request

Let's use this example from the Github docs:

Html

"application/vnd.github-issue.html+json"

Return html rendered from the body's markdown. Response will include body_html.

Examples:

    my $p = Pithub::Issues->new(
        prepare_request => sub {
            my ($request) = @_;
            $request->header( Accept => 'application/vnd.github-issue.html+json' );
        }
    );

    my $result = $p->get(
        user     => 'miyagawa',
        repo     => 'Plack',
        issue_id => 209,
    );

    print $result->content->{body_html};

Please compare to the solution where you set the custom HTTP header on the method call, instead globally on the object:

    my $p = Pithub::Issues->new;

    my $result = $p->get(
        user     => 'miyagawa',
        repo     => 'Plack',
        issue_id => 209,
        options  => {
            prepare_request => sub {
                my ($request) = @_;
                $request->header( Accept => 'application/vnd.github-issue.html+json' );
            },
        }
    );

    print $result->content->{body_html};

repo

Examples:

    my $c = Pithub::Repos::Collaborators->new( repo => 'Pithub' );
    my $result = $c->list( user => 'plu' );

There are two helper methods:

• clear_repo: reset the repo attribute

token

See also: <http://developer.github.com/v3/oauth/>

ua

user

Examples:

    my $c = Pithub::Repos::Collaborators->new( user => 'plu' );
    my $result = $c->list( repo => 'Pithub' );

There are two helper methods:

• clear_user: reset the user attribute

utf8

Examples:

    my $p = Pithub->new(utf8 => 0); # disable utf8 en/decoding
    my $p = Pithub->new(utf8 => 1); # enable utf8 en/decoding (default)

request

•

method: mandatory string, one of the following:

• path: mandatory string of the relative path used for making the API call.
• data: optional data reference, usually a reference to an array or hash. It must be possible to serialize this using JSON. This will be the HTTP request body.
• options: optional hash reference to set additional options on the request. So far "prepare_request" is supported. See more about that in the examples below. So this can be used on every method which maps directly to an API call.
• params: optional hash reference to set additional "GET" parameters. This could be achieved using the "prepare_request" in the "options" hashref as well, but this is shorter. It's being used in list method of Pithub::Issues for example.

Usually you should not end up using this method at all. It's only available if Pithub is missing anything from the Github v3 API. Though here are some examples how to use it:

• Same as "list" in Pithub::Issues:

      my $p      = Pithub->new;
      my $result = $p->request(
          method => 'GET',
          path   => '/repos/plu/Pithub/issues',
          params => {
              state     => 'closed',
              direction => 'asc',
          }
      );
      

• Same as "get" in Pithub::Users:

      my $p = Pithub->new;
      my $result = $p->request(
          method => 'GET',
          path   => '/users/plu',
      );
      

• Same as "create" in Pithub::Gists:

      my $p      = Pithub->new;
      my $method = 'POST';
      my $path   = '/gists';
      my $data   = {
          description => 'the description for this gist',
          public      => 1,
          files       => { 'file1.txt' => { content => 'String file content' } }
      };
      my $result = $p->request(
          method => $method,
          path   => $path,
          data   => $data,
      );
      

• Same as "get" in Pithub::GitData::Trees:

      my $p       = Pithub->new;
      my $method  = 'GET';
      my $path    = '/repos/miyagawa/Plack/issues/209';
      my $data    = undef;
      my $options = {
          prepare_request => sub {
              my ($request) = @_;
              $request->header( Accept => 'application/vnd.github-issue.html+json' );
          },
      };
      my $result = $p->request(
          method  => $method,
          path    => $path,
          data    => $data,
          options => $options,
      );
      

This method always returns a Pithub::Result object.

has_token (?$request)

rate_limit

has_jsonp_callback: check if the jsonp_callback attribute is set

has_per_page: check if the per_page attribute is set

has_repo: check if the repo attribute is set

has_user: check if the user attribute is set

It might make sense to use this together with the repo attribute:

    my $c = Pithub::Repos::Commits->new( user => 'plu', repo => 'Pithub' );
    my $result = $c->list;
    my $result = $c->list_comments;
    my $result = $c->get('6b6127383666e8ecb41ec20a669e4f0552772363');