jnewland-fireeagle 0.8.0.0 → 0.8.0.1

data/Manifest.txt

@@ -7,14 +7,27 @@ README.txt
 Rakefile
 lib/fireeagle.rb
 lib/fireeagle/client.rb
+lib/fireeagle/error.rb
 lib/fireeagle/location.rb
+lib/fireeagle/location_hierarchy.rb
+lib/fireeagle/locations.rb
 lib/fireeagle/response.rb
 lib/fireeagle/user.rb
 lib/fireeagle/version.rb
 setup.rb
-spec/fireeagle_location_spec.rb
 spec/fireeagle_response_spec.rb
 spec/fireeagle_spec.rb
+spec/location_spec.rb
+spec/locations_spec.rb
+spec/responses/error.xml
+spec/responses/exact_location_chunk.xml
+spec/responses/location_chunk.xml
+spec/responses/location_chunk_with_query.xml
+spec/responses/locations_chunk.xml
+spec/responses/lookup.xml
+spec/responses/recent.xml
+spec/responses/user.xml
+spec/responses/within.xml
 spec/spec.opts
 spec/spec_helper.rb
 tasks/environment.rake

data/config/hoe.rb

@@ -58,7 +58,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   
   # == Optional
   p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.extra_deps = [ ['oauth', '>= 0.2.1'], ['hpricot', '>= 0.6'], ['GeoRuby', '>= 1.3.2'] ]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.extra_deps = [ ['oauth', '>= 0.3.1'], ['happymapper', '>= 0.2.1'], ['GeoRuby', '>= 1.3.2'] ]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
   
   #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
   

data/lib/fireeagle/client.rb

@@ -1,4 +1,4 @@
-class FireEagle
+module FireEagle
   class Client
     # TODO add access_token=() and request_token=() methods that check whether the tokens are usable
     
@@ -154,8 +154,8 @@ 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
+      response = get(FireEagle::LOOKUP_API_PATH, :params => params)
+      FireEagle::Response.parse(response.body).locations
     end
 
     # Sets a User's current Location using using a Place ID hash or a set of Location parameters. If the User
@@ -186,15 +186,15 @@ class FireEagle
     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)
+      response = post(FireEagle::UPDATE_API_PATH, :params => location)
+      FireEagle::Response.parse(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
+      response = get(FireEagle::USER_API_PATH)
+      FireEagle::Response.parse(response.body).users.first
     end
     alias_method :location, :user
 
@@ -209,8 +209,8 @@ class FireEagle
     def recent(time = 'now', count = 10, start = 1)
       raise FireEagle::ArgumentError, "OAuth Access Token Required" unless @access_token
       params = { :count => count, :start => start, :time => time }
-      response = get(FireEagle::RECENT_API_PATH + ".#{format}", :params => params)
-      FireEagle::Response.new(response.body).users
+      response = get(FireEagle::RECENT_API_PATH, :params => params)
+      FireEagle::Response.parse(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.
@@ -237,8 +237,8 @@ class FireEagle
       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
+      response = get(FireEagle::WITHIN_API_PATH, :params => params)
+      FireEagle::Response.parse(response.body).users
     end
 
   protected
@@ -265,17 +265,17 @@ class FireEagle
     def request(method, url, options) #:nodoc:
       response = case method
       when :post
-        access_token.request(:post, url, options[:params])
+        access_token.request(:post, "#{url}.#{format}", options[:params])
       when :get
         qs = options[:params].collect { |k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join("&") if options[:params]
-        access_token.request(:get, "#{url}?#{qs}")
+        access_token.request(:get, "#{url}.#{format}?#{qs}")
       else
         raise ArgumentError, "method #{method} not supported"
       end
 
       case response.code
+      when '404'; then raise FireEagle::FireEagleException, "Not Found"
       when '500'; then raise FireEagle::FireEagleException, "Internal Server Error"
-      when '400'; then raise FireEagle::FireEagleException, "Method Not Implemented Yet"
       else response
       end
     end

data/lib/fireeagle/error.rb

@@ -0,0 +1,9 @@
+module FireEagle
+  class Error
+    include HappyMapper
+
+    tag "err"
+    attribute :code, String
+    attribute :message, String, :tag => "msg"
+  end
+end

data/lib/fireeagle/location.rb

@@ -1,70 +1,55 @@
-#Describes a location
-class FireEagle
-  class Location
+module FireEagle
+  class StringWithExactMatch < String
+    attr_writer :exact_match
 
-    #Initialize a Location from an XML response
-    def initialize(doc)
-      doc = Hpricot(doc) unless doc.is_a?(Hpricot::Doc || Hpricot::Elem)
-      @doc = doc
-    end
+    def initialize(value = "")
+      node = XML::Parser.string(value).parse.root
+      str = super(node.content)
+      str.exact_match = node.attributes.to_h["exact-match"] == "true"
+      node = nil
 
-    def label
-      @label ||= @doc.at("/location/label").innerText rescue nil
+      str
     end
 
-    #Level of granularity for this Location
-    def level
-      @level ||= @doc.at("/location/level").innerText.to_i rescue nil
-    end
-
-    #Name of the level of granularity for this Location
-    def level_name
-      @level_name ||= @doc.at("/location/level-name").innerText rescue nil
-    end
-
-    #Human Name for this Location
-    def name
-      @name ||= @doc.at("/location/name").innerText rescue nil
-    end
-    alias_method :to_s, :name
-
-    #Unique identifier for this place. Pro-tip: This is the same place_id used by Flickr.
-    def place_id
-      @place_id ||= @doc.at("/location/place-id").innerText rescue nil
-    end
-    
-    #Numeric unique identifier for this place.
-    def woeid
-      @woeid ||= @doc.at("/location/woeid").innerText rescue nil
+    def exact_match?
+      @exact_match
     end
+  end
 
-    #The Time at which the User last updated in this Location
-    def located_at
-      @located_at ||= Time.parse(@doc.at("/location/located-at").innerText) rescue nil
-    end
+  # Represents a location
+  class Location
+    include HappyMapper
+
+    tag "location"
+    attribute :best_guess, Boolean, :tag => "best-guess"
+    element :label, String
+    element :level, Integer
+    element :level_name, String, :tag => "level-name"
+    element :located_at, Time,   :tag => "located-at"
+    element :name, String
+    element :normal_name, String, :tag => "normal-name"
+    element :place_id, StringWithExactMatch, :tag => "place-id", :parser => :new, :raw => true
+    element :query, String
+    element :woeid, StringWithExactMatch,    :parser => :new,    :raw => true
+
+    element :_box, GeoRuby::SimpleFeatures::Geometry,   :tag => "box",
+      :namespace => "georss", :parser => :from_georss, :raw => true
+    element :_point, GeoRuby::SimpleFeatures::Geometry, :tag => "point",
+      :namespace => "georss", :parser => :from_georss, :raw => true
 
-    #The coordinates of the lower corner of a bounding box surrounding this Location
-    def lower_corner
-      @georss ||= @doc.at("/location//georss:box").innerText.split.map{ |l| l.to_f } rescue nil
-      @lower_corner ||= @georss[0..1] rescue nil
+    def best_guess?
+      best_guess == true
     end
 
     # The GeoRuby[http://georuby.rubyforge.org/] representation of this location
     def geom
-      if @doc.at("/location//georss:box")
-        @geo ||= GeoRuby::SimpleFeatures::Geometry.from_georss(@doc.at("/location//georss:box").to_s)
-      elsif @doc.at("/location//georss:point")
-        @geo ||= GeoRuby::SimpleFeatures::Geometry.from_georss(@doc.at("/location//georss:point").to_s)
-      else
-        return nil
-      end
+      _point || _box
     end
+
     alias_method :geo, :geom
-    
-    #Is this Location FireEagle's best guess?
-    def best_guess?
-      @best_guess ||= @doc.at("/location").attributes["best-guess"] == "true" rescue false
-    end
 
+    def to_s
+      name
+    end
   end
-end
+end

data/lib/fireeagle/location_hierarchy.rb

@@ -0,0 +1,10 @@
+module FireEagle
+  class LocationHierarchy
+    include HappyMapper
+
+    tag "location-hierarchy"
+    attribute :string,    String
+    attribute :timezone,  String
+    has_many  :locations, Location
+  end
+end

data/lib/fireeagle/locations.rb

@@ -0,0 +1,36 @@
+module FireEagle
+  class Locations
+    include Enumerable
+    include HappyMapper
+
+    tag "locations"
+    attribute :count, Integer
+    attribute :start, Integer
+    attribute :total, Integer
+    has_many  :locations, Location, :single => false
+
+    def [](*args)
+      locations[*args]
+    end
+
+    alias_method :slice, :[]
+
+    def each(&block)
+      locations.each(&block)
+    end
+
+    def first
+      locations.first
+    end
+
+    def last
+      locations.last
+    end
+
+    def length
+      locations.length
+    end
+
+    alias_method :size, :length
+  end
+end

data/lib/fireeagle/response.rb

@@ -1,31 +1,33 @@
-class FireEagle
+module FireEagle
   class Response
+    include HappyMapper
 
-    #Parses the XML response from FireEagle
-    def initialize(doc)
-      doc = Hpricot(doc) unless doc.is_a?(Hpricot::Doc || Hpricot::Elem)
-      @doc = doc
-      raise FireEagle::FireEagleException, @doc.at("/rsp/err").attributes["msg"] if !success? 
-    end
+    tag "rsp"
+    attribute :status,  String, :tag => "stat"
+    element   :querystring, String
+    has_one   :error, Error
+    has_one   :locations, Locations
+    has_many  :users, User
 
-    #does the response indicate success?
-    def success?
-      @doc.at("/rsp").attributes["stat"] == "ok" rescue false
+    def self.parse(xml, opts = {})
+      rsp = super(xml, opts)
+
+      raise FireEagleException, rsp.error.message if rsp.fail?
+
+      rsp
     end
 
-    #An array of of User-specific tokens and their Location at all levels the Client can see and larger.
-    def users
-      @users ||= @doc.search("/rsp//user").map do |user|
-        FireEagle::User.new(user.to_s)
-      end
+    def fail?
+      status == "fail"
     end
 
-    #A Location array.
-    def locations
-      @locations ||= @doc.search("/rsp/locations/location").map do |location|
-        FireEagle::Location.new(location.to_s)
-      end
+    # does the response indicate success?
+    def success?
+      status == "ok"
     end
 
+    def user
+      users[0]
+    end
   end
 end

data/lib/fireeagle/user.rb

@@ -1,37 +1,20 @@
-class FireEagle
+module FireEagle
   class User
-    #Parses the XML response from FireEagle.
-    def initialize(doc)
-      doc = Hpricot(doc) unless doc.is_a?(Hpricot::Doc || Hpricot::Elem)
-      @doc = doc
-    end
-
-    #The User-specific token for this Client.
-    def token
-      @token ||= @doc.at("/user").attributes["token"] rescue nil
-    end
+    include HappyMapper
 
-    #The time at which this user was last located
-    def located_at
-      @located_at ||= Time.parse(@doc.at("/user").attributes["located-at"]) rescue nil
-    end
+    tag "user"
+    attribute :located_at, Time, :tag => "located-at"
+    attribute :readable, Boolean
+    attribute :token, String
+    attribute :writable, Boolean
+    has_one   :location_hierarchy, LocationHierarchy, :tag => "location-hierarchy"
 
-    #FireEagle's "best guess" form this User's Location. This best guess is derived as the most accurate
-    #level of the hierarchy with a timestamp in the last half an hour <b>or</b> as the most accurate
-    #level of the hierarchy with the most recent timestamp.
     def best_guess
-      @best_guess ||= locations.select { |location| location.best_guess? }.first rescue nil
+      @best_guess ||= locations.select { |loc| loc.best_guess? }.first
     end
 
-    #An Array containing all Location granularity that the Client has been allowed to
-    #see for the User. The Location elements returned are arranged in hierarchy order consisting of: 
-    #Country, State, County, Large Cities, Neighbourhoods/Local Area, Postal Code and exact location.
-    #The Application should therefore be prepared to receive a response that may consist of (1) only
-    #country, or (2) country & state or (3) country, state & county and so forth.
     def locations
-      @locations ||= @doc.search("/user/location-hierarchy/location").map do |location|
-        FireEagle::Location.new(location.to_s)
-      end
+      location_hierarchy && location_hierarchy.locations
     end
   end
 end

data/lib/fireeagle/version.rb

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

data/lib/fireeagle.rb

@@ -5,10 +5,18 @@ gem 'oauth', ">= 0.2.4"
 require 'oauth/helper'
 require 'oauth/client/helper'
 require 'oauth/request_proxy/net_http'
-require 'hpricot'
 require 'geo_ruby'
+require 'happymapper'
 
-class FireEagle
+require File.dirname(__FILE__) + '/fireeagle/client'
+require File.dirname(__FILE__) + '/fireeagle/location'
+require File.dirname(__FILE__) + '/fireeagle/locations'
+require File.dirname(__FILE__) + '/fireeagle/location_hierarchy'
+require File.dirname(__FILE__) + '/fireeagle/user'
+require File.dirname(__FILE__) + '/fireeagle/error'
+require File.dirname(__FILE__) + '/fireeagle/response'
+
+module FireEagle
   API_SERVER = "https://fireeagle.yahooapis.com"
   AUTH_SERVER = "https://fireeagle.yahoo.net"
   REQUEST_TOKEN_PATH = "/oauth/request_token"
@@ -25,13 +33,10 @@ class FireEagle
                         # not yet supported
                         #,:geom, :upcoming_venue_id, :yahoo_local_id, :plazes_id
 
-  class Error < RuntimeError #:nodoc:
-  end
-
-  class ArgumentError < Error #:nodoc:
+  class ArgumentError < StandardError #:nodoc:
   end
 
-  class FireEagleException < Error #:nodoc:
+  class FireEagleException < StandardError #:nodoc:
   end
 end
 
@@ -59,8 +64,3 @@ class OAuth::Consumer
   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'

data/spec/fireeagle_response_spec.rb

@@ -1,11 +1,11 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
-describe "FireEagle Response" do
+describe FireEagle::Response do
 
   describe "user / location parsing" do
 
     before(:each) do
-      @response = FireEagle::Response.new(XML_LOCATION_RESPONSE)
+      @response = FireEagle::Response.parse(XML_LOCATION_RESPONSE)
     end
 
     it "should indicate success" do
@@ -33,7 +33,7 @@ describe "FireEagle Response" do
   describe "location parsing" do
 
     before(:each) do
-      @response = FireEagle::Response.new(XML_LOOKUP_RESPONSE)
+      @response = FireEagle::Response.parse(XML_LOOKUP_RESPONSE)
     end
 
     it "should indicate success" do
@@ -57,7 +57,7 @@ describe "FireEagle Response" do
   describe "error handling" do
 
     it "should raise an exception when returned xml with a status of fail" do
-      lambda { FireEagle::Response.new(XML_ERROR_RESPONSE) }.should raise_error(FireEagle::FireEagleException)
+      lambda { FireEagle::Response.parse(XML_ERROR_RESPONSE) }.should raise_error(FireEagle::FireEagleException, "Something bad happened")
     end
 
   end

data/spec/fireeagle_spec.rb

@@ -134,11 +134,12 @@ describe "FireEagle" do
   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 = stub('response', :body => XML_LOOKUP_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_LOOKUP_RESPONSE)
+      fail_response = stub('fail response', :body => XML_FAIL_LOOKUP_RESPONSE)
+      @client.stub!(:request).with(:get, FireEagle::LOOKUP_API_PATH, :params => {:q => "30022"}).and_return(response)
+      @client.stub!(:request).with(:get, FireEagle::LOOKUP_API_PATH, :params => {:mnc => 12, :mcc => 502, :lac => 2051, :cellid => 39091}).and_return(fail_response)
     end
 
     it "should return an array of Locations" do
@@ -153,6 +154,11 @@ describe "FireEagle" do
       @client.lookup(:q => "30022").first.name.should == "Alpharetta, GA 30022"
     end
 
+    it "should raise an exception if the lookup failed" do
+      lambda {
+        @client.lookup(:mnc => 12, :mcc => 502, :lac => 2051, :cellid => 39091)
+      }.should raise_error(FireEagle::FireEagleException, "Place can't be identified.")
+    end
   end
 
   describe "within method" do
@@ -165,10 +171,6 @@ describe "FireEagle" do
     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
@@ -187,4 +189,37 @@ describe "FireEagle" do
     end
   end
 
+  describe "making a request" do
+    before do
+      @client = FireEagle::Client.new(:consumer_key => 'key', :consumer_secret => 'sekret', :access_token => 'toke', :access_token_secret => 'sekret')
+      @access_token = stub('access token')
+      @client.stub!(:access_token).and_return(@access_token)
+    end
+
+    it "should not raise any exception when response is OK" do
+      response = stub('response', :code => '200', :body => XML_RECENT_RESPONSE)
+      @access_token.stub!(:request).and_return(response)
+      lambda { @client.recent }.should_not raise_error
+    end
+
+    it "should raise an exception when requesting to a resource that doesn't exist (404)" do
+      response = stub('response', :code => '404', :body => '')
+      @access_token.stub!(:request).and_return(response)
+      lambda { @client.recent }.should raise_error(FireEagle::FireEagleException, 'Not Found')
+    end
+
+    it "should raise an exception when requesting to a resource that hit an internal server error (500)" do
+      response = stub('response', :code => '500', :body => '')
+      @access_token.stub!(:request).and_return(response)
+      lambda { @client.recent }.should raise_error(FireEagle::FireEagleException, 'Internal Server Error')
+    end
+
+    it "should raise an exception when response is apart from 200, 404 and 500" do
+      %w{401 403 405}.each do |code|
+        response = stub('response', :code => code, :body => XML_ERROR_RESPONSE)
+        @access_token.stub!(:request).and_return(response)
+        lambda { @client.recent }.should raise_error(FireEagle::FireEagleException, 'Something bad happened')
+      end
+    end
+  end
 end

data/spec/{fireeagle_location_spec.rb → location_spec.rb}

@@ -1,10 +1,10 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
-describe "FireEagle Location" do
+describe FireEagle::Location do
 
   before(:each) do
-    location = Hpricot.XML(XML_LOCATION_CHUNK)
-    @location = FireEagle::Location.new(location)
+    @location = FireEagle::Location.parse(responses(:location_chunk))
+    @location_with_query = FireEagle::Location.parse(responses(:location_chunk_with_query))
   end
 
   it "should know if this is a best guess" do
@@ -23,38 +23,56 @@ describe "FireEagle Location" do
     @location.name.should == 'Davis, CA'
   end
 
-  it "should represent the location place id" do
+  it "should represent the raw name" do
+    @location.normal_name.should == "Davis"
+  end
+
+  it "should represent the location's place id" do
     @location.place_id.should == 'u4L9ZOObApTdx1q3'
   end
 
+  it "should represent whether the location's place id is an exact match" do
+    @location.place_id.should be_an_exact_match
+  end
+
+  it "should represent the location's WOEID" do
+    @location.woeid.should == "2389646"
+  end
+
+  it "should represent whether the location's WOEID is an exact match" do
+    @location.woeid.should be_an_exact_match
+  end
+
   it "should represent the location's timestamp" do
     @location.located_at.should == Time.parse("2008-01-22T14:23:11-08:00")
   end
 
+  it "should represent the label" do
+    @location.label.should == "Home of UC Davis"
+  end
+
   it "should use the name for #to_s" do
     @location.to_s.should == @location.name
   end
 
-  describe "GeoRuby support" do
+  it "should represent the querystring" do
+    @location_with_query.query.should == "q=333%20W%20Harbor%20Dr,%20San%20Diego,%20CA"
+  end
 
+  describe "GeoRuby support" do
     it "should represent a bounding box as a GeoRuby Envelope" do
-      location = Hpricot.XML(XML_LOCATION_CHUNK)
-      @location = FireEagle::Location.new(location)
+      @location = FireEagle::Location.parse(responses(:location_chunk))
       @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 = FireEagle::Location.parse(responses(:exact_location_chunk))
       @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 = FireEagle::Location.parse(responses(:exact_location_chunk))
       @location.geo.should be_an_instance_of(GeoRuby::SimpleFeatures::Point)
     end
-
   end
-
-end
+end

data/spec/locations_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe FireEagle::Locations do
+  before :each do
+    @instance = FireEagle::Locations.parse(responses(:locations_chunk))
+  end
+
+  it "should be Enumerable" do
+    @instance.should be_a_kind_of(Enumerable)
+  end
+
+  it "should have a length" do
+    @instance.length.should == 9
+  end
+
+  it "should have a size" do
+    @instance.size.should == 9
+  end
+
+  it "should be indexable" do
+    @instance[0].should_not be_nil
+  end
+
+  it "should be indexable by Range" do
+    @instance[0..2].length.should == 3
+  end
+
+  it "should be indexable by 'start' and 'length'" do
+    @instance[0, 2].length.should == 2
+  end
+
+  it "should be sliceable" do
+    @instance.should respond_to(:slice)
+  end
+
+  it "should have a first element" do
+    @instance.first.should == @instance[0]
+  end
+
+  it "should have a last element" do
+    @instance.last.should == @instance[-1]
+  end
+end

data/spec/responses/error.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="fail">
+  <err code="11" msg="Something bad happened" />
+</rsp>

data/spec/responses/exact_location_chunk.xml

@@ -0,0 +1,3 @@
+<location xmlns:georss="http://www.georss.org/georss">
+  <georss:point>38.5351715088 -121.7948684692</georss:point>
+</location>

data/spec/responses/location_chunk.xml

@@ -0,0 +1,11 @@
+<location best-guess="false" xmlns:georss="http://www.georss.org/georss">
+  <georss:box>38.5351715088 -121.7948684692 38.575668335 -121.6747894287</georss:box>
+  <level>3</level>
+  <level-name>city</level-name>
+  <located-at>2008-01-22T14:23:11-08:00</located-at>
+  <name>Davis, CA</name>
+  <normal-name>Davis</normal-name>
+  <woeid exact-match="true">2389646</woeid>
+  <place-id exact-match="true">u4L9ZOObApTdx1q3</place-id>
+  <label>Home of UC Davis</label>
+</location>

data/spec/responses/location_chunk_with_query.xml

@@ -0,0 +1,9 @@
+<location best-guess="true" xmlns:georss="http://www.georss.org/georss">
+  <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>
+  <query>q=333%20W%20Harbor%20Dr,%20San%20Diego,%20CA</query>
+</location>

data/spec/responses/locations_chunk.xml

@@ -0,0 +1,38 @@
+<locations start="0" total="9" count="9">
+  <location>
+    <name>Alpharetta, GA 30022</name>
+    <place-id>IrhZMHuYA5s1fFi4Qw</place-id>
+  </location>
+  <location>
+    <name>Hannover, Region Hannover, Deutschland</name>
+    <place-id>88Hctc2bBZlhvlwbUg</place-id>
+  </location>
+  <location>
+    <name>N&#238;mes, Gard, France</name>
+    <place-id>Sut8q82bBZkF0s1eTg</place-id>
+  </location>
+  <location>
+    <name>Ceggia, Venezia, Italia</name>
+    <place-id>s9ulRieYA5TkNK9otw</place-id>
+  </location>
+  <location>
+    <name>Comit&#225;n de Dom&#237;nguez, Comitan de Dominguez, M&#233;xico</name>
+    <place-id>.51HvYKbBZnSAeNHWw</place-id>
+  </location>
+  <location>
+    <name>Platanos Aitoloakarnanias, Etolia Kai Akarnania, Greece</name>
+    <place-id>CmfJ2H.YA5QKpS56HQ</place-id>
+  </location>
+  <location>
+    <name>Krak&#243;w, Krak&#243;w, Polska</name>
+    <place-id>9bYc0l.bA5vPTGscQg</place-id>
+  </location>
+  <location>
+    <name>Nakuru, Kenya</name>
+    <place-id>VDprypWYA5sujnZphA</place-id>
+  </location>
+  <location>
+    <name>Fez, Al Magreb</name>
+    <place-id>BxOaGgSYA5R40Nm1RA</place-id>
+  </location>
+</locations>

data/spec/responses/lookup.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rsp stat="ok">
+  <querystring>q=30022</querystring>
+  <locations start="0" total="9" count="9">
+    <location>
+      <name>Alpharetta, GA 30022</name>
+      <place-id>IrhZMHuYA5s1fFi4Qw</place-id>
+    </location>
+    <location>
+      <name>Hannover, Region Hannover, Deutschland</name>
+      <place-id>88Hctc2bBZlhvlwbUg</place-id>
+    </location>
+    <location>
+      <name>N&#238;mes, Gard, France</name>
+      <place-id>Sut8q82bBZkF0s1eTg</place-id>
+    </location>
+    <location>
+      <name>Ceggia, Venezia, Italia</name>
+      <place-id>s9ulRieYA5TkNK9otw</place-id>
+    </location>
+    <location>
+      <name>Comit&#225;n de Dom&#237;nguez, Comitan de Dominguez, M&#233;xico</name>
+      <place-id>.51HvYKbBZnSAeNHWw</place-id>
+    </location>
+    <location>
+      <name>Platanos Aitoloakarnanias, Etolia Kai Akarnania, Greece</name>
+      <place-id>CmfJ2H.YA5QKpS56HQ</place-id>
+    </location>
+    <location>
+      <name>Krak&#243;w, Krak&#243;w, Polska</name>
+      <place-id>9bYc0l.bA5vPTGscQg</place-id>
+    </location>
+    <location>
+      <name>Nakuru, Kenya</name>
+      <place-id>VDprypWYA5sujnZphA</place-id>
+    </location>
+    <location>
+      <name>Fez, Al Magreb</name>
+      <place-id>BxOaGgSYA5R40Nm1RA</place-id>
+    </location>
+  </locations>
+</rsp>

data/spec/responses/recent.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rsp xmlns:georss="http://www.georss.org/georss" stat="ok">
+  <users>
+    <user located-at="2008-07-31T22:31:37+12:00" token="5pyl1xip0uh6"/>
+    <user located-at="2008-07-31T21:49:03+12:00" token="i71yc3myixg3"/>
+    <user located-at="2008-07-30T21:40:54+12:00" token="q1jm8nubnpsi"/>
+  </users>
+</rsp>

data/spec/responses/user.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="ok" xmlns:georss="http://www.georss.org/georss">
+  <user token="16w3z6ysudxt" located-at="2008-12-09T17:14:50-08:00" readable="true" writable="true">
+    <location-hierarchy timezone="America/Los_Angeles">
+      <location best-guess="false">
+        <georss:box>38.5351715088 -121.7948684692 38.575668335 -121.6747894287</georss:box>
+        <label>Home of UC Davis</label>
+        <level>3</level>
+        <level-name>city</level-name>
+        <located-at>2008-01-22T14:23:11-08:00</located-at>
+        <name>Davis, CA</name>
+        <place-id>u4L9ZOObApTdx1q3</place-id>
+      </location>
+      <location best-guess="true">
+        <georss:box>38.3131217957 -122.4230804443 38.9261016846 -121.5012969971</georss:box>
+        <level>4</level>
+        <level-name>region</level-name>
+        <located-at>2008-01-22T18:45:26-08:00</located-at>
+        <name>Yolo County, California</name>
+        <place-id>YUYMh9CbBJ61mgFe</place-id>
+      </location>
+      <location best-guess="false">
+        <georss:box>32.5342788696 -124.4150238037 42.0093803406 -114.1308135986</georss:box>
+        <level>5</level>
+        <level-name>state</level-name>
+        <located-at>2008-01-22T18:45:26-08:00</located-at>
+        <name>California</name>
+        <place-id>SVrAMtCbAphCLAtP</place-id>
+      </location>
+      <location best-guess="false">
+        <georss:box>18.9108390808 -167.2764129639 72.8960571289 -66.6879425049</georss:box>
+        <level>6</level>
+        <level-name>country</level-name>
+        <located-at>2008-01-22T18:45:26-08:00</located-at>
+        <name>United States</name>
+        <place-id>4KO02SibApitvSBieQ</place-id>
+      </location>
+    </location-hierarchy>
+  </user>
+</rsp>

data/spec/responses/within.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rsp xmlns:georss="http://www.georss.org/georss" stat="ok">
+  <users>
+    <user located-at="2008-07-31T22:31:37+12:00" token="5pyl1xip0uh6"/>
+    <user located-at="2008-07-31T21:49:03+12:00" token="i71yc3myixg3"/>
+  </users>
+</rsp>

data/spec/spec_helper.rb

@@ -7,54 +7,18 @@ rescue LoadError
 end
 require 'time'
 
-XML_ERROR_RESPONSE = <<-RESPONSE
-<?xml version="1.0" encoding="utf-8"?>
-<rsp stat="fail">
-  <err code="11" msg="Something bad happened" />
-</rsp>
-RESPONSE
+module ResponseHelper
+  def responses(key)
+    File.read(File.join(File.dirname(__FILE__), "responses", "#{key}.xml"))
+  end
+end
 
-XML_LOCATION_RESPONSE = <<-RESPONSE
-<?xml version="1.0" encoding="utf-8"?>
-<rsp stat="ok" xmlns:georss="http://www.georss.org/georss">
-  <user token="16w3z6ysudxt">
-    <location-hierarchy>
-      <location best-guess="false">
-        <georss:box>38.5351715088 -121.7948684692 38.575668335 -121.6747894287</georss:box>
-        <level>3</level>
-        <level-name>city</level-name>
-        <located-at>2008-01-22T14:23:11-08:00</located-at>
-        <name>Davis, CA</name>
-        <place-id>u4L9ZOObApTdx1q3</place-id>
-      </location>
-      <location best-guess="true">
-        <georss:box>38.3131217957 -122.4230804443 38.9261016846 -121.5012969971</georss:box>
-        <level>4</level>
-        <level-name>region</level-name>
-        <located-at>2008-01-22T18:45:26-08:00</located-at>
-        <name>Yolo County, California</name>
-        <place-id>YUYMh9CbBJ61mgFe</place-id>
-      </location>
-      <location best-guess="false">
-        <georss:box>32.5342788696 -124.4150238037 42.0093803406 -114.1308135986</georss:box>
-        <level>5</level>
-        <level-name>state</level-name>
-        <located-at>2008-01-22T18:45:26-08:00</located-at>
-        <name>California</name>
-        <place-id>SVrAMtCbAphCLAtP</place-id>
-      </location>
-      <location best-guess="false">
-        <georss:box>18.9108390808 -167.2764129639 72.8960571289 -66.6879425049</georss:box>
-        <level>6</level>
-        <level-name>country</level-name>
-        <located-at>2008-01-22T18:45:26-08:00</located-at>
-        <name>United States</name>
-        <place-id>4KO02SibApitvSBieQ</place-id>
-      </location>
-    </location-hierarchy>
-  </user>
-</rsp>
-RESPONSE
+Spec::Runner.configure do |config|
+  include ResponseHelper
+end
+
+XML_ERROR_RESPONSE = File.read(File.join(File.dirname(__FILE__), "responses", "error.xml"))
+XML_LOCATION_RESPONSE = File.read(File.join(File.dirname(__FILE__), "responses", "user.xml"))
 
 XML_SUCCESS_RESPONSE = <<-RESPONSE
 <?xml version="1.0" encoding="utf-8"?>
@@ -63,205 +27,17 @@ XML_SUCCESS_RESPONSE = <<-RESPONSE
 </rsp>
 RESPONSE
 
-XML_LOCATION_CHUNK = <<-RESPONSE
-<location best-guess="false">
-  <georss:box>38.5351715088 -121.7948684692 38.575668335 -121.6747894287</georss:box>
-  <level>3</level>
-  <level-name>city</level-name>
-  <located-at>2008-01-22T14:23:11-08:00</located-at>
-  <name>Davis, CA</name>
-  <place-id>u4L9ZOObApTdx1q3</place-id>
-</location>
-RESPONSE
+XML_LOOKUP_RESPONSE = File.read(File.join(File.dirname(__FILE__), "responses", "lookup.xml"))
 
-XML_EXACT_LOCATION_CHUNK = <<-RESPONSE
-<location>
-  <georss:point>38.5351715088 -121.7948684692</georss:box>
-</location>
-RESPONSE
-
-XML_LOOKUP_RESPONSE = <<-RESPONSE
-<?xml version="1.0" encoding="UTF-8"?>
-<rsp stat="ok">
-  <querystring>q=30022</querystring>
-  <locations start="0" total="9" count="9">
-    <location>
-      <name>Alpharetta, GA 30022</name>
-      <place-id>IrhZMHuYA5s1fFi4Qw</place-id>
-    </location>
-    <location>
-      <name>Hannover, Region Hannover, Deutschland</name>
-      <place-id>88Hctc2bBZlhvlwbUg</place-id>
-    </location>
-    <location>
-      <name>N&#238;mes, Gard, France</name>
-      <place-id>Sut8q82bBZkF0s1eTg</place-id>
-    </location>
-    <location>
-      <name>Ceggia, Venezia, Italia</name>
-      <place-id>s9ulRieYA5TkNK9otw</place-id>
-    </location>
-    <location>
-      <name>Comit&#225;n de Dom&#237;nguez, Comitan de Dominguez, M&#233;xico</name>
-      <place-id>.51HvYKbBZnSAeNHWw</place-id>
-    </location>
-    <location>
-      <name>Platanos Aitoloakarnanias, Etolia Kai Akarnania, Greece</name>
-      <place-id>CmfJ2H.YA5QKpS56HQ</place-id>
-    </location>
-    <location>
-      <name>Krak&#243;w, Krak&#243;w, Polska</name>
-      <place-id>9bYc0l.bA5vPTGscQg</place-id>
-    </location>
-    <location>
-      <name>Nakuru, Kenya</name>
-      <place-id>VDprypWYA5sujnZphA</place-id>
-    </location>
-    <location>
-      <name>Fez, Al Magreb</name>
-      <place-id>BxOaGgSYA5R40Nm1RA</place-id>
-    </location>
-  </locations>
+XML_FAIL_LOOKUP_RESPONSE = <<-RESPONSE
+<?xml version="1.0" encoding="utf-8"?>
+<rsp stat="fail">
+  <err msg="Place can't be identified." code="6"/>
 </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_WITHIN_RESPONSE = File.read(File.join(File.dirname(__FILE__), "responses", "within.xml"))
 
-XML_RECENT_RESPONSE = <<-RESPONSE
-<?xml version="1.0" encoding="UTF-8"?>
-<rsp xmlns:georss="http://www.georss.org/georss" stat="ok">
-  <users>
-    <user located-at="2008-07-31T22:31:37+12:00" token="5pyl1xip0uh6"/>
-    <user located-at="2008-07-31T21:49:03+12:00" token="i71yc3myixg3"/>
-    <user located-at="2008-07-30T21:40:54+12:00" token="q1jm8nubnpsi"/>
-  </users>
-</rsp>
-RESPONSE
+XML_RECENT_RESPONSE = File.read(File.join(File.dirname(__FILE__), "responses", "recent.xml"))
 
-require File.dirname(__FILE__) + '/../lib/fireeagle'
+require File.dirname(__FILE__) + '/../lib/fireeagle'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jnewland-fireeagle
 version: !ruby/object:Gem::Version 
-  version: 0.8.0.0
+  version: 0.8.0.1
 platform: ruby
 authors: 
 - Jesse Newland
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-29 00:00:00 -07:00
+date: 2009-02-03 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,16 +19,16 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.4
+        version: 0.3.1
     version: 
 - !ruby/object:Gem::Dependency 
-  name: hpricot
+  name: happymapper
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0.6"
+        version: 0.2.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: GeoRuby
@@ -39,6 +39,15 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.3.2
     version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
 description: Ruby wrapper for Yahoo!'s FireEagle
 email: 
 - jnewland@gmail.com
@@ -61,14 +70,27 @@ files:
 - Rakefile
 - lib/fireeagle.rb
 - lib/fireeagle/client.rb
+- lib/fireeagle/error.rb
 - lib/fireeagle/location.rb
+- lib/fireeagle/location_hierarchy.rb
+- lib/fireeagle/locations.rb
 - lib/fireeagle/response.rb
 - lib/fireeagle/user.rb
 - lib/fireeagle/version.rb
 - setup.rb
-- spec/fireeagle_location_spec.rb
 - spec/fireeagle_response_spec.rb
 - spec/fireeagle_spec.rb
+- spec/location_spec.rb
+- spec/locations_spec.rb
+- spec/responses/error.xml
+- spec/responses/exact_location_chunk.xml
+- spec/responses/location_chunk.xml
+- spec/responses/location_chunk_with_query.xml
+- spec/responses/locations_chunk.xml
+- spec/responses/lookup.xml
+- spec/responses/recent.xml
+- spec/responses/user.xml
+- spec/responses/within.xml
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/environment.rake