geokit 1.2.6 → 1.3.0

data/History.txt

@@ -1,3 +1,9 @@
+=== 1.3.0 / 2009-04-11
+* Added capability to define multiple API keys for different domains that may be pointing to the same application (thanks Glenn Powell)
+* Added numeric accuracy accessor for Yahoo and Google geocoders (thanks Andrew Fecheyr Lippens)
+* Implement #hash and #eql? on LatLng to allow for using it as a hash key (thanks Luke Melia and Ross Kaffenberger)
+*
+
 === 1.2.6 / 2009-03-19
 * misc minor fixes
 

data/README.markdown

@@ -74,6 +74,12 @@ If you're using this gem by itself, here are the configuration options:
 		# See http://www.google.com/apis/maps/signup.html
 		# and http://www.google.com/apis/maps/documentation/#Geocoding_Examples
 		Geokit::Geocoders::google = 'REPLACE_WITH_YOUR_GOOGLE_KEY'
+		
+		# You can also set multiple API KEYS for different domains that may be directed to this same application.
+		# The domain from which the current user is being directed will automatically be updated for Geokit via
+		# the GeocoderControl class, which gets it's begin filter mixed into the ActionController.
+		# You define these keys with a Hash as follows:
+		#Geokit::Geocoders::google = { 'rubyonrails.org' => 'RUBY_ON_RAILS_API_KEY', 'ruby-docs.org' => 'RUBY_DOCS_API_KEY' }
 		    
 		# This is your username and password for geocoder.us.
 		# To use the free service, the value can be set to nil or false.  For 

data/geokit.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geokit}
-  s.version = "1.2.6"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andre Lewis and Bill Eisenhauer"]
-  s.date = %q{2009-02-09}
+  s.date = %q{2009-4-11}
   s.description = %q{Geokit Gem}
   s.email = ["andre@earthcode.com / bill_eisenhauer@yahoo.com"]
   s.extra_rdoc_files = ["Manifest.txt", "README.markdown"]

data/lib/geokit.rb

@@ -1,5 +1,5 @@
 module Geokit
-  VERSION = '1.2.6'
+  VERSION = '1.3.0'
   # These defaults are used in Geokit::Mappable.distance_to and in acts_as_mappable
   @@default_units = :miles
   @@default_formula = :sphere

data/lib/geokit/geocoders.rb

@@ -72,16 +72,29 @@ module Geokit
     @@provider_order = [:google,:us]
     @@logger=Logger.new(STDOUT)
     @@logger.level=Logger::INFO
+    @@domain = nil
+    
+    def self.domain
+      @@domain
+    end
+
+    def self.domain=(obj)
+      @@domain = obj
+    end
     
     [:yahoo, :google, :geocoder_us, :geocoder_ca, :geonames, :provider_order, :timeout, 
-     :proxy_addr, :proxy_port, :proxy_user, :proxy_pass,:logger].each do |sym|
+     :proxy_addr, :proxy_port, :proxy_user, :proxy_pass, :logger].each do |sym|
       class_eval <<-EOS, __FILE__, __LINE__
         def self.#{sym}
-          if defined?(#{sym.to_s.upcase})
+          value = if defined?(#{sym.to_s.upcase})
             #{sym.to_s.upcase}
           else
             @@#{sym}
           end
+          if value.is_a?(Hash)
+            value = (self.domain.nil? ? nil : value[self.domain]) || value.values.first
+          end
+          value
         end
 
         def self.#{sym}=(obj)
@@ -298,6 +311,8 @@ module Geokit
           res.zip=doc.elements['//Zip'].text if doc.elements['//Zip'] && doc.elements['//Zip'].text != nil
           res.street_address=doc.elements['//Address'].text if doc.elements['//Address'] && doc.elements['//Address'].text != nil
           res.precision=doc.elements['//Result'].attributes['precision'] if doc.elements['//Result']
+          # set the accuracy as google does (added by Andruby)
+          res.accuracy=%w{unknown country state state city zip zip+4 street address building}.index(res.precision)
           res.success=true
           return res
         else 
@@ -441,8 +456,8 @@ module Geokit
         # Translate accuracy into Yahoo-style token address, street, zip, zip+4, city, state, country
         # For Google, 1=low accuracy, 8=high accuracy
         address_details=doc.elements['.//*[local-name() = "AddressDetails"]']
-        accuracy = address_details ? address_details.attributes['Accuracy'].to_i : 0
-        res.precision=%w{unknown country state state city zip zip+4 street address building}[accuracy]
+        res.accuracy = address_details ? address_details.attributes['Accuracy'].to_i : 0
+        res.precision=%w{unknown country state state city zip zip+4 street address building}[res.accuracy]
         res.success=true
         
         return res        

data/lib/geokit/mappable.rb

@@ -251,6 +251,14 @@ module Geokit
       other.is_a?(LatLng) ? self.lat == other.lat && self.lng == other.lng : false
     end
     
+    def hash
+      lat.hash + lng.hash
+    end
+    
+    def eql?(other)
+      self == other
+    end
+    
     # A *class* method to take anything which can be inferred as a point and generate
     # a LatLng from it. You should use this anything you're not sure what the input is,
     # and want to deal with it as a LatLng if at all possible. Can take:
@@ -317,6 +325,9 @@ module Geokit
     attr_accessor :success, :provider, :precision
     # Street number and street name are extracted from the street address attribute.
     attr_reader :street_number, :street_name
+    # accuracy is set for Yahoo and Google geocoders, it is a numeric value of the 
+    # precision. see http://code.google.com/apis/maps/documentation/geocoding/#GeocodingAccuracy
+    attr_accessor :accuracy
 
     # Constructor expects a hash of symbols to correspond with attributes.
     def initialize(h={})

data/test/test_google_geocoder.rb

@@ -50,6 +50,15 @@ class GoogleGeocoderTest < BaseGeocoderTest #:nodoc: all
     assert_equal "100 Spear St, San Francisco, CA 94105, USA", res.full_address #slightly different from yahoo
     assert_equal "google", res.provider
   end  
+  
+  def test_google_full_address_accuracy
+    response = MockSuccess.new
+    response.expects(:body).returns(GOOGLE_FULL)
+    url = "http://maps.google.com/maps/geo?q=#{Geokit::Inflector.url_escape(@full_address_short_zip)}&output=xml&key=Google&oe=utf-8"
+    Geokit::Geocoders::GoogleGeocoder.expects(:call_geocoder_service).with(url).returns(response)
+    res=Geokit::Geocoders::GoogleGeocoder.geocode(@google_full_loc)
+    assert_equal 8, res.accuracy
+  end
 
   def test_google_city
     response = MockSuccess.new
@@ -66,6 +75,15 @@ class GoogleGeocoderTest < BaseGeocoderTest #:nodoc: all
     assert_equal "google", res.provider
   end  
   
+  def test_google_city_accuracy
+    response = MockSuccess.new
+    response.expects(:body).returns(GOOGLE_CITY)
+    url = "http://maps.google.com/maps/geo?q=#{Geokit::Inflector.url_escape(@address)}&output=xml&key=Google&oe=utf-8"
+    Geokit::Geocoders::GoogleGeocoder.expects(:call_geocoder_service).with(url).returns(response)
+    res=Geokit::Geocoders::GoogleGeocoder.geocode(@address)
+    assert_equal 4, res.accuracy
+  end
+  
   def test_google_city_with_geo_loc
     response = MockSuccess.new
     response.expects(:body).returns(GOOGLE_CITY)

data/test/test_latlng.rb

@@ -128,5 +128,21 @@ class LatLngTest < Test::Unit::TestCase #:nodoc: all
     res=Geokit::LatLng.normalize([lat,lng])
     assert_equal res,Geokit::LatLng.new(lat,lng)
   end
-    
+  
+  def test_hash
+    lat=37.7690
+    lng=-122.443
+    first = Geokit::LatLng.new(lat,lng)
+    second = Geokit::LatLng.new(lat,lng)
+    assert_equal first.hash, second.hash
+  end
+  
+  def test_eql?
+    lat=37.7690
+    lng=-122.443
+    first = Geokit::LatLng.new(lat,lng)
+    second = Geokit::LatLng.new(lat,lng)
+    assert first.eql?(second)
+    assert second.eql?(first)
+  end
 end

data/test/test_yahoo_geocoder.rb

@@ -32,6 +32,15 @@ class YahooGeocoderTest < BaseGeocoderTest #:nodoc: all
     do_full_address_assertions(Geokit::Geocoders::YahooGeocoder.geocode(@address))
   end 
   
+  def test_yahoo_full_address_accuracy
+    response = MockSuccess.new
+    response.expects(:body).returns(YAHOO_FULL)
+    url = "http://api.local.yahoo.com/MapsService/V1/geocode?appid=Yahoo&location=#{Geokit::Inflector.url_escape(@address)}"
+    Geokit::Geocoders::YahooGeocoder.expects(:call_geocoder_service).with(url).returns(response)
+    res = Geokit::Geocoders::YahooGeocoder.geocode(@address)
+    assert_equal 8, res.accuracy
+  end
+  
   def test_yahoo_full_address_with_geo_loc
     response = MockSuccess.new
     response.expects(:body).returns(YAHOO_FULL)
@@ -48,6 +57,15 @@ class YahooGeocoderTest < BaseGeocoderTest #:nodoc: all
     do_city_assertions(Geokit::Geocoders::YahooGeocoder.geocode(@address))
   end
   
+  def test_yahoo_city_accuracy
+    response = MockSuccess.new
+    response.expects(:body).returns(YAHOO_CITY)
+    url = "http://api.local.yahoo.com/MapsService/V1/geocode?appid=Yahoo&location=#{Geokit::Inflector.url_escape(@address)}"
+    Geokit::Geocoders::YahooGeocoder.expects(:call_geocoder_service).with(url).returns(response)
+    res = Geokit::Geocoders::YahooGeocoder.geocode(@address)
+    assert_equal 4, res.accuracy
+  end
+  
   def test_yahoo_city_with_geo_loc
     response = MockSuccess.new
     response.expects(:body).returns(YAHOO_CITY)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: geokit
 version: !ruby/object:Gem::Version 
-  version: 1.2.6
+  version: 1.3.0
 platform: ruby
 authors: 
 - Andre Lewis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-19 00:00:00 -07:00
+date: 2009-04-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency