graticule 0.2.6 → 0.2.7

data/CHANGELOG.txt

@@ -1,3 +1,11 @@
+0.2.7 (2008-10-03)
+* Adding Multimap geocoder [Tom Taylor]
+* Added MapQuest geocoder [Andrew Selder]
+* Fix google geocoder for responses that only return coordinates [Andrew Selder]
+
+0.2.5
+* fixed address mapping for local search maps (again)
+
 0.2.4 (2007-05-15)
 * fixed address mapping for local search maps (Tom Taylor)
 

data/Manifest.txt

@@ -19,6 +19,7 @@ lib/graticule/geocoder/geocoder_us.rb
 lib/graticule/geocoder/google.rb
 lib/graticule/geocoder/host_ip.rb
 lib/graticule/geocoder/local_search_maps.rb
+lib/graticule/geocoder/map_quest.rb
 lib/graticule/geocoder/meta_carta.rb
 lib/graticule/geocoder/multi.rb
 lib/graticule/geocoder/postcode_anywhere.rb
@@ -35,6 +36,7 @@ test/fixtures/responses/geocoder_us/unknown.xml
 test/fixtures/responses/google/badkey.xml
 test/fixtures/responses/google/limit.xml
 test/fixtures/responses/google/missing_address.xml
+test/fixtures/responses/google/only_coordinates.xml
 test/fixtures/responses/google/partial.xml
 test/fixtures/responses/google/server_error.xml
 test/fixtures/responses/google/success.xml
@@ -69,4 +71,3 @@ test/unit/graticule/geocoder/postcode_anywhere_test.rb
 test/unit/graticule/geocoder/yahoo_test.rb
 test/unit/graticule/geocoder_test.rb
 test/unit/graticule/location_test.rb
-

data/lib/graticule.rb

@@ -10,6 +10,7 @@ require 'graticule/geocoder/bogus'
 require 'graticule/geocoder/rest'
 require 'graticule/geocoder/google'
 require 'graticule/geocoder/host_ip'
+require 'graticule/geocoder/map_quest'
 require 'graticule/geocoder/multi'
 require 'graticule/geocoder/yahoo'
 require 'graticule/geocoder/geocoder_ca'
@@ -17,6 +18,7 @@ require 'graticule/geocoder/geocoder_us'
 require 'graticule/geocoder/local_search_maps'
 require 'graticule/geocoder/meta_carta'
 require 'graticule/geocoder/postcode_anywhere'
+require 'graticule/geocoder/multimap'
 require 'graticule/distance'
 require 'graticule/distance/haversine'
 require 'graticule/distance/spherical'

data/lib/graticule/geocoder/geocoder_ca.rb

@@ -13,6 +13,8 @@ module Graticule #:nodoc:
         get :locate => address.is_a?(String) ? address : location_from_params(address).to_s(:country => false)
       end
       
+    private
+      
       def parse_response(xml) #:nodoc:
         returning Location.new do |location|
           location.latitude = xml.elements['geodata/latt'].text.to_f

data/lib/graticule/geocoder/geocoder_us.rb

@@ -27,6 +27,8 @@ module Graticule #:nodoc:
       def locate(address)
         get :address => address.is_a?(String) ? address : location_from_params(address).to_s(:country => false)
       end
+      
+    private
 
       def parse_response(xml) #:nodoc:
         location = Location.new

data/lib/graticule/geocoder/google.rb

@@ -5,15 +5,11 @@ module Graticule #:nodoc:
     # First you need a Google Maps API key.  You can register for one here:
     # http://www.google.com/apis/maps/signup.html
     # 
-    # Then you create a GoogleGeocode object and start locating addresses:
-    # 
-    #   require 'rubygems'
-    #   require 'graticule'
-    # 
-    #   gg = Graticule.service(:google).new(:key => MAPS_API_KEY)
+    #   gg = Graticule.service(:google).new(MAPS_API_KEY)
     #   location = gg.locate '1600 Amphitheater Pkwy, Mountain View, CA'
     #   p location.coordinates
-    # 
+    #   #=> [37.423111, -122.081783
+    #
     class Google < Rest
       # http://www.google.com/apis/maps/documentation/#Geocoding_HTTP_Request
     
@@ -30,10 +26,7 @@ module Graticule #:nodoc:
         8 => :address       # Address level accuracy. (Since 2.59)
       }
 
-      # Creates a new GoogleGeocode that will use Google Maps API key +key+.  You
-      # can sign up for an API key here:
-      #
-      # http://www.google.com/apis/maps/signup.html
+      # Creates a new GoogleGeocode that will use Google Maps API +key+.
       def initialize(key)
         @key = key
         @url = URI.parse 'http://maps.google.com/maps/geo'
@@ -44,21 +37,24 @@ module Graticule #:nodoc:
         get :q => address.is_a?(String) ? address : location_from_params(address).to_s
       end
 
+    private
+
       # Extracts a Location from +xml+.
       def parse_response(xml) #:nodoc:
-        address = REXML::XPath.first(xml, '//xal:AddressDetails', 'xal' => "urn:oasis:names:tc:ciq:xsdschema:xAL:2.0")
-
         longitude, latitude, = xml.elements['/kml/Response/Placemark/Point/coordinates'].text.split(',').map { |v| v.to_f }
-      
-        Location.new \
-          :street => value(address.elements['//ThoroughfareName/text()']),
-          :locality => value(address.elements['//LocalityName/text()']),
-          :region => value(address.elements['//AdministrativeAreaName/text()']),
-          :postal_code => value(address.elements['//PostalCodeNumber/text()']),
-          :country => value(address.elements['//CountryNameCode/text()']),
-          :latitude => latitude,
-          :longitude => longitude,
-          :precision => PRECISION[address.attribute('Accuracy').value.to_i] || :unknown
+        returning Location.new(:latitude => latitude, :longitude => longitude) do |l|
+          address = REXML::XPath.first(xml, '//xal:AddressDetails',
+            'xal' => "urn:oasis:names:tc:ciq:xsdschema:xAL:2.0")
+
+          if address
+            l.street = value(address.elements['//ThoroughfareName/text()'])
+            l.locality = value(address.elements['//LocalityName/text()'])
+            l.region = value(address.elements['//AdministrativeAreaName/text()'])
+            l.postal_code = value(address.elements['//PostalCodeNumber/text()'])
+            l.country = value(address.elements['//CountryNameCode/text()'])
+            l.precision = PRECISION[address.attribute('Accuracy').value.to_i] || :unknown
+          end
+        end
       end
 
       # Extracts and raises an error from +xml+, if any.
@@ -92,15 +88,13 @@ module Graticule #:nodoc:
         super params
       end
     
-      private
-    
-        def value(element)
-          element.value if element
-        end
-    
-        def text(element)
-          element.text if element
-        end
+      def value(element)
+        element.value if element
+      end
+  
+      def text(element)
+        element.text if element
+      end
     end
   end
 end

data/lib/graticule/geocoder/local_search_maps.rb

@@ -20,7 +20,7 @@ module Graticule #:nodoc:
     private
     
       def map_attributes(location)
-        mapping = {:street => :address, :locality => :city, :region => :state, :postal_code => :zip, :country => :country}
+        mapping = {:street => :street, :locality => :city, :region => :state, :postal_code => :zip, :country => :country}
         mapping.keys.inject({}) do |result,attribute|
           result[mapping[attribute]] = location.attributes[attribute] unless location.attributes[attribute].blank?
           result

data/lib/graticule/geocoder/map_quest.rb

@@ -0,0 +1,109 @@
+module Graticule #:nodoc:
+  module Geocoder #:nodoc:
+
+    # First you need a Mapquest API key.  You can register for one here:
+    # http://www.mapquest.com/features/main.adp?page=developer_tools_oapi
+    #
+    # Then you create a MapquestGeocode object and start locating addresses:
+    #
+    #   gg = Graticule.service(:map_quest).new(MAPS_API_KEY)
+    #   location = gg.locate :street => '1600 Amphitheater Pkwy', :locality => 'Mountain View', :region => 'CA'
+    #   p location.coordinates
+    #
+    class MapQuest < Rest
+      # http://trc.mapquest.com
+
+      PRECISION = {
+        0 => :unknown,
+        'COUNTRY' => :country,
+        'STATE' => :state,
+        'COUNTY' => :state,
+        'CITY' => :city,
+        'ZIP' => :zip,'ZIP7' => :zip,'ZIP9' => :zip,
+        'INTERSECTIONS' => :street,
+        'STREET' => :street,
+        'ADDRESS' => :address
+      }
+
+      # Creates a new MapquestGeocode that will use Mapquest API key +key+.
+      #
+      # WARNING: The MapQuest API Keys tend to be already URI encoded. If this is the case
+      # be sure to URI.unescape the key in the call to new
+      def initialize(key)
+        @key = key
+        @url = URI.parse 'http://web.openapi.mapquest.com/oapi/transaction'
+      end
+
+      # Locates +address+ returning a Location
+      def locate(address)
+        get map_attributes(location_from_params(address))
+      end
+
+    private
+
+      def map_attributes(location)
+        mapping = {:street => :address, :locality => :city, :region => :stateProvince, :postal_code => :postalcoe, :country => :country}
+        mapping.keys.inject({}) do |result,attribute|
+          result[mapping[attribute]] = location.attributes[attribute] unless location.attributes[attribute].blank?
+          result
+        end
+      end
+      
+      # Extracts a Location from +xml+.
+      def parse_response(xml) #:nodoc:
+        address = REXML::XPath.first(xml, '/advantage/geocode/locations/location')
+
+        Location.new \
+        :street => value(address.elements['//address/text()']),
+        :locality => value(address.elements['//city/text()']),
+        :region => value(address.elements['//stateProvince/text()']),
+        :postal_code => value(address.elements['//postalCode/text()']),
+        :country => value(address.elements['//country/text()']),
+        :latitude => value(address.elements['//latitude/text()']),
+        :longitude => value(address.elements['//longitude/text()']),
+        :precision => PRECISION[address.elements['//geocodeQuality'].text] || :unknown
+      end
+
+      # Extracts and raises an error from +xml+, if any.
+      def check_error(xml) #:nodoc:
+        return unless xml.elements['//error']
+        status = xml.elements['//error/code'].text.to_i
+        msg = xml.elements['//error/text'].text
+        case status
+        when 255..299 then
+          raise CredentialsError, msg
+        when 400..500 then
+          raise AddressError, msg
+        when 600.699 then
+          raise Error, msg
+        when 900 then
+          raise AddressError, 'invalid latitude'
+        when 901 then
+          raise AddressError, 'invalid longitude'
+        when 902 then
+          raise AddressError, 'error parsing params'
+        when 9902 then
+          raise CredentialsError, 'invalid key'
+        when 9904 then
+          raise CredentialsError, 'key missing'
+        else
+          raise Error, "unknown error #{status}: #{msg}"
+        end
+      end
+
+      # Creates a URL from the Hash +params+.  Automatically adds the key and
+      # sets the output type to 'xml'.
+      def make_url(params) #:nodoc:
+        super params.merge({:key => @key, :transaction => 'geocode', :ambiguities => 0})
+      end
+
+      def value(element)
+        element.value if element
+      end
+
+      def text(element)
+        element.text if element
+      end
+    end
+  end
+end

data/lib/graticule/version.rb

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

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

@@ -0,0 +1 @@
+<?xml version='1.0' encoding='UTF-8'?><kml xmlns='http://earth.google.com/kml/2.0'><Response><name>15-17 </name><Status><code>200</code><request>geocode</request></Status><Placemark id='p1'><Point><coordinates>-17.000000,15.000000,0</coordinates></Point></Placemark></Response></kml>

data/test/test_helper.rb

@@ -1,12 +1,9 @@
-#!/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'
 require 'mocha'
 

data/test/unit/graticule/distance_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 module Graticule
   module Distance

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

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 module Graticule
   module Geocoder

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

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 module Graticule
   module Geocoder
@@ -25,6 +25,16 @@ module Graticule
         assert_equal location, @geocoder.locate('1600 Amphitheatre Parkway, Mountain View, CA')
       end
       
+        # <?xml version='1.0' encoding='UTF-8'?><kml xmlns='http://earth.google.com/kml/2.0'><Response><name>15-17 </name><Status><code>200</code><request>geocode</request></Status><Placemark id='p1'><Point><coordinates>-17.000000,15.000000,0</coordinates></Point></Placemark></Response></kml>
+        def test_only_coordinates
+          return unless prepare_response(:only_coordinates)
+
+          location = Location.new(:longitude => -17.000000, :latitude => 15.000000)
+          assert_equal location, @geocoder.locate('15-17 & 16 Railroad Square, Nashua, NH, 03064')
+        end
+        
+
+
       def test_partial
         return unless prepare_response(:partial)
         

data/test/unit/graticule/geocoder/host_ip_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 module Graticule
   module Geocoder

data/test/unit/graticule/geocoder/local_search_maps_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 module Graticule
   module Geocoder

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

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 module Graticule
   module Geocoder

data/test/unit/graticule/geocoder/multi_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 module Graticule
   module Geocoder
@@ -7,7 +7,7 @@ module Graticule
       def setup
         @mock_geocoders = [mock("geocoder 1"), mock("geocoder 2")]
         @mock_geocoders.each {|g| g.stubs(:locate) }
-        @geocoder = Multi.new *@mock_geocoders
+        @geocoder = Multi.new(*@mock_geocoders)
       end
 
       def test_locate_calls_each_geocoder_and_raises_error

data/test/unit/graticule/geocoder/multimap_test.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+module Graticule
+  module Geocoder
+    class MultimapTest < Test::Unit::TestCase
+
+      def setup
+        URI::HTTP.responses = []
+        URI::HTTP.uris = []
+        @geocoder = Multimap.new 'API_KEY'
+        @location = Location.new(
+          :street => "Oxford Street",
+          :locality => "London",
+          :region => "London",
+          :postal_code => "W1",
+          :country => "GB",
+          :longitude => -0.14839,
+          :latitude => 51.51452,
+          :precision => :address
+        )
+      end
+
+    def test_locate
+      prepare_response(:success)
+      assert_equal @location, @geocoder.locate('Oxford Street, LONDON, W1')
+    end
+
+    def test_url_from_string
+      prepare_response(:success)
+      @geocoder.locate('Oxford Street, LONDON, W1')
+      assert_equal 'http://clients.multimap.com/API/geocode/1.2/API_KEY?qs=Oxford%20Street,%20LONDON,%20W1', URI::HTTP.uris.first
+    end
+    
+    def test_url_from_location
+      prepare_response(:success)
+      @geocoder.locate(:street => 'Oxford Street', :city => 'London')
+      assert_equal 'http://clients.multimap.com/API/geocode/1.2/API_KEY?city=&countryCode=&postalCode=&region=&street=Oxford%20Street', URI::HTTP.uris.first
+    end
+
+
+    def test_locate_bad_address
+      prepare_response(:no_matches)
+      assert_raise(Error) { @geocoder.locate('yucksthoeusthaoeusnhtaosu') }
+    end
+
+    protected
+      def prepare_response(id)
+        URI::HTTP.responses << response('multimap', id)
+      end
+
+    end
+  end
+end

data/test/unit/graticule/geocoder/postcode_anywhere_test.rb

@@ -1,6 +1,6 @@
 # account code: INDIV30777
 # license key: KG39-HM17-PZ95-NR98
-require File.dirname(__FILE__) + '/../../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 module Graticule
   module Geocoder

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

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 module Graticule
   module Geocoder

data/test/unit/graticule/geocoder_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 module Graticule
   class GeocoderTest < Test::Unit::TestCase

data/test/unit/graticule/location_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../test_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 
 module Graticule
   class LocationTest < Test::Unit::TestCase

metadata

@@ -1,33 +1,54 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: graticule
 version: !ruby/object:Gem::Version 
-  version: 0.2.6
-date: 2007-09-12 00:00:00 -04:00
-summary: API for using all the popular geocoding services.
-require_paths: 
-- lib
-email: brandon@opensoul.org
-homepage: http://graticule.rubyforge.org
-rubyforge_project: graticule
-description: Graticule is a geocoding API that provides a common interface to all the popular services, including Google, Yahoo, Geocoder.us, and MetaCarta.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.2.7
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Brandon Keepers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-03 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: Graticule is a geocoding API that provides a common interface to all the popular services, including Google, Yahoo, Geocoder.us, and MetaCarta.
+email: brandon@opensoul.org
+executables: 
+- geocode
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- test/fixtures/responses/host_ip/private.txt
+- test/fixtures/responses/host_ip/success.txt
+- test/fixtures/responses/host_ip/unknown.txt
+- test/fixtures/responses/local_search_maps/empty.txt
+- test/fixtures/responses/local_search_maps/not_found.txt
+- test/fixtures/responses/local_search_maps/success.txt
 files: 
 - CHANGELOG.txt
 - LICENSE.txt
@@ -50,6 +71,7 @@ files:
 - lib/graticule/geocoder/google.rb
 - lib/graticule/geocoder/host_ip.rb
 - lib/graticule/geocoder/local_search_maps.rb
+- lib/graticule/geocoder/map_quest.rb
 - lib/graticule/geocoder/meta_carta.rb
 - lib/graticule/geocoder/multi.rb
 - lib/graticule/geocoder/postcode_anywhere.rb
@@ -66,6 +88,7 @@ files:
 - test/fixtures/responses/google/badkey.xml
 - test/fixtures/responses/google/limit.xml
 - test/fixtures/responses/google/missing_address.xml
+- test/fixtures/responses/google/only_coordinates.xml
 - test/fixtures/responses/google/partial.xml
 - test/fixtures/responses/google/server_error.xml
 - test/fixtures/responses/google/success.xml
@@ -100,6 +123,33 @@ files:
 - test/unit/graticule/geocoder/yahoo_test.rb
 - test/unit/graticule/geocoder_test.rb
 - test/unit/graticule/location_test.rb
+has_rdoc: true
+homepage: http://graticule.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: graticule
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: API for using all the popular geocoding services.
 test_files: 
 - test/unit/graticule/distance_test.rb
 - test/unit/graticule/geocoder/geocoder_us_test.rb
@@ -108,46 +158,8 @@ test_files:
 - test/unit/graticule/geocoder/local_search_maps_test.rb
 - test/unit/graticule/geocoder/meta_carta_test.rb
 - test/unit/graticule/geocoder/multi_test.rb
+- test/unit/graticule/geocoder/multimap_test.rb
 - test/unit/graticule/geocoder/postcode_anywhere_test.rb
 - test/unit/graticule/geocoder/yahoo_test.rb
 - test/unit/graticule/geocoder_test.rb
 - test/unit/graticule/location_test.rb
-rdoc_options: 
-- --main
-- README.txt
-extra_rdoc_files: 
-- CHANGELOG.txt
-- LICENSE.txt
-- Manifest.txt
-- README.txt
-- test/fixtures/responses/host_ip/private.txt
-- test/fixtures/responses/host_ip/success.txt
-- test/fixtures/responses/host_ip/unknown.txt
-- test/fixtures/responses/local_search_maps/empty.txt
-- test/fixtures/responses/local_search_maps/not_found.txt
-- test/fixtures/responses/local_search_maps/success.txt
-executables: 
-- geocode
-extensions: []
-
-requirements: []
-
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.3.0
-    version: