Net::FireEagle - access Yahoo's new FireEagle location service
# Set up Fire Eagle oauth
my $fe = Net::FireEagle->new( consumer_key => $consumer_key,
consumer_secret => $consumer_secret );
# Resume previous Fire Eagle oauth, feed access token and secret
my $fe2 = Net::FireEagle->new( consumer_key => $consumer_key,
consumer_secret => $consumer_secret,
access_token => $access_token,
access_token_secret => $access_token_secret );
# Send this to user to grant authorization for this app
my $auth_url = $fe->authorization_url;
# ... and request an access token
# Note: you can save these in DB to restore previous Fire Eagle oauth session
my ($access_token, $access_token_secret) = $fe->request_access_token;
# Get them back
my $access_token = $fe->access_token;
my $access_token_secret = $fe->access_token_secret;
# Can't query or update location without authorization
my $loc = $fe->location; # returns xml
my $loc = $fe->location( format => 'xml' ); # returns xml
my $loc = $fe->location( format => 'json' ); # returns json
# returns result on success. dies or returns undef on failure
my $return = $fe->update_location( "500 Third St., San Francisco, CA" );
# Find a location. Returns either xml or json
my $return = $fe->lookup_location( "Pensacola" );
Fire Eagle is a site that stores information about your location. With your permission, other services and devices can either update that information or access it. By helping applications respond to your location, Fire Eagle is designed to make the world around you more interesting! Use your location to power friend-finders, games, local information services, blog badges and stuff like that...
For more information see http://fireeagle.yahoo.net/
For more information read this
http://fireeagle.yahoo.net/developer/documentation/getting_started
but, in short you have to first get an API key from the FireEagle site. Then using this consumer key and consumer secret you have to authenticate the relationship between you and your user. See the script fireagle packaged with this module for an example of how to do this.
The script fireeagle shipped with this module gives you really quick access to your FireEagle account - you can use it to simply query and update your location.
It also serves as a pretty good example of how to do desktop app authentication and how to use the API.
Create a new FireEagle object. This must have the options
which you can get at http://fireeagle.yahoo.net/developer/manage
then, when you have your per-user authentication tokens (see above) you can supply
Whether the client has the necessary credentials to be authorized.
Note that the credentials may be wrong and so the request may still fail.
Returns the current consumer key.
Can optionally set the consumer key.
Returns the current consumer secret.
Can optionally set the consumer secret.
Returns the current access token.
Can optionally set a new token.
Returns the current access token secret.
Can optionally set a new secret.
Request the access token and access token secret for this user.
The user must have authorized this app at the url given by get_authorization_url first.
Returns the access token and access token secret but also sets them internally so that after calling this method you can immediately call location or update_location.
Get the URL to authorize a user.
Get the user's current location.
Options are passed in as a hash and may be one of
Either 'xml' or 'json'. Defaults to 'xml'.
Takes a free form string with the new location.
Return the result of the update in either xml or json depending on opts.
The location can either be a plain string or a hash reference containing location parameters as described in
http://fireeagle.yahoo.net/developer/documentation/location#locparams
Disambiguates potential values for update. Results from lookup can be passed to update to ensure that Fire Eagle will understand how to parse the location parameter.
Return the result of the update in either xml or json depending on opts.
The query can either be a plain string or a hash reference containing location parameters as described in
http://fireeagle.yahoo.net/developer/documentation/location#locparams
If Math::Random::MT is installed then any nonces generated will use a Mersenne Twiser instead of Perl's built in randomness function.
Non known
The latest code for this module can be found at
http://svn.unixbeard.net/simon/Net-FireEagle
Original code by Yahoo! Brickhouse.
Additional code from Aaron Straup Cope
Rewritten and packaged by Simon Wistow <swistow@sixapart.com>
Copyright 2008 - Simon Wistow and Yahoo! Brickhouse
Distributed under the same terms as Perl itself.
See perlartistic and perlgpl.
