/ 
Net-Twitter-3.01000_01
River stage two • 20 direct dependents • 34 total dependents
/ Net::Twitter::Role::OAuth

NAME

Net::Twitter::Role::OAuth - Net::Twitter role that provides OAuth instead of Basic Authentication

SYNOPSIS

use Net::Twitter;

my $nt = Net::Twitter->new(
    traits          => ['API::REST', 'OAuth'],
    consumer_key    => "YOUR-CONSUMER-KEY",
    consumer_secret => "YOUR-CONSUMER-SECRET",
);

# Do some Authentication work. See EXAMPLES

my $tweets = $nt->friends_timeline;
my $res    = $nt->update({ status => "I CAN HAZ OAUTH!" });

DESCRIPTION

Net::Twitter::Role::OAuth is a Net::Twitter role that provides OAuth authentication instead of the default Basic Authentication.

Note that this client only works with APIs that are compatible to OAuth authentication.

EXAMPLES

Here's how to authorize users as a desktop app mode:

use Net::Twitter;

my $nt = Net::Twitter>new(
    traits          => ['API::REST', 'OAuth'],
    consumer_key    => "YOUR-CONSUMER-KEY",
    consumer_secret => "YOUR-CONSUMER-SECRET",
);

# You'll save the token and secret in cookie, config file or session database
my($access_token, $access_token_secret) = restore_tokens();
if ($access_token && $access_token_secret) {
    $nt->access_token($access_token);
    $nt->access_token_secret($access_token_secret);
}

unless ( $nt->is_authorized ) {
    # The client is not yet authorized: Do it now
    print "Authorize this app at ", $nt->get_authorization_url, " and enter the PIN#\n";

    my $pin = <STDIN>; # wait for input
    chomp $pin;

    my($access_token, $access_token_secret) = $nt->request_access_token($pin);
    save_tokens($access_token, $access_token_secret); # if necessary
}

# Everything's ready

In a web application mode, you need to save the oauth_token and oauth_token_secret somewhere when you redirect the user to the OAuth authorization URL.

sub twitter_authorize : Local {
    my($self, $c) = @_;

    my $nt = Net::Twitter->new(traits => [qw/API::REST OAuth/], %param);
    my $url = $nt->get_authorization_url;

    $c->response->cookies->{oauth} = {
        value => {
            token => $nt->request_token,
            token_secret => $nt->request_token_secret,
        },
    };

    $c->response->redirect($url);
}

And when the user returns back, you'll reset those request token and secret to upgrade the request token to access token.

sub twitter_auth_callback : Local {
    my($self, $c) = @_;

    my %cookie = $c->request->cookies->{oauth}->value;

    my $nt = Net::Twitter::OAuth->new(traits => [qw/API::REST OAuth/], %param);
    $nt->request_token($cookie{token});
    $nt->request_token_secret($cookie{token_secret});

    my($access_token, $access_token_secret)
        = $nt->request_access_token;

    # Save $access_token and $access_token_secret in the database associated with $c->user
}

Later on, you can retrieve and reset those access token and secret before calling any Twitter API methods.

sub make_tweet : Local {
    my($self, $c) = @_;

    my($access_token, $access_token_secret) = ...;

    my $nt = Net::Twitter::OAuth->new(traits => [qw/API::REST OAuth/], %param);
    $nt->access_token($access_token);
    $nt->access_token_secret($access_token_secret);

    # Now you can call any Net::Twitter API methods on $nt
    my $status = $c->req->param('status');
    my $res = $nt->update({ status => $status });
}

METHODS

oauth
$nt->oauth;

Returns Net::Twitter::OAuth::Simple object to deal with getting and setting OAuth tokens.

DELEGATED METHODS

The following method calls are delegated to the internal Net::Twitter::OAuth::Simple object. I.e., these calls are identical:

$nt->authorized;
$nt->oauth->authorized;

See Net::OAuth::Simple and Net::Twitter::OAuth::Simple for full documentation.

authorized

Whether the client has the necessary credentials to be authorized.

Note that the credentials may be wrong and so the request may fail.

request_access_token [PIN]

Request the access token and access token secret for this user.

The user must have authorized this app at the url given by get_authorization_url first.

For desktop applications, the Twitter authorization page will present the user with a PIN number. Prompt the user for the PIN number, and pass it as an argument to request_access_token.

Returns the access token and access token secret but also sets them internally so that after calling this method, you can immediately call API methods requiring authentication.

get_authorization_url

Get the URL used to authorize the user. Returns a URI object.

access_token

Get or set the access token.

access_token_secret

Get or set the access token secret.

request_token

Get or set the request token.

request_token_secret

Get or set the request token secret.

DEPRECATED METHODS

is_authorized

Use authorized instead.

oauth_authorization_url

Use get_authorization_url instead.

oauth_token
$nt->oauth_token($access_token, $access_token_secret);

Use access_token and access_token_seccret instead:

$nt->access_token($access_token);
$nt->access_token_secret($access_token_secret);

ACKNOWLEDGEMENTS

This module was originally authored by Tatsuhiko Miyagawa as Net::Twitter::OAuth, a subclass of the Net::Twitter 2.x. It was refactored into a Moose Role for use in Net::Twitter 3.0 and above by Marc Mims. Many thanks to Tatsuhiko for the original work on both code and documentation.

AUTHORS

Marc Mims <marc@questright.com>

Tatsuhiko Miyagawa <miyagawa@bulknews.net>

LICENSE

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

SEE ALSO

Net::Twitter, Net::Twitter::OAuth::Simple, Net::OAuth::Simple