| Net-Twitter-Lite documentation | Contained in the Net-Twitter-Lite distribution. |
Net::Twitter::Lite - A perl interface to the Twitter API
This document describes Net::Twitter::Lite version 0.10004
use Net::Twitter::Lite;
my $nt = Net::Twitter::Lite->new(
username => $user,
password => $password
);
my $result = eval { $nt->update('Hello, world!') };
eval {
my $statuses = $nt->friends_timeline({ since_id => $high_water, count => 100 });
for my $status ( @$statuses ) {
print "$status->{created_at} <$status->{user}{screen_name}> $status->{text}\n";
}
};
warn "$@\n" if $@;
This module provides a perl interface to the Twitter APIs. It uses the same API definitions as Net::Twitter, but without the extra bells and whistles and without the additional dependencies. Same great taste, less filling.
This module is related to, but is not part of the Net::Twitter
distribution. It's API methods and API method documentation are generated
from Net::Twitter's internals. It exists for those who cannot, or prefer
not to install Moose and its dependencies.
You should consider upgrading to Net::Twitter for additional functionality,
finer grained control over features, full backwards compatibility with older
versions of Net::Twitter, and additional error handling options.
The default apiurl changed in version 0.08006. The change should be
transparent to client code, unless you're using the netrc option. If so,
you'll need to either update the .netrc entry and change the machine
value from twitter.com to api.twitter.com, or set either the netrc
or netrc_machine options to twitter.com.
$nt = Net::Twitter::Lite->new(netrc_machine => 'twitter.com', netrc => 1);
# -or-
$nt = Net::Twitter::Lite->new(netrc => 'twitter.com');
Beginning with version 0.03, it is necessary for web applications using OAuth
authentication to pass the callback parameter to get_authorization_url.
In the absence of a callback parameter, when the user authorizes the
application a PIN number is displayed rather than redirecting the user back to
your site.
If you are migrating from Net::Twitter 2.12 (or an earlier version), you may need to make some minor changes to your application code in order to user Net::Twitter::Lite successfully.
The primary difference is in error handling. Net::Twitter::Lite throws
exceptions on error. It does not support the get_error, http_code, and
http_message methods used in Net::Twitter 2.12 and prior versions.
Instead of
# DON'T!
my $friends = $nt->friends();
if ( $friends ) {
# process $friends
}
wrap the API call in an eval block:
# DO!
my $friends = eval { $nt->friends() };
if ( $friends ) {
# process $friends
}
Here's a much more complex example taken from application code using Net::Twitter 2.12:
# DON'T!
my $friends = $nt->friends();
if ( $friends ) {
# process $friends
}
else {
my $error = $nt->get_error;
if ( ref $error ) {
if ( ref($error) eq 'HASH' && exists $error->{error} ) {
$error = $error->{error};
}
else {
$error = 'Unexpected error type ' . ref($error);
}
}
else {
$error = $nt->http_code() . ": " . $nt->http_message;
}
warn "$error\n";
}
The Net::Twitter::Lite equivalent is:
# DO!
eval {
my $friends = $nt->friends();
# process $friends
};
warn "$@\n" if $@;
return;
In Net::Twitter::Lite, an error can always be treated as a string. See Net::Twitter::Lite::Error. The HTTP Status Code and HTTP Message are both available. Rather than accessing them via the Net::Twitter::Lite instance, you access them via the Net::Twitter::Lite::Error instance thrown as an error.
For example:
# DO!
eval {
my $friends = $nt->friends();
# process $friends
};
if ( my $error = $@ ) {
if ( blessed $error && $error->isa("Net::Twitter::Lite::Error)
&& $error->code() == 502 ) {
$error = "Fail Whale!";
}
warn "$error\n";
}
newNet::Twitter::Lite does not support the following Net::Twitter 2.12 options to
new. It silently ignores them:
If Net::Twitter::Lite is unable to create an instance of the class specified in
the useragent_class option to new, it dies, rather than falling back to
an LWP::UserAgent object. You really don't want a failure to create the
useragent_class you specified to go unnoticed.
Net::Twitter::Lite does not support the TwitterVision API. Use Net::Twitter, instead, if you need it.
Net::Twitter::Lite does not API parameter validation. This is a feature. If Twitter adds a new option to an API method, you can use it immediately by passing it in the HASH ref to the API call.
Net::Twitter::Lite relies on Twitter to validate its own parameters. An appropriate exception will be thrown if Twitter reports a parameter error.
See skip_arg_validation. If Twitter returns an bad parameter error, an appropriate exception will be thrown.
This option allowed the following idiom in Net::Twitter 2.12:
# DON'T!
for my $friend ( @{ $nt->friends() } ) {
# process $friend
}
The equivalent Net::Twitter::Lite code is:
# DO!
eval {
for my $friend ( @{ $nt->friends() } ) {
# process $friend
}
};
The clone method was added to Net::Twitter 2.x to allow safe error handling
in an environment where concurrent requests are handled, for example, when
using LWP::UserAgent::POE as the useragent_class. Since Net::Twitter::Lite
throws exceptions instead of stashing them in the Net::Twitter::Lite instance,
it is safe in a current request environment, obviating the need for clone.
These methods are replaced by Net::Twitter::Lite::Error. An instance of that class is thrown errors are encountered.
This constructs a Net::Twitter::Lite object. It takes several named parameters,
all of them optional:
This is the screen name or email used to authenticate with Twitter. Use this option for Basic Authentication, only.
This is the password used to authenticate with Twitter. Use this option for Basic Authentication, only.
A string containing the OAuth consumer key provided by Twitter when an application is registered. Use this option for OAuth authentication, only.
A string containing the OAuth consumer secret. Use this option for OAuth authentication, only.
the OAuth trait is included.
A HASH ref of URLs to be used with OAuth authentication. Defaults to:
{
request_token_url => "http://twitter.com/oauth/request_token",
authorization_url => "http://twitter.com/oauth/authorize",
access_token_url => "http://twitter.com/oauth/access_token",
xauth_url => "https://twitter.com/oauth/access_token",
}
The value for the X-Twitter-Client-Name HTTP header. It defaults to "Perl
Net::Twitter::Lite".
The value for the X-Twitter-Client-Version HTTP header. It defaults to
current version of the Net::Twitter::Lite module.
The value for the X-Twitter-Client-URL HTTP header. It defaults to the
search.cpan.org page for the Net::Twitter::Lite distribution.
The LWP::UserAgent compatible class used internally by Net::Twitter::Lite. It
defaults to "LWP::UserAgent". For POE based applications, consider using
"LWP::UserAgent::POE".
An HASH ref of arguments to pass to constructor of the class specified with
useragent_class, above. It defaults to {} (an empty HASH ref).
The value for User-Agent HTTP header. It defaults to
"Net::Twitter::Lite/0.10004 (Perl)".
The value used in the source parameter of API method calls. It is currently
only used in the update method in the REST API. It defaults to
"twitterpm". This results in the text "from Net::Twitter" rather than "from
web" for status messages posted from Net::Twitter::Lite when displayed via the
Twitter web interface. The value for this parameter is provided by Twitter
when a Twitter application is registered. See
http://apiwiki.twitter.com/FAQ#HowdoIget%E2%80%9CfromMyApp%E2%80%9DappendedtoupdatessentfrommyAPIapplication.
The URL for the Twitter API. This defaults to "http://twitter.com".
If set to 1 (or any value that evaluates to true), apiurl defaults to "http://identi.ca/api".
If set to 1, an SSL connection will be used for all API calls. Defaults to 0.
(Optional) Sets the machine key to look up in .netrc to obtain
credentials. If set to 1, Net::Twitter::Lite will use the value of the netrc_machine
option (below).
# in .netrc
machine api.twitter.com
login YOUR_TWITTER_USER_NAME
password YOUR_TWITTER_PASSWORD
machine semifor.twitter.com
login semifor
password SUPERSECRET
# in your perl program
$nt = Net::Twitter::Lite->new(netrc => 1);
$nt = Net::Twitter::Lite->new(netrc => 'semifor.twitter.com');
(Optional) Sets the machine entry to look up in .netrc when <netrc = 1>>
is used. Defaults to api.twitter.com.
Set the credentials for Basic Authentication. This is helpful for managing multiple accounts.
Whether the client has the necessary credentials to be authorized.
Note that the credentials may be wrong and so the request may fail.
Returns list including the access token, access token secret, user_id, and
screen_name for this user. Takes a HASH of arguments. The verifier argument
is required. See OAUTH EXAMPLES.
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 the
verifier 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 the URL used to authorize the user. Returns a URI object. For web
applications, pass your applications callback URL as the callback parameter.
No arguments are required for desktop applications (callback defaults to
oob, out-of-band).
Get the URL used to authenticate the user with "Sign in with Twitter"
authentication flow. Returns a URI object. For web applications, pass your
applications callback URL as the callback parameter. No arguments are
required for desktop applications (callback defaults to oob, out-of-band).
Exchanges a username and password for OAuth tokens. Your application must be approved for XAuth access by Twitter for this method to work. Twitter does not grant XAuth access for web applications except for a brief period of time to allow them to switch form Basic authentication to OAuth authentication.
Get or set the access token.
Get or set the access token secret.
Get or set the request token.
Get or set the request token secret.
Get or set the access_token URL.
Get or set the authentication URL.
Get or set the authorization URL.
Get or set the request_token URL.
Get or set the XAuth access token request URL.
Most Twitter API methods take parameters. All Net::Twitter::Lite API methods will accept a HASH ref of named parameters as specified in the Twitter API documentation. For convenience, many Net::Twitter::Lite methods accept simple positional arguments as documented, below. The positional parameter passing style is optional; you can always use the named parameters in a hash ref if you prefer.
For example, the REST API method update has one required parameter,
status. You can call update with a HASH ref argument:
$nt->update({ status => 'Hello world!' });
Or, you can use the convenient form:
$nt->update('Hello world!');
The update method also has an optional parameter, in_reply_to_status_id.
To use it, you must use the HASH ref form:
$nt->update({ status => 'Hello world!', in_reply_to_status_id => $reply_to });
Convenience form is provided for the required parameters of all API methods. So, these two calls are equivalent:
$nt->friendship_exists({ user_a => $fred, user_b => $barney });
$nt->friendship_exists($fred, $barney);
Many API methods have aliases. You can use the API method name, or any of its aliases, as you prefer. For example, these calls are all equivalent:
$nt->friendship_exists($fred, $barney);
$nt->relationship_exists($fred, $barney);
$nt->follows($fred, $barney);
Aliases support both the HASH ref and convenient forms:
$nt->follows({ user_a => $fred, user_b => $barney });
Methods that support the page parameter expect page numbers > 0. Twitter silently
ignores invalid page values. So { page => 0 } produces the same result
as { page => 1 }.
In addition to the arguments specified for each API method described below, an
additional authenticate parameter can be passed. To request an
Authorization header, pass authenticated => 1; to suppress an
authentication header, pass authentication => 0. Even if requested, an
Authorization header will not be added if there are no user credentials
(username and password for Basic Authentication; access tokens for OAuth).
This is probably only useful for the rate_limit_status method in the REST API, since it returns different values for an authenticated and a non-authenticated call.
Several of these methods accept a user ID as the id parameter. The user ID
can be either a screen name, or the users numeric ID. To disambiguate, use
the screen_name or user_id parameters, instead.
For example, These calls are equivalent:
$nt->create_friend('perl_api'); # screen name
$nt->create_friend(1564061); # numeric ID
$nt->create_friend({ id => 'perl_api' });
$nt->create_friend({ screen_name => 'perl_api' });
$nt->create_friend({ user_id => 1564061 });
However user_id 911 and screen_name 911 are separate Twitter accounts. These calls are NOT equivalent:
$nt->create_friend(911); # interpreted as screen name
$nt->create_friend({ user_id => 911 }); # screen name: richellis
Whenever the id parameter is required and user_id and screen_name are
also parameters, using any one of them satisfies the requirement.
Returns the current trend, geo and sleep time information for the authenticating user.
Returns: HashRef
Returns the current count of friends, followers, updates (statuses) and favorites of the authenticating user.
Returns: HashRef
Returns all lists the authenticating or specified user subscribes to, including
their own. The user is specified using the user_id or screen_name
parameters. If no user is given, the authenticating user is used. Requires
authentication unless requesting for another user.
Returns: ArrayRef[List]
Returns if the authenticating user is blocking a target user. Will return the blocked user's object if a block exists, and error with HTTP 404 response code otherwise.
Returns: BasicUser
Returns an array of user objects that the authenticating user is blocking.
Returns: ArrayRef[BasicUser]
Returns an array of numeric user ids the authenticating user is blocking.
Returns: ArrayRef[Int]
Blocks the user specified in the ID parameter as the authenticating user. Returns the blocked user when successful. You can find out more about blocking in the Twitter Support Knowledge Base.
Returns: BasicUser
Favorites the status specified in the ID parameter as the authenticating user. Returns the favorite status when successful.
Returns: Status
Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user when successful. Returns a string describing the failure condition when unsuccessful.
Returns: BasicUser
Creates a saved search for the authenticated user.
Returns: SavedSearch
Un-blocks the user specified in the ID parameter as the authenticating user. Returns the un-blocked user when successful.
Returns: BasicUser
Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.
Returns: DirectMessage
Un-favorites the status specified in the ID parameter as the authenticating user. Returns the un-favorited status.
Returns: Status
Discontinues friendship with the user specified in the ID parameter as the authenticating user. Returns the un-friended user when successful. Returns a string describing the failure condition when unsuccessful.
Returns: BasicUser
Destroys a saved search. The search, specified by id, must be owned
by the authenticating user.
Returns: SavedSearch
Destroys the status specified by the required ID parameter. The authenticating user must be the author of the specified status.
Returns: Status
Returns a list of the 20 most recent direct messages sent to the authenticating user including detailed information about the sending and recipient users.
Returns: ArrayRef[DirectMessage]
Disables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.
Returns: BasicUser
Enables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful.
Returns: BasicUser
Ends the session of the authenticating user, returning a null cookie. Use this method to sign users out of client-facing applications like widgets.
Returns: Error
Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter.
Returns: ArrayRef[Status]
Returns a reference to an array of the user's followers. If id, user_id,
or screen_name is not specified, the followers of the authenticating user are
returned. The returned users are ordered from most recently followed to least
recently followed.
Use the optional cursor parameter to retrieve users in pages of 100. When
the cursor parameter is used, the return value is a reference to a hash with
keys previous_cursor, next_cursor, and users. The value of users
is a reference to an array of the user's friends. The result set isn't
guaranteed to be 100 every time as suspended users will be filtered out. Set
the optional cursor parameter to -1 to get the first page of users. Set it
to the prior return's value of previous_cursor or next_cursor to page
forward or backwards. When there are no prior pages, the value of
previous_cursor will be 0. When there are no subsequent pages, the value of
next_cursor will be 0.
Returns: HashRef|ArrayRef[User]
Returns a reference to an array of numeric IDs for every user following the specified user.
Use the optional cursor parameter to retrieve IDs in pages of 5000. When
the cursor parameter is used, the return value is a reference to a hash with
keys previous_cursor, next_cursor, and ids. The value of ids is a
reference to an array of IDS of the user's followers. Set the optional cursor
parameter to -1 to get the first page of IDs. Set it to the prior return's
value of previous_cursor or next_cursor to page forward or backwards.
When there are no prior pages, the value of previous_cursor will be 0. When
there are no subsequent pages, the value of next_cursor will be 0.
Returns: HashRef|ArrayRef[Int]
Returns a reference to an array of the user's friends. If id, user_id,
or screen_name is not specified, the friends of the authenticating user are
returned. The returned users are ordered from most recently followed to least
recently followed.
Use the optional cursor parameter to retrieve users in pages of 100. When
the cursor parameter is used, the return value is a reference to a hash with
keys previous_cursor, next_cursor, and users. The value of users
is a reference to an array of the user's friends. The result set isn't
guaranteed to be 100 every time as suspended users will be filtered out. Set
the optional cursor parameter to -1 to get the first page of users. Set it
to the prior return's value of previous_cursor or next_cursor to page
forward or backwards. When there are no prior pages, the value of
previous_cursor will be 0. When there are no subsequent pages, the value of
next_cursor will be 0.
Returns: Hashref|ArrayRef[User]
Returns a reference to an array of numeric IDs for every user followed the specified user.
Use the optional cursor parameter to retrieve IDs in pages of 5000. When
the cursor parameter is used, the return value is a reference to a hash with
keys previous_cursor, next_cursor, and ids. The value of ids is a
reference to an array of IDS of the user's friends. Set the optional cursor
parameter to -1 to get the first page of IDs. Set it to the prior return's
value of previous_cursor or next_cursor to page forward or backwards.
When there are no prior pages, the value of previous_cursor will be 0. When
there are no subsequent pages, the value of next_cursor will be 0.
Returns: HashRef|ArrayRef[Int]
Returns the 20 most recent statuses posted by the authenticating user and that user's friends. This is the equivalent of /home on the Web.
Returns: ArrayRef[Status]
Tests for the existence of friendship between two users. Will return true if user_a follows user_b, otherwise will return false.
Returns: Bool
Returns an HASH ref with an array of numeric IDs in the ids element for
every user who has a pending request to follow the authenticating user.
Returns: HashRef
Returns an HASH ref with an array of numeric IDs in the ids element for
every protected user for whom the authenticating user has a pending follow
request.
Returns: HashRef
Returns details of a place returned from the reverse_geocode method.
Returns: HashRef
Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends. This is the equivalent of /timeline/home on the Web.
Returns: ArrayRef[Status]
Returns the relationship of the authenticating user to the comma separated list or ARRAY ref of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none. Requires authentication.
Returns: ArrayRef
Return up to 20 users worth of extended information, specified by either ID, screen name, or combination of the two. The author's most recent status (if the authenticating user has permission) will be returned inline. This method is rate limited to 1000 calls per hour.
This method will accept user IDs or screen names as either a comma delimited string, or as an ARRAY ref. It will also accept arguments in the normal HASHREF form or as a simple list of named arguments. I.e., any of the following forms are acceptable:
$nt->lookup_users({ user_id => '1234,6543,3333' });
$nt->lookup_users(user_id => '1234,6543,3333');
$nt->lookup_users({ user_id => [ 1234, 6543, 3333 ] });
$nt->lookup_users({ screen_name => 'fred,barney,wilma' });
$nt->lookup_users(screen_name => ['fred', 'barney', 'wilma']);
$nt->lookup_users(
screen_name => ['fred', 'barney' ],
user_id => '4321,6789',
);
Returns: ArrayRef[User]
Returns the 20 most recent mentions (statuses containing @username) for the authenticating user.
Returns: ArrayRef[Status]
Sends a new direct message to the specified user from the authenticating user.
Requires both the user and text parameters. Returns the sent message when
successful. In order to support numeric screen names, the screen_name or
user_id parameters may be used instead of user.
Returns: DirectMessage
Returns an ARRAY ref of user IDs for which the authenticating user does not want to receive retweets.
Returns: ArrayRef[UserIDs]
Returns the 20 most recent statuses from non-protected users who have set a custom user icon. Does not require authentication. Note that the public timeline is cached for 60 seconds so requesting it more often than that is a waste of resources.
If user credentials are provided, public_timeline calls are authenticated,
so they count against the authenticated user's rate limit. Use ->public_timeline({ authenticate => 0 }) to make an unauthenticated call
which will count against the calling IP address' rate limit, instead.
Returns: ArrayRef[Status]
Returns the remaining number of API requests available to the authenticated user before the API limit is reached for the current hour.
Use ->rate_limit_status({ authenticate => 0 }) to force an
unauthenticated call, which will return the status for the IP address rather
than the authenticated user. (Note: for a web application, this is the server's
IP address.)
Returns: RateLimitStatus
If available, returns an array of replies and mentions related to the specified status. There is no guarantee there will be any replies or mentions in the response. This method is only available to users who have access to #newtwitter. Requires authentication.
Returns: ArrayRef[Status]
The user specified in the id is blocked by the authenticated user and reported as a spammer.
Returns: User
Retweets a tweet. Requires the id parameter of the tweet you are retweeting. Returns the original tweet with retweet details embedded.
Returns: Status
Returns up to 100 users who retweeted the status identified by id.
Returns: ArrayRef[User]
Returns the IDs of up to 100 users who retweeted the status identified by id.
Returns: ArrayRef[User]
Returns the 20 most recent retweets posted by the authenticating user.
Returns: ArrayRef[Status]
Returns the 20 most recent retweets posted by the specified user. The user is
specified using the user_id or screen_name parameters. This method is identical
to retweeted_by_me except you can choose the user to view. Does not require
authentication, unless the user is protected.
Returns: ArrayRef
Returns the 20 most recent retweets posted by the authenticating user's friends.
Returns: ArrayRef[Status]
Returns the 20 most recent retweets posted by users the specified user
follows. The user is specified using the user_id or screen_name
parameters. This method is identical to retweeted_to_me
except you can choose the user to view.
Does not require authentication, unless the user is protected.
Returns: ArrayRef
Returns up to 100 of the first retweets of a given tweet.
Returns: Arrayref[Status]
Returns the 20 most recent tweets of the authenticated user that have been retweeted by others.
Returns: ArrayRef[Status]
Search for places (cities and neighborhoods) that can be attached to a statuses/update. Given a latitude and a longitude, return a list of all the valid places that can be used as a place_id when updating a status. Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location up with a call to statuses/update.
There are multiple granularities of places that can be returned -- "neighborhoods", "cities", etc. At this time, only United States data is available through this method.
Required. The latitude to query about. Valid ranges are -90.0 to +90.0 (North is positive) inclusive.
Required. The longitude to query about. Valid ranges are -180.0 to +180.0 (East is positive) inclusive.
Optional. A hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If this is not passed in, then it is assumed to be 0m. If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).
Optional. The minimal granularity of data to return. If this is not passed
in, then neighborhood is assumed. city can also be passed.
Optional. A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many "nearby" results to return. Ideally, only pass in the number of places you intend to display to the user here.
Returns: HashRef
Returns the authenticated user's saved search queries.
Returns: ArrayRef[SavedSearch]
Returns a list of the 20 most recent direct messages sent by the authenticating user including detailed information about the sending and recipient users.
Returns: ArrayRef[DirectMessage]
Returns a single direct message, specified by an id parameter. Like
the direct_messages request, this method will include the
user objects of the sender and recipient. Requires authentication.
Returns: HashRef
Returns detailed information about the relationship between two users.
Returns: Relationship
Retrieve the data for a saved search, by ID, owned by the authenticating user.
Returns: SavedSearch
Returns a single status, specified by the id parameter. The status's author will be returned inline.
Returns: Status
Returns extended information of a given user, specified by ID or screen name as per the required id parameter. This information includes design settings, so third party developers can theme their widgets according to a given user's preferences. You must be properly authenticated to request the page of a protected user.
Returns: ExtendedUser
Returns the list of suggested user categories. The category slug can be used in
the user_suggestions API method get the users in that category . Does not
require authentication.
Returns: ArrayRef
Returns the string "ok" status code.
Returns: Str
Returns the top ten queries that are currently trending on Twitter. The response includes the time of the request, the name of each trending topic, and the url to the Twitter Search results page for that topic.
Returns: ArrayRef[Query]
Returns the locations with trending topic information. The response is an array of "locations" that encode the location's WOEID (a Yahoo! Where On Earth ID http://developer.yahoo.com/geo/geoplanet/) and some other human-readable information such as a the location's canonical name and country.
When the optional lat and long parameters are passed, the available trend
locations are sorted by distance from that location, nearest to farthest.
Use the WOEID returned in the location object to query trends for a specific location.
Returns: ArrayRef[Location]
Returns the current top ten trending topics on Twitter. The response includes the time of the request, the name of each trending topic, and query used on Twitter Search results page for that topic.
Returns: HashRef
Returns the top 20 trending topics for each hour in a given day.
Returns: HashRef
Returns the top 10 trending topics for a specific location. The response is an array of "trend" objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Search, and the direct URL that can be issued against Search. This information is cached for five minutes, and therefore users are discouraged from querying these endpoints faster than once every five minutes. Global trends information is also available from this API by using a WOEID of 1.
Returns: ArrayRef[Trend]
Returns the top 30 trending topics for each day in a given week.
Returns: HashRef
Updates the authenticating user's status. Requires the status parameter specified. A status update with text identical to the authenticating user's current status will be ignored.
Required. The text of your status update. URL encode as necessary. Statuses over 140 characters will cause a 403 error to be returned from the API.
Optional. The ID of an existing status that the update is in reply to. o Note: This parameter will be ignored unless the author of the tweet this parameter references is mentioned within the status text. Therefore, you must include @username, where username is the author of the referenced tweet, within the update.
Optional. The location's latitude that this tweet refers to. The valid ranges for latitude is -90.0 to +90.0 (North is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding long parameter with this tweet.
Optional. The location's longitude that this tweet refers to. The valid ranges for longitude is -180.0 to +180.0 (East is positive) inclusive. This parameter will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding lat parameter with this tweet.
Optional. The place to attach to this status update. Valid place_ids can be
found by querying reverse_geocode.
Optional. By default, geo-tweets will have their coordinates exposed in the
status object (to remain backwards compatible with existing API applications).
To turn off the display of the precise latitude and longitude (but keep the
contextual location information), pass display_coordinates = 0> on the
status update.
Returns: Status
Sets which device Twitter delivers updates to for the authenticating user. Sending none as the device parameter will disable IM or SMS updates.
Returns: BasicUser
Allows you enable or disable retweets and device notifications from the specified user. All other values are assumed to be false. Requires authentication.
Returns: HashRef
Sets values that users are able to set under the "Account" tab of their settings page. Only the parameters specified will be updated; to only update the "name" attribute, for example, only include that parameter in your request.
Returns: ExtendedUser
Updates the authenticating user's profile background image. The image
parameter must be an arrayref with the same interpretation as the image
parameter in the update_profile_image method. The use parameter allows
you to specify whether to use the uploaded profile background or not. See
that method's documentation for details.
Returns: ExtendedUser
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 /users/show API method.
Returns: ExtendedUser
Updates the authenticating user's profile image. The image parameter is an
arrayref with the following interpretation:
[ $file ] [ $file, $filename ] [ $file, $filename, Content_Type => $mime_type ] [ undef, $filename, Content_Type => $mime_type, Content => $raw_image_data ]
The first value of the array ($file) is the name of a file to open. The
second value ($filename) is the name given to Twitter for the file. If
$filename is not provided, the basename portion of $file is used. If
$mime_type is not provided, it will be provided automatically using
LWP::MediaTypes::guess_media_type().
$raw_image_data can be provided, rather than opening a file, by passing
undef as the first array value.
Returns: ExtendedUser
Access the users in a given category of the Twitter suggested user list and
return their most recent status if they are not a protected user. Currently
supported values for optional parameter lang are en, fr, de, es,
it. Does not require authentication.
Returns: ArrayRef
Returns the 20 most recent statuses posted from the authenticating user. It's also possible to request another user's timeline via the id parameter. This is the equivalent of the Web /archive page for your own user, or the profile page for a third party.
Returns: ArrayRef[Status]
Run a search for users similar to Find People button on Twitter.com; the same results returned by people search on Twitter.com will be returned by using this API (about being listed in the People Search). It is only possible to retrieve the first 1000 matches from this API.
Returns: ArrayRef[Users]
Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid.
Returns: ExtendedUser
Returns a HASH reference with some meta-data about the query including the
next_page, refresh_url, and max_id. The statuses are returned in
results. To iterate over the results, use something similar to:
my $r = $nt->search($searh_term);
for my $status ( @{$r->{results}} ) {
print "$status->{text}\n";
}
Returns: HashRef
Adds the user identified by id to the list.
Returns a reference the added user as a hash reference.
Returns: User
Creates a new list for the authenticated user. The mode parameter may be
either public or private. If not specified, it defaults to public.
Returns: HashRef
Deletes a list owned by the authenticating user. Returns the list as a hash reference.
Returns:
Deletes the user identified by id from the specified list.
Returns the deleted user as a hash reference.
Returns:
Returns the specified list as a hash reference.
Returns: HashRef
Returns a reference to an array of lists owned by the specified user. If the user is the authenticated user, it returns both public and private lists. Otherwise, it only returns public lists.
When the cursor parameter is used, a hash reference is returned; the lists
are returned in the lists element of the hash.
Returns: ArrayRef[List]
Returns the list member as a HASH reference if id is a member of the list.
Otherwise, returns undef.
Returns: ArrayRef[User]
Returns the subscriber as a HASH reference if id is a subscriber to the list.
Otherwise, returns undef.
Returns: ArrayRef[User]
Returns the list members as an array reference.
The optional id parameter can be used to determine if the user specified by
id is a member of the list. If so, the user is returned as a hash
reference; if not, undef is returned.
When the cursor parameter is used, a hash reference is returned; the members
are returned in the users element of the hash.
Returns: ArrayRef[User]
Returns the lists the specified user is a member of as an array reference.
When the cursor parameter is used, a hash reference is returned; the lists
are returned in the lists element of the hash.
Returns:
Returns a timeline of list member statuses as an array reference.
Returns: ArrayRef[Status]
Returns the subscribers to a list as an array reference.
When the cursor parameter is used, a hash reference is returned; the subscribers
are returned in the users element of the hash.
Returns: ArrayRef[User]
Returns a lists to which the specified user is subscribed as an array reference.
When the cursor parameter is used, a hash reference is returned; the lists
are returned in the lists element of the hash.
Returns:
Adds multiple users id to the list. Users are specified with the screen_name
or user_id parameter with a reference to an ARRAY of values.
Returns a reference the added user as a hash reference.
Returns: ArrayRef[User]
Subscribes the authenticated user to the specified list.
Returns: List
Unsubscribes the authenticated user from the specified list.
Returns: List
Updates a list to change the name, mode, description, or any combination thereof.
Returns: HashRef
When Net::Twitter::Lite encounters a Twitter API error or a network error, it
throws a Net::Twitter::Lite::Error object. You can catch and process these
exceptions by using eval blocks and testing $@:
eval {
my $statuses = $nt->friends_timeline(); # this might die!
for my $status ( @$statuses ) {
#...
}
};
if ( $@ ) {
# friends_timeline encountered an error
if ( blessed $@ && $@->isa('Net::Twitter::Lite::Error' ) {
#... use the thrown error obj
warn $@->error;
}
else {
# something bad happened!
die $@;
}
}
Net::Twitter::Lite::Error stringifies to something reasonable, so if you don't need
detailed error information, you can simply treat $@ as a string:
eval { $nt->update($status) };
if ( $@ ) {
warn "update failed because: $@\n";
}
Net::Twitter::Lite currently supports both Basic Authentication and OAuth. The
choice of authentication strategies is determined by the options passed to
new or the use of the credentials method. An error will be thrown if
options for both strategies are provided.
To use Basic Authentication, pass the username and password options to
new, or call credentials to set them. When Basic Authentication is used,
the Authorization header is set on each authenticated API call.
To use OAuth authentication, pass the consumer_key and consumer_secret options to new.
Net::OAuth::Simple must be installed in order to use OAuth and an error will be thrown if OAuth is attempted without it. Net::Twitter::Lite does not require Net::OAuth::Simple, making OAuth an optional feature.
See the examples directory included in this distribution for full working
examples using OAuth.
Here's how to authorize users as a desktop app mode:
use Net::Twitter::Lite;
my $nt = Net::Twitter::Lite->new(
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->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, $user_id, $screen_name) =
$nt->request_access_token(verifier => $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::Lite->new(%param);
my $url = $nt->get_authorization_url(callback => $callbackurl);
$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::Lite->new(%param);
$nt->request_token($cookie{token});
$nt->request_token_secret($cookie{token_secret});
my $verifier = $c->req->param->{oauth_verifier};
my($access_token, $access_token_secret, $user_id, $screen_name) =
$nt->request_access_token(verifier => $verifier);
# 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::Lite->new(%param);
$nt->access_token($access_token);
$nt->access_token_secret($access_token_secret);
# Now you can call any Net::Twitter::Lite API methods on $nt
my $status = $c->req->param('status');
my $res = $nt->update({ status => $status });
}
The Net::Twitter::Lite exception object.
This is the official Twitter API documentation. It describes the methods and their parameters in more detail and may be more current than the documentation provided with this module.
This LWP::UserAgent compatible class can be used in POE based application along with Net::Twitter::Lite to provide concurrent, non-blocking requests.
Please report bugs to bug-net-twitter@rt.cpan.org, or through the web
interface at https://rt.cpan.org/Dist/Display.html?Queue=Net-Twitter.
Join the Net::Twitter IRC channel at irc://irc.perl.org/net-twitter.
Follow perl_api: http://twitter.com/perl_api.
Track Net::Twitter::Lite development at http://github.com/semifor/net-twitter-lite.
Marc Mims <marc@questright.com>
Copyright (c) 2009 Marc Mims
The Twitter API itself, and the description text used in this module is:
Copyright (c) 2009 Twitter
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| Net-Twitter-Lite documentation | Contained in the Net-Twitter-Lite distribution. |
package Net::Twitter::Lite; use 5.005; use warnings; use strict; our $VERSION = '0.10004'; $VERSION = eval { $VERSION }; use Carp; use URI::Escape; use JSON::Any qw/XS JSON/; use HTTP::Request::Common; use Net::Twitter::Lite::Error; use Encode qw/encode_utf8/; my $json_handler = JSON::Any->new(utf8 => 1); sub new { my ($class, %args) = @_; my $netrc = delete $args{netrc}; my $new = bless { apiurl => 'http://api.twitter.com/1', searchapiurl => 'http://search.twitter.com', search_trends_api_url => 'http://api.twitter.com/1', lists_api_url => 'http://api.twitter.com/1', apirealm => 'Twitter API', $args{identica} ? ( apiurl => 'http://identi.ca/api' ) : (), useragent => __PACKAGE__ . "/$VERSION (Perl)", clientname => __PACKAGE__, clientver => $VERSION, clienturl => 'http://search.cpan.org/dist/Net-Twitter-Lite/', source => 'twitterpm', useragent_class => 'LWP::UserAgent', useragent_args => {}, oauth_urls => { request_token_url => "https://twitter.com/oauth/request_token", authentication_url => "https://twitter.com/oauth/authenticate", authorization_url => "https://twitter.com/oauth/authorize", access_token_url => "https://twitter.com/oauth/access_token", xauth_url => "https://twitter.com/oauth/access_token", }, netrc_machine => 'api.twitter.com', %args }, $class; if ( delete $args{ssl} ) { $new->{$_} =~ s/^http:/https:/ for qw/apiurl searchapiurl search_trends_api_url lists_api_url/; } # get username and password from .netrc if ( $netrc ) { eval { require Net::Netrc; 1 } || croak "Net::Netrc is required for the netrc option"; my $host = $netrc eq '1' ? $new->{netrc_machine} : $netrc; my $nrc = Net::Netrc->lookup($host) || croak "No .netrc entry for $host"; @{$new}{qw/username password/} = $nrc->lpa; } $new->{ua} ||= do { eval "use $new->{useragent_class}"; croak $@ if $@; $new->{useragent_class}->new(%{$new->{useragent_args}}); }; $new->{ua}->agent($new->{useragent}); $new->{ua}->default_header('X-Twitter-Client' => $new->{clientname}); $new->{ua}->default_header('X-Twitter-Client-Version' => $new->{clientver}); $new->{ua}->default_header('X-Twitter-Client-URL' => $new->{clienturl}); $new->{ua}->env_proxy; $new->{_authenticator} = exists $new->{consumer_key} ? '_oauth_authenticated_request' : '_basic_authenticated_request'; $new->credentials(@{$new}{qw/username password/}) if exists $new->{username} && exists $new->{password}; return $new; } sub credentials { my $self = shift; my ($username, $password) = @_; croak "exected a username and password" unless @_ == 2; croak "OAuth authentication is in use" if exists $self->{consumer_key}; $self->{username} = $username; $self->{password} = $password; my $uri = URI->new($self->{apiurl}); my $netloc = join ':', $uri->host, $uri->port; $self->{ua}->credentials($netloc, $self->{apirealm}, $username, $password); } # This is a hack. Rather than making Net::OAuth an install requirement for # Net::Twitter::Lite, require it at runtime if any OAuth methods are used. It # simply returns the string 'Net::OAuth' after successfully requiring # Net::OAuth. sub _oauth { my $self = shift; return $self->{_oauth} ||= do { eval "use Net::OAuth 0.25"; croak "Install Net::OAuth 0.25 or later for OAuth support" if $@; eval '$Net::OAuth::PROTOCOL_VERSION = Net::OAuth::PROTOCOL_VERSION_1_0A'; die $@ if $@; 'Net::OAuth'; }; } # simple check to see if we have access tokens; does not check to see if they are valid sub authorized { my $self = shift; return defined $self->{access_token} && $self->{access_token_secret}; } # OAuth token accessors for my $method ( qw/ access_token access_token_secret request_token request_token_secret / ) { no strict 'refs'; *{__PACKAGE__ . "::$method"} = sub { my $self = shift; $self->{$method} = shift if @_; return $self->{$method}; }; } # OAuth url accessors for my $method ( qw/ request_token_url authentication_url authorization_url access_token_url xauth_url / ) { no strict 'refs'; *{__PACKAGE__ . "::$method"} = sub { my $self = shift; $self->{oauth_urls}{$method} = shift if @_; return URI->new($self->{oauth_urls}{$method}); }; } # get the athorization or authentication url sub _get_auth_url { my ($self, $which_url, %params ) = @_; $self->_request_request_token(%params); my $uri = $self->$which_url; $uri->query_form(oauth_token => $self->request_token); return $uri; } # get the authentication URL from Twitter sub get_authentication_url { return shift->_get_auth_url(authentication_url => @_) } # get the authorization URL from Twitter sub get_authorization_url { return shift->_get_auth_url(authorization_url => @_) } # common portion of all oauth requests sub _make_oauth_request { my ($self, $type, %params) = @_; my $request = $self->_oauth->request($type)->new( version => '1.0', consumer_key => $self->{consumer_key}, consumer_secret => $self->{consumer_secret}, request_method => 'GET', signature_method => 'HMAC-SHA1', timestamp => time, nonce => time ^ $$ ^ int(rand 2**32), %params, ); $request->sign; return $request; } # called by get_authorization_url to obtain request tokens sub _request_request_token { my ($self, %params) = @_; my $uri = $self->request_token_url; $params{callback} ||= 'oob'; my $request = $self->_make_oauth_request( 'request token', request_url => $uri, %params, ); my $res = $self->{ua}->get($request->to_url); die "GET $uri failed: ".$res->status_line unless $res->is_success; # reuse $uri to extract parameters from the response content $uri->query($res->content); my %res_param = $uri->query_form; $self->request_token($res_param{oauth_token}); $self->request_token_secret($res_param{oauth_token_secret}); } # exchange request tokens for access tokens; call with (verifier => $verifier) sub request_access_token { my ($self, %params ) = @_; my $uri = $self->access_token_url; my $request = $self->_make_oauth_request( 'access token', request_url => $uri, token => $self->request_token, token_secret => $self->request_token_secret, %params, # verifier => $verifier ); my $res = $self->{ua}->get($request->to_url); die "GET $uri failed: ".$res->status_line unless $res->is_success; # discard request tokens, they're no longer valid delete $self->{request_token}; delete $self->{request_token_secret}; # reuse $uri to extract parameters from content $uri->query($res->content); my %res_param = $uri->query_form; return ( $self->access_token($res_param{oauth_token}), $self->access_token_secret($res_param{oauth_token_secret}), $res_param{user_id}, $res_param{screen_name}, ); } # exchange username and password for access tokens sub xauth { my ( $self, $username, $password ) = @_; my $uri = $self->xauth_url; my $request = $self->_make_oauth_request( 'XauthAccessToken', request_url => $uri, x_auth_username => $username, x_auth_password => $password, x_auth_mode => 'client_auth', ); my $res = $self->{ua}->get($request->to_url); die "GET $uri failed: ".$res->status_line unless $res->is_success; # reuse $uri to extract parameters from content $uri->query($res->content); my %res_param = $uri->query_form; return ( $self->access_token($res_param{oauth_token}), $self->access_token_secret($res_param{oauth_token_secret}), $res_param{user_id}, $res_param{screen_name}, ); } # common call for both Basic Auth and OAuth sub _authenticated_request { my $self = shift; my $authenticator = $self->{_authenticator}; $self->$authenticator(@_); } sub _encode_args { my $args = shift; # Values need to be utf-8 encoded. Because of a perl bug, exposed when # client code does "use utf8", keys must also be encoded. # see: http://www.perlmonks.org/?node_id=668987 # and: http://perl5.git.perl.org/perl.git/commit/eaf7a4d2 return { map { utf8::upgrade($_) unless ref($_); $_ } %$args }; } sub _oauth_authenticated_request { my ($self, $http_method, $uri, $args, $authenticate) = @_; delete $args->{source}; # not necessary with OAuth requests my $is_multipart = grep { ref } %$args; my $msg; if ( $authenticate && $self->authorized ) { local $Net::OAuth::SKIP_UTF8_DOUBLE_ENCODE_CHECK = 1; my $request = $self->_make_oauth_request( 'protected resource', request_url => $uri, request_method => $http_method, token => $self->access_token, token_secret => $self->access_token_secret, extra_params => $is_multipart ? {} : $args, ); if ( $http_method =~ /^(?:GET|DELETE)$/ ) { $msg = HTTP::Request->new($http_method, $request->to_url); } elsif ( $http_method eq 'POST' ) { $msg = $is_multipart ? POST($request->request_url, Authorization => $request->to_authorization_header, Content_Type => 'form-data', Content => [ %$args ], ) : POST($$uri, Content => $request->to_post_body) ; } else { croak "unexpected http_method: $http_method"; } } elsif ( $http_method eq 'GET' ) { $uri->query_form($args); $args = {}; $msg = GET($uri); } elsif ( $http_method eq 'POST' ) { my $encoded_args = { %$args }; _encode_args($encoded_args); $msg = $self->_mk_post_msg($uri, $args); } else { croak "unexpected http_method: $http_method"; } return $self->{ua}->request($msg); } sub _basic_authenticated_request { my ($self, $http_method, $uri, $args, $authenticate) = @_; _encode_args($args); my $msg; if ( $http_method =~ /^(?:GET|DELETE)$/ ) { $uri->query_form($args); $msg = HTTP::Request->new($http_method, $uri); } elsif ( $http_method eq 'POST' ) { $msg = $self->_mk_post_msg($uri, $args); } else { croak "unexpected HTTP method: $http_method"; } if ( $authenticate && $self->{username} && $self->{password} ) { $msg->headers->authorization_basic(@{$self}{qw/username password/}); } return $self->{ua}->request($msg); } sub _mk_post_msg { my ($self, $uri, $args) = @_; # if any of the arguments are (array) refs, use form-data return (grep { ref } values %$args) ? POST($uri, Content_Type => 'form-data', Content => [ %$args ]) : POST($uri, $args); } { ### scope $api_def my $api_def = [ [ REST => [ [ 'account_settings', { aliases => [ qw// ], path => 'account/settings', method => 'GET', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'account_totals', { aliases => [ qw// ], path => 'account/totals', method => 'GET', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'all_lists', { aliases => [ qw// ], path => 'lists/all', method => 'GET', params => [ qw/id user_id screen_name/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'block_exists', { aliases => [ qw// ], path => 'blocks/exists/:id', method => 'GET', params => [ qw/id user_id screen_name include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'blocking', { aliases => [ qw// ], path => 'blocks/blocking', method => 'GET', params => [ qw/page include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'blocking_ids', { aliases => [ qw// ], path => 'blocks/blocking/ids', method => 'GET', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'create_block', { aliases => [ qw// ], path => 'blocks/create/:id', method => 'POST', params => [ qw/id user_id screen_name include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'create_favorite', { aliases => [ qw// ], path => 'favorites/create/:id', method => 'POST', params => [ qw/id include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'create_friend', { aliases => [ qw/follow_new/ ], path => 'friendships/create/:id', method => 'POST', params => [ qw/id user_id screen_name follow include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities follow/ ], base_url_method => 'apiurl', } ], [ 'create_saved_search', { aliases => [ qw// ], path => 'saved_searches/create', method => 'POST', params => [ qw/query/ ], required => [ qw/query/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'destroy_block', { aliases => [ qw// ], path => 'blocks/destroy/:id', method => 'POST', params => [ qw/id user_idscreen_name/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'destroy_direct_message', { aliases => [ qw// ], path => 'direct_messages/destroy/:id', method => 'POST', params => [ qw/id include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'destroy_favorite', { aliases => [ qw// ], path => 'favorites/destroy/:id', method => 'POST', params => [ qw/id include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'destroy_friend', { aliases => [ qw/unfollow/ ], path => 'friendships/destroy/:id', method => 'POST', params => [ qw/id user_id screen_name include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'destroy_saved_search', { aliases => [ qw// ], path => 'saved_searches/destroy/:id', method => 'POST', params => [ qw/id/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'destroy_status', { aliases => [ qw// ], path => 'statuses/destroy/:id', method => 'POST', params => [ qw/id trim_user include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/trim_user include_entities/ ], base_url_method => 'apiurl', } ], [ 'direct_messages', { aliases => [ qw// ], path => 'direct_messages', method => 'GET', params => [ qw/since_id max_id count page include_entities/ ], required => [ qw/include_entities/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'disable_notifications', { aliases => [ qw// ], path => 'notifications/leave/:id', method => 'POST', params => [ qw/id screen_name include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'downtime_schedule', { aliases => [ qw// ], path => 'help/downtime_schedule', method => 'GET', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 1, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'enable_notifications', { aliases => [ qw// ], path => 'notifications/follow/:id', method => 'POST', params => [ qw/id screen_name include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'end_session', { aliases => [ qw// ], path => 'account/end_session', method => 'POST', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'favorites', { aliases => [ qw// ], path => 'favorites/:id', method => 'GET', params => [ qw/id page include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'followers', { aliases => [ qw// ], path => 'statuses/followers/:id', method => 'GET', params => [ qw/id user_id screen_name cursor include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'followers_ids', { aliases => [ qw// ], path => 'followers/ids/:id', method => 'GET', params => [ qw/id user_id screen_name cursor/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'friends', { aliases => [ qw/following/ ], path => 'statuses/friends/:id', method => 'GET', params => [ qw/id user_id screen_name cursor include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'friends_ids', { aliases => [ qw/following_ids/ ], path => 'friends/ids/:id', method => 'GET', params => [ qw/id user_id screen_name cursor/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'friends_timeline', { aliases => [ qw/following_timeline/ ], path => 'statuses/friends_timeline', method => 'GET', params => [ qw/since_id max_id count page skip_user trim_user include_entities include_rts/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/skip_user trim_user include_entities include_rts/ ], base_url_method => 'apiurl', } ], [ 'friendship_exists', { aliases => [ qw/relationship_exists follows/ ], path => 'friendships/exists', method => 'GET', params => [ qw/user_a user_b/ ], required => [ qw/user_a user_b/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'friendships_incoming', { aliases => [ qw// ], path => 'friendships/incoming', method => 'GET', params => [ qw/cursor/ ], required => [ qw/cursor/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'friendships_outgoing', { aliases => [ qw// ], path => 'friendships/outgoing', method => 'GET', params => [ qw/cursor/ ], required => [ qw/cursor/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'geo_id', { aliases => [ qw// ], path => 'geo/id/:id', method => 'GET', params => [ qw/id/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'home_timeline', { aliases => [ qw// ], path => 'statuses/home_timeline', method => 'GET', params => [ qw/since_id max_id count page skip_user exclude_replies contributor_details include_rts include_entities trim_user include_my_retweet/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/skip_user exclude_replies contributor_details include_rts include_entities trim_user include_my_retweet/ ], base_url_method => 'apiurl', } ], [ 'lookup_friendships', { aliases => [ qw// ], path => 'friendships/lookup', method => 'GET', params => [ qw/user_id screen_name/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'lookup_users', { aliases => [ qw// ], path => 'users/lookup', method => 'GET', params => [ qw/user_id screen_name include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'mentions', { aliases => [ qw/replies/ ], path => 'statuses/replies', method => 'GET', params => [ qw/since_id max_id count page trim_user include_rts include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/trim_user include_rts include_entities/ ], base_url_method => 'apiurl', } ], [ 'new_direct_message', { aliases => [ qw// ], path => 'direct_messages/new', method => 'POST', params => [ qw/user text screen_name user_id include_entities/ ], required => [ qw/user text/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'no_retweet_ids', { aliases => [ qw// ], path => 'friendships/no_retweet_ids', method => 'GET', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'public_timeline', { aliases => [ qw// ], path => 'statuses/public_timeline', method => 'GET', params => [ qw/skip_user trim_user include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/skip_user trim_user include_entities/ ], base_url_method => 'apiurl', } ], [ 'rate_limit_status', { aliases => [ qw// ], path => 'account/rate_limit_status', method => 'GET', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'related_results', { aliases => [ qw// ], path => 'related_results/show/:id', method => 'GET', params => [ qw/id/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'report_spam', { aliases => [ qw// ], path => 'report_spam', method => 'POST', params => [ qw/id user_id screen_name include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'retweet', { aliases => [ qw// ], path => 'statuses/retweet/:id', method => 'POST', params => [ qw/id include_entities trim_user/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities trim_user/ ], base_url_method => 'apiurl', } ], [ 'retweeted_by', { aliases => [ qw// ], path => 'statuses/:id/retweeted_by', method => 'GET', params => [ qw/id count page trim_user include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities trim_user/ ], base_url_method => 'apiurl', } ], [ 'retweeted_by_ids', { aliases => [ qw// ], path => 'statuses/:id/retweeted_by/ids', method => 'GET', params => [ qw/id count page trim_user include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities trim_user/ ], base_url_method => 'apiurl', } ], [ 'retweeted_by_me', { aliases => [ qw// ], path => 'statuses/retweeted_by_me', method => 'GET', params => [ qw/since_id max_id count page trim_user include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/trim_user include_entities/ ], base_url_method => 'apiurl', } ], [ 'retweeted_by_user', { aliases => [ qw// ], path => 'statuses/retweeted_by_user', method => 'GET', params => [ qw/id user_id screen_name/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'retweeted_to_me', { aliases => [ qw// ], path => 'statuses/retweeted_to_me', method => 'GET', params => [ qw/since_id max_id count page/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'retweeted_to_user', { aliases => [ qw// ], path => 'statuses/retweeted_to_user', method => 'GET', params => [ qw/id user_id screen_name/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'retweets', { aliases => [ qw// ], path => 'statuses/retweets/:id', method => 'GET', params => [ qw/id count trim_user include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/trim_user include_entities/ ], base_url_method => 'apiurl', } ], [ 'retweets_of_me', { aliases => [ qw/retweeted_of_me/ ], path => 'statuses/retweets_of_me', method => 'GET', params => [ qw/since_id max_id count page trim_user include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/trim_user include_entities/ ], base_url_method => 'apiurl', } ], [ 'reverse_geocode', { aliases => [ qw// ], path => 'geo/reverse_geocode', method => 'GET', params => [ qw/lat long accuracy granularity max_results/ ], required => [ qw/lat long/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'saved_searches', { aliases => [ qw// ], path => 'saved_searches', method => 'GET', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'sent_direct_messages', { aliases => [ qw// ], path => 'direct_messages/sent', method => 'GET', params => [ qw/since_id max_id page count include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'show_direct_message', { aliases => [ qw// ], path => 'direct_messages/show/:id', method => 'GET', params => [ qw/id include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'show_friendship', { aliases => [ qw/show_relationship/ ], path => 'friendships/show', method => 'GET', params => [ qw/source_id source_screen_name target_id target_id_name/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'show_saved_search', { aliases => [ qw// ], path => 'saved_searches/show/:id', method => 'GET', params => [ qw/id/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'show_status', { aliases => [ qw// ], path => 'statuses/show/:id', method => 'GET', params => [ qw/id trim_user include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/trim_user include_entities/ ], base_url_method => 'apiurl', } ], [ 'show_user', { aliases => [ qw// ], path => 'users/show/:id', method => 'GET', params => [ qw/id screen_name include_entities/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'suggestion_categories', { aliases => [ qw// ], path => 'users/suggestions', method => 'GET', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'test', { aliases => [ qw// ], path => 'help/test', method => 'GET', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'trends', { aliases => [ qw// ], path => 'trends', method => 'GET', params => [ qw// ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 0, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'trends_available', { aliases => [ qw// ], path => 'trends/available', method => 'GET', params => [ qw/lat long/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 0, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'trends_current', { aliases => [ qw// ], path => 'trends/current', method => 'GET', params => [ qw/exclude/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 0, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'trends_daily', { aliases => [ qw// ], path => 'trends/daily', method => 'GET', params => [ qw/date exclude/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 0, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'trends_location', { aliases => [ qw// ], path => 'trends/:woeid', method => 'GET', params => [ qw/woeid/ ], required => [ qw/woeid/ ], add_source => 0, deprecated => 0, authenticate => 0, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'trends_weekly', { aliases => [ qw// ], path => 'trends/weekly', method => 'GET', params => [ qw/date exclude/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 0, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'update', { aliases => [ qw// ], path => 'statuses/update', method => 'POST', params => [ qw/status lat long place_id display_coordinates in_reply_to_status_id trim_user include_entities/ ], required => [ qw/status/ ], add_source => 1, deprecated => 0, authenticate => 1, booleans => [ qw/display_coordinates trim_user include_entities/ ], base_url_method => 'apiurl', } ], [ 'update_delivery_device', { aliases => [ qw// ], path => 'account/update_delivery_device', method => 'POST', params => [ qw/device/ ], required => [ qw/device/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'update_friendship', { aliases => [ qw// ], path => 'friendships/update', method => 'POST', params => [ qw/id user_id screen_name device retweets/ ], required => [ qw/id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/device retweets/ ], base_url_method => 'apiurl', } ], [ 'update_location', { aliases => [ qw// ], path => 'account/update_location', method => 'POST', params => [ qw/location/ ], required => [ qw/location/ ], add_source => 0, deprecated => 1, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'update_profile', { aliases => [ qw// ], path => 'account/update_profile', method => 'POST', params => [ qw/name email url location description include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'update_profile_background_image', { aliases => [ qw// ], path => 'account/update_profile_background_image', method => 'POST', params => [ qw/image use/ ], required => [ qw/image/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/use/ ], base_url_method => 'apiurl', } ], [ 'update_profile_colors', { aliases => [ qw// ], path => 'account/update_profile_colors', method => 'POST', params => [ qw/profile_background_color profile_text_color profile_link_color profile_sidebar_fill_color profile_sidebar_border_color/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'update_profile_image', { aliases => [ qw// ], path => 'account/update_profile_image', method => 'POST', params => [ qw/image/ ], required => [ qw/image/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'user_suggestions', { aliases => [ qw/follow_suggestions/ ], path => 'users/suggestions/:category/members', method => 'GET', params => [ qw/category lang/ ], required => [ qw/category/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'apiurl', } ], [ 'user_timeline', { aliases => [ qw// ], path => 'statuses/user_timeline/:id', method => 'GET', params => [ qw/id user_id screen_name since_id max_id count page skip_user trim_user include_entities include_rts/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/skip_user trim_user include_entities include_rts/ ], base_url_method => 'apiurl', } ], [ 'users_search', { aliases => [ qw/find_people search_users/ ], path => 'users/search', method => 'GET', params => [ qw/q per_page page include_entities/ ], required => [ qw/q/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], [ 'verify_credentials', { aliases => [ qw// ], path => 'account/verify_credentials', method => 'GET', params => [ qw/include_entities/ ], required => [ qw// ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw/include_entities/ ], base_url_method => 'apiurl', } ], ] ], [ Search => [ [ 'search', { aliases => [ qw// ], path => 'search', method => 'GET', params => [ qw/q callback lang locale rpp page since_id until geocode show_user result_type/ ], required => [ qw/q/ ], add_source => 0, deprecated => 0, authenticate => 0, booleans => [ qw// ], base_url_method => 'searchapiurl', } ], ] ], [ Lists => [ [ 'add_list_member', { aliases => [ qw// ], path => ':user/:list_id/members', method => 'POST', params => [ qw/user list_id id/ ], required => [ qw/user list_id id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'create_list', { aliases => [ qw// ], path => ':user/lists', method => 'POST', params => [ qw/user name mode description/ ], required => [ qw/user name/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'delete_list', { aliases => [ qw// ], path => ':user/lists/:list_id', method => 'DELETE', params => [ qw/user list_id/ ], required => [ qw/user list_id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'delete_list_member', { aliases => [ qw/remove_list_member/ ], path => ':user/:list_id/members', method => 'DELETE', params => [ qw/user list_id id/ ], required => [ qw/user list_id id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'get_list', { aliases => [ qw// ], path => ':user/lists/:list_id', method => 'GET', params => [ qw/user list_id/ ], required => [ qw/user list_id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'get_lists', { aliases => [ qw/list_lists/ ], path => ':user/lists', method => 'GET', params => [ qw/user cursor/ ], required => [ qw/user/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'is_list_member', { aliases => [ qw// ], path => ':user/:list_id/members/:id', method => 'GET', params => [ qw/user list_id id/ ], required => [ qw/user list_id id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'is_list_subscriber', { aliases => [ qw/is_subscribed_list/ ], path => ':user/:list_id/subscribers/:id', method => 'GET', params => [ qw/user list_id id/ ], required => [ qw/user list_id id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'list_members', { aliases => [ qw// ], path => ':user/:list_id/members', method => 'GET', params => [ qw/user list_id id cursor/ ], required => [ qw/user list_id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'list_memberships', { aliases => [ qw// ], path => ':user/lists/memberships', method => 'GET', params => [ qw/user cursor/ ], required => [ qw/user/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'list_statuses', { aliases => [ qw// ], path => ':user/lists/:list_id/statuses', method => 'GET', params => [ qw/user list_id since_id max_id per_page page/ ], required => [ qw/user list_id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'list_subscribers', { aliases => [ qw// ], path => ':user/:list_id/subscribers', method => 'GET', params => [ qw/user list_id id cursor/ ], required => [ qw/user list_id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'list_subscriptions', { aliases => [ qw// ], path => ':user/lists/subscriptions', method => 'GET', params => [ qw/user cursor/ ], required => [ qw/user/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'members_create_all', { aliases => [ qw/add_list_members/ ], path => ':user/:list_id/members/create_all', method => 'POST', params => [ qw/user list_id screen_name user_id/ ], required => [ qw/user list_id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'subscribe_list', { aliases => [ qw// ], path => ':user/:list_id/subscribers', method => 'POST', params => [ qw/user list_id/ ], required => [ qw/user list_id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'unsubscribe_list', { aliases => [ qw// ], path => ':user/:list_id/subscribers', method => 'DELETE', params => [ qw/user list_id/ ], required => [ qw/user list_id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], [ 'update_list', { aliases => [ qw// ], path => ':user/lists/:list_id', method => 'POST', params => [ qw/user list_id name mode description/ ], required => [ qw/user list_id/ ], add_source => 0, deprecated => 0, authenticate => 1, booleans => [ qw// ], base_url_method => 'lists_api_url', } ], ] ], ]; my $with_url_arg = sub { my ($path, $args) = @_; if ( defined(my $id = delete $args->{id}) ) { $path .= uri_escape($id); } else { chop($path); } return $path; }; while ( @$api_def ) { my $api = shift @$api_def; my $api_name = shift @$api; my $methods = shift @$api; for my $method ( @$methods ) { my $name = shift @$method; my %options = %{ shift @$method }; my ($arg_names, $path) = @options{qw/required path/}; $arg_names = $options{params} if @$arg_names == 0 && @{$options{params}} == 1; my $modify_path = $path =~ s,/id$,/, ? $with_url_arg : sub { $_[0] }; my $code = sub { my $self = shift; # copy callers args since we may add ->{source} my $args = ref $_[-1] eq 'HASH' ? { %{pop @_} } : {}; croak sprintf "$name expected %d args", scalar @$arg_names if @_ > @$arg_names; # promote positional args to named args for ( my $i = 0; @_; ++$i ) { my $param = $arg_names->[$i]; croak "duplicate param $param: both positional and named" if exists $args->{$param}; $args->{$param} = shift; } $args->{source} ||= $self->{source} if $options{add_source}; my $authenticate = exists $args->{authenticate} ? delete $args->{authenticate} : $options{authenticate} ; # promote boolean parameters for my $boolean_arg ( @{ $options{booleans} } ) { if ( exists $args->{$boolean_arg} ) { next if $args->{$boolean_arg} =~ /^true|false$/; $args->{$boolean_arg} = $args->{$boolean_arg} ? 'true' : 'false'; } } # Workaround Twitter bug: any value passed for skip_user is treated as true. # The only way to get 'false' is to not pass the skip_user at all. delete $args->{skip_user} if exists $args->{skip_user} && $args->{skip_user} eq 'false'; # replace placeholder arguments my $local_path = $path; $local_path =~ s,/:id$,, unless exists $args->{id}; # remove optional trailing id $local_path =~ s/:(\w+)/delete $args->{$1} or croak "required arg '$1' missing"/eg; my $uri = URI->new($self->{$options{base_url_method}} . "/$local_path.json"); return $self->_parse_result( $self->_authenticated_request($options{method}, $uri, $args, $authenticate) ); }; no strict 'refs'; *{__PACKAGE__ . "::$_"} = $code for $name, @{$options{aliases}}; } } # catch expected error and promote it to an undef for ( qw/list_members is_list_member list_subscribers is_list_subscriber/ ) { my $orig = __PACKAGE__->can($_) or die; my $code = sub { my $r = eval { $orig->(@_) }; if ( $@ ) { return if $@ =~ /The specified user is not a (?:memb|subscrib)er of this list/; die $@; } return $r; }; no strict 'refs'; no warnings 'redefine'; *{__PACKAGE__ . "::$_"} = $code; } # special case parameter handling for lookup_users for ( qw/lookup_users/ ) { my $orig = __PACKAGE__->can($_) or die; my $code = sub { my $self = shift; my $args = ref $_[-1] eq 'HASH' ? pop @_ : {}; $args = { %$args, @_ }; for ( qw/screen_name user_id/ ) { $args->{$_} = join(',' => @{ $args->{$_} }) if ref $args->{$_} eq 'ARRAY'; } return $orig->($self, $args); }; no strict 'refs'; no warnings 'redefine'; *{__PACKAGE__ . "::$_"} = $code; } } ### end scope for $api_def sub _from_json { my ($self, $json) = @_; return eval { $json_handler->from_json($json) }; } sub _parse_result { my ($self, $res) = @_; # workaround for Laconica API returning bools as strings # (Fixed in Laconi.ca 0.7.4) my $content = $res->content; $content =~ s/^"(true|false)"$/$1/; my $obj = $self->_from_json($content); # Twitter sometimes returns an error with status code 200 if ( $obj && ref $obj eq 'HASH' && exists $obj->{error} ) { die Net::Twitter::Lite::Error->new(twitter_error => $obj, http_response => $res); } return $obj if $res->is_success && defined $obj; my $error = Net::Twitter::Lite::Error->new(http_response => $res); $error->twitter_error($obj) if ref $obj; die $error; } 1; __END__