NAME

Net::GitHub::V2::Users - GitHub Users API

SYNOPSIS

    use Net::GitHub::V2::Users;

    my $user = Net::GitHub::V2::Users->new(
        owner => 'fayland'
    );

DESCRIPTION

http://develop.github.com/p/users.html

For those (authentication required) below, you must set login and token (in https://github.com/account)

    my $user = Net::GitHub::V2::Users->new(
        owner => 'fayland',
        login => 'fayland', token => '54b5197d7f92f52abc5c7149b313cf51', # faked
    );

METHODS

search

    my $results = $user->search( 'fayland' );

user searching

list

    my $repositories = $user->list(); # show the owner in ->new
    my $repositories = $user->list('nothingmuch');
    

list out all the repositories for a user

show

    my $uinfo = $user->show(); # owner in ->new
    my $uinfo = $user->show( 'nothingmuch' );

get extended information on user

update

    $user->update(
        name  => 'Another Name',
        email => 'Another@email.com',
    );

update your users information (authentication required)

possible keys: name, email, blog, company, location

followers

following

    my $followers = $user->followers; # owner in ->new
    my $following = $user->following;

follow

unfollow

    $user->follow( 'nothingmuch' );
    $user->unfollow( 'nothingmuch' );

follow or unfollow users (authentication required)

pub_keys

add_pub_key

remove_pub_key

    $user->add_pub_key( 'keyname', $key );
    my $pub_keys = $user->pub_keys;
    $user->remove_pub_key( $key_id ); # from $pub_keys

Public Key Management (authentication required)

emails

add_email

remove_email

    $user->add_email( 'another@email.com' );
    my $emails = $user->emails;
    $user->remove_email( 'another@email.com' );

Email Address Management (authentication required)

AUTHOR

Fayland Lam, <fayland at gmail.com>

COPYRIGHT & LICENSE

Copyright 2009 Fayland Lam, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.