jsl-placemaker 0.0.1.2 → 0.0.1.5

data/README.rdoc

@@ -1,34 +1,67 @@
 = Description
 
-Ruby interface for the Yahoo PlaceMaker API.
+Yahoo! Placemaker is a freely available geoparsing Web service. It helps developers make their applications location-aware by 
+identifying places in unstructured and atomic content - feeds, web pages, news, status updates - and returning geographic metadata 
+for geographic indexing and markup.
+
+This library is a Ruby interface for accessing the {Yahoo PlaceMaker API}[http://developer.yahoo.com/geo/placemaker/].
 
 = Installation
 
-Assuming that you've set up your ruby environment to pull gems from GitHub, install placemaker with the following command:
+Assuming that you've set up your ruby environment to pull gems from GitHub 
+(see {the GitHub instructions if you haven't yet done this}[http://gems.github.com]), 
+install placemaker with the following command:
 
   sudo gem install jsl-placemaker
 
 = Usage
 
-The following is an example of using the Placemaker gem to read places in a standard feed.
+The following is an example of using the Placemaker gem to read places in a standard feed.  You'll have to get a Yahoo App ID first if you haven't 
+already done so.
 
   require 'placemaker'
-  p = Placemaker.new(:appid => YOUR_APP_ID, :document_url => 'http://feeds.feedburner.com/wooster', :document_type => 'text/xml')
-  results = p.fetch
+  p = Placemaker::Client.new(:appid => YOUR_APP_ID, :document_url => 'http://feeds.feedburner.com/wooster', :document_type => 'text/xml')
+  p.fetch!
+
+This will make a call to the Placemaker service and populate the Placemaker::Client object with data about the places in the content that you
+sent to Yahoo.  The information that you'll be interested in may be divided into "documents" and "meta-data".
+
+== Documents
+
+Once you've run the +fetch!+ method on the Placemaker::Client, you may invoke the method +documents+ which will return a set of Placemaker::Document
+objects corresponding to each of the entries in the feed given to the placemaker service.  For example, if you gave a +document_url+ pointing
+to a feed containing 15 entries, there will be 15 documents in the resulting client object.
+
+The following are methods that you may invoke on each of the Placemaker::Document objects to find out more about the place information that
+Yahoo was able to glean from the input document:
+
+* place_details - Returns a Placemaker::Location object that is a container for one named place mentioned in the document
+* administrative_scope - Returns a Placemaker::Location object that is a container for the smallest administrative place that best describes the document 
+* geographic_scope - Returns a Placemaker::Location object that is a container for the smallest place that best describes the document 
+* extents - Returns a Placemaker::Extents object that is a container for the the map extents covering the places mentioned in the document
+
+Below is a summary of the methods that these objects respond to.  You may wish to browse the Placemaker rdoc files for these classes to see 
+for more details.
   
-"Results" will be a collection of Placemaker::Document objects.  Each of these documents corresponds to a feed entry, and it may
-have one or more "places":
+=== Placemaker::Location
+
+Placemaker::Location objects contain a woe_id, name, location_type and centroid.
+
+* woe_id - permanent identifier for the place
+* name - fully qualified name for the place
+* location_type - type name for the place
+* centroid - centroid for the place, responds to +lat+ and +lng+
 
-results.first.places
+=== Placemaker::Extents
 
-Places are Placemaker::Place objects, and they contain information about the place that is discussed in this particular feed.
+Placemaker::Extents are bounding boxes for an area of interest.  They respond to methods for +center+, +south_west+ and +north_east+.  In
+all of these cases, they return a Placemaker::Coordinates object responding to +lat+ and +lng+.
 
-= TODO
+== Meta-data
 
-This library is a rough first pass at using the Yahoo Placemaker API.  It needs refinement in the parsing of the resultset
-returned by Yahoo, as there is plenty of functionality still unexposed in this interface.  It is also still relatively untested
-and surely has bugs.
+The request to the Yahoo place coding service returns information about the request.  You may invoke the methods +processing_time+, 
++version+, and +document_length+ to find out more about the request.
 
 = Author
 
-Justin S. Leitgeb, mailto:justin@phq.org
+Justin S. Leitgeb, justin@phq.org

data/lib/placemaker/{reader.rb → client.rb}

@@ -1,34 +1,57 @@
 module Placemaker
-  class Reader
+  
+  # Main interface to the Placemaker API.
+  class Client
     POST_FIELDS =  %w[ appid document_content document_url document_type document_title 
       auto_disambiguate focus_woe_id input_language output_type ].map{|f| f.to_sym}
 
-    attr_reader :documents
-
     def initialize(options = {})
       @options = options
       @options[:appid] ||= ENV['PLACEMAKER_APPID']
-      @documents = [ ]
+      
+      @xml_parser = Placemaker::XmlParser.new('NODOC')
+      
       verify_content_set
       verify_document_type_set
     end
 
-    POST_FIELDS.each do |f|
-      define_method(f) do  # def appid
-        @options[f]        #   @options[:appid]
-      end                  # end
-    end
-
-    def fetch
+    # Fetches the place information for input parameters from the Yahoo Placemaker service
+    def fetch!
       fields = POST_FIELDS.reject{|f| @options[f].nil? }.map do |f|
         # Change ruby-form fields to url type, e.g., document_content => documentContent
         cgi_param = f.to_s.gsub(/\_(.)/) {|s| s.upcase}.gsub('_', '').sub(/url/i, 'URL')
         Curl::PostField.content(cgi_param, @options[f])
       end
 
-      res = Curl::Easy.http_post('http://wherein.yahooapis.com/v1/document', *fields)
-      xml_parser = Placemaker::XmlParser.new(res.body_str)
-      @documents = xml_parser.documents
+      res         = Curl::Easy.http_post('http://wherein.yahooapis.com/v1/document', *fields)
+      @xml_parser = Placemaker::XmlParser.new(res.body_str)
+    end
+
+    # Returns a collection of Placemaker::Document items as containers for content location information
+    def documents
+      @xml_parser.documents
+    end
+    
+    # time in seconds to process the document
+    def processing_time
+      @xml_parser.processing_time
+    end
+    
+    # version of the software used to process the document 
+    def version
+      @xml_parser.version
+    end
+
+    # length in bytes of the document
+    def document_length
+      @xml_parser.document_length
+    end
+    
+    # Create convenience methods to access post fields from the @options hash, mostly for testing.
+    POST_FIELDS.each do |f|
+      define_method(f) do  # def appid
+        @options[f]        #   @options[:appid]
+      end                  # end
     end
 
     private

data/lib/placemaker/coordinates.rb

@@ -0,0 +1,13 @@
+module Placemaker
+  class Coordinates
+    include Placemaker::XmlHelper
+    
+    def lat
+      @nodeset.search('.//xmlns:latitude', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').inner_text.to_f
+    end
+    
+    def lng
+      @nodeset.search('.//xmlns:longitude', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').inner_text.to_f
+    end
+  end
+end

data/lib/placemaker/document.rb

@@ -1,14 +1,32 @@
 module Placemaker
+  
   class Document
-    def initialize(nodeset)
-      @nodeset = nodeset
-    end
+    include Placemaker::XmlHelper
     
-    def places
+    # Returns a Placemaker::Location object that is a container for one named place mentioned in the document 
+    def place_details
       @nodeset.search('.//xmlns:placeDetails', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').map do |p|
-        Placemaker::Place.new(p)
+        Placemaker::PlaceDetails.new(p)
       end
     end
     
+    # Returns a Placemaker::Location object that is a container for the smallest administrative place that best describes the document 
+    def administrative_scope
+      as = @nodeset.search('.//xmlns:administrativeScope', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').first
+      Placemaker::Location.new(as) unless as.nil?
+    end
+    
+    # Returns a Placemaker::Location object that is a container for the smallest place that best describes the document 
+    def geographic_scope
+      gs = @nodeset.search('.//xmlns:geographicScope', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').first
+      Placemaker::Location.new(gs) unless gs.nil?
+    end
+    
+    # Returns a Placemaker::Extents object that is a container for the the map extents covering the places mentioned in the document 
+    def extents
+      extents = @nodeset.search('.//xmlns:extents', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').first
+      Placemaker::Extents.new(extents) unless extents.nil?
+    end
   end
+  
 end

data/lib/placemaker/extents.rb

@@ -0,0 +1,23 @@
+module Placemaker
+  
+  # container for the the map extents covering the places mentioned in the document 
+  class Extents
+    include Placemaker::XmlHelper
+            
+    # coordinates of center (WGS84)
+    def center
+      Placemaker::Coordinates.new(@nodeset.search('.//xmlns:center', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema'))
+    end
+    
+    # coordinates of southwest corner of bounding box (WGS84)
+    def south_west
+      Placemaker::Coordinates.new(@nodeset.search('.//xmlns:southWest', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema'))
+    end
+    
+    # coordinates of northeast corner of bounding box (WGS84)
+    def north_east
+      Placemaker::Coordinates.new(@nodeset.search('.//xmlns:northEast', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema'))
+    end
+  end
+
+end

data/lib/placemaker/location.rb

@@ -0,0 +1,33 @@
+module Placemaker
+
+  # Parses and contains data for +place+, +administrative scope+ and +geographic scope+ elements.
+  class Location
+    include Placemaker::XmlHelper
+    
+    # permanent identifier for the place
+    def woe_id
+      nested_node('woeId').to_i
+    end
+
+    # fully qualified name for the place
+    def name
+      nested_node('name')
+    end
+    
+    # place type name for the place
+    def location_type
+      nested_node('type')
+    end
+    
+    # centroid for the place
+    def centroid
+      Placemaker::Coordinates.new(@nodeset.search('.//xmlns:centroid', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema'))
+    end
+
+    private    
+    
+    def nested_node(name)
+      @nodeset.search(".//xmlns:#{name}", 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').inner_text
+    end    
+  end
+end

data/lib/placemaker/place_details.rb

@@ -0,0 +1,28 @@
+module Placemaker
+
+  # container for one named place mentioned in the document
+  class PlaceDetails
+    include Placemaker::XmlHelper
+    
+    # Returns a Placemaker::Location object as a container for place information.
+    def place
+      Placemaker::Location.new(@nodeset.search('.//xmlns:place', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema'))
+    end
+    
+    # type of match (0=text or text and coordinates, 1=coordinates only) 
+    def match_type
+      nested_node('matchType').to_i
+    end
+
+    # relative weight of the place within the document (range 1-100) 
+    def weight
+      nested_node('weight').to_i
+    end
+
+    # confidence that the document mentions the place (range 1-10) 
+    def confidence
+      nested_node('confidence').to_i
+    end    
+
+  end
+end

data/lib/placemaker/xml_helper.rb

@@ -0,0 +1,14 @@
+module Placemaker
+  module XmlHelper
+    def initialize(nodeset)
+      @nodeset = nodeset
+    end
+    
+    # Returns the inner text of a node with the given name under the current @nodeset 
+    def nested_node(name)
+      @nodeset.search(".//xmlns:#{name}", 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').inner_text
+    end
+    
+    private :nested_node
+  end
+end

data/lib/placemaker/xml_parser.rb

@@ -3,10 +3,24 @@ module Placemaker
     def initialize(xml_body)
       @body = xml_body
       @xml = Nokogiri::XML(xml_body)
+    end    
+    
+    # time in seconds to process the document
+    def processing_time
+      @xml.xpath('.//xmlns:processingTime', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').inner_text.to_f
+    end
+    
+    # version of the software used to process the document 
+    def version
+      @xml.xpath('.//xmlns:version', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').inner_text.strip
+    end
+    
+    # length in bytes of the document
+    def document_length
+      @xml.xpath('.//xmlns:documentLength', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').inner_text.to_i  
     end
     
-    # Returns a set of documents corresponding to the RSS entries in input data.
-    # Returns a collection of Placemaker::Document objects.
+    #  Returns a set of Placemaker::Document objects as containers for content location information
     def documents
       @xml.xpath('//xmlns:document', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').map do |d|
         Placemaker::Document.new(d)

data/lib/placemaker.rb

@@ -3,6 +3,8 @@ require 'curb'
 require 'nokogiri'
 require 'cgi'
 
+require File.join(File.dirname(__FILE__), %w[placemaker xml_helper])
+
 lib_dirs =  [ 'core_ext', 'placemaker' ].map do |d|
   File.join(File.dirname(__FILE__), d)
 end

data/placemaker.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{placemaker}
-  s.version = "0.0.1.2"
+  s.version = "0.0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Leitgeb"]
@@ -14,11 +14,12 @@ Gem::Specification.new do |s|
   ]
   
   
-  s.files = ["lib/core_ext/array.rb", "lib/core_ext/hash.rb", "lib/placemaker/document.rb", "lib/placemaker/place.rb", 
-    "lib/placemaker/reader.rb", "lib/placemaker/xml_parser.rb", "lib/placemaker.rb", "LICENSE",
-    "placemaker.gemspec", "Rakefile", "README.rdoc", "spec/fixtures/xml_rss_feed_result.xml", 
-    "spec/placemaker/document_spec.rb", "spec/placemaker/place_spec.rb", "spec/placemaker/reader_spec.rb", 
-    "spec/placemaker/xml_parser_spec.rb", "spec/spec_helper.rb"]
+  s.files = ["lib/core_ext/array.rb", "lib/core_ext/hash.rb", "lib/placemaker/client.rb", "lib/placemaker/coordinates.rb", 
+    "lib/placemaker/document.rb", "lib/placemaker/extents.rb", "lib/placemaker/location.rb", "lib/placemaker/place_details.rb", 
+    "lib/placemaker/xml_helper.rb", "lib/placemaker/xml_parser.rb", "lib/placemaker.rb", "LICENSE", "placemaker.gemspec", 
+    "Rakefile", "README.rdoc", "spec/fixtures/xml_rss_feed_result.xml", "spec/placemaker/client_spec.rb", "spec/placemaker/coordinates_spec.rb", 
+    "spec/placemaker/document_spec.rb", "spec/placemaker/extents_spec.rb", "spec/placemaker/location_spec.rb", 
+    "spec/placemaker/place_details_spec.rb", "spec/placemaker/xml_parser_spec.rb", "spec/spec_helper.rb"]
   
   s.has_rdoc = true
   s.homepage = %q{http://github.com/jsl/placemaker}
@@ -26,8 +27,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{Ruby interface over the Yahoo Placemaker API}
-  s.test_files = ["spec/fixtures/xml_rss_feed_result.xml", "spec/placemaker/document_spec.rb", "spec/placemaker/place_spec.rb", 
-    "spec/placemaker/reader_spec.rb", "spec/placemaker/xml_parser_spec.rb", "spec/spec_helper.rb"]
+  
+  s.test_files = ["spec/fixtures/xml_rss_feed_result.xml", "spec/placemaker/client_spec.rb", "spec/placemaker/coordinates_spec.rb", 
+    "spec/placemaker/document_spec.rb", "spec/placemaker/extents_spec.rb", "spec/placemaker/location_spec.rb", 
+    "spec/placemaker/place_details_spec.rb", "spec/placemaker/xml_parser_spec.rb", "spec/spec_helper.rb"]
 
   s.extra_rdoc_files = [ "README.rdoc" ]
   

data/spec/placemaker/{reader_spec.rb → client_spec.rb}

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__),  '..', 'spec_helper')
 
-describe Placemaker::Reader do
+describe Placemaker::Client do
   before do
     @valid_opts = {
       :document_url   => 'http://www.example.com',
@@ -11,36 +11,36 @@ describe Placemaker::Reader do
   describe "object initialization" do
     it "should set appid to the value of ENV['PLACEMAKER_APPID']" do
       ENV['PLACEMAKER_APPID'] = 'foo'
-      p = Placemaker::Reader.new(@valid_opts)
+      p = Placemaker::Client.new(@valid_opts)
       p.appid.should == 'foo'
     end
     
     it "should initialize #documents to an empty array" do
-      p = Placemaker::Reader.new(@valid_opts)
+      p = Placemaker::Client.new(@valid_opts)
       p.documents.should be_a(Array)
       p.documents.should be_empty
     end
   
     it "should raise an argument error if the document_type is not correctly set" do
       lambda {
-        Placemaker::Reader.new(@valid_opts.except(:document_type))
+        Placemaker::Client.new(@valid_opts.except(:document_type))
       }.should raise_error(ArgumentError)
     end
   
     it "should set the appid to the value of options[:appid] if provided" do
       ENV['PLACEMAKER_APPID'] = 'foo'
-      p = Placemaker::Reader.new(@valid_opts.merge(:appid => 'fark', :document_url => 'foo'))
+      p = Placemaker::Client.new(@valid_opts.merge(:appid => 'fark', :document_url => 'foo'))
       p.appid.should == 'fark'  
     end
   
     it "should create methods to allow access to configuration parameters" do
-      p = Placemaker::Reader.new(@valid_opts.merge(:document_content => 'foo'))
+      p = Placemaker::Client.new(@valid_opts.merge(:document_content => 'foo'))
       p.document_content.should == 'foo'
     end
   
     it "should raise an error if both document_content and document_url are nil" do
       lambda {
-        p = Placemaker::Reader.new
+        p = Placemaker::Client.new
       }.should raise_error(ArgumentError)
     end
   end

data/spec/placemaker/coordinates_spec.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__),  '..', 'spec_helper')
+
+describe Placemaker::Coordinates do
+  before do
+    @xml_str = File.read(File.join(File.dirname(__FILE__), %w[.. fixtures xml_rss_feed_result.xml]))
+    @xmlp = Placemaker::XmlParser.new(@xml_str)
+    @doc = @xmlp.documents[5]    
+    @coords = @doc.place_details.first.place.centroid
+  end
+  
+  it "should be a Placemaker::Coordinates object" do
+    @coords.should be_a(Placemaker::Coordinates)
+  end
+end

data/spec/placemaker/document_spec.rb

@@ -6,14 +6,34 @@ describe Placemaker::Document do
     @xmlp = Placemaker::XmlParser.new(@xml_str)
     @doc = @xmlp.documents[5]
   end
-
+    
   describe "#places" do
     it "should have 4 places for the given node" do
-      @doc.places.size.should == 4
+      @doc.place_details.size.should == 4
+    end
+    
+    it "should return a Placemaker::PlaceDetails object for the first node" do
+      @doc.place_details.first.should be_a(Placemaker::PlaceDetails)
+    end
+  end
+  
+  describe "#administrative_scope" do
+    it "should have an administrative scope" do
+      @doc.administrative_scope.should_not be_nil
+    end
+    
+    it "should return a Placemaker::Location object" do
+      @doc.administrative_scope.should be_a(Placemaker::Location)
+    end
+  end
+  
+  describe "#geographic_scope" do
+    it "should have an geographic scope" do
+      @doc.geographic_scope.should_not be_nil
     end
     
-    it "should return a Placemaker::Place object for the first node" do
-      @doc.places.first.should be_a(Placemaker::Place)
+    it "should return a Placemaker::Location object" do
+      @doc.geographic_scope.should be_a(Placemaker::Location)
     end
   end
 end

data/spec/placemaker/extents_spec.rb

@@ -0,0 +1,56 @@
+require File.join(File.dirname(__FILE__),  '..', 'spec_helper')
+
+describe Placemaker::Extents do
+  before do
+    @xml_str = File.read(File.join(File.dirname(__FILE__), %w[.. fixtures xml_rss_feed_result.xml]))
+    @xmlp = Placemaker::XmlParser.new(@xml_str)
+    @doc = @xmlp.documents[5]
+    @extents = @doc.extents
+  end
+
+  it "should be a Placemaker::Extents object" do
+    @extents.should be_a(Placemaker::Extents)
+  end
+
+  describe "#center" do
+    it "should return a Placemaker::Point object" do
+      @extents.center.should be_a(Placemaker::Coordinates)
+    end
+    
+    it "should have a lat of 38.8913" do
+      @extents.center.lat.should == 38.8913
+    end
+    
+    it "should have a lng of -77.0337" do
+      @extents.center.lng.should == -77.0337
+    end
+  end
+  
+  describe "#south_west" do
+    it "should return a Placemaker::Point object" do
+      @extents.south_west.should be_a(Placemaker::Coordinates)
+    end
+    
+    it "should have a lat of 18.9108" do
+      @extents.south_west.lat.should == 18.9108
+    end
+    
+    it "should have a lng of -167.276" do
+      @extents.south_west.lng.should == -167.276
+    end
+  end
+  
+  describe "#north_east" do
+    it "should return a Placemaker::Point object" do
+      @extents.north_east.should be_a(Placemaker::Coordinates)
+    end
+    
+    it "should have a lat of 72.8961" do
+      @extents.north_east.lat.should == 72.8961
+    end
+    
+    it "should have a lng of -66.6879" do
+      @extents.north_east.lng.should == -66.6879
+    end
+  end
+end

data/spec/placemaker/{place_spec.rb → location_spec.rb}

@@ -1,61 +1,44 @@
 require File.join(File.dirname(__FILE__),  '..', 'spec_helper')
 
-describe Placemaker::Place do
+describe Placemaker::Location do
   before do
     @xml_str = File.read(File.join(File.dirname(__FILE__), %w[.. fixtures xml_rss_feed_result.xml]))
     @xmlp = Placemaker::XmlParser.new(@xml_str)
-    @doc = @xmlp.documents[5]
-    @place = @doc.places.first
+    @doc = @xmlp.documents[5]    
+    @loc = @doc.place_details.first.place
   end
   
   describe "#woe_id" do
     it "should equal 2442047" do
-      @place.woe_id.should == 2442047
+      @loc.woe_id.should == 2442047
     end
   end
   
   describe "place_type" do
     it "should be Town" do
-      @place.place_type.should == 'Town'
+      @loc.location_type.should == 'Town'
     end
   end
   
   describe "#name" do
     it "should be Los Angeles, CA, US" do
-      @place.name.should == 'Los Angeles, CA, US'
+      @loc.name.should == 'Los Angeles, CA, US'
     end
   end
   
   describe "centroid" do
     
     it "should be a Placemaker::Point object" do
-      @place.centroid.should be_a(Placemaker::Point)
+      @loc.centroid.should be_a(Placemaker::Coordinates)
     end
     
     it "should return an object with lat set to 34.0533" do
-      @place.centroid.lat.should == 34.0533
+      @loc.centroid.lat.should == 34.0533
     end
     
     it "should return an object with lng set to -118.245" do
-      @place.centroid.lng.should == -118.245
+      @loc.centroid.lng.should == -118.245
     end
   end
   
-  describe "#match_type" do
-    it "should be 0" do
-      @place.match_type.should == 0
-    end
-  end
-  
-  describe "#weight" do
-    it "should be 1" do
-      @place.weight.should == 1
-    end
-  end
-  
-  describe "#confidence" do
-    it "should be 9" do
-      @place.confidence.should == 9
-    end
-  end
 end

data/spec/placemaker/place_details_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__),  '..', 'spec_helper')
+
+describe Placemaker::PlaceDetails do
+  before do
+    @xml_str = File.read(File.join(File.dirname(__FILE__), %w[.. fixtures xml_rss_feed_result.xml]))
+    @xmlp = Placemaker::XmlParser.new(@xml_str)
+    @doc = @xmlp.documents[5]
+    @pd = @doc.place_details.first
+  end
+    
+  describe "#match_type" do
+    it "should be 0" do
+      @pd.match_type.should == 0
+    end
+  end
+  
+  describe "#weight" do
+    it "should be 1" do
+      @pd.weight.should == 1
+    end
+  end
+  
+  describe "#confidence" do
+    it "should be 9" do
+      @pd.confidence.should == 9
+    end
+  end
+end

data/spec/placemaker/xml_parser_spec.rb

@@ -5,6 +5,24 @@ describe Placemaker::XmlParser do
     @xml_str = File.read(File.join(File.dirname(__FILE__), %w[.. fixtures xml_rss_feed_result.xml]))
     @xmlp = Placemaker::XmlParser.new(@xml_str)
   end
+
+  describe "processing_time" do
+    it "should return 0.028125" do
+      @xmlp.processing_time.should == 0.028125
+    end
+  end
+
+  describe "version" do
+    it "should return build 090508" do
+      @xmlp.version.should == 'build 090508'
+    end
+  end
+
+  describe "document_length" do
+    it "should return 29700" do
+      @xmlp.document_length.should == 29700
+    end
+  end
   
   describe "#documents" do
     it "should return 15 documents" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsl-placemaker
 version: !ruby/object:Gem::Version 
-  version: 0.0.1.2
+  version: 0.0.1.5
 platform: ruby
 authors: 
 - Justin Leitgeb
@@ -43,9 +43,13 @@ extra_rdoc_files:
 files: 
 - lib/core_ext/array.rb
 - lib/core_ext/hash.rb
+- lib/placemaker/client.rb
+- lib/placemaker/coordinates.rb
 - lib/placemaker/document.rb
-- lib/placemaker/place.rb
-- lib/placemaker/reader.rb
+- lib/placemaker/extents.rb
+- lib/placemaker/location.rb
+- lib/placemaker/place_details.rb
+- lib/placemaker/xml_helper.rb
 - lib/placemaker/xml_parser.rb
 - lib/placemaker.rb
 - LICENSE
@@ -53,9 +57,12 @@ files:
 - Rakefile
 - README.rdoc
 - spec/fixtures/xml_rss_feed_result.xml
+- spec/placemaker/client_spec.rb
+- spec/placemaker/coordinates_spec.rb
 - spec/placemaker/document_spec.rb
-- spec/placemaker/place_spec.rb
-- spec/placemaker/reader_spec.rb
+- spec/placemaker/extents_spec.rb
+- spec/placemaker/location_spec.rb
+- spec/placemaker/place_details_spec.rb
 - spec/placemaker/xml_parser_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -92,8 +99,11 @@ specification_version: 2
 summary: Ruby interface over the Yahoo Placemaker API
 test_files: 
 - spec/fixtures/xml_rss_feed_result.xml
+- spec/placemaker/client_spec.rb
+- spec/placemaker/coordinates_spec.rb
 - spec/placemaker/document_spec.rb
-- spec/placemaker/place_spec.rb
-- spec/placemaker/reader_spec.rb
+- spec/placemaker/extents_spec.rb
+- spec/placemaker/location_spec.rb
+- spec/placemaker/place_details_spec.rb
 - spec/placemaker/xml_parser_spec.rb
 - spec/spec_helper.rb

data/lib/placemaker/place.rb

@@ -1,47 +0,0 @@
-module Placemaker
-  class Point < OpenStruct
-  end
-  
-  class Place
-    def initialize(nodeset)
-      @nodeset = nodeset
-    end
-    
-    def centroid
-      centroid = @nodeset.search('.//xmlns:centroid', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema')
-      lat = centroid.search('.//xmlns:latitude', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').inner_text.to_f
-      lng = centroid.search('.//xmlns:longitude', 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').inner_text.to_f
-      Placemaker::Point.new(:lat => lat, :lng => lng)
-    end
-
-    def place_type
-      nested_node('type')
-    end
-
-    def match_type
-      nested_node('matchType').to_i
-    end
-
-    def weight
-      nested_node('weight').to_i
-    end
-
-    def confidence
-      nested_node('confidence').to_i
-    end
-    
-    def name
-      nested_node('name')
-    end
-    
-    def woe_id
-      nested_node('woeId').to_i
-    end
-    
-    private
-    
-    def nested_node(name)
-      @nodeset.search(".//xmlns:#{name}", 'xmlns' => 'http://wherein.yahooapis.com/v1/schema').inner_text
-    end
-  end
-end