NAME
API::Twitter - Perl 5 API wrapper for Twitter.com
VERSION
version 0.01
SYNOPSIS
use API::Twitter;
my $twitter = API::Twitter->new(
consumer_key => 'CONSUMER_KEY',
consumer_secret => 'CONSUMER_SECRET',
access_token => 'ACCESS_TOKEN',
access_token_secret => 'ACCESS_TOKEN_SECRET',
identifier => 'IDENTIFIER',
);
$twitter->debug(1);
$twitter->fatal(1);
my $user = $twitter->users('lookup');
my $results = $user->fetch;
# after some introspection
$user->update( ... );DESCRIPTION
This distribution provides an object-oriented thin-client library for interacting with the Twitter (http://twitter.com) API. For usage and documentation information visit https://dev.twitter.com/rest/public.
THIN CLIENT
A thin-client library is advantageous as it has complete API coverage and can easily adapt to changes in the API with minimal effort. As a thin-client library, this module does not map specific HTTP requests to specific routines, nor does it provide parameter validation, pagination, or other conventions found in typical API client implementations, instead, it simply provides a simple and consistent mechanism for dynamically generating HTTP requests. Additionally, this module has support for debugging and retrying API calls as well as throwing exceptions when 4xx and 5xx server response codes are returned.
Building
my $user = $twitter->users('lookup');
$user->action; # GET /users/lookup
$user->action('head'); # HEAD /users/lookup
$user->action('patch'); # PATCH /users/lookupBuilding up an HTTP request object is extremely easy, simply call method names which correspond to the API's path segments in the resource you wish to execute a request against. This module uses autoloading and returns a new instance with each method call. The following is the equivalent:
Chaining
my $users = $twitter->resource('users');
# or
my $users = $twitter->users;
my $user = $users->resource('lookup');
# then
$user->action('put', %args); # PUT /users/lookupBecause each call returns a new API instance configured with a resource locator based on the supplied parameters, reuse and request isolation are made simple, i.e., you will only need to configure the client once in your application.
Fetching
my $users = $twitter->users;
# query-string parameters
$users->fetch( query => { ... } );
# equivalent to
my $users = $twitter->resource('users');
$users->action( get => ( query => { ... } ) );This example illustrates how you might fetch an API resource.
Creating
my $users = $twitter->users;
# content-body parameters
$users->create( data => { ... } );
# query-string parameters
$users->create( query => { ... } );
# equivalent to
$twitter->resource('users')->action(
post => ( query => { ... }, data => { ... } )
);This example illustrates how you might create a new API resource.
Updating
my $users = $twitter->users;
my $user = $users->resource('lookup');
# content-body parameters
$user->update( data => { ... } );
# query-string parameters
$user->update( query => { ... } );
# or
my $user = $twitter->users('lookup');
$user->update( ... );
# equivalent to
$twitter->resource('users')->action(
put => ( query => { ... }, data => { ... } )
);This example illustrates how you might update a new API resource.
Deleting
my $users = $twitter->users;
my $user = $users->resource('lookup');
# content-body parameters
$user->delete( data => { ... } );
# query-string parameters
$user->delete( query => { ... } );
# or
my $user = $twitter->users('lookup');
$user->delete( ... );
# equivalent to
$twitter->resource('users')->action(
delete => ( query => { ... }, data => { ... } )
);This example illustrates how you might delete an API resource.
Transacting
my $users = $twitter->resource('users', 'lookup');
my ($results, $transaction) = $users->action( ... );
my $request = $transaction->req;
my $response = $transaction->res;
my $headers;
$headers = $request->headers;
$headers = $response->headers;
# etcThis example illustrates how you can access the transaction object used represent and process the HTTP transaction.
PARAMETERS
access_token
$twitter->access_token;
$twitter->access_token('ACCESS_TOKEN');The access_token parameter should be set to an API access_token associated with your account.
access_token_secret
$twitter->access_token_secret;
$twitter->access_token_secret('ACCESS_TOKEN_SECRET');The access_token_secret parameter should be set to an API access_token_secret associated with your account.
consumer_key
$twitter->consumer_key;
$twitter->consumer_key('CONSUMER_KEY');The consumer_key parameter should be set to an API consumer_key associated with your account.
consumer_secret
$twitter->consumer_secret;
$twitter->consumer_secret('CONSUMER_SECRET');The consumer_secret parameter should be set to an API consumer_secret associated with your account.
identifier
$twitter->identifier;
$twitter->identifier('IDENTIFIER');The identifier parameter should be set to a string that identifies your app.
ATTRIBUTES
debug
$twitter->debug;
$twitter->debug(1);The debug attribute if true prints HTTP requests and responses to standard out.
fatal
$twitter->fatal;
$twitter->fatal(1);The fatal attribute if true promotes 4xx and 5xx server response codes to exceptions, a API::Twitter::Exception object.
retries
$twitter->retries;
$twitter->retries(10);The retries attribute determines how many times an HTTP request should be retried if a 4xx or 5xx response is received. This attribute defaults to 1.
timeout
$twitter->timeout;
$twitter->timeout(5);The timeout attribute determines how long an HTTP connection should be kept alive. This attribute defaults to 10.
url
$twitter->url;
$twitter->url(Mojo::URL->new('https://api.twitter.com'));The url attribute set the base/pre-configured URL object that will be used in all HTTP requests. This attribute expects a Mojo::URL object.
user_agent
$twitter->user_agent;
$twitter->user_agent(Mojo::UserAgent->new);The user_agent attribute set the pre-configured UserAgent object that will be used in all HTTP requests. This attribute expects a Mojo::UserAgent object.
METHODS
action
my $result = $twitter->action($verb, %args);
# e.g.
$twitter->action('head', %args); # HEAD request
$twitter->action('options', %args); # OPTIONS request
$twitter->action('patch', %args); # PATCH requestThe action method issues a request to the API resource represented by the object. The first parameter will be used as the HTTP request method. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
create
my $results = $twitter->create(%args);
# or
$twitter->POST(%args);The create method issues a POST request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
delete
my $results = $twitter->delete(%args);
# or
$twitter->DELETE(%args);The delete method issues a DELETE request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
fetch
my $results = $twitter->fetch(%args);
# or
$twitter->GET(%args);The fetch method issues a GET request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
update
my $results = $twitter->update(%args);
# or
$twitter->PUT(%args);The update method issues a PUT request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
RESOURCES
account
$twitter->account;The account method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#account.
application
$twitter->application;The application method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#application.
blocks
$twitter->blocks;The blocks method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#blocks.
direct_messages
$twitter->direct_messages;The direct_messages method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#direct_messages.
favorites
$twitter->favorites;The favorites method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#favorites.
followers
$twitter->followers;The followers method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#followers.
friends
$twitter->friends;The friends method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#friends.
friendships
$twitter->friendships;The friendships method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#friendships.
geo
$twitter->geo;The geo method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#geo.
help
$twitter->help;The help method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#help.
lists
$twitter->lists;The lists method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#lists.
media
$twitter->media;The media method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#media.
mutes
$twitter->mutes;The mutes method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#mutes.
saved_searches
$twitter->saved_searches;The saved_searches method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#saved_searches.
search
$twitter->search;The search method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#search.
statuses
$twitter->statuses;The statuses method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#statuses.
trends
$twitter->trends;The trends method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#trends.
users
$twitter->users;The users method returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://dev.twitter.com/rest/public#users.
AUTHOR
Al Newkirk <anewkirk@ana.io>
COPYRIGHT AND LICENSE
This software is copyright (c) 2014 by Al Newkirk.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.