view release on metacpan or  search on metacpan

README  view on Meta::CPAN

    more optional ones:

   Parameters
    *   user (required)

        The user-name or email of the user the authorization is being
        created against.

    *   password (required)

        The user's password.

    *   scopes

        An ArrayRef of scopes (described "Legal Scopes").

    *   note

        A short note (or reminder) describing what the authorization is for.

    *   note_url

        A link that describes why the authorization has been generated We
        throw an exception on error or failure, and return the structure
        describing the new authorization token (and the token itself, as
        described below) on success.

    *   client_id (required if client_secret is given)

        If requesting an authorization for a specific app, pass its client
        key here.

    *   client_secret (required if client_id is given)

        If requesting an authorization for a specific app, pass its client
        secret here.

   On success...
    A successful return from get_gh_token() will look something like this:

        {
            app => {
                name => "test! (API)",
                url  => "http://developer.github.com/v3/oauth/#oauth-authorizations-api",
            },
            created_at => "2012-12-24T14:28:17Z",
            id         => xxxxxxx, # an integer > 0
            note       => "test!",
            note_url   => undef,
            scopes     => ["public_repo"],
            token      => "****************************************",
            updated_at => "2012-12-24T14:28:17Z",
            url        => "https://api.github.com/authorizations/xxxxxxx",
        }

    The "token" slot is probably the bit you want.

   On failure/error...
    On failure, we confess() our sins:

        Failed: 401/Unauthorized / Bad credentials ...

    That is, we "confess" in Carp with the status code, status message, and
    the message returned from GitHub itself.

  legal_scopes
    Returns a list of legal scope names. (See get_gh_token() doc for the
    list)

  is_legal_scope('scope_name')
    Returns true if the scope name given is a legal scope.

MANAGING AUTHORIZATIONS
    All of a user's GitHub authorization tokens can be viewed and revoked on
    their GitHub Applications <https://github.com/settings/applications>
    account page.

    Users may revoke tokens at any time through GitHub proper.

SSL VALIDATION
    We instruct our user-agent (HTTP::Tiny in this case) to validate the
    remote server's certificate, as described in "SSL-SUPPORT" in
    HTTP::Tiny. (Essentially, using Mozilla::CA).

    While this satisfies the "let's be cautious" alarms in the author's
    head, this may be too paranoid or not paranoid enough for you. If so,
    please file an issue or pull request and we'll work something out.

LIMITATIONS
    This package currently has no capabilities for deleting, altering, or
    otherwise doing anything with tokens outside of creating them.

SEE ALSO
    Please see those modules/websites for more information related to this
    module.

    *   The GitHub OAuth API reference
        <http://developer.github.com/v3/oauth/#create-a-new-authorization>

    *   Net::GitHub

    *   Pithub

SOURCE
    The development version is on github at
    <http://github.com/RsrchBoy/github-authorization> and may be cloned from
    <git://github.com/RsrchBoy/github-authorization.git>

BUGS
    Please report any bugs or feature requests on the bugtracker website
    https://github.com/RsrchBoy/github-authorization/issues

    When submitting a bug or request, please include a test-file or a patch
    to an existing test-file that illustrates the bug or desired feature.

AUTHOR
    Chris Weyl <cweyl@alumni.drew.edu>

COPYRIGHT AND LICENSE
    This software is Copyright (c) 2012 by Chris Weyl.