GUI-graticule 0.2.7.2 → 0.2.7.3

data/Manifest.txt

@@ -26,6 +26,8 @@ lib/graticule/geocoder/postcode_anywhere.rb
 lib/graticule/geocoder/rest.rb
 lib/graticule/geocoder/yahoo.rb
 lib/graticule/location.rb
+lib/graticule/locations.rb
+lib/graticule/precision.rb
 lib/graticule/version.rb
 site/index.html
 site/plugin.html
@@ -36,6 +38,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/multiple.xml
 test/fixtures/responses/google/only_coordinates.xml
 test/fixtures/responses/google/partial.xml
 test/fixtures/responses/google/server_error.xml
@@ -56,12 +59,14 @@ test/fixtures/responses/postcode_anywhere/canada.xml
 test/fixtures/responses/postcode_anywhere/empty.xml
 test/fixtures/responses/postcode_anywhere/success.xml
 test/fixtures/responses/postcode_anywhere/uk.xml
+test/fixtures/responses/yahoo/multiple.xml
 test/fixtures/responses/yahoo/success.xml
 test/fixtures/responses/yahoo/unknown_address.xml
 test/mocks/uri.rb
 test/test_helper.rb
 test/unit/graticule/distance_test.rb
 test/unit/graticule/geocoder/geocoder_us_test.rb
+test/unit/graticule/geocoder/geocoders.rb
 test/unit/graticule/geocoder/google_test.rb
 test/unit/graticule/geocoder/host_ip_test.rb
 test/unit/graticule/geocoder/local_search_maps_test.rb

data/lib/graticule/locations.rb

@@ -0,0 +1,108 @@
+require "english/levenshtein"
+
+module Graticule
+  class Locations < Array
+    attr :options
+
+    def best_match(options, &comparator)
+      @options = options
+      comparator ||= default_comparator
+
+      max(&comparator)
+    end
+
+    private
+
+    def default_comparator
+      Proc.new do |a, b|
+        compare = 0
+
+        # If an original location object was passed in, compare our results to
+        # that in an attempt to find the best match. 
+        if(options[:original])
+          # Always prefer the result matches our original country.
+          unless(options[:original].country.blank?)
+            if(a.normalized_country == options[:original].normalized_country)
+              if(b.normalized_country != options[:original].normalized_country)
+                compare = 1
+              end
+            else
+              if(b.normalized_country == options[:original].normalized_country)
+                compare = -1 
+              end
+            end
+          end
+
+          # If one of the results has come up with a result outside the
+          # starting state, it's probably wrong, so we'll always prefer the
+          # other result.
+          if(compare == 0)
+            unless(options[:original].region.blank?)
+              if(a.normalized_region == options[:original].normalized_region)
+                if(b.normalized_region != options[:original].normalized_region)
+                  compare = 1
+                end
+              else
+                if(b.normalized_region == options[:original].normalized_region)
+                  compare = -1
+                end
+              end
+            end
+          end
+
+          # If the states match, then we'll try to find the best match based on
+          # the rest of the data. Since the rest of the items are subject to
+          # minor changes that might not be bad (more specific city,
+          # alternately named street address, etc), we'll perform some voodoo
+          # to see which result is most similar to our original address. We're
+          # basically checking which result has the fewest character changes
+          # within the strings.
+          if(compare == 0)
+            # Come up with the character distance for the normalized addresses
+            # for each location we're comparing to the original location.
+            distance = {}
+            { :a => a, :b => b }.each do |key, obj|
+              distance[key] = 0
+
+              unless(options[:original].locality.blank?)
+                distance[key] += English::Levenshtein.distance(options[:original].normalized_locality, obj.normalized_locality)
+              end
+
+              unless(options[:original].street.blank?)
+                street = if(obj.normalized_street.blank?) then obj.normalized_premise else obj.normalized_street end
+                distance[key] += English::Levenshtein.distance(options[:original].normalized_street, street)
+              end
+
+              unless(options[:original].postal_code.blank?)
+                distance[key] += English::Levenshtein.distance(options[:original].postal_code_base, obj.postal_code_base)
+              end
+            end
+
+            # Pick the object whose normalized address is the most similar
+            # character-wise to the original address.
+            if(distance[:a] < distance[:b])
+              compare = 1
+            elsif(distance[:a] > distance[:b])
+              compare = -1
+            end
+          end
+        end
+
+        # If things are still equal at this point, we'll then prefer the result
+        # with the higher precision.
+        if(compare == 0) 
+          compare = a.precision <=> b.precision
+        end
+
+        # And if we still don't have a verdict, we'll use the result of which
+        # ever geocoder we prefer (in our case, Google, since that's what our
+        # maps will be shown on).
+        if(compare == 0)
+          compare = a.geocoder <=> b.geocoder
+        end
+
+        compare
+      end
+    end
+  end
+end

data/lib/graticule/precision.rb

@@ -0,0 +1,52 @@
+module Graticule
+  class Precision
+    include Comparable
+
+    attr_reader :order, :name
+
+    def initialize(order, name)
+      @order = order
+      @name = name
+    end
+
+    def <=>(other)
+      order <=> other.order
+    end
+
+    def to_s
+      @name
+    end
+
+    def self.unknown
+      @@unknown ||= Precision.new(0, "unknown")
+    end
+
+    def self.country
+      @@country ||= Precision.new(1, "country")
+    end
+
+    def self.state
+      @@state ||= Precision.new(2, "state")
+    end
+
+    def self.city
+      @@city ||= Precision.new(3, "city")
+    end
+
+    def self.zip
+      @@zip ||= Precision.new(4, "zip")
+    end
+
+    def self.street
+      @@street ||= Precision.new(5, "street")
+    end
+
+    def self.address
+      @@address ||= Precision.new(6, "address")
+    end
+
+    def self.premise
+      @@premise ||= Precision.new(7, "premise")
+    end
+  end
+end

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

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><kml xmlns="http://earth.google.com/kml/2.0"><Response><name>gardiner</name><Status><code>200</code><request>geocode</request></Status><Placemark id="p1"><address>Gardiner, ME, USA</address><AddressDetails Accuracy="4" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>US</CountryNameCode><AdministrativeArea><AdministrativeAreaName>ME</AdministrativeAreaName><Locality><LocalityName>Gardiner</LocalityName></Locality></AdministrativeArea></Country></AddressDetails><Point><coordinates>-69.802949,44.198024,0</coordinates></Point></Placemark><Placemark id="p2"><address>Gardiner, NY, USA</address><AddressDetails Accuracy="4" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>US</CountryNameCode><AdministrativeArea><AdministrativeAreaName>NY</AdministrativeAreaName><Locality><LocalityName>Gardiner</LocalityName></Locality></AdministrativeArea></Country></AddressDetails><Point><coordinates>-74.150462,41.679737,0</coordinates></Point></Placemark><Placemark id="p3"><address>Gardiner, Mt, USA</address><AddressDetails Accuracy="4" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>US</CountryNameCode><AdministrativeArea><AdministrativeAreaName>Mt</AdministrativeAreaName><Locality><LocalityName>Gardiner</LocalityName></Locality></AdministrativeArea></Country></AddressDetails><Point><coordinates>-110.705881,45.031672,0</coordinates></Point></Placemark><Placemark id="p4"><address>Gardiner, ME, USA</address><AddressDetails Accuracy="4" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>US</CountryNameCode><AdministrativeArea><AdministrativeAreaName>ME</AdministrativeAreaName><SubAdministrativeArea><SubAdministrativeAreaName>Kennebec</SubAdministrativeAreaName><Locality><LocalityName>Gardiner</LocalityName></Locality></SubAdministrativeArea></AdministrativeArea></Country></AddressDetails><Point><coordinates>-69.803716,44.195982,0</coordinates></Point></Placemark><Placemark id="p5"><address>Gardiner, NY, USA</address><AddressDetails Accuracy="4" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>US</CountryNameCode><AdministrativeArea><AdministrativeAreaName>NY</AdministrativeAreaName><SubAdministrativeArea><SubAdministrativeAreaName>Ulster</SubAdministrativeAreaName><Locality><LocalityName>Gardiner</LocalityName></Locality></SubAdministrativeArea></AdministrativeArea></Country></AddressDetails><Point><coordinates>-74.150462,41.679737,0</coordinates></Point></Placemark></Response></kml>

data/test/fixtures/responses/yahoo/multiple.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="zip"><Latitude>44.229180</Latitude><Longitude>-69.774749</Longitude><Address></Address><City>Gardiner</City><State>ME</State><Zip></Zip><Country>US</Country></Result><Result precision="zip"><Latitude>45.032793</Latitude><Longitude>-110.705543</Longitude><Address></Address><City>Gardiner</City><State>MT</State><Zip></Zip><Country>US</Country></Result><Result precision="zip"><Latitude>41.679944</Latitude><Longitude>-74.151021</Longitude><Address></Address><City>Gardiner</City><State>NY</State><Zip></Zip><Country>US</Country></Result><Result precision="zip"><Latitude>43.729115</Latitude><Longitude>-124.111529</Longitude><Address></Address><City>Gardiner</City><State>OR</State><Zip></Zip><Country>US</Country></Result></ResultSet>
+<!-- ws03.search.scd.yahoo.com uncompressed/chunked Thu Jun  5 14:53:30 PDT 2008 -->

data/test/unit/graticule/geocoder/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: GUI-graticule
 version: !ruby/object:Gem::Version 
-  version: 0.2.7.2
+  version: 0.2.7.3
 platform: ruby
 authors: 
 - Brandon Keepers
@@ -72,6 +72,8 @@ files:
 - lib/graticule/geocoder/rest.rb
 - lib/graticule/geocoder/yahoo.rb
 - lib/graticule/location.rb
+- lib/graticule/locations.rb
+- lib/graticule/precision.rb
 - lib/graticule/version.rb
 - site/index.html
 - site/plugin.html
@@ -82,6 +84,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/multiple.xml
 - test/fixtures/responses/google/only_coordinates.xml
 - test/fixtures/responses/google/partial.xml
 - test/fixtures/responses/google/server_error.xml
@@ -102,12 +105,14 @@ files:
 - test/fixtures/responses/postcode_anywhere/empty.xml
 - test/fixtures/responses/postcode_anywhere/success.xml
 - test/fixtures/responses/postcode_anywhere/uk.xml
+- test/fixtures/responses/yahoo/multiple.xml
 - test/fixtures/responses/yahoo/success.xml
 - test/fixtures/responses/yahoo/unknown_address.xml
 - test/mocks/uri.rb
 - test/test_helper.rb
 - test/unit/graticule/distance_test.rb
 - test/unit/graticule/geocoder/geocoder_us_test.rb
+- test/unit/graticule/geocoder/geocoders.rb
 - test/unit/graticule/geocoder/google_test.rb
 - test/unit/graticule/geocoder/host_ip_test.rb
 - test/unit/graticule/geocoder/local_search_maps_test.rb