fireeagle 0.6.1 → 0.6.2

data/History.txt

@@ -1,3 +1,10 @@
+== 0.6.2
+
+* Offload heavy lifting to OAuth for tokens and signing requests
+* Add time parameter to Client#recent
+* Change lookup params from :cid to :cellid to follow Fire Eagle
+* Cleaned up specs
+
 == 0.6.1
 
 * Remove 'not implemented' message

data/config/requirements.rb

@@ -2,10 +2,11 @@ require 'fileutils'
 include FileUtils
 
 require 'rubygems'
-%w[rake hoe newgem rubigen].each do |req_gem|
+%w[rake hoe newgem rubigen oauth geo_ruby].each do |req_gem|
   begin
     require req_gem
   rescue LoadError
+    req_gem = 'GeoRuby' if req_gem == 'geo_ruby' # gem not the same name
     puts "This Rakefile requires the '#{req_gem}' RubyGem."
     puts "Installation: gem install #{req_gem} -y"
     exit

data/lib/fireeagle.rb

@@ -20,7 +20,7 @@ class FireEagle
   RECENT_API_PATH    = "/api/0.1/recent"
   WITHIN_API_PATH    = "/api/0.1/within"
   FORMAT_XML         = "xml"
-  UPDATE_PARAMS      = :lat, :lon, :woeid, :place_id, :address, :mnc, :mcc, :lac, :cid, :postal, :city, :state, :country, :q, :label
+  UPDATE_PARAMS      = :lat, :lon, :woeid, :place_id, :address, :mnc, :mcc, :lac, :cellid, :postal, :city, :state, :country, :q, :label
                         # not yet supported
                         #,:geom, :upcoming_venue_id, :yahoo_local_id, :plazes_id
 
@@ -34,9 +34,9 @@ class FireEagle
   end
 end
 
-#FireEagle additions to the <code>Hash</code> class
+# FireEagle additions to the <code>Hash</code> class
 class Hash
-  #Returns <code>true</code> if the ALL or NONE of the given keys are present in <i>hsh</i>.
+  # Returns <code>true</code> if the ALL or NONE of the given keys are present in <i>my_keys</i>.
   def has_all_or_none_keys?(*my_keys)
     size = my_keys.length
     false_count = 0
@@ -47,7 +47,19 @@ class Hash
   end
 end
 
+# FireEagle addition to the <code>OAuth::Consumer</code> class
+class OAuth::Consumer
+  alias_method :create_http_with_verify, :create_http
+  # Monkey patch to silence the SSL warnings
+  def create_http_without_verify #:nodoc:
+    http_object             = create_http_with_verify
+    http_object.verify_mode = OpenSSL::SSL::VERIFY_NONE if uri.scheme=="https"
+    http_object
+  end
+  alias_method :create_http, :create_http_without_verify
+end
+
 require File.dirname(__FILE__) + '/fireeagle/client'
 require File.dirname(__FILE__) + '/fireeagle/location'
 require File.dirname(__FILE__) + '/fireeagle/user'
-require File.dirname(__FILE__) + '/fireeagle/response'
+require File.dirname(__FILE__) + '/fireeagle/response'

data/lib/fireeagle/client.rb

@@ -76,23 +76,23 @@ class FireEagle
         :debug  => false,
         :format => FireEagle::FORMAT_XML
       }.merge(options)
-    
+
       # symbolize keys
       options.map do |k,v|
         options[k.to_sym] = v
       end
       raise FireEagle::ArgumentError, "OAuth Consumer Key and Secret required" if options[:consumer_key].nil? || options[:consumer_secret].nil?
-      @consumer = OAuth::Consumer.new(options[:consumer_key], options[:consumer_secret])
-      @debug = options[:debug]
-      @format = options[:format]
-      @app_id = options[:app_id]
+      @consumer = OAuth::Consumer.new(options[:consumer_key], options[:consumer_secret], :site => FireEagle::API_SERVER, :authorize_url => FireEagle::AUTHORIZATION_URL)
+      @debug    = options[:debug]
+      @format   = options[:format]
+      @app_id   = options[:app_id]
       if options[:access_token] && options[:access_token_secret]
-        @access_token = OAuth::Token.new(options[:access_token], options[:access_token_secret])
+        @access_token = OAuth::AccessToken.new(@consumer, options[:access_token], options[:access_token_secret])
       else
         @access_token = nil
       end
       if options[:request_token] && options[:request_token_secret]
-        @request_token = OAuth::Token.new(options[:request_token], options[:request_token_secret])
+        @request_token = OAuth::RequestToken.new(@consumer, options[:request_token], options[:request_token_secret])
       else
         @request_token = nil
       end
@@ -101,8 +101,7 @@ class FireEagle
     # Obtain an <strong>new</strong> unauthorized OAuth Request token
     def get_request_token(force_token_regeneration = false)
       if force_token_regeneration || @request_token.nil?
-        response = get(FireEagle::REQUEST_TOKEN_PATH, :token => nil)
-        @request_token = create_token(response)
+        @request_token = consumer.get_request_token
       end
       @request_token
     end
@@ -116,14 +115,13 @@ class FireEagle
     # The URL the user must access to authorize this token. request_token must be called first. For use by web-based and desktop-based applications.
     def authorization_url
       raise FireEagle::ArgumentError, "call #get_request_token first" if @request_token.nil?
-      "#{FireEagle::AUTHORIZATION_URL}?oauth_token=#{@request_token.token}"
+      request_token.authorize_url
     end
 
     #Exchange an authorized OAuth Request token for an access token. For use by desktop-based and mobile applications.
     def convert_to_access_token
       raise FireEagle::ArgumentError, "call #get_request_token and have user authorize the token first" if @request_token.nil?
-      response = get(FireEagle::ACCESS_TOKEN_PATH, :token => @request_token)
-      @access_token = create_token(response)
+      @access_token = request_token.get_access_token
     end
 
     # Disambiguates potential values for update query. Results from lookup can be passed to
@@ -133,19 +131,19 @@ class FireEagle
     #
     # There is a specific order for looking up locations. For example, if you provide lat, lon, and address,
     # FireEagle will use the the latitude and longitude geo-coordinates and ignore the address.
-    # 
+    #
     # Location Hash keys, in order of priority:
-    # 
-    # [<tt>(:lat, :lon)</tt>]              both required, valid values are floats of -180 to 180 for lat and -90 to 90 for lon
-    # [<tt>(:woeid)</tt>]                 Where on Earth ID
-    # [<tt>:place_id</tt>]                Place ID (via Flickr/Upcomoing); deprecated in favor of WOE IDs when possible
-    # [<tt>:address</tt>]                 street address (may contain a full address, but will be combined with postal, city, state, and country when available) 
-    # [<tt>(:mnc, :mcc, :lac, :cid)</tt>]    cell tower information, all required (as integers) for a valid tower location
-    # [<tt>:postal</tt>]                  a ZIP or postal code (combined with address, city, state, and country when available)
-    # [<tt>:city</tt>]                    city (combined with address, postal, state, and country when available)
-    # [<tt>:state</tt>]                   state (combined with address, postal, city, and country when available)
-    # [<tt>:country</tt>]                 country (combined with address, postal, city, and state when available)
-    # [<tt>:q</tt>]                       Free-text fallback containing user input. Lat/lon pairs and geometries will be extracted if possible, otherwise this string will be geocoded as-is. 
+    #
+    # [<tt>(:lat, :lon)</tt>]                   both required, valid values are floats of -180 to 180 for lat and -90 to 90 for lon
+    # [<tt>(:woeid)</tt>]                       Where on Earth ID
+    # [<tt>:place_id</tt>]                      Place ID (via Flickr/Upcomoing); deprecated in favor of WOE IDs when possible
+    # [<tt>:address</tt>]                       street address (may contain a full address, but will be combined with postal, city, state, and country when available)
+    # [<tt>(:mnc, :mcc, :lac, :cellid)</tt>]    cell tower information, all required (as integers) for a valid tower location
+    # [<tt>:postal</tt>]                        a ZIP or postal code (combined with address, city, state, and country when available)
+    # [<tt>:city</tt>]                          city (combined with address, postal, state, and country when available)
+    # [<tt>:state</tt>]                         state (combined with address, postal, city, and country when available)
+    # [<tt>:country</tt>]                       country (combined with address, postal, city, and state when available)
+    # [<tt>:q</tt>]                             Free-text fallback containing user input. Lat/lon pairs and geometries will be extracted if possible, otherwise this string will be geocoded as-is.
     #
     # Not yet supported:
     #
@@ -154,9 +152,7 @@ class FireEagle
     # * <tt>plazes_id</tt>
     def lookup(params)
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
-
       response = get(FireEagle::LOOKUP_API_PATH + ".#{format}", :params => params)
-
       FireEagle::Response.new(response.body).locations
     end
 
@@ -167,18 +163,18 @@ class FireEagle
     #
     # There is a specific order for looking up locations. For example, if you provide lat, lon, and address,
     # FireEagle will use the the latitude and longitude geo-coordinates and ignore the address.
-    # 
+    #
     # Location Hash keys, in order of priority:
-    # 
-    # [<tt>(:lat, :lon)</tt>]              both required, valid values are floats of -180 to 180 for lat and -90 to 90 for lon
-    # [<tt>:place_id</tt>]                Place ID - valid values decrypts to an integer value
-    # [<tt>:address</tt>]                 street address (may contain a full address, but will be combined with postal, city, state, and country when available) 
-    # [<tt>(:mnc, :mcc, :lac, :cid)</tt>]    cell tower information, all required (as integers) for a valid tower location
-    # [<tt>:postal</tt>]                  a ZIP or postal code (combined with address, city, state, and country when available)
-    # [<tt>:city</tt>]                    city (combined with address, postal, state, and country when available)
-    # [<tt>:state</tt>]                   state (combined with address, postal, city, and country when available)
-    # [<tt>:country</tt>]                 country (combined with address, postal, city, and state when available)
-    # [<tt>:q</tt>]                       Free-text fallback containing user input. Lat/lon pairs and geometries will be extracted if possible, otherwise this string will be geocoded as-is. 
+    #
+    # [<tt>(:lat, :lon)</tt>]                   both required, valid values are floats of -180 to 180 for lat and -90 to 90 for lon
+    # [<tt>:place_id</tt>]                      Place ID - valid values decrypts to an integer value
+    # [<tt>:address</tt>]                       street address (may contain a full address, but will be combined with postal, city, state, and country when available)
+    # [<tt>(:mnc, :mcc, :lac, :cellid)</tt>]    cell tower information, all required (as integers) for a valid tower location
+    # [<tt>:postal</tt>]                        a ZIP or postal code (combined with address, city, state, and country when available)
+    # [<tt>:city</tt>]                          city (combined with address, postal, state, and country when available)
+    # [<tt>:state</tt>]                         state (combined with address, postal, city, and country when available)
+    # [<tt>:country</tt>]                       country (combined with address, postal, city, and state when available)
+    # [<tt>:q</tt>]                             Free-text fallback containing user input. Lat/lon pairs and geometries will be extracted if possible, otherwise this string will be geocoded as-is.
     #
     # Not yet supported:
     #
@@ -187,50 +183,48 @@ class FireEagle
     # * <tt>plazes_id</tt>
     def update(location = {})
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
-
       location = sanitize_location_hash(location)
-
       response = post(FireEagle::UPDATE_API_PATH + ".#{format}", :params => location)
-
       FireEagle::Response.new(response.body)
     end
 
     # Returns the Location of a User.
     def user
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
-
       response = get(FireEagle::USER_API_PATH + ".#{format}")
-
       FireEagle::Response.new(response.body).users.first
     end
     alias_method :location, :user
 
-    # Query for Users of an Application who have updated their Location recently. Returns a list of 
+    # Query for Users of an Application who have updated their Location recently. Returns a list of
     # Users for the Application with recently updated locations.
-    def recent(count = 10, start = 0)
+    #
+    # == Optional parameters:
+    #
+    # <tt>count</tt>  Number of users to return per page. (default: 10)
+    # <tt>start</tt>  The page number at which to start returning the list of users. Pages are 0-indexed, each page contains the per_page number of users. (default: 0)
+    # <tt>time</tt>   The time to start looking at recent updates from. Value is flexible, supported forms are 'now', 'yesterday', '12:00', '13:00', '1:00pm' and '2008-03-12 12:34:56'. (default: 'now')
+    def recent(count = 10, start = 0, time = 'now')
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
-
-      params = { :count => count, :start => start }
-
+      params = { :count => count, :start => start, :time => time }
       response = get(FireEagle::RECENT_API_PATH + ".#{format}", :params => params)
-
       FireEagle::Response.new(response.body).users
     end
 
     # Takes a Place ID or a Location and returns a list of users of your application who are within the bounding box of that Location.
     #
     # Location Hash keys, in order of priority:
-    # 
-    # [<tt>(:lat, :lon)</tt>]              both required, valid values are floats of -180 to 180 for lat and -90 to 90 for lon
-    # [<tt>:woeid</tt>]                   Where on Earth ID
-    # [<tt>:place_id</tt>]                Place ID
-    # [<tt>:address</tt>]                 street address (may contain a full address, but will be combined with postal, city, state, and country when available) 
-    # [<tt>(:mnc, :mcc, :lac, :cid)</tt>]    cell tower information, all required (as integers) for a valid tower location
-    # [<tt>:postal</tt>]                  a ZIP or postal code (combined with address, city, state, and country when available)
-    # [<tt>:city</tt>]                    city (combined with address, postal, state, and country when available)
-    # [<tt>:state</tt>]                   state (combined with address, postal, city, and country when available)
-    # [<tt>:country</tt>]                 country (combined with address, postal, city, and state when available)
-    # [<tt>:q</tt>]                       Free-text fallback containing user input. Lat/lon pairs and geometries will be extracted if possible, otherwise this string will be geocoded as-is. 
+    #
+    # [<tt>(:lat, :lon)</tt>]                   both required, valid values are floats of -180 to 180 for lat and -90 to 90 for lon
+    # [<tt>:woeid</tt>]                         Where on Earth ID
+    # [<tt>:place_id</tt>]                      Place ID
+    # [<tt>:address</tt>]                       street address (may contain a full address, but will be combined with postal, city, state, and country when available)
+    # [<tt>(:mnc, :mcc, :lac, :cellid)</tt>]    cell tower information, all required (as integers) for a valid tower location
+    # [<tt>:postal</tt>]                        a ZIP or postal code (combined with address, city, state, and country when available)
+    # [<tt>:city</tt>]                          city (combined with address, postal, state, and country when available)
+    # [<tt>:state</tt>]                         state (combined with address, postal, city, and country when available)
+    # [<tt>:country</tt>]                       country (combined with address, postal, city, and state when available)
+    # [<tt>:q</tt>]                             Free-text fallback containing user input. Lat/lon pairs and geometries will be extracted if possible, otherwise this string will be geocoded as-is.
     #
     # Not yet supported:
     #
@@ -239,12 +233,9 @@ class FireEagle
     # * <tt>plazes_id</tt>
     def within(location = {}, count = 10, start = 0)
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
-
       location = sanitize_location_hash(location)
       params = { :count => count, :start => start }.merge(location)
-
       response = get(FireEagle::WITHIN_API_PATH + ".#{format}", :params => params)
-
       FireEagle::Response.new(response.body).users
     end
 
@@ -257,24 +248,10 @@ class FireEagle
 
       location = location.reject { |key, value| !FireEagle::UPDATE_PARAMS.include?(key) }
       raise FireEagle::ArgumentError, "Requires all or none of :lat, :lon" unless location.has_all_or_none_keys?(:lat, :lon)
-      raise FireEagle::ArgumentError, "Requires all or none of :mnc, :mcc, :lac, :cellid" unless location.has_all_or_none_keys?(:mnc, :mcc, :lac, :cid)
+      raise FireEagle::ArgumentError, "Requires all or none of :mnc, :mcc, :lac, :cellid" unless location.has_all_or_none_keys?(:mnc, :mcc, :lac, :cellid)
       location
     end
 
-    def xml? #:nodoc:
-      format == FireEagle::FORMAT_XML
-    end
-
-    def create_token(response) #:nodoc:
-      token = Hash[*response.body.split("&").map { |x| x.split("=") }.flatten]
-      OAuth::Token.new(token["oauth_token"], token["oauth_token_secret"])
-    end
-
-    # Is the Client in debug mode?
-    def debug?
-      @debug == true
-    end
-
     def get(url, options = {}) #:nodoc:
       request(:get, url, options)
     end
@@ -284,33 +261,21 @@ class FireEagle
     end
 
     def request(method, url, options) #:nodoc:
-      options = {
-        :params => {},
-        :token  => @access_token
-      }.merge(options)
-
-      request_uri = URI.parse(FireEagle::API_SERVER + url)
-      http = Net::HTTP.new(request_uri.host, request_uri.port)
-      http.set_debug_output $stderr if debug?
-      if FireEagle::API_SERVER =~ /https:/
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = case method
+      when :post
+        access_token.request(:post, url, options[:params])
+      when :get
+        qs = options[:params].collect { |k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join("&")
+        access_token.request(:get, "#{url}?#{qs}")
+      else
+        raise ArgumentError, "method #{method} not supported"
       end
 
-      request = nil
-      if method == :post
-        request = Net::HTTP::Post.new(request_uri.path)
-        request.set_form_data(options[:params])
-      elsif method == :get
-        qs = options[:params].collect { |k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join("&")
-        request = Net::HTTP::Get.new(request_uri.path + "?" + qs)
+      case response.code
+      when '500'; then raise FireEagle::FireEagleException, "Internal Server Error"
+      when '400'; then raise FireEagle::FireEagleException, "Method Not Implemented Yet"
+      else response
       end
-      request.oauth!(http, consumer, options[:token])
-      response = http.request(request)
-      raise FireEagle::FireEagleException, "Internal Server Error" if response.code == '500'
-      raise FireEagle::FireEagleException, "Method Not Implemented Yet" if response.code == '400'
-      response
     end
-
   end
-end
+end

data/lib/fireeagle/version.rb

@@ -2,7 +2,7 @@ class FireEagle #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 6
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/fireeagle_location_spec.rb

@@ -8,7 +8,7 @@ describe "FireEagle Location" do
   end
 
   it "should know if this is a best guess" do
-    @location.best_guess?.should == false
+    @location.should_not be_best_guess
   end
 
   it "should represent the level" do
@@ -30,7 +30,7 @@ describe "FireEagle Location" do
   it "should represent the location's timestamp" do
     @location.located_at.should == Time.parse("2008-01-22T14:23:11-08:00")
   end
-  
+
   it "should use the name for #to_s" do
     @location.to_s.should == @location.name
   end
@@ -40,19 +40,19 @@ describe "FireEagle Location" do
     it "should represent a bounding box as a GeoRuby Envelope" do
       location = Hpricot.XML(XML_LOCATION_CHUNK)
       @location = FireEagle::Location.new(location)
-      @location.geom.class.should == GeoRuby::SimpleFeatures::Envelope
+      @location.geom.should be_an_instance_of(GeoRuby::SimpleFeatures::Envelope)
     end
 
     it "should represent an exact point as a GeoRuby Point" do
       location = Hpricot.XML(XML_EXACT_LOCATION_CHUNK)
       @location = FireEagle::Location.new(location)
-      @location.geom.class.should == GeoRuby::SimpleFeatures::Point
+      @location.geom.should be_an_instance_of(GeoRuby::SimpleFeatures::Point)
     end
 
     it "should be aliased as 'geo'" do
       location = Hpricot.XML(XML_EXACT_LOCATION_CHUNK)
       @location = FireEagle::Location.new(location)
-      @location.geo.class.should == GeoRuby::SimpleFeatures::Point     
+      @location.geo.should be_an_instance_of(GeoRuby::SimpleFeatures::Point)
     end
 
   end

data/spec/fireeagle_response_spec.rb

@@ -7,29 +7,29 @@ describe "FireEagle Response" do
     before(:each) do
       @response = FireEagle::Response.new(XML_LOCATION_RESPONSE)
     end
-    
+
     it "should indicate success" do
-      @response.success?.should == true
+      @response.should be_success
     end
 
     it "should have an array of users" do
-      @response.users.size.should == 1
+      @response.should have(1).users
     end
-    
+
     it "should have each users' token" do
       @response.users.first.token.should == "16w3z6ysudxt"
     end
-    
+
     it "should flag the best guess" do
       @response.users.first.best_guess.name.should == "Yolo County, California"
     end
-    
-    it "should have users' loactions" do
-      @response.users.first.locations.size.should == 4
+
+    it "should have users' locations" do
+      @response.users.first.should have(4).locations
     end
 
   end
-  
+
   describe "location parsing" do
 
     before(:each) do
@@ -37,11 +37,11 @@ describe "FireEagle Response" do
     end
 
     it "should indicate success" do
-      @response.success?.should == true
+      @response.should be_success
     end
 
     it "should have an array of locations" do
-      @response.locations.size.should == 9
+      @response.should have(9).locations
     end
 
     it "should have each location's place_id" do

data/spec/fireeagle_spec.rb

@@ -12,7 +12,7 @@ describe "FireEagle" do
 
     it "should initialize an OAuth::Consumer" do
       @consumer = mock(OAuth::Consumer)
-      OAuth::Consumer.should_receive(:new).and_return(@consumer)
+      OAuth::Consumer.should_receive(:new).with('key', 'sekret', :site => FireEagle::API_SERVER, :authorize_url => FireEagle::AUTHORIZATION_URL).and_return(@consumer)
       client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
     end
 
@@ -20,16 +20,16 @@ describe "FireEagle" do
 
   describe "web app authentication scenario" do
 
-    it "should initialize a OAuth::Token if given it's token and secret" do
-      @access_token = mock(OAuth::Token)
-      OAuth::Token.stub!(:new).and_return(@access_token)
+    it "should initialize an OAuth::AccessToken if given its token and secret" do
+      @access_token = mock(OAuth::AccessToken)
+      OAuth::AccessToken.stub!(:new).and_return(@access_token)
       client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
       client.access_token.should == @access_token
     end
 
-    it "should initialize a request token if given one" do
-      @request_token = mock(OAuth::Token)
-      OAuth::Token.stub!(:new).and_return(@request_token)
+    it "should initialize an OAuth::RequestToken if given its token and secret" do
+      @request_token = mock(OAuth::RequestToken)
+      OAuth::RequestToken.stub!(:new).and_return(@request_token)
       client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :request_token => 'toke', :request_token_secret => 'sekret')
       client.request_token.should == @request_token
     end
@@ -38,7 +38,7 @@ describe "FireEagle" do
   describe "request token scenario" do
     it "shouldn't initialize with a access_token" do
       client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
-      client.access_token.should == nil
+      client.access_token.should be_nil
     end
 
     it "should require token exchange before calling any API methods" do
@@ -49,12 +49,15 @@ describe "FireEagle" do
     end
 
     it "should generate a Request Token URL" do
+      consumer = mock(OAuth::Consumer)
+      token    = mock(OAuth::RequestToken)
+      consumer.should_receive(:get_request_token).and_return(token)
+      token.should_receive(:authorize_url)
+
       client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
-      @token = mock("token", :token => 'foo')
-      client.stub!(:get).and_return('')
-      client.stub!(:create_token).and_return(@token)
+      client.should_receive(:consumer).and_return(consumer)
       client.get_request_token
-      client.authorization_url.should =~ /\?oauth_token=foo/
+      client.authorization_url
     end
 
     it "should require #get_request_token be called before #convert_to_access_token" do
@@ -71,14 +74,19 @@ describe "FireEagle" do
       end.should raise_error(FireEagle::ArgumentError)
     end
 
-    it "should generate a Request Token URL" do
+    it "should generate an Access Token" do
+      consumer  = mock(OAuth::Consumer)
+      req_token = mock(OAuth::RequestToken)
+      acc_token = mock(OAuth::AccessToken)
+      consumer.should_receive(:get_request_token).and_return(req_token)
+      req_token.should_receive(:get_access_token).and_return(acc_token)
+
       client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret')
-      @token = mock("token", :token => 'foo')
-      client.stub!(:get).and_return('')
-      client.stub!(:create_token).and_return(@token)
+      client.should_receive(:consumer).and_return(consumer)
+
       client.get_request_token
       client.convert_to_access_token
-      client.access_token.should == @token
+      client.access_token.should == acc_token
     end
 
   end
@@ -87,7 +95,7 @@ describe "FireEagle" do
 
     before(:each) do
       @client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
-      @response = mock('response', :body => XML_SUCCESS_RESPONSE)
+      @response = stub('response', :body => XML_SUCCESS_RESPONSE)
       @client.stub!(:request).and_return(@response)
     end
 
@@ -96,13 +104,13 @@ describe "FireEagle" do
       lambda { @client.update(:lat => 1, :lon => 2) }.should_not raise_error(FireEagle::ArgumentError)
     end
 
-    it "requires all or none of :mnc, :mcc, :lac, :cid" do
-      lambda { @client.update(:mcc => 123, :lac => "whatever", :cid => true) }.should raise_error(FireEagle::ArgumentError)
-      lambda { @client.update(:mcc => 123, :mnc => 123123, :lac => "whatever", :cid => true) }.should_not raise_error(FireEagle::ArgumentError)
+    it "requires all or none of :mnc, :mcc, :lac, :cellid" do
+      lambda { @client.update(:mcc => 123, :lac => "whatever", :cellid => true) }.should raise_error(FireEagle::ArgumentError)
+      lambda { @client.update(:mcc => 123, :mnc => 123123, :lac => "whatever", :cellid => true) }.should_not raise_error(FireEagle::ArgumentError)
     end
 
     it "should wrap the result" do
-      @client.update(:mcc => 123, :mnc => 123123, :lac => "whatever", :cid => true).users.first.token.should == "16w3z6ysudxt"
+      @client.update(:mcc => 123, :mnc => 123123, :lac => "whatever", :cellid => true).users.first.token.should == "16w3z6ysudxt"
     end
 
   end
@@ -110,9 +118,9 @@ describe "FireEagle" do
   describe "user method" do
 
     before(:each) do
-      @client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
-      @response = mock('response', :body => XML_LOCATION_RESPONSE)
-      @client.stub!(:request).and_return(@response)
+      @client   = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
+      response = stub('response', :body => XML_LOCATION_RESPONSE)
+      @client.stub!(:request).and_return(response)
     end
 
     it "should return a best guess" do
@@ -120,21 +128,21 @@ describe "FireEagle" do
     end
 
     it "should return several locations" do
-      @client.user.locations.size.should == 4
+      @client.user.should have(4).locations
     end
 
   end
-  
+
   describe "lookup method" do
 
     before(:each) do
       @client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
-      @response = mock('response', :body => XML_LOOKUP_RESPONSE)
+      @response = stub('response', :body => XML_LOOKUP_RESPONSE)
       @client.stub!(:request).and_return(@response)
     end
 
     it "should return an array of Locations" do
-      @client.lookup(:q => "30022").size.should == 9
+      @client.lookup(:q => "30022").should have(9).items
     end
 
     it "should return a place id for each" do
@@ -147,4 +155,36 @@ describe "FireEagle" do
 
   end
 
-end
+  describe "within method" do
+    before do
+      @client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
+      @response = stub('response', :body => XML_WITHIN_RESPONSE)
+      @client.stub!(:request).and_return(@response)
+    end
+
+    it "should return an array of Users" do
+      @client.within(:woe => "12796255").should have(2).users
+    end
+
+    it "should return an array of Locations for each" do
+      @client.within(:woe => "12796255").first.should have(5).locations
+    end
+  end
+
+  describe "recent method" do
+    before do
+      @client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
+      @response = stub('response', :body => XML_RECENT_RESPONSE)
+      @client.stub!(:request).and_return(@response)
+    end
+
+    it "should return an array of Users" do
+      @client.recent(2, 1, 'yesterday').should have(2).users
+    end
+
+    it "should return an array of Locations for each" do
+      @client.recent(2, 1, 'yesterday').first.should have(5).locations
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -124,5 +124,236 @@ XML_LOOKUP_RESPONSE = <<-RESPONSE
 </rsp>
 RESPONSE
 
+XML_WITHIN_RESPONSE = <<-RESPONSE
+<?xml version="1.0" encoding="UTF-8"?>
+<rsp stat="ok">
+  <users>
+    <user token="MQdDrJgXMNJi">
+      <location-hierarchy>
+        <location best-guess="true">
+          <id>111541</id>
+          <georss:point>32.7093315125 -117.1650772095</georss:point>
+          <level>0</level>
+          <level-name>exact</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>333 W Harbor Dr, San Diego, CA</name>
+        </location>
+        <location best-guess="false">
+          <id>111551</id>
+          <georss:box>
+            32.6916618347 -117.2174377441 32.744140625 -117.1458892822
+          </georss:box>
+          <level>1</level>
+          <level-name>postal</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>San Diego, CA 92101</name>
+          <place-id>NpiXqwmYA5viX3K3Ew</place-id>
+          <woeid>12796255</woeid>
+        </location>
+        <location best-guess="false">
+          <id>111561</id>
+          <georss:box>
+            32.5349388123 -117.2884292603 33.1128082275 -116.9142913818
+          </georss:box>
+          <level>3</level>
+          <level-name>city</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>San Diego, CA</name>
+          <place-id>Nm4O.DebBZTYKUsu</place-id>
+          <woeid>2487889</woeid>
+        </location>
+        <location best-guess="false">
+          <id>111571</id>
+          <georss:box>
+            32.5342788696 -124.4150238037 42.0093803406 -114.1308135986
+          </georss:box>
+          <level>5</level>
+          <level-name>state</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>California</name>
+          <place-id>SVrAMtCbAphCLAtP</place-id>
+          <woeid>2347563</woeid>
+        </location>
+        <location best-guess="false">
+          <id>111581</id>
+          <georss:box>
+            18.9108390808 -167.2764129639 72.8960571289 -66.6879425049
+          </georss:box>
+          <level>6</level>
+          <level-name>country</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>United States</name>
+          <place-id>4KO02SibApitvSBieQ</place-id>
+          <woeid>23424977</woeid>
+        </location>
+      </location-hierarchy>
+    </user>
+    <user token="MQdDrJgXMNJi">
+      <location-hierarchy>
+        <location best-guess="true">
+          <id>111541</id>
+          <georss:point>32.7093315125 -117.1650772095</georss:point>
+          <level>0</level>
+          <level-name>exact</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>333 W Harbor Dr, San Diego, CA</name>
+        </location>
+        <location best-guess="false">
+          <id>111551</id>
+          <georss:box>
+            32.6916618347 -117.2174377441 32.744140625 -117.1458892822
+          </georss:box>
+          <level>1</level>
+          <level-name>postal</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>San Diego, CA 92101</name>
+          <place-id>NpiXqwmYA5viX3K3Ew</place-id>
+          <woeid>12796255</woeid>
+        </location>
+        <location best-guess="false">
+          <id>111561</id>
+          <georss:box>
+            32.5349388123 -117.2884292603 33.1128082275 -116.9142913818
+          </georss:box>
+          <level>3</level>
+          <level-name>city</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>San Diego, CA</name>
+          <place-id>Nm4O.DebBZTYKUsu</place-id>
+          <woeid>2487889</woeid>
+        </location>
+        <location best-guess="false">
+          <id>111571</id>
+          <georss:box>
+            32.5342788696 -124.4150238037 42.0093803406 -114.1308135986
+          </georss:box>
+          <level>5</level>
+          <level-name>state</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>California</name>
+          <place-id>SVrAMtCbAphCLAtP</place-id>
+          <woeid>2347563</woeid>
+        </location>
+        <location best-guess="false">
+          <id>111581</id>
+          <georss:box>
+            18.9108390808 -167.2764129639 72.8960571289 -66.6879425049
+          </georss:box>
+          <level>6</level>
+          <level-name>country</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>United States</name>
+          <place-id>4KO02SibApitvSBieQ</place-id>
+          <woeid>23424977</woeid>
+        </location>
+      </location-hierarchy>
+    </user>
+  </users>
+</rsp>
+RESPONSE
+
+XML_RECENT_RESPONSE = <<-RESPONSE
+<?xml version="1.0" encoding="UTF-8"?>
+<rsp stat="ok" xmlns:georss="http://www.georss.org/georss">
+  <users>
+    <user token="MQdDrJgXMNJi">
+      <location-hierarchy>
+        <location best-guess="true">
+          <id>111541</id>
+          <georss:point>32.7093315125 -117.1650772095</georss:point>
+          <level>0</level>
+          <level-name>exact</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>333 W Harbor Dr, San Diego, CA</name>
+        </location>
+        <location best-guess="false">
+          <id>111551</id>
+          <georss:box>32.6916618347 -117.2174377441 32.744140625 -117.1458892822</georss:box>
+          <level>1</level>
+          <level-name>postal</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>San Diego, CA 92101</name>
+          <place-id>NpiXqwmYA5viX3K3Ew</place-id>
+          <woeid>12796255</woeid>
+        </location>
+        <location best-guess="false">
+          <id>111561</id>
+          <georss:box>32.5349388123 -117.2884292603 33.1128082275 -116.9142913818</georss:box>
+          <level>3</level>
+          <level-name>city</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>San Diego, CA</name>
+          <place-id>Nm4O.DebBZTYKUsu</place-id>
+          <woeid>2487889</woeid>
+        </location>
+        <location best-guess="false">
+          <id>111571</id>
+          <georss:box>32.5342788696 -124.4150238037 42.0093803406 -114.1308135986</georss:box>
+          <level>5</level>
+          <level-name>state</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>California</name>
+          <place-id>SVrAMtCbAphCLAtP</place-id>
+          <woeid>2347563</woeid>
+        </location>
+        <location best-guess="false">
+          <id>111581</id>
+          <georss:box>18.9108390808 -167.2764129639 72.8960571289 -66.6879425049</georss:box>
+          <level>6</level>
+          <level-name>country</level-name>
+          <located-at>2008-03-03T09:05:16-08:00</located-at>
+          <name>United States</name>
+          <place-id>4KO02SibApitvSBieQ</place-id>
+          <woeid>23424977</woeid>
+        </location>
+      </location-hierarchy>
+    </user>
+    <user token="XMoZaTjZJiOQ">
+      <location-hierarchy>
+        <location best-guess="true">
+          <id>113221</id>
+          <georss:box>32.8155899048 -96.8162918091 32.8511695862 -96.7717132568</georss:box>
+          <level>1</level>
+          <level-name>postal</level-name>
+          <located-at>2008-03-03T10:24:24-08:00</located-at>
+          <name>Dallas, TX 75205</name>
+          <place-id>1KTPxFCYA5vlcics6A</place-id>
+          <woeid>12790441</woeid>
+        </location>
+        <location best-guess="false">
+          <id>113231</id>
+          <georss:box>32.6209487915 -96.9988708496 33.0258712769 -96.4660263062</georss:box>
+          <level>3</level>
+          <level-name>city</level-name>
+          <located-at>2008-03-03T10:24:24-08:00</located-at>
+          <name>Dallas, TX</name>
+          <place-id>bgWooz.bApRFBRNK</place-id>
+          <woeid>2388929</woeid>
+        </location>
+        <location best-guess="false">
+          <id>113241</id>
+          <georss:box>25.8372898102 -106.645652771 36.5006904602 -93.5079269409</georss:box>
+          <level>5</level>
+          <level-name>state</level-name>
+          <located-at>2008-03-03T10:24:24-08:00</located-at>
+          <name>Texas</name>
+          <place-id>b1Yi6qubApjz6jWW</place-id>
+          <woeid>2347602</woeid>
+        </location>
+        <location best-guess="false">
+          <id>113251</id>
+          <georss:box>18.9108390808 -167.2764129639 72.8960571289 -66.6879425049</georss:box>
+          <level>6</level>
+          <level-name>country</level-name>
+          <located-at>2008-03-03T10:24:24-08:00</located-at>
+          <name>United States</name>
+          <place-id>4KO02SibApitvSBieQ</place-id>
+          <woeid>23424977</woeid>
+        </location>
+      </location-hierarchy>
+    </user>
+  </users>
+</rsp>
+RESPONSE
 
 require File.dirname(__FILE__) + '/../lib/fireeagle'

data/tasks/rspec.rake

@@ -19,3 +19,14 @@ Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "spec/spec.opts"]
   t.spec_files = FileList['spec/*_spec.rb']
 end
+
+# Make spec the default task
+# from http://blog.subterfusion.net/2008/rake-hacks-overriding-tasks-quick-binary-run-intelligent-irb/
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+
+Rake.application.remove_task :default
+task :default => :spec

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fireeagle
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors: 
 - Jesse Newland
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-06 00:00:00 -05:00
+date: 2008-03-13 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency