https://github.com/awncorp/api-github

Github.com API Client
https://github.com/awncorp/api-github

api-client perl perl5

Last synced: 9 months ago
JSON representation

Github.com API Client

• Host: GitHub
• URL: https://github.com/awncorp/api-github
• Owner: awncorp
• License: other
• Created: 2020-10-03T19:03:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-10-03T20:32:53.000Z (over 5 years ago)
• Last Synced: 2025-07-12T03:28:50.436Z (12 months ago)
• Topics: api-client, perl, perl5
• Language: Perl
• Homepage:
• Size: 29.3 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README
  • Changelog: CHANGES
  • License: LICENSE

Awesome Lists containing this project

README

          
NAME

    API::Github - Github.com API Client

VERSION

    version 0.06

SYNOPSIS

        use API::Github;

    

        my $github = API::Github->new(

            username   => 'USERNAME',

            token      => 'TOKEN',

            identifier => 'APPLICATION NAME',

        );

    

        $github->debug(1);

        $github->fatal(1);

    

        my $user = $github->users('h@x0r');

        my $results = $user->fetch;

    

        # after some introspection

    

        $user->update( ... );

DESCRIPTION

    This distribution provides an object-oriented thin-client library for

    interacting with the Github (http://github.com) API. For usage and

    documentation information visit https://developer.github.com/v3.

    API::Github is derived from API::Client and inherits all of it's

    functionality. Please read the documentation for API::Client for more

    usage information.

ATTRIBUTES

 identifier

        $github->identifier;

        $github->identifier('IDENTIFIER');

    The identifier attribute should be set to a string that identifies your

    application.

 token

        $github->token;

        $github->token('TOKEN');

    The token attribute should be set to the API user's personal access

    token.

 username

        $github->username;

        $github->username('USERNAME');

    The username attribute should be set to the API user's username.

 debug

        $github->debug;

        $github->debug(1);

    The debug attribute if true prints HTTP requests and responses to

    standard out.

 fatal

        $github->fatal;

        $github->fatal(1);

    The fatal attribute if true promotes 4xx and 5xx server response codes

    to exceptions, a API::Client::Exception object.

 retries

        $github->retries;

        $github->retries(10);

    The retries attribute determines how many times an HTTP request should

    be retried if a 4xx or 5xx response is received. This attribute

    defaults to 0.

 timeout

        $github->timeout;

        $github->timeout(5);

    The timeout attribute determines how long an HTTP connection should be

    kept alive. This attribute defaults to 10.

 url

        $github->url;

        $github->url(Mojo::URL->new('https://api.github.com'));

    The url attribute set the base/pre-configured URL object that will be

    used in all HTTP requests. This attribute expects a Mojo::URL object.

 user_agent

        $github->user_agent;

        $github->user_agent(Mojo::UserAgent->new);

    The user_agent attribute set the pre-configured UserAgent object that

    will be used in all HTTP requests. This attribute expects a

    Mojo::UserAgent object.

METHODS

 action

        my $result = $github->action($verb, %args);

    

        # e.g.

    

        $github->action('head', %args);    # HEAD request

        $github->action('options', %args); # OPTIONS request

        $github->action('patch', %args);   # PATCH request

    The action method issues a request to the API resource represented by

    the object. The first parameter will be used as the HTTP request

    method. The arguments, expected to be a list of key/value pairs, will

    be included in the request if the key is either data or query.

 create

        my $results = $github->create(%args);

    

        # or

    

        $github->POST(%args);

    The create method issues a POST request to the API resource represented

    by the object. The arguments, expected to be a list of key/value pairs,

    will be included in the request if the key is either data or query.

 delete

        my $results = $github->delete(%args);

    

        # or

    

        $github->DELETE(%args);

    The delete method issues a DELETE request to the API resource

    represented by the object. The arguments, expected to be a list of

    key/value pairs, will be included in the request if the key is either

    data or query.

 fetch

        my $results = $github->fetch(%args);

    

        # or

    

        $github->GET(%args);

    The fetch method issues a GET request to the API resource represented

    by the object. The arguments, expected to be a list of key/value pairs,

    will be included in the request if the key is either data or query.

 update

        my $results = $github->update(%args);

    

        # or

    

        $github->PUT(%args);

    The update method issues a PUT request to the API resource represented

    by the object. The arguments, expected to be a list of key/value pairs,

    will be included in the request if the key is either data or query.

RESOURCES

 emojis

        $github->emojis;

    The emojis method returns a new instance representative of the API

    emojis resource requested. This method accepts a list of path segments

    which will be used in the HTTP request. The following documentation can

    be used to find more information.

    https://developer.github.com/v3/emojis.

 events

        $github->events;

    The events method returns a new instance representative of the API

    events resource requested. This method accepts a list of path segments

    which will be used in the HTTP request. The following documentation can

    be used to find more information.

    https://developer.github.com/v3/activity/events.

 feeds

        $github->feeds;

    The feeds method returns a new instance representative of the API feeds

    resource requested. This method accepts a list of path segments which

    will be used in the HTTP request. The following documentation can be

    used to find more information.

    https://developer.github.com/v3/activity/feeds.

 gists

        $github->gists;

    The gists method returns a new instance representative of the API gists

    resource requested. This method accepts a list of path segments which

    will be used in the HTTP request. The following documentation can be

    used to find more information. https://developer.github.com/v3/gists.

 gitignore

        $github->gitignore;

    The gitignore method returns a new instance representative of the API

    gitignore resource requested. This method accepts a list of path

    segments which will be used in the HTTP request. The following

    documentation can be used to find more information.

    https://developer.github.com/v3/gitignore.

 issues

        $github->issues;

    The issues method returns a new instance representative of the API

    issues resource requested. This method accepts a list of path segments

    which will be used in the HTTP request. The following documentation can

    be used to find more information.

    https://developer.github.com/v3/issues.

 licenses

        $github->licenses;

    The licenses method returns a new instance representative of the API

    licenses resource requested. This method accepts a list of path

    segments which will be used in the HTTP request. The following

    documentation can be used to find more information.

    https://developer.github.com/v3/licenses.

 markdown

        $github->markdown;

    The markdown method returns a new instance representative of the API

    markdown resource requested. This method accepts a list of path

    segments which will be used in the HTTP request. The following

    documentation can be used to find more information.

    https://developer.github.com/v3/markdown.

 meta

        $github->meta;

    The meta method returns a new instance representative of the API meta

    resource requested. This method accepts a list of path segments which

    will be used in the HTTP request. The following documentation can be

    used to find more information. https://developer.github.com/v3/meta.

 notifications

        $github->notifications;

    The notifications method returns a new instance representative of the

    API notifications resource requested. This method accepts a list of

    path segments which will be used in the HTTP request. The following

    documentation can be used to find more information.

    https://developer.github.com/v3/activity/notifications.

 orgs

        $github->orgs;

    The orgs method returns a new instance representative of the API orgs

    resource requested. This method accepts a list of path segments which

    will be used in the HTTP request. The following documentation can be

    used to find more information. https://developer.github.com/v3/orgs.

 rate_limit

        $github->rate_limit;

    The rate_limit method returns a new instance representative of the API

    rate_limit resource requested. This method accepts a list of path

    segments which will be used in the HTTP request. The following

    documentation can be used to find more information.

    https://developer.github.com/v3/rate_limit.

 repos

        $github->repos;

    The repos method returns a new instance representative of the API repos

    resource requested. This method accepts a list of path segments which

    will be used in the HTTP request. The following documentation can be

    used to find more information. https://developer.github.com/v3/repos.

 search

        $github->search;

    The search method returns a new instance representative of the API

    search resource requested. This method accepts a list of path segments

    which will be used in the HTTP request. The following documentation can

    be used to find more information.

    https://developer.github.com/v3/search.

 users

        $github->users;

    The users method returns a new instance representative of the API users

    resource requested. This method accepts a list of path segments which

    will be used in the HTTP request. The following documentation can be

    used to find more information. https://developer.github.com/v3/users.

AUTHOR

    Al Newkirk 

COPYRIGHT AND LICENSE

    This software is copyright (c) 2014 by Al Newkirk.

    This is free software; you can redistribute it and/or modify it under

    the same terms as the Perl 5 programming language system itself.