@@ -60,7 +60,21 @@ You can now update and query that user's location, assuming the User gave you th More information about the acceptable parameters for updating a User's location is available in the RDoc for "FireEagle::Client#update":http://fireeagle.rubyforge.org/classes/FireEagle/Client.html -More information about 'location' response is available in the RDoc for "FireEagle::Location":http://fireeagle.rubyforge.org/classes/FireEagle/Location.html. The 'best guess' location is currently automatically selected and returned. +More information about 'location' response is available in the RDoc for "FireEagle::Location":http://fireeagle.rubyforge.org/classes/FireEagle/Location.html. The 'best guess' location is currently automatically selected and returned. We'd really appreciate it if you didn't call FireEagle to get a user's location on every page load - please cache locations for an appropriate length of time + +Oh, and you get some pretty rad class-level finders too: + +<pre> +>> User.find_fireeagle_recent(:conditions => { :time => 'now' }, :limit => 10, :offset => 0) +</pre> + +The call above returns a list of users of the application who have updated their location within the given amount of time. The @time@ condition is flexible, supported forms are 'now', 'yesterday', '12:00', '13:00', '1:00pm' and '2008-03-12 12:34:56'. (default: 'now') + +>> User.find_fireeagle_within(:conditions => { :woe => "12796255" }, :limit => 10, :offset => 0) + +The call above takes a Place ID or a WoE ID and returns a list of users using your application who are within the bounding box of that location. Not for the faint of heart, this method is experimental and may not be stable. + +The arrays of Users returned by both of the class level finders have their most recent location information cached fresh from Fire Eagle. h3. Author README.textile @@ -23,14 +23,14 @@ module RideTheFireeagle end def find_fireeagle_recent(args = {}) - args = {:limit => 10, :offset => 0, :time => 'now'}.merge(args) - fe_users = fireeagle.recent(args[:limit], args[:offset], args[:time]) rescue [] + args = {:limit => 10, :offset => 0, :conditions => {:time => 'now'}}.merge(args) + fe_users = fireeagle.recent(args[:limit], args[:offset], args[:conditions][:time]) rescue [] convert_fe_users_to_ar_objects(fe_users) end - def find_fireeagle_within(location = {}, args = {}) - args = {:limit => 10, :offset => 0}.merge(args) - fe_users = fireeagle.within(location, args[:limit], args[:offset]) rescue [] + def find_fireeagle_within(args = {}) + args = {:limit => 10, :offset => 0, :conditions => {}}.merge(args) + fe_users = fireeagle.within(args[:conditions], args[:limit], args[:offset]) rescue [] convert_fe_users_to_ar_objects(fe_users) end lib/ride_the_fireeagle.rb @@ -35,18 +35,18 @@ describe "The User class" do it "should load recently updated users" do @client.should_receive(:recent).with(10, 0, 'now').and_return([@fe_user_1, @fe_user_2]) - users = User.find_fireeagle_recent(:limit => 10, :offset => 0, :time => 'now') + users = User.find_fireeagle_recent(:limit => 10, :offset => 0, :conditions => {:time => 'now'}) end it "should load users within a bounding box" do @client.should_receive(:within).with({:foo => :bar}, 10, 0).and_return([@fe_user_1, @fe_user_2]) - users = User.find_fireeagle_within({:foo => :bar}, :limit => 10, :offset => 0) + users = User.find_fireeagle_within(:conditions => {:foo => :bar}, :limit => 10, :offset => 0) users.map(&:fireeagle_access_token).should == [@user1, @user2].map(&:fireeagle_access_token) end it "should cache users' locations when calling class level finders" do @client.should_receive(:within).with({:foo => :bar}, 10, 0).and_return([@fe_user_1, @fe_user_2]) - users = User.find_fireeagle_within({:foo => :bar}, :limit => 10, :offset => 0) + users = User.find_fireeagle_within(:conditions => {:foo => :bar}, :limit => 10, :offset => 0) user = users.first user.stub!(:authorized_with_fireeagle?).and_return(true) @client.should_not_receive(:user) spec/ride_the_fireeagle_spec.rb 0fdde5b2a07105a79bea0d1a16213f5ad4417519 Jesse Newland jnewland@gmail.com http://github.com/jnewland/ride_the_fireeagle/commit/7b7b939aa0c311bca3e38762a8a836252b9454b1 7b7b939aa0c311bca3e38762a8a836252b9454b1 2008-03-24T16:54:04-07:00 2008-03-24T16:54:04-07:00 rework the class level finders to look like AR finders, and give 'em some doc love eafc4392c394bbd2888a8989996c84986a37077e Jesse Newland jnewland@gmail.com