/ 
Facebook-Graph-0.0600
River stage one • 4 direct dependents • 4 total dependents
/ Facebook::Graph

NAME

Facebook::Graph - A fast and easy way to integrate your apps with Facebook.

VERSION

version 0.0600

SYNOPSIS

my $fb = Facebook::Graph->new;
my $sarah_bownds = $fb->fetch('sarahbownds');
my $perl_page = $fb->fetch('16665510298');

Or better yet:

my $sarah_bownds = $fb->query
   ->find('sarahbownds')
   ->include_metadata
   ->select_fields(qw( id name picture ))
   ->request
   ->as_hashref;
   
my $sarahs_picture_uri = $fb->picture('sarahbownds')->get_large->uri_as_string;

Building A Privileged App

my $fb = Facebook::Graph->new(
   app_id          => $facebook_application_id,
   secret          => $facebook_application_secret,
   postback        => 'https://www.yourapplication.com/facebook/oauth/postback',
);

Get the user to authorize your app (only needed if you want to fetch non-public information or publish stuff):

my $uri = $fb
   ->authorize
   ->extend_permissions(qw(offline_access publish_stream))
   ->uri_as_string;

# redirect the user's browser to $uri

Handle the Facebook authorization code postback:

my $q = Plack::Request->new($env);
$fb->request_access_token($q->query_param('code'));

Or if you already had the access token:

$fb->access_token($token);

Get some info:

my $user = $fb->fetch('me');
my $friends = $fb->fetch('me/friends');
my $sarah_bownds = $fb->fetch('sarahbownds');

DESCRIPTION

This is a Perl interface to the Facebook Graph API http://developers.facebook.com/docs/api. With this module you can currently query public Facebook data, query privileged Facebook data, and build a privileged Facebook application. See the TODO for all that this module cannot yet do.

WARNING: The work on this module has only just begun because the Graph API itself isn't very new, and I'm only working on it as I have some tuits. Therefore things are potentially subject to change drastically with each release.

METHODS

new ( [ params ] )

The constructor.

params

A hash of base parameters, just so you don't have to pass them around. If you only want to do public queries then these params are not needed.

access_token

An access token string used to make Facebook requests as a privileged user. Required if you want to make privileged queries or perform privileged actions on Facebook objects.

app_id

The application id that you get from Facebook after registering (http://developers.facebook.com/setup/) your application on their site. Required if you'll be calling the request_access_token, convert_sessions, or authorize methods.

secret

The application secret that you get from Facebook after registering your application. Required if you'll be calling the request_access_token or convert_sessions methods.

postback

The URI that Facebook should post your authorization code back to. Required if you'll be calling the request_access_token or authorize methods.

NOTE: It must be a sub URI of the URI that you put in the Application Settings > Connect > Connect URL field of your application's profile on Facebook.

authorize ( )

Creates a Facebook::Graph::Authorize object, which can be used to get permissions from a user for your application.

request_access_token ( code )

Creates a Facebook::Graph::AccessToken object and fetches an access token from Facebook, which will allow everything you do with Facebook::Graph to work within user privileges rather than through the public interface. Returns a Facebook::Graph::AccessToken::Response object, and also sets the access_token property in the Facebook::Graph object.

code

An authorization code string that you should have gotten by going through the authorize process.

query ( )

Creates a Facebook::Graph::Query object, which can be used to fetch and search data from Facebook.

fetch ( id )

Returns a hash reference of an object from facebook. A quick way to grab an object from Facebook. These two statements are identical:

my $sarah = $fb->fetch('sarahbownds');

my $sarah = $fb->query->find('sarahbownds')->request->as_hashref;

id

An profile id like sarahbownds or an object id like 16665510298 for the Perl page.

picture ( id )

Returns a Facebook::Graph::Picture object, which can be used to generate the URLs of the pictures of any object on Facebook.

id

An profile id like sarahbownds or an object id like 16665510298 for the Perl page.

add_post ( )

Creates a Facebook::Graph::Publish::Post object, which can be used to publish data to a user's feed/wall.

add_like ( id )

Creates a Facebook::Graph::Publish::Like object to tell everyone about a post you like.

id

The id of a post you like.

add_comment ( id )

Creates a Facebook::Graph::Publish::Comment object that you can use to comment on a note.

id

The id of the post you want to comment on.

add_note ( )

Creates a Facebook::Graph::Publish::Note object, which can be used to publish notes.

Creates a Facebook::Graph::Publish::Link object, which can be used to publish links.

add_event ( )

Creates a Facebook::Graph::Publish::Event object, which can be used to publish events.

rsvp_maybe ( id )

RSVP as 'maybe' to an event.

id

The id of an event.

rsvp_attending ( id )

RSVP as 'attending' to an event.

id

The id of an event.

rsvp_declined ( id )

RSVP as 'declined' to an event.

id

The id of an event.

convert_sessions ( sessions )

A utility method to convert old sessions into access tokens that can be used with the Graph API. Returns an array reference of hash references of access tokens.

[
  {
    "access_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "expires": 1271649600,
  },
  ...
]

See also Facebook::Graph::Session.

sessions

An array reference of session ids from the old Facebook API.

EXCEPTIONS

This module throws exceptions when it encounters a problem. The exceptions are an array reference. The first element is an HTTP status code. The second element is a human readable string. The third element is the exception type as identified by the Facebook API, or if something terrible went wrong Unknown. For example:

[400, 'Could not execute request (https://graph.facebook.com?fields=): GraphMethodException - Unsupported get request.', 'GraphMethodException']

TODO

I still need to add publishing albums/photos, deleting of content, impersonation, and analytics to have a feature complete API. Would also like to figure out inbox stuff, but it doesn't seem to be documented. In addition, the module could use a lot more tests.

PREREQS

Any::Moose JSON LWP URI Crypt::SSLeay DateTime DateTime::Format::Strptime

NOTE: This module requires SSL to function, but on some systems Crypt::SSLeay can be difficult to install. You may optionally choose to install IO::Socket::SSL instead and it will provide the same function. Unfortunately that means you'll need to force Facebook::Graph to install if you do not have Crypt::SSLeay installed.

SUPPORT

Repository

http://github.com/rizen/Facebook-Graph

Bug Reports

http://github.com/rizen/Facebook-Graph/issues

SEE ALSO

If you're looking for a fully featured Facebook client in Perl I highly recommend WWW::Facebook::API. It does just about everything, it just uses the old Facebook API.

AUTHOR

JT Smith <jt_at_plainblack_dot_com>

LEGAL

Facebook::Graph is Copyright 2010 Plain Black Corporation (http://www.plainblack.com) and is licensed under the same terms as Perl itself.