public
Description: Ruby wrapper for Yahoo!'s FireEagle
Homepage: http://fireeagle.rubyforge.org/
Clone URL: git://github.com/jnewland/fireeagle.git
mojodna (author)
Wed Jun 10 15:45:11 -0700 2009
Jesse Newland (committer)
Thu Jul 30 07:06:19 -0700 2009
name age message
file .gitignore Wed Mar 05 05:08:21 -0800 2008 rethinking the version number [Jesse Newland]
file History.txt Thu Jul 30 07:06:15 -0700 2009 support for OAuth 1.0a Signed-off-by: Jesse Ne... [mojodna]
file License.txt Wed Mar 05 05:16:22 -0800 2008 cleanup before push to rubyforge [Jesse Newland]
file Manifest.txt Tue Feb 03 16:11:10 -0800 2009 updated Manifest and deps [mojodna]
file README.txt Wed Mar 05 06:58:08 -0800 2008 document github repo [Jesse Newland]
file Rakefile Thu Feb 21 18:51:02 -0800 2008 rubyforge jumping jacks. github needs a gem ser... [Jesse Newland]
directory config/ Tue Feb 03 16:11:10 -0800 2009 updated Manifest and deps [mojodna]
file fireeagle.gemspec Thu Jul 30 07:06:19 -0700 2009 bump version Signed-off-by: Jesse Newland <jne... [mojodna]
directory lib/ Thu Jul 30 07:06:17 -0700 2009 rev'd to 0.8.99 Signed-off-by: Jesse Newland <... [mojodna]
directory script/ Thu Feb 21 18:51:02 -0800 2008 rubyforge jumping jacks. github needs a gem ser... [Jesse Newland]
file setup.rb Thu Jun 21 14:53:28 -0700 2007 initial import [jnewland]
directory spec/ Mon Feb 02 19:15:40 -0800 2009 Added missing response elements [mojodna]
directory tasks/ Mon Mar 10 23:42:20 -0700 2008 Make spec the default Rake task [kamal]
README.txt
FireEagle[http://fireeagle.yahoo.net] (FE) is a system providing centralized
management of user location information. FE allows 3rd party developers to
pdate and/or access user's location data.

http://fireeagle.yahoo.net/developer/documentation

== Installation

 gem install fireeagle
 
== Usage

  >> require 'fireeagle'
  >> client = FireEagle::Client.new(
    :consumer_key        => "<consumer key>",
    :consumer_secret     => "<consumer secret>",
    :access_token        => "[access token]",
    :access_token_secret => "[access token secret]")

==== With a User-specific OAuth Access Token

  # update your location
  >> client.update(:q => "punta del diablo, uruguay") # I wish
  # query your location
  >> user = client.user
  => #<FireEagle::User:0x1ca5e08 ... >
  >> user.locations
  => [#<FireEagle::Location:0x1cdd9e8 ...>, #<FireEagle::Location:0x1cc8ffc ...>, ... ]
  >> user.best_guess
  => #<FireEagle::Location:0x1cdd9e8 ...>
  >> user.best_guess.name
  => "Punta del Diablo, Uruguay"
  # lookup a location
  >> locations = client.lookup(:q => "30022")
  => [#<FireEagle::Location:0x1cdd9e8 ...>, #<FireEagle::Location:0x1cc8ffc ...>, ...]
  >> locations.first.name => "Alpharetta, GA 30022"
  >> locations.first.place_id => "IrhZMHuYA5s1fFi4Qw"

== Authorization

Authorization is handled by OAuth. For more details about the OAuth
authorization flow and how it differs based on your application type, please
see http://fireeagle.yahoo.net/developer/documentation/authorizing

== Contributing

http://github.com/jnewland/fireeagle/tree/master. You know what to do.

Rubyforge Project Page:: http://rubyforge.org/projects/fireeagle
Author::    Jesse Newland (http://soylentfoo.jnewland.com) (jnewland@gmail.com[mailto:jnewland@gmail.com])
Copyright:: Copyright (c) 2008 Jesse Newland. Portions[http://pastie.caboo.se/private/oevvkdzl0zrdkf8s7hetg] Copyright 
(c) 2008 Yahoo!
License::   Distributed under the same terms as Ruby