graticule 1.0.0.pre → 1.0.0.pre2

data/.gitignore

@@ -2,4 +2,5 @@ test/config.yml
 *.gem
 pkg
 coverage
-rdoc
+rdoc
+.DS_Store

data/VERSION

@@ -1 +1 @@
-1.0.0.pre
+1.0.0.pre2

data/graticule.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{graticule}
-  s.version = "1.0.0.pre"
+  s.version = "1.0.0.pre2"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brandon Keepers"]
-  s.date = %q{2009-12-05}
+  s.date = %q{2010-02-04}
   s.default_executable = %q{geocode}
   s.description = %q{Graticule is a geocoding API that provides a common interface to all the popular services, including Google, Yahoo, Geocoder.us, and MetaCarta.}
   s.email = %q{brandon@opensoul.org}
@@ -50,6 +50,7 @@ Gem::Specification.new do |s|
      "lib/graticule/geocoder/multimap.rb",
      "lib/graticule/geocoder/yahoo.rb",
      "lib/graticule/location.rb",
+     "lib/graticule/precision.rb",
      "site/index.html",
      "site/plugin.html",
      "site/stylesheets/style.css",
@@ -100,6 +101,7 @@ Gem::Specification.new do |s|
      "test/graticule/geocoder/yahoo_test.rb",
      "test/graticule/geocoder_test.rb",
      "test/graticule/location_test.rb",
+     "test/graticule/precision_test.rb",
      "test/mocks/uri.rb",
      "test/test_helper.rb"
   ]
@@ -172,6 +174,7 @@ Gem::Specification.new do |s|
      "test/graticule/geocoder/yahoo_test.rb",
      "test/graticule/geocoder_test.rb",
      "test/graticule/location_test.rb",
+     "test/graticule/precision_test.rb",
      "test/mocks",
      "test/mocks/uri.rb",
      "test/test_helper.rb"

data/lib/graticule.rb

@@ -4,6 +4,7 @@ require 'active_support'
 
 require 'graticule/core_ext'
 require 'graticule/location'
+require 'graticule/precision'
 require 'graticule/geocoder'
 require 'graticule/geocoder/base'
 require 'graticule/geocoder/bogus'

data/lib/graticule/geocoder/google.rb

@@ -14,16 +14,16 @@ module Graticule #:nodoc:
     
       # http://www.google.com/apis/maps/documentation/reference.html#GGeoAddressAccuracy
       PRECISION = {
-        0 => :unknown,      # Unknown location.
-        1 => :country,      # Country level accuracy.
-        2 => :region,       # Region (state, province, prefecture, etc.) level accuracy.
-        3 => :region,       # Sub-region (county, municipality, etc.) level accuracy.
-        4 => :locality,     # Town (city, village) level accuracy.
-        5 => :postal_code,  # Post code (zip code) level accuracy.
-        6 => :street,       # Street level accuracy.
-        7 => :street,       # Intersection level accuracy.
-        8 => :address,      # Address level accuracy.
-        9 => :premise       # Premise (building name, property name, shopping center, etc.) level accuracy.
+        0 => Precision::Unknown,      # Unknown location.
+        1 => Precision::Country,      # Country level accuracy.
+        2 => Precision::Region,       # Region (state, province, prefecture, etc.) level accuracy.
+        3 => Precision::Region,       # Sub-region (county, municipality, etc.) level accuracy.
+        4 => Precision::Locality,     # Town (city, village) level accuracy.
+        5 => Precision::PostalCode,   # Post code (zip code) level accuracy.
+        6 => Precision::Street,       # Street level accuracy.
+        7 => Precision::Street,       # Intersection level accuracy.
+        8 => Precision::Address,      # Address level accuracy.
+        9 => Precision::Premise       # Premise (building name, property name, shopping center, etc.) level accuracy.
       }
 
       def initialize(key)

data/lib/graticule/geocoder/mapquest.rb

@@ -13,19 +13,19 @@ module Graticule #:nodoc:
       # I would link to the documentation here, but there is none that will do anything but confuse you.
 
       PRECISION = {
-        'L1' => :address,
-        'I1' => :street,
-        'B1' => :street,
-        'B2' => :street,
-        'B3' => :street,
-        'Z3' => :postal_code,
-        'Z4' => :postal_code,
-        'Z2' => :postal_code,
-        'Z1' => :postal_code,
-        'A5' => :locality,
-        'A4' => :region,
-        'A3' => :region,
-        'A1' => :country
+        'L1' => Precision::Address,
+        'I1' => Precision::Street,
+        'B1' => Precision::Street,
+        'B2' => Precision::Street,
+        'B3' => Precision::Street,
+        'Z3' => Precision::PostalCode,
+        'Z4' => Precision::PostalCode,
+        'Z2' => Precision::PostalCode,
+        'Z1' => Precision::PostalCode,
+        'A5' => Precision::Locality,
+        'A4' => Precision::Region,
+        'A3' => Precision::Region,
+        'A1' => Precision::Country
       }
 
       def initialize(client_id, password)

data/lib/graticule/geocoder/multi.rb

@@ -45,12 +45,9 @@ module Graticule #:nodoc:
                 result = geocoder.locate address
               end
               result if @acceptable.call(result)
-            rescue Error => e
+            rescue => e
               last_error = e
               nil
-            rescue Errno::ECONNREFUSED
-              logger.error("Connection refused to #{service}")
-              nil
             end
           end
         end

data/lib/graticule/geocoder/multimap.rb

@@ -10,12 +10,12 @@ module Graticule #:nodoc:
       # http://www.multimap.com/share/documentation/clientzone/gqcodes.htm
       
       PRECISION = {
-        6 => :country,
-        5 => :state,
-        4 => :postal_code,
-        3 => :locality,
-        2 => :street,
-        1 => :address
+        6 => Precision::Country,
+        5 => Precision::Region,
+        4 => Precision::PostalCode,
+        3 => Precision::Locality,
+        2 => Precision::Street,
+        1 => Precision::Address
       }
       
       # Web services initializer.
@@ -40,7 +40,7 @@ module Graticule #:nodoc:
         when Location
           get "street" => location.street, 
               "region" => location.region, 
-              "city" => location.city, 
+              "city" => location.locality, 
               "postalCode" => location.postal_code, 
               "countryCode" => location.country
         end

data/lib/graticule/geocoder/yahoo.rb

@@ -7,14 +7,14 @@ module Graticule #:nodoc:
     class Yahoo < Base
 
       PRECISION = {
-        "country" => :country,
-        "state"   => :region,
-        "city"    => :locality,
-        "zip+4"   => :postal_code,
-        "zip+2"   => :postal_code,
-        "zip"     => :postal_code,
-        "street"  => :street,
-        "address" => :address
+        "country" => Precision::Country,
+        "state"   => Precision::Region,
+        "city"    => Precision::Locality,
+        "zip+4"   => Precision::PostalCode,
+        "zip+2"   => Precision::PostalCode,
+        "zip"     => Precision::PostalCode,
+        "street"  => Precision::Street,
+        "address" => Precision::Address
       }
 
       # Web services initializer.

data/lib/graticule/location.rb

@@ -9,11 +9,15 @@ module Graticule
     
     def initialize(attrs = {})
       attrs.each do |key,value|
-        instance_variable_set "@#{key}", value
+        self.send("#{key}=", value)
       end
       self.precision ||= :unknown
     end
     
+    def precision=(precision)
+      @precision = Precision.new(precision.to_s)
+    end
+    
     def attributes
       [:latitude, :longitude, :street, :locality, :region, :postal_code, :country, :precision].inject({}) do |result,attr|
         result[attr] = self.send(attr) unless self.send(attr).blank?

data/lib/graticule/precision.rb

@@ -0,0 +1,46 @@
+module Graticule
+  
+  # Used to compare the precision of different geocoded locations
+  class Precision
+    include Comparable
+    attr_reader :name
+    
+    NAMES = [
+      :unknown,
+      :country,
+      :region,
+      :locality,
+      :postal_code,
+      :street,
+      :address,
+      :premise
+    ]
+    
+    def initialize(name)
+      @name = name.to_sym
+      raise ArgumentError, "#{name} is not a valid precision. Use one of #{NAMES.inspect}" unless NAMES.include?(@name)
+    end
+    
+    Unknown    = Precision.new(:unknown)
+    Country    = Precision.new(:country)
+    Region     = Precision.new(:region)
+    Locality   = Precision.new(:locality)
+    PostalCode = Precision.new(:postal_code)
+    Street     = Precision.new(:street)
+    Address    = Precision.new(:address)
+    Premise    = Precision.new(:premise)
+    
+    def to_s
+      @name.to_s
+    end
+    
+    def <=>(other)
+      other = Precision.new(other) unless other.is_a?(Precision)
+      NAMES.index(self.name) <=> NAMES.index(other.name)
+    end
+    
+    def ==(other)
+      (self <=> other) == 0
+    end
+  end
+end

data/test/graticule/geocoder/multimap_test.rb

@@ -32,8 +32,8 @@ module Graticule
     
     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
+      @geocoder.locate(:street => 'Oxford Street', :locality => 'London')
+      assert_equal 'http://clients.multimap.com/API/geocode/1.2/API_KEY?city=London&countryCode=&postalCode=&region=&street=Oxford%20Street', URI::HTTP.uris.first
     end
 
 

data/test/graticule/location_test.rb

@@ -77,5 +77,10 @@ module Graticule
       chicago = Location.new(:latitude => 41.85, :longitude => -87.65)
       assert_equal 'America/Chicago', chicago.time_zone
     end
+    
+    def test_casts_precision
+      assert_equal Precision::Region, Location.new(:precision => :region).precision
+      assert_equal Precision::Street, Location.new(:precision => Precision::Street).precision
+    end
   end
 end

data/test/graticule/precision_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+module Graticule
+  class PrecisionTest < Test::Unit::TestCase
+    def test_constants_exist
+      %w(
+        Unknown
+        Country
+        Region
+        Locality
+        PostalCode
+        Street
+        Address
+        Premise
+      ).each do |const|
+        assert Precision.const_defined?(const), "Can't find #{const}"
+      end
+    end
+    
+    def test_can_compare_precisions
+      assert Precision::Country < Precision::Region
+      assert Precision::Country > Precision::Unknown
+      assert Precision::Country == Precision::Country
+      assert Precision::Country == Precision.new(:country)
+      assert Precision::Country != Precision::Premise
+    end
+    
+    def test_can_compare_against_symbols
+      assert Precision::Country < :region
+    end
+    
+    def test_can_compare_against_symbols
+      assert_raise(ArgumentError) { Precision::Unknown > :foo }
+      assert_raise(ArgumentError) { Precision::Unknown == :bar }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: graticule
 version: !ruby/object:Gem::Version 
-  version: 1.0.0.pre
+  version: 1.0.0.pre2
 platform: ruby
 authors: 
 - Brandon Keepers
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-05 00:00:00 -05:00
+date: 2010-02-04 00:00:00 -05:00
 default_executable: geocode
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,6 +73,7 @@ files:
 - lib/graticule/geocoder/multimap.rb
 - lib/graticule/geocoder/yahoo.rb
 - lib/graticule/location.rb
+- lib/graticule/precision.rb
 - site/index.html
 - site/plugin.html
 - site/stylesheets/style.css
@@ -123,6 +124,7 @@ files:
 - test/graticule/geocoder/yahoo_test.rb
 - test/graticule/geocoder_test.rb
 - test/graticule/location_test.rb
+- test/graticule/precision_test.rb
 - test/mocks/uri.rb
 - test/test_helper.rb
 has_rdoc: true
@@ -205,5 +207,6 @@ test_files:
 - test/graticule/geocoder/yahoo_test.rb
 - test/graticule/geocoder_test.rb
 - test/graticule/location_test.rb
+- test/graticule/precision_test.rb
 - test/mocks/uri.rb
 - test/test_helper.rb