graticule 0.1.1

data/test/fixtures/responses/google/unknown_address.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<kml xmlns="http://earth.google.com/kml/2.0">
+    <Response>
+        <name>1600</name>
+        <Status>
+            <code>602</code>
+            <request>geocode</request>
+        </Status>
+    </Response>
+</kml>

data/test/fixtures/responses/meta_carta/bad_address.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE Locations SYSTEM "Locations.dtd">
+<Locations xmlns:gml="http://www.opengis.net/gml" CreatedBy="MetaCarta GeoParser v3.5.0-labs-alpha" CreatedOn="Sat Jun 17 02:05:42 2006" ConvertedFromBinaryFormat="False" InputByteLength="0">
+  <ViewBox>
+    <gml:Box srsName="epsg:4326">
+      <gml:coordinates>-90.000000,-180.000000 90.000000,180.000000</gml:coordinates>
+    </gml:Box>
+  </ViewBox>
+</Locations>

data/test/fixtures/responses/meta_carta/multiple.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE Locations SYSTEM "Locations.dtd">
+<Locations xmlns:gml="http://www.opengis.net/gml" CreatedBy="MetaCarta GeoParser v3.5.0-labs-alpha" CreatedOn="Sat Jun 17 02:14:05 2006" ConvertedFromBinaryFormat="False" InputByteLength="1">
+  <ViewBox>
+    <gml:Box srsName="epsg:4326">
+      <gml:coordinates>43.800000,-126.133333 51.406390,-118.530830</gml:coordinates>
+    </gml:Box>
+  </ViewBox>
+  <Location Name="Seattle" Type="PPL" Population="563374" Hierarchy="United States/Washington/King/Seattle">
+    <ViewBox>
+      <gml:Box srsName="epsg:4326">
+        <gml:coordinates>43.806390,-126.130830 51.406390,-118.530830</gml:coordinates>
+      </gml:Box>
+    </ViewBox>
+    <Centroid>
+      <gml:Point>
+        <gml:coordinates>-122.330830000000006,47.606389999999998</gml:coordinates>
+      </gml:Point>
+    </Centroid>
+  </Location>
+  <Location Name="Seattle" Type="PRT" Population="-1" Hierarchy="United States/Seattle">
+    <ViewBox>
+      <gml:Box srsName="epsg:4326">
+        <gml:coordinates>43.800000,-126.133333 51.400000,-118.533333</gml:coordinates>
+      </gml:Box>
+    </ViewBox>
+    <Centroid>
+      <gml:Point>
+        <gml:coordinates>-122.333332999999996,47.6</gml:coordinates>
+      </gml:Point>
+    </Centroid>
+  </Location>
+</Locations>

data/test/fixtures/responses/meta_carta/success.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE Locations SYSTEM "Locations.dtd">
+<Locations xmlns:gml="http://www.opengis.net/gml" CreatedBy="MetaCarta GeoParser v3.5.0-labs-alpha" CreatedOn="Thu Jun 15 23:56:50 2006" ConvertedFromBinaryFormat="False" InputByteLength="0">
+  <ViewBox>
+    <gml:Box srsName="epsg:4326">
+      <gml:coordinates>26.238611,37.293889 40.438611,51.493889</gml:coordinates>
+    </gml:Box>
+  </ViewBox>
+  <Location Name="Baghdad" Type="PPLC" Population="5672516" Hierarchy="Iraq/Baghdad/Baghdad">
+    <ViewBox>
+      <gml:Box srsName="epsg:4326">
+        <gml:coordinates>26.238611,37.293889 40.438611,51.493889</gml:coordinates>
+      </gml:Box>
+    </ViewBox>
+    <RemainingQuery/>
+    <Confidence>0.195185</Confidence>
+    <Centroid>
+      <gml:Point>
+        <gml:coordinates>44.393889,33.338611</gml:coordinates>
+      </gml:Point>
+    </Centroid>
+  </Location>
+</Locations>

data/test/fixtures/responses/yahoo/success.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0"?>
+<ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:maps" xsi:schemaLocation="urn:yahoo:maps http://api.local.yahoo.com/MapsService/V1/GeocodeResponse.xsd"><Result precision="address"><Latitude>37.416384</Latitude><Longitude>-122.024853</Longitude><Address>701 FIRST AVE</Address><City>SUNNYVALE</City><State>CA</State><Zip>94089-1019</Zip><Country>US</Country></Result></ResultSet>
+<!-- ws01.search.re2.yahoo.com compressed/chunked Sun Oct 15 18:23:09 PDT 2006 -->

data/test/fixtures/responses/yahoo/unknown_address.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Error xmlns="urn:yahoo:api">
+		The following errors were detected:
+		<Message>unable to parse location</Message>
+</Error>
+<!-- ws02.search.scd.yahoo.com uncompressed/chunked Thu Jun  8 15:53:20 PDT 2006 -->

data/test/mocks/uri.rb

@@ -0,0 +1,51 @@
+require 'uri/http'
+require 'open-uri'
+
+##
+# This stub overrides OpenURI's open method to allow programs that use OpenURI
+# to be easily tested.
+#
+# == Usage
+#
+#   require 'rc_rest/uri_stub'
+#   
+#   class TestMyClass < Test::Unit::TestCase
+#     
+#     def setup
+#       URI::HTTP.responses = []
+#       URI::HTTP.uris = []
+#       
+#       @obj = MyClass.new
+#     end
+#     
+#     def test_my_method
+#       URI::HTTP.responses << 'some text open would ordinarily return'
+#       
+#       result = @obj.my_method
+#       
+#       assert_equal :something_meaninfgul, result
+#       
+#       assert_equal true, URI::HTTP.responses.empty?
+#       assert_equal 1, URI::HTTP.uris.length
+#       assert_equal 'http://example.com/path', URI::HTTP.uris.first
+#     end
+#     
+#  end
+
+class URI::HTTP # :nodoc:
+
+  class << self
+    attr_accessor :responses, :uris
+  end
+
+  alias original_open open
+
+  def open
+    self.class.uris << self.to_s
+    io = StringIO.new(self.class.responses.shift)
+    OpenURI::Meta.init(io)
+    yield io
+  end
+
+end
+

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__) + '/mocks')
+$:.unshift(File.dirname(__FILE__)+ '/extra')
+
+require 'rubygems'
+require 'yaml'
+require 'test/unit'
+require 'breakpoint'
+require 'graticule'
+
+module Test
+  module Unit
+    module Assertions
+      
+      private
+        def response(geocoder, response)
+          clean_backtrace do
+            File.read(File.dirname(__FILE__) + "/fixtures/responses/#{geocoder}/#{response}.xml")
+          end
+        end
+      
+        def clean_backtrace(&block)
+          yield
+        rescue AssertionFailedError => e
+          path = File.expand_path(__FILE__)
+          raise AssertionFailedError, e.message, e.backtrace.reject { |line| File.expand_path(line) =~ /#{path}/ }
+        end
+    end
+  end
+end

data/test/unit/graticule/distance_test.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+module Graticule
+  module Distance
+    class DistanceFormulaTest < Test::Unit::TestCase
+      EARTH_RADIUS_IN_MILES = 3963.1676
+      EARTH_RADIUS_IN_KILOMETERS = 6378.135
+
+      FORMULAS = [Haversine, Spherical, Vincenty]
+
+      def test_earth_radius
+        assert_equal EARTH_RADIUS_IN_MILES, EARTH_RADIUS[:miles]
+        assert_equal EARTH_RADIUS_IN_KILOMETERS, EARTH_RADIUS[:kilometers]
+      end
+
+      def test_distance
+        washington_dc = Location.new(:latitude => 38.898748, :longitude => -77.037684)
+        chicago = Location.new(:latitude => 41.85, :longitude => -87.65)
+        
+        FORMULAS.each do |formula|
+          assert_in_delta formula.distance(washington_dc, chicago), formula.distance(chicago, washington_dc), 0.1
+          assert_in_delta 594.820, formula.distance(washington_dc, chicago), 1.0
+          assert_in_delta 594.820, formula.distance(washington_dc, chicago, :miles), 1.0
+          assert_in_delta 957.275, formula.distance(washington_dc, chicago, :kilometers), 1.0
+        end
+      end
+      
+    end
+  end
+end

data/test/unit/graticule/geocoder_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+module Graticule
+  class GeocoderTest < Test::Unit::TestCase
+
+    def test_cannot_instantiate
+      assert_raises(NotImplementedError) { Geocoder.new }
+    end
+    
+    def test_bogus_service
+      assert_equal BogusGeocoder, Graticule.service(:bogus)
+    end
+
+    def test_yahoo_service
+      assert_equal YahooGeocoder, Graticule.service(:yahoo)
+    end
+
+    def test_google_service
+      assert_equal GoogleGeocoder, Graticule.service(:google)
+    end
+
+    def test_geocoder_us_service
+      assert_equal GeocoderUsGeocoder, Graticule.service(:geocoder_us)
+    end
+
+    def test_meta_carta_service
+      assert_equal MetaCartaGeocoder, Graticule.service(:meta_carta)
+    end
+  
+  end
+end

data/test/unit/graticule/geocoders/geocoder_us_test.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+require File.dirname(__FILE__) + '/geocoders'
+
+module Graticule
+  class GeocoderUsTest < Test::Unit::TestCase
+
+    def setup
+      URI::HTTP.responses = []
+      URI::HTTP.uris = []
+
+      @geocoder = GeocoderUsGeocoder.new
+      @location = Location.new(
+        :street => "1600 Pennsylvania Ave NW, Washington DC 20502",
+        :longitude => -77.037684,
+        :latitude => 38.898748
+      )
+    end
+
+    def test_success
+      prepare_response(:success)
+      assert_equal @location, @geocoder.locate('1600 Pennsylvania Ave, Washington DC')
+    end
+    
+    def test_url
+      prepare_response(:success)
+      @geocoder.locate('1600 Pennsylvania Ave, Washington DC')
+      assert_equal 'http://rpc.geocoder.us/service/rest/geocode?address=1600%20Pennsylvania%20Ave,%20Washington%20DC',
+                   URI::HTTP.uris.first
+    end
+
+    def test_locate_bad_address
+      prepare_response(:unknown)
+      assert_raises(AddressError) { @geocoder.locate('yuck') }
+    end
+
+  protected
+    def prepare_response(id)
+      URI::HTTP.responses << response('geocoder_us', id)
+    end
+
+  end
+end

data/test/unit/graticule/geocoders/geocoders.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+
+
+module Graticule
+  
+  # Generic tests for all geocoders (theoretically)
+  module GeocodersTestCase
+    
+    def test_success
+      return unless prepare_response(:success)
+      
+      location = Location.new(
+        :street => "1600 Amphitheatre Pkwy",
+        :city => "Mountain View",
+        :state => "CA",
+        :zip => "94043",
+        :country => "US",
+        :longitude => -122.083739,
+        :latitude => 37.423021,
+        :precision => :address
+      )
+      assert_equal location, @geocoder.locate('1600 Amphitheatre Parkway, Mountain View, CA')
+    end
+    
+    def test_bad_key
+      return unless prepare_response(:badkey)
+      assert_raises(CredentialsError) { @geocoder.locate('x') }
+    end
+    
+    def test_locate_missing_address
+      return unless prepare_response(:missing_address)
+      assert_raises(AddressError) { @geocoder.locate 'x' }
+    end
+    
+    def test_locate_server_error
+      return unless prepare_response(:server_error)
+      assert_raises(Error) { @geocoder.locate 'x' }
+    end
+
+    def test_locate_too_many_queries
+      return unless prepare_response(:limit)
+      assert_raises(CredentialsError) { @geocoder.locate 'x' }
+    end
+
+    def test_locate_unavailable_address
+      return unless prepare_response(:unavailable)
+      assert_raises(AddressError) { @geocoder.locate 'x' }
+    end
+
+    def test_locate_unknown_address
+      return unless prepare_response(:unknown_address)
+      assert_raises(AddressError) { @geocoder.locate 'x' }
+    end
+
+  end
+end

data/test/unit/graticule/geocoders/google_test.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+require File.dirname(__FILE__) + '/geocoders'
+
+module Graticule
+  class GoogleGeocoderTest < Test::Unit::TestCase
+    # run tests from GeocodersTest
+    include GeocodersTestCase
+    
+    def setup
+      URI::HTTP.responses = []
+      URI::HTTP.uris = []
+      @geocoder = GoogleGeocoder.new(:key => 'APP_ID')
+    end
+    
+    protected
+
+      def prepare_response(id = :success)
+        URI::HTTP.responses << response('google', id)
+      end
+    
+  end
+end

data/test/unit/graticule/geocoders/meta_carta_test.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+require File.dirname(__FILE__) + '/geocoders'
+
+module Graticule
+  class MetaCartaGeocoderTest < Test::Unit::TestCase
+
+    def setup
+      URI::HTTP.responses = []
+      URI::HTTP.uris = []
+
+      @geocoder = MetaCartaGeocoder.new
+    end
+
+    def test_locate
+      prepare_response(:success)
+
+      expected = MetaCartaGeocoder::Location.new 'Baghdad', 'PPLC', 5672516,
+                                                  'Iraq/Baghdad/Baghdad',
+                                                  44.393889, 33.338611, 0.195185,
+                                                  [[26.238611, 37.293889],
+                                                   [40.438611, 51.493889]]
+
+      location = @geocoder.locate('baghdad')
+      assert_equal expected, location
+      assert_equal [44.393889, 33.338611], location.coordinates
+
+      assert_equal true, URI::HTTP.responses.empty?
+      assert_equal 1, URI::HTTP.uris.length
+      assert_equal 'http://labs.metacarta.com/GeoParser/?output=locations&q=baghdad',
+                   URI::HTTP.uris.first
+    end
+
+    def test_locate_bad_address
+      prepare_response(:bad_address)
+      assert_raises(AddressError) { @geocoder.locate('aoeueou') }
+    end
+
+    def test_locations
+      prepare_response(:multiple)
+
+      expected = [
+        MetaCartaGeocoder::Location.new('Seattle', 'PPL', 563374,
+                                         'United States/Washington/King/Seattle',
+                                         -122.33083, 47.60639, nil,
+                                         [[43.806390, -126.130830],
+                                          [51.406390, -118.530830]]),
+        MetaCartaGeocoder::Location.new('Seattle', 'PRT', nil,
+                                         'United States/Seattle',
+                                         -122.333333, 47.6, nil,
+                                         [[43.8, -126.133333],
+                                          [51.4, -118.533333]]),
+      ]
+
+      locations, viewbox = @geocoder.locations('seattle')
+      assert_equal expected, locations
+      assert_equal [[43.8, -126.133333], [51.40639, -118.53083]], viewbox
+
+      assert_equal true, URI::HTTP.responses.empty?
+      assert_equal 1, URI::HTTP.uris.length
+      assert_equal 'http://labs.metacarta.com/GeoParser/?loc=seattle&output=locations',
+                   URI::HTTP.uris.first
+    end
+
+  protected
+    def prepare_response(id = :success)
+      URI::HTTP.responses << response('meta_carta', id)
+    end
+
+  end
+end

data/test/unit/graticule/geocoders/yahoo_test.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+require File.dirname(__FILE__) + '/geocoders'
+
+module Graticule
+  class YahooGeocoderTest < Test::Unit::TestCase
+    #include GeocodersTestCase
+
+    def setup
+      URI::HTTP.responses = []
+      URI::HTTP.uris = []
+      @geocoder = YahooGeocoder.new 'APP_ID'
+      @location = Location.new(
+        :street => "701 First Ave",
+        :city => "Sunnyvale",
+        :state => "CA",
+        :zip => "94089-1019",
+        :country => "US",
+        :longitude => -122.024853,
+        :latitude => 37.416384,
+        :precision => :address
+      )
+    end
+
+  def test_locate
+    prepare_response(:success)
+    assert_equal [@location], @geocoder.locate('701 First Street, Sunnyvale, CA')
+  end
+  
+  def test_url
+    prepare_response(:success)
+    @geocoder.locate('701 First Street, Sunnyvale, CA')
+    assert_equal 'http://api.local.yahoo.com/MapsService/V1/geocode?appid=APP_ID&location=701%20First%20Street,%20Sunnyvale,%20CA&output=xml',
+                 URI::HTTP.uris.first
+  end
+  
+
+  def test_locate_bad_address
+    prepare_response(:unknown_address)
+    assert_raise(Error) { @geocoder.locate('yucksthoeusthaoeusnhtaosu') }
+  end
+
+  protected
+    def prepare_response(id)
+      URI::HTTP.responses << response('yahoo', id)
+    end
+  
+  end
+
+end