NAME

Pithub::Users::Followers

VERSION

version 0.01000

METHODS

follow

• Follow a user

      PUT /user/following/:user

Examples:

    $p = Pithub->new( token => 'b3c62c6' );
    $result = $p->users->followers->follow( user => 'plu' );

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

is_following

• Check if the authenticated user is following another given user

      GET /user/following/:user

Examples:

    $p = Pithub->new( token => 'b3c62c6' );
    $result = $p->users->followers->is_following( user => 'rafl' );

    $f = Pithub::Users::Followers->new( token => 'b3c62c6' );
    $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

• List the authenticated user's followers:

      GET /user/followers

Examples:

    $p = Pithub->new;
    $result = $p->users->followers->list( user => 'plu' );

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

    $p = Pithub->new( token => 'b3c62c6' );
    $result = $p->users->followers->list;

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

list_following

• List who a user is following:

      GET /users/:user/following

• List who the authenicated user is following:

      GET /user/following

Examples:

    $p = Pithub->new;
    $result = $p->users->followers->list_following( user => 'plu' );

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

    $p = Pithub->new( token => 'b3c62c6' );
    $result = $p->users->followers->list_following;

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

unfollow

• Unfollow a user

      DELETE /user/following/:user

Examples:

    $p = Pithub->new;
    $result = $p->users->followers->unfollow( user => 'plu' );

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