############################################################################## # Net::Twitter - Perl OO interface to www.twitter.com # v2.12 # Copyright (c) 2009 Chris Thompson ############################################################################## package Net::Twitter; $VERSION = "2.12"; use 5.005; use strict; use URI::Escape; use JSON::Any 1.19; use LWP::UserAgent 2.032; use Carp; sub new { my $class = shift; my %conf; if ( scalar @_ == 1 ) { if ( ref $_[0] ) { %conf = %{ $_[0] }; } else { croak "Bad argument \"" . $_[0] . "\" passed, please pass a hashref containing config values."; } } else { %conf = @_; } ### Add quick identica => 1 switch if ( ( defined $conf{identica} ) and ( $conf{identica} ) ) { $conf{apiurl} = 'http://identi.ca/api'; $conf{apihost} = 'identi.ca:80'; $conf{apirealm} = 'Laconica API'; } ### Set to default twitter values if not $conf{apiurl} = 'http://twitter.com' unless defined $conf{apiurl}; $conf{apihost} = 'twitter.com:80' unless defined $conf{apihost}; $conf{apirealm} = 'Twitter API' unless defined $conf{apirealm}; ### Set default Twitter search API URL $conf{searchapiurl} = 'http://search.twitter.com/search.json' unless defined $conf{searchapiurl}; ### Set useragents, HTTP Headers, source codes. $conf{useragent} = "Net::Twitter/$Net::Twitter::VERSION (PERL)" unless defined $conf{useragent}; $conf{clientname} = 'Perl Net::Twitter' unless defined $conf{clientname}; $conf{clientver} = $Net::Twitter::VERSION unless defined $conf{clientver}; $conf{clienturl} = "http://www.net-twitter.info" unless defined $conf{clienturl}; $conf{source} = 'twitterpm' unless defined $conf{source}; ### Make it say "From Net:Twitter" ### Allow specifying a class other than LWP::UA $conf{no_fallback} = 0 unless defined $conf{no_fallback}; $conf{useragent_class} ||= 'LWP::UserAgent'; eval "use $conf{useragent_class}"; if ($@) { if ( ( defined $conf{no_fallback} ) and ( $conf{no_fallback} ) ) { croak $conf{useragent_class} . " failed to load, and no_fallback enabled. Terminating."; } carp $conf{useragent_class} . " failed to load, reverting to LWP::UserAgent"; $conf{useragent_class} = "LWP::UserAgent"; } ### Create an LWP Object to work with if ( ( $conf{useragent_args} ) and ( ref $conf{useragent_args} ) ) { $conf{ua} = $conf{useragent_class}->new( %{$conf{useragent_args}} ); } else { $conf{ua} = $conf{useragent_class}->new(); } $conf{username} = $conf{user} if defined $conf{user}; $conf{password} = $conf{pass} if defined $conf{pass}; $conf{ua}->credentials( $conf{apihost}, $conf{apirealm}, $conf{username}, $conf{password} ); $conf{ua}->agent( $conf{useragent} ); $conf{ua}->default_header( "X-Twitter-Client:" => $conf{clientname} ); $conf{ua}->default_header( "X-Twitter-Client-Version:" => $conf{clientver} ); $conf{ua}->default_header( "X-Twitter-Client-URL:" => $conf{clienturl} ); $conf{ua}->env_proxy(); ### Twittervision support. Is this still necessary? $conf{twittervision} = '0' unless defined $conf{twittervision}; $conf{tvurl} = 'http://api.twittervision.com' unless defined $conf{tvurl}; $conf{tvhost} = 'api.twittervision.com:80' unless defined $conf{tvhost}; $conf{tvrealm} = 'Web Password' unless defined $conf{tvrealm}; if ( $conf{twittervision} ) { $conf{tvua} = $conf{useragent_class}->new(); $conf{tvua}->credentials( $conf{tvhost}, $conf{tvrealm}, $conf{username}, $conf{password} ); $conf{tvua}->agent( $conf{useragent} ); $conf{tvua}->default_header( "X-Twitter-Client:" => $conf{clientname} ); $conf{tvua}->default_header( "X-Twitter-Client-Version:" => $conf{clientver} ); $conf{tvua}->default_header( "X-Twitter-Client-URL:" => $conf{clienturl} ); $conf{tvua}->env_proxy(); } $conf{skip_arg_validation} = 0 unless defined $conf{skip_arg_validation}; $conf{die_on_validation} = 0 unless defined $conf{die_on_validation}; $conf{error_return_val} = ( ( defined $conf{arrayref_on_error} ) and ( $conf{arrayref_on_error} ) ) ? [] : undef; $conf{response_error} = undef; $conf{response_code} = undef; $conf{response_method} = undef; return bless {%conf}, $class; } ### Return a shallow copy of the object to allow error handling when used in ### Parallel/Async setups like POE. Set response_error to undef to prevent ### spillover, just in case. sub clone { my $self = shift; bless { %{$self}, response_error => $self->{error_return_val} }; } ### Change the credentials sub credentials { my ( $self, $username, $password, $apihost, $apirealm ) = @_; $apirealm ||= 'Twitter API'; $apihost ||= 'twitter.com:80'; $self->{ua}->credentials( $apihost, $apirealm, $username, $password ); } sub get_error { my $self = shift; my $response = eval { JSON::Any->jsonToObj( $self->{response_error} ) }; if ( !defined $response ) { $response = { request => undef, error => "TWITTER RETURNED ERROR MESSAGE BUT PARSING OF THE JSON RESPONSE FAILED - " . $self->{response_error} }; } return $response; } sub http_code { my $self = shift; return $self->{response_code}; } sub http_message { my $self = shift; return $self->{response_message}; } sub update_twittervision { my ( $self, $location ) = @_; my $response; if ( $self->{twittervision} ) { my $tvreq = $self->{tvua} ->post( $self->{tvurl} . "/user/update_location.json", [ location => uri_escape($location) ] ); if ( $tvreq->content ne "User not found" ) { $self->{response_code} = $tvreq->code; $self->{response_message} = $tvreq->message; $self->{response_error} = $tvreq->content; if ( $tvreq->is_success ) { $response = eval { JSON::Any->jsonToObj( $tvreq->content ) }; if ( !defined $response ) { $self->{response_error} = "TWITTERVISION RETURNED SUCCESS BUT PARSING OF THE RESPONSE FAILED - " . $tvreq->content; } } } } return $response; } sub search { my $self = shift; my $args = shift; my $url = $self->{searchapiurl} . "?"; my $retval; ### Return if no args specified. if ( !defined($args) ) { carp "No query string specified"; return $self->{error_return_val}; } ### If the first argument passed is a string, convert it into a hashref ### with the arg assigned to the key "q" if ( !ref($args) ) { $args = { "q" => $args }; } ### Allow use of "query", but use the argument "q" ### This has the side effect of overwriting q with query if ( defined $args->{query} ) { if ( defined $args->{q} ) { carp "Both 'q' and 'query' specified, using value of 'query'."; } $args->{q} = delete( $args->{query} ); } ### For backcompat with Br3nda's N::T::Search, allow a hashref as a second ### argument. Here we just combine with the previous arg, so there's only ### one hashref to deal with my $otherargs = shift; if ( ref($otherargs) eq "HASH" ) { if ( ( defined $otherargs->{q} ) || ( defined $otherargs->{query} ) ) { carp "Specifed a query both as a plain text first arg and in the hashref second arg."; carp "Using query from first arg"; } $otherargs->{"q"} = $args->{"q"}; $args = $otherargs; } ### Make a string out of the args to append to the URL. foreach my $argname ( sort keys %{$args} ) { # drop arguments with undefined values next unless defined $args->{$argname}; $url .= "&" unless substr( $url, -1 ) eq "?"; $url .= $argname . "=" . uri_escape( $args->{$argname} ); } ### Make the request, store the results. my $req = $self->{ua}->get($url); $self->{response_code} = $req->code; $self->{response_message} = $req->message; $self->{response_error} = $req->content; undef $retval; ### Trap a case where twitter could return a 200 success but give up badly formed JSON ### which would cause it to die. This way it simply assigns undef to $retval ### If this happens, response_code, response_message and response_error aren't going to ### have any indication what's wrong, so we prepend a statement to request_error. if ( $req->is_success ) { $retval = eval { JSON::Any->jsonToObj( $req->content ) }; if ( !defined $retval ) { $self->{response_error} = "TWITTER RETURNED SUCCESS BUT PARSING OF THE RESPONSE FAILED - " . $req->content; return $self->{error_return_val}; } } return $retval; } ### Load method data into %apicalls at runtime. BEGIN { ### Have to turn strict refs off in order to insert subrefs by value. no strict "refs"; *{_get_apicalls} = sub { my $api = { "public_timeline" => { "blankargs" => 1, "post" => 0, "uri" => "/statuses/public_timeline", "args" => {}, }, "friends_timeline" => { "blankargs" => 1, "post" => 0, "uri" => "/statuses/friends_timeline", "args" => { "since" => 0, "since_id" => 0, "count" => 0, "page" => 0, }, }, "user_timeline" => { "blankargs" => 1, "post" => 0, "uri" => "/statuses/user_timeline/ID", "args" => { "id" => 0, "since" => 0, "since_id" => 0, "count" => 0, "page" => 0, }, }, "show_status" => { "blankargs" => 0, "post" => 0, "uri" => "/statuses/show/ID", "args" => { "id" => 1, }, }, "update" => { "blankargs" => 0, "post" => 1, "uri" => "/statuses/update", "args" => { "status" => 1, "in_reply_to_status_id" => 0, "source" => 0, }, }, "replies" => { "blankargs" => 1, "post" => 0, "uri" => "/statuses/replies", "args" => { "page" => 0, "since" => 0, "since_id" => 0, }, }, "destroy_status" => { "blankargs" => 0, "post" => 1, "uri" => "/statuses/destroy/ID", "args" => { "id" => 1, }, }, "friends" => { "blankargs" => 1, "post" => 0, "uri" => "/statuses/friends/ID", "args" => { "id" => 0, "page" => 0, "since" => 0, }, }, "followers" => { "blankargs" => 1, "post" => 0, "uri" => "/statuses/followers", "args" => { "id" => 0, "page" => 0, }, }, "show_user" => { "blankargs" => 0, "post" => 0, "uri" => "/users/show/ID", "args" => { "id" => 1, "email" => 1, }, }, "direct_messages" => { "blankargs" => 1, "post" => 0, "uri" => "/direct_messages", "args" => { "since" => 0, "since_id" => 0, "page" => 0, }, }, "sent_direct_messages" => { "blankargs" => 1, "post" => 0, "uri" => "/direct_messages/sent", "args" => { "since" => 0, "since_id" => 0, "page" => 0, }, }, "new_direct_message" => { "blankargs" => 0, "post" => 1, "uri" => "/direct_messages/new", "args" => { "user" => 1, "text" => 1, }, }, "destroy_direct_message" => { "blankargs" => 0, "post" => 1, "uri" => "/direct_messages/destroy/ID", "args" => { "id" => 1, }, }, "create_friend" => { "blankargs" => 0, "post" => 1, "uri" => "/friendships/create/ID", "args" => { "id" => 1, "follow" => 0, }, }, "destroy_friend" => { "blankargs" => 0, "post" => 1, "uri" => "/friendships/destroy/ID", "args" => { "id" => 1, }, }, "relationship_exists" => { "blankargs" => 0, "post" => 0, "uri" => "/friendships/exists", "args" => { "user_a" => 1, "user_b" => 1, }, }, "friends_ids" => { "blankargs" => 1, "post" => 0, "uri" => "/friends/ids/ID", "args" => { "id" => 0, }, }, "followers_ids" => { "blankargs" => 1, "post" => 0, "uri" => "/followers/ids/ID", "args" => { "id" => 0, }, }, "verify_credentials" => { "blankargs" => 1, "post" => 0, "uri" => "/account/verify_credentials", "args" => {}, }, "end_session" => { "blankargs" => 1, "post" => 1, "uri" => "/account/end_session", "args" => {}, }, "update_profile" => { "blankargs" => 0, "post" => 1, "uri" => "/account/update_profile", "args" => { "name" => 0, "email" => 0, "url" => 0, "location" => 0, "description" => 0, }, }, "update_profile_colors" => { "blankargs" => 0, "post" => 1, "uri" => "/account/update_profile_colors", "args" => { "profile_background_color" => 0, "profile_text_color" => 0, "profile_link_color" => 0, "profile_sidebar_fill_color" => 0, "profile_sidebar_border_color" => 0, }, }, "update_profile_image" => { "blankargs" => 0, "post" => 1, "uri" => "/account/update_profile_image", "args" => { "image" => 1, }, }, "update_profile_background_image" => { "blankargs" => 0, "post" => 1, "uri" => "/account/update_profile_background_image", "args" => { "image" => 1, }, }, "update_delivery_device" => { "blankargs" => 0, "post" => 1, "uri" => "/account/update_delivery_device", "args" => { "device" => 1, }, }, "rate_limit_status" => { "blankargs" => 1, "post" => 0, "uri" => "/account/rate_limit_status", "args" => {}, }, "favorites" => { "blankargs" => 1, "post" => 0, "uri" => "/favorites", "args" => { "id" => 0, "page" => 0, }, }, "create_favorite" => { "blankargs" => 0, "post" => 1, "uri" => "/favorites/create/ID", "args" => { "id" => 1, }, }, "destroy_favorite" => { "blankargs" => 0, "post" => 1, "uri" => "/favorites/destroy/ID", "args" => { "id" => 1, }, }, "enable_notifications" => { "blankargs" => 0, "post" => 1, "uri" => "/notifications/follow/ID", "args" => { "id" => 1, }, }, "disable_notifications" => { "blankargs" => 0, "post" => 1, "uri" => "/notifications/leave/ID", "args" => { "id" => 1, }, }, "create_block" => { "blankargs" => 0, "post" => 1, "uri" => "/blocks/create/ID", "args" => { "id" => 1, }, }, "destroy_block" => { "blankargs" => 0, "post" => 1, "uri" => "/blocks/destroy/ID", "args" => { "id" => 1, }, }, "test" => { "blankargs" => 1, "post" => 0, "uri" => "/help/test", "args" => {}, }, "downtime_schedule" => { "blankargs" => 100, "post" => 0, "uri" => "/help/downtime_schedule", "args" => {}, }, }; }; ### For each method name in %apicalls insert a stub method to handle request. my %apicalls = %{ _get_apicalls() }; foreach my $methodname ( keys %apicalls ) { *{$methodname} = sub { my $self = shift; my $args = shift; my $whoami; my $url = $self->{apiurl}; my $seen_id = 0; my $retval; ### Store the method name, since a sub doesn't know it's name without ### a bit of work and more dependancies than are really prudent. eval { $whoami = $methodname }; ### Get this method's definition from the table my $method_def = $apicalls{$whoami}; ### Set the correct request type for this method my $reqtype = ( $method_def->{post} ) ? "POST" : "GET"; ### Check if no args sent and args are required. if ( ( !defined $args ) && ( !$method_def->{blankargs} ) ) { if ( $self->{die_on_validation} ) { croak "The method $whoami requires arguments and none specified. Terminating."; } else { carp "The method $whoami requires arguments and none specified. Discarding request"; $self->{response_error} = { "request" => $url, "error" => "The method $whoami requires arguments and none specified." }; } return $self->{error_return_val}; } ### For backwards compatibility we need to handle the user handing a single, scalar ### arg in, instead of a hashref. Since the methods that allowed this in 1.xx have ### different defaults, use a bit of logic to stick the value in the right place. my %idsubs = map { $_ => 1 } qw ( create_block destroy_block friends show_user create_friend destroy_friend destroy_direct_message show_status create_favorite destroy_favorite destroy_status disable_notifications enable_notifications favorites followers user_timeline friends_ids followers_ids ); if ( ( !ref($args) ) && ( defined $args ) ) { if ( $whoami eq "relationship_exists" ) { my $user_b = shift; $args = { "user_a" => $args, "user_b" => $user_b }; } elsif ( $whoami eq "update" ) { $args = { "status" => $args }; } elsif ( $whoami eq "replies" ) { $args = { "page" => $args }; } elsif ( exists $idsubs{$whoami} ) { $args = { "id" => $args }; } elsif ( $whoami =~ m/update_profile_image|update_profile_background_image/ ) { $args = { "image" => $args }; } elsif ( $whoami eq "update_delivery_device" ) { $args = { "device" => $args }; } elsif ( $whoami eq "update_location" ) { $args = { "location" => $args }; } else { ### $args is not a hashref and $whoami is not one of the legacy ### subs, so we punt. if ( $self->{die_on_validation} ) { croak "Argument is not a HASHREF. Terminating."; } else { carp "Argument is not a HASHREF. Discarding request"; $self->{response_error} = { "request" => $url, "error" => "Argument is not a HASHREF." }; } return $self->{error_return_val}; } } ### Handle source arg for update method. if ( $whoami eq "update" ) { $args->{source} = $self->{source}; } ### Create the URL. If it ends in /ID it needs the id param substituted ### into the URL and not as an arg. if ( ( my $uri = $method_def->{uri} ) =~ s|/ID|| ) { if ( defined $args->{id} ) { $url .= $uri . "/" . delete( $args->{id} ) . ".json"; $seen_id++; } elsif ( $whoami eq "show_user" ) { ### show_user requires either id or email, this workaround checks that email is ### passed if id is not. if ( !defined $args->{email} ) { carp "Either id or email is required by show_user, discarding request."; $self->{response_error} = { "request" => $method_def->{uri}, "error" => "Either id or email is required by show_user, discarding request.", }; return $self->{error_return_val}; } $url .= "$uri.json"; } else { ### No id field is found but may be optional. If so, skip id in the URL and just ### tack on .json, otherwise warn and return undef if ( $method_def->{args}->{id} ) { carp "The field id is required and not specified"; $self->{response_error} = { "request" => $method_def->{uri}, "error" => "The field id is required and not specified", }; return $self->{error_return_val}; } else { $url .= $uri . ".json"; } } } else { $url .= $uri . ".json"; } ### Validate args. Don't validate if $args is undef, we've already checked that ### undef is OK to pass up above if ( defined $args ) { foreach my $argname ( sort keys %{ $method_def->{args} } ) { if ( $whoami eq "show_user" ) { ### We already validated the wonky args to show_user above. next; } if ( ( $argname eq "id" ) and ($seen_id) ) { ### We've already handled id by putting it in the url, it doesn't ### go in the args. next; } if ( !$self->{skip_arg_validation} ) { if ( ( $method_def->{args}->{$argname} ) and ( !defined $args->{$argname} ) ) { if ( $self->{die_on_validation} ) { croak "The field $argname is required and not specified. Terminating."; } else { carp "The field $argname is required and not specified, discarding request."; $self->{response_error} = { "request" => $url, "error" => "The field $argname is required and not specified" }; } return $self->{error_return_val}; } } } } ### Final Validation of $args, Drop args that are named but undefined, and complain when ### bogus args are passed. if ( !$self->{skip_arg_validation} ) { foreach my $argkey ( sort keys %{$args} ) { if ( !defined $args->{$argkey} ) { carp "Argument $argkey specified as undef, discarding."; $self->{response_error} = { "request" => $url, "error" => "Argument $argkey specified as undef." }; delete $args->{$argkey}; } elsif ( !exists $method_def->{args}->{$argkey} ) { carp "Unknown argument $argkey passed, discarding."; $self->{response_error} = { "request" => $url, "error" => "Unknown argument $argkey passed." }; delete $args->{$argkey}; } } } ### Send the LWP request my $req; if ( $reqtype eq 'POST' ) { $req = $self->{ua}->post( $url, $args ); } else { my $uri = URI->new($url); $uri->query_form($args); $req = $self->{ua}->get($uri); } $self->{response_code} = $req->code; $self->{response_message} = $req->message; $self->{response_error} = $req->content; undef $retval; if ( $req->is_success ) { $retval = eval { JSON::Any->jsonToObj( $req->content ) }; ### Trap a case where twitter could return a 200 success but give up badly formed JSON ### which would cause it to die. This way it simply assigns undef to $retval ### If this happens, response_code, response_message and response_error aren't going to ### have any indication what's wrong, so we prepend a statement to request_error. if ( !defined $retval ) { $self->{response_error} = "TWITTER RETURNED SUCCESS BUT PARSING OF THE RESPONSE FAILED - " . $req->content; return $self->{error_return_val}; } } return $retval; } } } 1; __END__ =head1 NAME Net::Twitter - Perl interface to twitter.com =head1 VERSION This document describes Net::Twitter version 2.12 =head1 SYNOPSIS #!/usr/bin/perl use Net::Twitter; my $twit = Net::Twitter->new({username=>"myuser", password=>"mypass" }); my $result = $twit->update({status => "My current Status"}); my $twit->credentials("otheruser", "otherpass"); my $result = $twit->update({status => "Status for otheruser"}); my $result = $twitter->search('Albi the racist dragon'); foreach my $tweet (@{ $results }) { my $speaker = $tweet->{from_user}; my $text = $tweet->{text}; my $time = $tweet->{created_at}; print "$time <$speaker> $text\n"; } my $steve = $twitter->search('Steve'); $twitter->update($steve .'? Who is steve?'); =head1 DESCRIPTION http://www.twitter.com provides a web 2.0 type of ubiquitous presence. This module allows you to set your status, as well as review the statuses of your friends. You can view the latest status of Net::Twitter on it's own twitter timeline at http://twitter.com/net_twitter =head1 METHODS AND ARGUMENTS Listed below are the methods available through the object. Please note that any method that takes a hashref as an argument must be called in the form: $twit->method({arg => "value"}); and not $twit->method(arg => "value"); If the curly brackets around the arguments are missing, the code which implements the convenience methods allowing you to specify a single argument as a string will interpret "arg" as your argument. =over =item C You must supply a hash containing the configuration for the connection. Valid configuration items are: =over =item C Username of your account at twitter.com. This is usually your email address. "user" is an alias for "username". REQUIRED. =item C Password of your account at twitter.com. "pass" is an alias for "password" REQUIRED. =item C OPTIONAL: Sets the User Agent header in the HTTP request. If omitted, this will default to "Net::Twitter/$Net::Twitter::Version (Perl)" =item C OPTIONAL: An L compatible class, e.g., L. If omitted, this will default to L. =item C OPTIONAL: A hashref passed to this option will be passed along to the UserAgent C call to specify its configuration. This will pass to whatever class is passed in C, if any. See the POD for L for details. NOTE: Any value passed in this hashref for "agent" will be overwritten. If setting the useragent is necessary, use the C option to C =item C OPTIONAL: If a C is specified but fails to load, the default behavior is to warn and fall back to using regular L. If C is set to a boolean true value, the C method will cause the code to C =item C OPTIONAL: Sets the source name, so messages will appear as "from " instead of "from web". Defaults to displaying "Perl Net::Twitter". Note: see Twitter FAQ, your client source needs to be included at twitter manually. This value will be a code which is assigned to you by Twitter. For example, the default value is "twitterpm", which causes Twitter to display the "from Perl Net::Twitter" in your timeline. Twitter claims that specifying a nonexistant code will cause the system to default to "from web". If you don't have a code from twitter, don't set one. =item C OPTIONAL: Sets the X-Twitter-Client-Name: HTTP Header. If omitted, this defaults to "Perl Net::Twitter" =item C OPTIONAL: Sets the X-Twitter-Client-Version: HTTP Header. If omitted, this defaults to the current Net::Twitter version, $Net::Twitter::VERSION. =item C OPTIONAL: Sets the X-Twitter-Client-URL: HTTP Header. If omitted, this defaults to C. =item C OPTIONAL. The URL of the API for twitter.com. This defaults to C if not set. =item C =item C OPTIONAL: If you do point to a different URL, you will also need to set C and C so that the internal LWP can authenticate. C defaults to C. C defaults to C. =item C OPTIONAL: Passing a true value for identica to new() will preset values for C, C and C which will point at the http://identi.ca twitter compatible API. All methods in Net::Twitter work as documented, except where listed in the identica/laconica documentation at: L For simplicity, you can also use L in your script instead of Net::Twitter, which will default to identica being set to true. =item C OPTIONAL: If the C argument is passed with a true value, the module will enable use of the L API. If enabled, the C method will include relevant location data in its response hashref. Also, the C method will allow setting of the current location. =item C OPTIONAL: Beginning in 2.00, Net::Twitter will validate arguments passed to the various API methods, flagging required args that were not passed, and discarding args passed that do not exist in the API specification. Passing a boolean True for skip_arg_validation into new() will skip this validation process entirely and allow requests to proceed regardless of the args passed. This defaults to false. =item C OPTIONAL: In the event that the arguments passed to a method do not pass the validation process listed above, the default action will be to warn the user, make the error readable through the get_error method listed below, and to return undef to the caller. Passing a boolean true value for die_on_validation to new() will change this behavior to simply executing a die() with the appropriate error message. This defaults to false. =item C OPTIONAL: By default any methods which find an error, whether from twitter or from bad args, will return undef. Passing C as a boolean TRUE to new() will cause all error states to return an empty arrayref instead. As most successful responses are in the form of arrayrefs, this will cause a uniform response type for all calls. All error messages and codes are still available with methods such as C. =back =item C Returns a shallow copy of the Net::Twitter object. This can be used when Net::Twitter is used in a Parallel or Asynchronous framework to enable easier access to returned error values. All clones share the same LWP::UserAgent object, so calling C will change the login credentials of all clones. =item C Change the credentials for logging into twitter. This is helpful when managing multiple accounts. C and C are optional and will default to the existing settings if omitted. =item C Returns the HTTP response code of the most recent request. =item C Returns the HTTP response message of the most recent request. =item C If the last request returned an error, the hashref containing the error message can be retrieved with C. This will provide some additional debugging information in addition to the http code and message above. =back =head2 STATUS METHODS =over =item C Set your current status. This returns a hashref containing your most recent status. Returns undef if an error occurs. The method accepts a hashref containing one or two arguments. =over =item C REQUIRED. The text of your status update. =item C OPTIONAL. The ID of an existing status that the status to be posted is in reply to. This implicitly sets the in_reply_to_user_id attribute of the resulting status to the user ID of the message being replied to. Invalid/missing status IDs will be ignored. =back =item C If the C argument is passed to C when the object is created, this method will update your location setting at twittervision.com. If the C arg is not set at object creation, this method will return an empty hashref, otherwise it will return a hashref containing the location data. =item C Returns status of a single tweet. The status' author will be returned inline. The argument is the ID or email address of the twitter user to pull, and is REQUIRED. This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". =item C Destroys the status specified by the required ID parameter. The authenticating user must be the author of the specified status. This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". =item C This returns an arrayref to an array of hashrefs, containing the 20 (or more) posts from either the authenticating user (if no argument is passed), or from a specific user if the id field is passed in a hashref. Accepts an optional argument of a hashref: =over =item C OPTIONAL: ID or email address of a user other than the authenticated user, in order to retrieve that user's user_timeline. =item C OPTIONAL: Narrows the returned results to just those statuses created after the specified HTTP-formatted date. =item C OPTIONAL: Narrows the returned results to just those statuses created after the specified ID. =item C OPTIONAL: Narrows the returned results to a certain number of statuses. This is limited to 200. =item C OPTIONAL: Gets the 20 next most recent statuses from the authenticating user and that user's friends, eg "page=3". =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". If passed as a string, no other args can be specified. =item C This returns an arrayref to an array of hashrefs, containing the information and status of each of the last 20 posts by all non-private twitter users. =item C Returns the 20 most recent statuses posted from the authenticating user and that user's friends. It's also possible to request another user's friends_timeline via the id parameter below. If called with no arguments, returns the friends' timeline for the authenticating user. Accepts an optional hashref as an argument: =over =item C OPTIONAL: Narrows the returned results to just those statuses created after the specified HTTP-formatted date. =item C OPTIONAL: Narrows the returned results to just those statuses created after the specified ID. =item C Narrows the returned results to a certain number of statuses. This is limited to 200. =item C Gets the 20 next most recent statuses from the authenticating user and that user's friends, eg "page=3". =back =item C This returns an arrayref to an array of hashrefs, containing the information and status of each of the last 20 replies (status updates prefixed with @username posted by users who are friends with the user being replied to) to the authenticating user. =over =item C OPTIONAL: Narrows the returned results to just those replies created after the specified HTTP-formatted date, up to 24 hours old. =item C OPTIONAL: Returns only statuses with an ID greater than (that is, more recent than) the specified ID. =item C OPTIONAL: Gets the 20 next most recent replies. =back =back =head2 USER METHODS =over =item C This returns an arrayref to an array of hashrefs. Each hashref contains the information and status of those you have marked as friends in twitter. Returns undef if an error occurs. Takes a hashref as an arg: =over =item C OPTIONAL: Narrows the returned results to just those friendships created after the specified HTTP-formatted date, up to 24 hours old. =item C OPTIONAL: User id or email address of a user other than the authenticated user, in order to retrieve that user's friends. =item C OPTIONAL: Gets the 100 next most recent friends, eg "page=3". =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". If passed as a string, no other args can be specified. =item C his returns an arrayref to an array of hashrefs. Each hashref contains the information and status of those who follow your status in twitter. Returns undef if an error occurs. If called without an argument returns the followers for the authenticating user, but can pull followers for a specific ID. Accepts an optional hashref for arguments: =over =item C OPTIONAL: The ID or screen name of the user for whom to request a list of followers. =item C OPTIONAL: Retrieves the next 100 followers. =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". If passed as a string, no other args can be specified. =item C Returns a hashref containing extended information of a single user. The argument is a hashref containing either the user's ID or email address. It is required to pass either one or the other, but not both: =over =item C The ID or screen name of the user. =item C The email address of the user. If C is specified, C is ignored. =back If the C argument is passed to C when the object is created, this method will include the location information for the user from twittervision.com, placing it inside the returned hashref under the key C. This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". If passed as a string, no other args can be specified. =back =head2 DIRECT MESSAGE METHODS =over =item C Returns a list of the direct messages sent to the authenticating user. Accepts an optional hashref for arguments: =over =item C OPTIONAL: Retrieves the 20 next most recent direct messages. =item C OPTIONAL: Narrows the returned results to just those statuses created after the specified HTTP-formatted date. =item C OPTIONAL: Narrows the returned results to just those statuses created after the specified ID. =back =item C Returns a list of the direct messages sent by the authenticating user. Accepts an optional hashref for arguments: =over =item C OPTIONAL: Retrieves the 20 next most recent direct messages. =item C OPTIONAL: Narrows the returned results to just those statuses created after the specified HTTP-formatted date. =item C OPTIONAL: Narrows the returned results to just those statuses created after the specified ID. =back =item C Sends a new direct message to the specified user from the authenticating user. REQUIRES an argument of a hashref: =over =item C REQUIRED: ID or email address of user to send direct message to. =item C REQUIRED: Text of direct message. =back =item C Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message. This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". =back =head2 FRIENDSHIP METHODS =over =item C Befriends the user specified in the id parameter as the authenticating user. Returns a hashref containing the befriended user's information when successful. =over =item C REQUIRED. The ID or screen name of the user to befriend. =item C OPTIONAL. Enable notifications for the target user in addition to becoming friends. =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". If passed as a string, no other args can be specified. =item C Discontinues friendship with the user specified in the ID parameter as the authenticating user. Returns a hashref containing the unfriended user's information when successful. This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". =item C Tests if friendship exists between the two users specified as arguments. Both arguments are REQUIRED. =back =head2 SOCIAL GRAPH METHODS =over =item C Returns an arrayref to an array of numeric IDs for every user the specified user is following. Returns undef if an error occurs. Takes a hashref as an arg: =over =item C OPTIONAL: User id or email address of a user other than the authenticated user, in order to retrieve that user's friends. =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". If passed as a string, no other args can be specified. If no args are passed, returns the list for the authenticating user. =item C Returns an arrayref to an array of numeric IDs for every user the specified user is followed by. Returns undef if an error occurs. Accepts an optional hashref for arguments: =over =item C OPTIONAL: The ID or screen name of the user for whom to request a list of followers. =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". If passed as a string, no other args can be specified. If no args are passed, returns the list for the authenticating user. =back =head2 ACCOUNT METHODS =over =item C Returns a hashref containing the authenticating user's extended information if the login credentials are correct. =item C Ends the session of the authenticating user, returning a null cookie. Use this method to sign users out of client-facing applications like widgets. =item C WARNING: This method has been deprecated in favor of the update_profile method below. It still functions today but will be removed in future versions. Updates the location attribute of the authenticating user, as displayed on the side of their profile and returned in various API methods. =item C Sets which device Twitter delivers updates to for the authenticating user. $device is required and must be one of: "sms", "im", or "none". Sending none as the device parameter will disable IM or SMS updates. =item C Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com. These values are also returned in the show_user method. This method takes a hashref as an argument, with the following optional fields containing a hex color string. =over =item C =item C =item C =item C =item C =back =item C) Updates the authenticating user's profile image. This takes as a required argument a GIF, JPG or PNG image, no larger than 700k in size. Expects raw image data, not a pathname or URL to the image. =item C) Updates the authenticating user's profile background image. This takes as a required argument a GIF, JPG or PNG image, no larger than 800k in size. Expects raw image data, not a pathname or URL to the image. =item C Returns the remaining number of API requests available to the authenticating user before the API limit is reached for the current hour. Calls to rate_limit_status require authentication, but will not count against the rate limit. =item C Sets values that users are able to set under the "Account" tab of their settings page. Takes as an argument a hashref containing fields to be updated. Only the parameters specified will be updated. For example, to only update the "name" attribute include only that parameter in the hashref. =over =item C OPTIONAL: Twitter user's name. Maximum of 40 characters. =item C OPTIONAL: Email address. Maximum of 40 characters. Must be a valid email address. =item C OPTIONAL: Homepage URL. Maximum of 100 characters. Will be prepended with "http://" if not present. =item C OPTIONAL: Geographic location. Maximum of 30 characters. The contents are not normalized or geocoded in any way. =item C OPTIONAL: Personal description. Maximum of 160 characters. =back =back =head2 FAVORITE METHODS =over =item C Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter. This takes a hashref as an argument: =over =item C OPTIONAL. The ID or screen name of the user for whom to request a list of favorite statuses. =item C OPTIONAL: Gets the 20 next most recent favorite statuses, eg "page=3". =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". If passed as a string, no other args can be specified. =item C Sets the specified ID as a favorite for the authenticating user. This takes a hashref as an argument: =over =item C REQUIRED: The ID of the status to favorite. =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". =item C Removes the specified ID as a favorite for the authenticating user. This takes a hashref as an argument: =over =item C REQUIRED. The ID of the status to un-favorite. =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". =back =head2 NOTIFICATION METHODS =over =item C Enables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful. This takes a hashref as an argument: =over =item C REQUIRED: The ID or screen name of the user to receive notices from. =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". =item C Disables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful. This takes a hashref as an argument: =over =item C REQUIRED: The ID or screen name of the user to stop receiving notices from. =back This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". =back =head2 BLOCK METHODS =over =item C Blocks the user id passed as an argument from the authenticating user. Returns a hashref containing the user information for the blocked user when successful. This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". You can find more information about blocking at L. =item C Un-blocks the user id passed as an argument from the authenticating user. Returns a hashref containing the user information for the blocked user when successful. This method can take the "id" argument passed to it either as a single string, or in a hashref with a key called "id". =back =head2 SEARCH As of version 2.00, Net::Twitter implements the search functionality of Twitter, using code derived from Net::Twitter::Search by Brenda Wallace. =over =item C Performs a search on http://search.twitter.com for your query string. This returns a hashref which is slightly different than the other methods such as public_timeline. The hashref contains a key named C which contains an arrayref to an array of hashrefs, each hashref containing a single post. These hashrefs do not include the "user" item with the posting user's information such as the *_timeline methods do. This method takes a required hashref as an argument: =over =item C =item C REQUIRED: Specifies the string to search for. This can include any of the Twitter search operators listed at L. Please see below for information about backwards compatibility with Net::Twitter::Search. Both q and query are aliases to the same argument. Specifying both will use the value specified for "query". Please note that you cannot use the "near" search operator to specify arbitrary Lat/Long locations. For this use the C argument below. =item C OPTIONAL: Restricts results to a specific language, given by an ISO 639-1 code. For example {'lang' => 'en'} =item C OPTIONAL: Sets the number of posts to return per page, up to a max of 100. =item C OPTIONAL: Sets the page number (starting at 1) to return, up to a max of roughly 1500 results (based on rpp * page) =item C OPTIONAL: Restricts returned posts to those status ids greater than the given id. =item C OPTIONAL: Returns posts by users located within the radius of the given latitude/longitude, where the user's location is taken from their Twitter profile. The format of the parameter value is "latitide,longitude,radius", with radius units specified as either "mi" (miles) or "km" (kilometers). =item C OPTIONAL: When set to a true boolean value C will prepend ":" to the beginning of the text of each post returned. =back =item BACKWARDS COMPATIBILITY WITH Net::Twitter::Search In order to maintain backwards compatibility with Net::Twitter::Search, the query/q arguments can be specified as plain text: $res = $twit->search("Farkle McFancypants") In addition, you can, in this case, specify all of the above arguments in a hashref as the second argument to the search method. $res = $twit->search("Farkle McFancypants", {lang => "en"}) Any query/q arguments in the hashref passed in this manner will be ignored, and the module will proceed using the string passed in the first argument as the query. =back =head2 HELP METHODS =over =item C Returns the string "ok" in the requested format with a 200 OK HTTP status code. =item C Returns the same text displayed on L when a maintenance window is scheduled. =back =head1 BUGS AND LIMITATIONS Please report any bugs or feature requests to C, or through the web interface at L. You can also join the Net::Twitter IRC channel at irc://irc.perl.org/net-twitter You can track Net::Twitter development at http://github.com/ct/net-twitter/tree/2.0 =head1 AUTHOR Chris Thompson The test framework for Net::Twitter was written by Marc "semifor" Mims. The framework of this module is shamelessly stolen from L. Big ups to Chris "perigrin" Prather for that. =head1 LICENCE AND COPYRIGHT Copyright (c) 2009, Chris Thompson . All rights reserved. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See L. =head1 DISCLAIMER OF WARRANTY BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.