oracular (3) Pithub::Search.3pm.gz

NAME

       Pithub::Search - Github legacy Search API

VERSION

       version 0.01041

METHODS

   email
       •   This API call is added for compatibility reasons only. There's no guarantee that full email searches
           will always be available.

               GET /legacy/user/email/:email

           Examples:

               my $search = Pithub::Search->new;
               my $result = $search->email(
                   email => 'plu@pqpq.de',
               );

   issues
       •   Find issues by state and keyword.

               GET /legacy/issues/search/:owner/:repository/:state/:keyword

           Examples:

               my $search = Pithub::Search->new;
               my $result = $search->issues(
                   user    => 'plu',
                   repo    => 'Pithub',
                   state   => 'open',
                   keyword => 'some keyword',
               );

   repos
       •   Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern.
           This method returns up to 100 results per page and pages can be fetched using the start_page
           parameter.

               GET /legacy/repos/search/:keyword

           Examples:

               my $search = Pithub::Search->new;
               my $result = $search->repos(
                   keyword => 'github',
                   params  => {
                       language   => 'Perl',
                       start_page => 0,
                   }
               );

   users
       •   Find users by keyword.

               GET /legacy/user/search/:keyword

           Examples:

               my $search = Pithub::Search->new;
               my $result = $search->users(
                   keyword => 'plu',
               );

AUTHOR

       Johannes Plunien <plu@cpan.org>

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.