Pithub::Users::Followers(3)

NAME
Pithub::Users::Followers - Github v3 User Followers API

VERSION
version 0.01043

METHODS

  follow

•   Follow a user

        PUT /user/following/:user

    Examples:

        my $f = Pithub::Users::Followers->new( token => 'b3c62c6' );
        my $result = $f->follow( user => 'plu' );

  is_following

•   Check if the authenticated user is following another given user

        GET /user/following/:user

    Examples:

        my $f = Pithub::Users::Followers->new( token => 'b3c62c6' );
        my $result = $f->is_following( user => 'rafl' );

        if ( $result->is_success ) {
            print "plu is following rafl\n";
        }
        elsif ( $result->code == 404 ) {
            print "plu is not following rafl\n";
        }

  list

•   List a user's followers:

        GET /users/:user/followers

    Examples:

        my $f = Pithub::Users::Followers->new;
        my $result = $f->list( user => 'plu' );

•   List the authenticated user's followers:

        GET /user/followers

    Examples:

        my $f = Pithub::Users::Followers->new( token => 'b3c62c6' );
        my $result = $f->list;

  list_following

•   List who a user is following:

        GET /users/:user/following

    Examples:

        my $f = Pithub::Users::Followers->new;
        my $result = $f->list_following( user => 'plu' );

•   List who the authenticated user is following:

        GET /user/following

    Examples:

        my $f = Pithub::Users::Followers->new( token => 'b3c62c6' );
        my $result = $f->list_following;

  unfollow

•   Unfollow a user

        DELETE /user/following/:user

    Examples:

        my $f = Pithub::Users::Followers->new;
        my $result = $f->unfollow( user => '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.