Pithub::Events(3)

NAME
Pithub::Events - Github v3 Events API

VERSION
version 0.01043

METHODS

  issue

•   List issue events for a repository

        GET /repos/:user/:repo/issues/events

    Examples:

        my $e      = Pithub::Events->new;
        my $result = $e->issue(
            user => 'plu',
            repo => 'Pithub',
        );

  network

•   List public events for a network of repositories

        GET /networks/:user/:repo/events

    Examples:

        my $e      = Pithub::Events->new;
        my $result = $e->network(
            user => 'plu',
            repo => 'Pithub',
        );

  org

•   List public events for an organization

        GET /orgs/:org/events

    Examples:

        my $e = Pithub::Events->new;
        my $result = $e->org( org => 'CPAN-API' );

  org_for_user

•   List events for an organization

        GET /users/:user/events/orgs/:org

    Examples:

        my $e = Pithub::Events->new;
        my $result = $e->org(
            org  => 'CPAN-API',
            user => 'plu',
        );

  public

•   List public events

        GET /events

    Examples:

        my $e      = Pithub::Events->new;
        my $result = $e->public;

  repos

•   List repository events

        GET /repos/:user/:repo/events

    Examples:

        my $e      = Pithub::Events->new;
        my $result = $e->repos(
            user => 'plu',
            repo => 'Pithub',
        );

  user_performed

•   List events performed by a user

        GET /users/:user/events

    If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.

    Examples:

        my $e = Pithub::Events->new;
        my $result = $e->user_performed( user => 'plu' );

        # List public events performed by a user
        my $e      = Pithub::Events->new;
        my $result = $e->user_performed(
            user   => 'plu',
            public => 1,
        );

  user_received

•   List events that a user has received

        GET /users/:user/received_events

    These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.

    Examples:

        my $e = Pithub::Events->new;
        my $result = $e->user_received( user => 'plu' );

        # List public events that a user has received
        my $e      = Pithub::Events->new;
        my $result = $e->user_received(
            user   => 'plu',
            public => 1,
        );

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.