geokit 1.2.5 → 1.2.6

data/History.txt

@@ -1,3 +1,6 @@
+=== 1.2.6 / 2009-03-19
+* misc minor fixes
+
 === 1.2.5 / 2009-02-25
 
 * fixed GeoLoc.to_yaml
@@ -27,3 +30,21 @@
 * fixed a problem with columns with "distance" in their name
 * added Geonames geocoder
 * the gem and plugin are now hosted at Github.
+
+=== 1.1.1 / 2008-01-20
+* fixes for distance calculation (in-memory and database) when distances are either very small or 0. 
+* NOTE: older versions of MySQL/Postgres may not work. See readme for more info.
+
+=== 1.1.0 / 2007-12-07
+* Geokit is now Rails 2.0 / Edge friendly. 
+
+=== 1.0.0 / 2007-07-22
+* see http://earthcode.com/blog/2007/07/new_geokit_release.html
+* auto geocoding: an option to automatically geocode a model's address field on create
+* in-memory sort-by-distance for arrays of location objects
+* bounding box queries: `Location.find :all, :bounds=>[sw,ne]`
+* improved performance by automatically adding a bounding box condition to radial queries
+* new Bounds class for in-memory bounds-related operations
+* ability to calculate heading and midpoint between two points
+* ability to calculate endpoint given a point, heading, and distance
+

data/README.markdown

@@ -16,8 +16,7 @@ Combine this gem with the [geokit-rails plugin](http://github.com/andre/geokit-r
 
 ## INSTALL
 
-    gem sources -a http://gems.github.com
-    sudo gem install andre-geokit
+    sudo gem install geokit
 
 ## QUICK START
 

data/Rakefile

@@ -4,10 +4,11 @@ require 'rubygems'
 require 'hoe'
 require './lib/geokit.rb'
 
-Hoe.new('geokit', Geokit::VERSION) do |p|
+project=Hoe.new('geokit', Geokit::VERSION) do |p|
   #p.rubyforge_name = 'geokit' # if different than lowercase project name
   p.developer('Andre Lewis', 'andre@earthcode.com')
   p.summary="Geokit provides geocoding and distance calculation in an easy-to-use API"
 end
 
+
 # vim: syntax=Ruby

data/geokit.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geokit}
-  s.version = "1.2.5"
+  s.version = "1.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andre Lewis and Bill Eisenhauer"]

data/lib/geokit.rb

@@ -1,5 +1,5 @@
 module Geokit
-  VERSION = '1.2.5'
+  VERSION = '1.2.6'
   # These defaults are used in Geokit::Mappable.distance_to and in acts_as_mappable
   @@default_units = :miles
   @@default_formula = :sphere
@@ -26,5 +26,5 @@ $: <<  path unless $:.include?(path)
 require 'geokit/geocoders'
 require 'geokit/mappable'
 
-# make old-style module name "GeoKit" equivilent to new-style "Geokit"
+# make old-style module name "GeoKit" equivalent to new-style "Geokit"
 GeoKit=Geokit

data/lib/geokit/geocoders.rb

@@ -105,7 +105,7 @@ module Geokit
       # empty one with a failed success code.
       def self.geocode(address)  
         res = do_geocode(address)
-        return res.success ? res : GeoLoc.new
+        return res.success? ? res : GeoLoc.new
       end  
       
       # Main method which calls the do_reverse_geocode template method which subclasses
@@ -113,7 +113,7 @@ module Geokit
       # empty one with a failed success code.
       def self.reverse_geocode(latlng)
         res = do_reverse_geocode(latlng)
-        return res.success ? res : GeoLoc.new        
+        return res.success? ? res : GeoLoc.new        
       end
       
       # Call the geocoder service using the timeout if configured.
@@ -400,7 +400,7 @@ module Geokit
           # Google can return multiple results as //Placemark elements. 
           # iterate through each and extract each placemark as a geoloc
           doc.each_element('//Placemark') do |e|
-            extracted_geoloc = extract_placemark(e) # g is now an instance of Geoloc
+            extracted_geoloc = extract_placemark(e) # g is now an instance of GeoLoc
             if geoloc.nil? 
               # first time through, geoloc is still nil, so we make it the geoloc we just extracted
               geoloc = extracted_geoloc 
@@ -492,7 +492,7 @@ module Geokit
       # longitude, city, and country code.  Sets the success attribute to false if the ip 
       # parameter does not match an ip address.  
       def self.do_geocode(ip)
-        return Geoloc.new if '0.0.0.0' == ip
+        return GeoLoc.new if '0.0.0.0' == ip
         return GeoLoc.new unless /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})?$/.match(ip)
         url = "http://api.hostip.info/get_html.php?ip=#{ip}&position=true"
         response = self.call_geocoder_service(url)
@@ -550,7 +550,7 @@ module Geokit
           begin
             klass = Geokit::Geocoders.const_get "#{provider.to_s.capitalize}Geocoder"
             res = klass.send :geocode, address
-            return res if res.success
+            return res if res.success?
           rescue
             logger.error("Something has gone very wrong during geocoding, OR you have configured an invalid class name in Geokit::Geocoders::provider_order. Address: #{address}. Provider: #{provider}")
           end

data/lib/geokit/mappable.rb

@@ -112,7 +112,7 @@ module Geokit
       # Geocodes a location using the multi geocoder.
       def geocode(location)
         res = Geocoders::MultiGeocoder.geocode(location)
-        return res if res.success
+        return res if res.success?
         raise Geokit::Geocoders::GeocodeError      
       end
     
@@ -270,7 +270,7 @@ module Geokit
           return Geokit::LatLng.new(match[1],match[2])
         else
           res = Geokit::Geocoders::MultiGeocoder.geocode(thing)
-          return res if res.success
+          return res if res.success?
           raise Geokit::Geocoders::GeocodeError  
         end
       elsif thing.is_a?(Array) && thing.size==2
@@ -337,6 +337,10 @@ module Geokit
     def is_us?
       country_code == 'US'
     end
+    
+    def success?
+      success == true
+    end
 
     # full_address is provided by google but not by yahoo. It is intended that the google
     # geocoding method will provide the full address, whereas for yahoo it will be derived

data/test/test_base_geocoder.rb

@@ -17,6 +17,12 @@ end
 # Base class for testing geocoders.
 class BaseGeocoderTest < Test::Unit::TestCase #:nodoc: all
 
+  class Geokit::Geocoders::TestGeocoder < Geokit::Geocoders::Geocoder
+    def self.do_get(url)
+      sleep(2)
+    end    
+  end
+
   # Defines common test fixtures.
   def setup
     @address = 'San Francisco, CA'    
@@ -28,14 +34,9 @@ class BaseGeocoderTest < Test::Unit::TestCase #:nodoc: all
   end  
   
   def test_timeout_call_web_service
-    Geokit::Geocoders::Geocoder.class_eval do
-      def self.do_get(url)
-        sleep(2)
-      end
-    end
     url = "http://www.anything.com"
     Geokit::Geocoders::timeout = 1
-    assert_nil Geokit::Geocoders::Geocoder.call_geocoder_service(url)    
+    assert_nil Geokit::Geocoders::TestGeocoder.call_geocoder_service(url)    
   end
   
   def test_successful_call_web_service

data/test/test_geoloc.rb

@@ -13,6 +13,14 @@ class GeoLocTest < Test::Unit::TestCase #:nodoc: all
     assert @loc.is_us?
   end
   
+  def test_success
+    assert !@loc.success?
+    @loc.success = false
+    assert !@loc.success?
+    @loc.success = true
+    assert @loc.success?
+  end
+  
   def test_street_number
     @loc.street_address = '123 Spear St.'
     assert_equal '123', @loc.street_number

data/test/test_geoplugin_geocoder.rb

@@ -39,13 +39,13 @@ class IpGeocoderTest < BaseGeocoderTest #:nodoc: all
     assert_equal "Minas Gerais", location.state
     assert_equal "BR", location.country_code
     assert_equal "geoPlugin", location.provider
-    assert location.success
+    assert location.success?
   end
 
   def test_invalid_ip
     location = GeoKit::Geocoders::GeoPluginGeocoder.geocode("pixrum")
     assert_not_nil location
-    assert !location.success
+    assert !location.success?
   end
   
   def test_service_unavailable
@@ -54,6 +54,6 @@ class IpGeocoderTest < BaseGeocoderTest #:nodoc: all
     GeoKit::Geocoders::GeoPluginGeocoder.expects(:call_geocoder_service).with(url).returns(failure)
     location = GeoKit::Geocoders::GeoPluginGeocoder.geocode("10.10.10.10")
     assert_not_nil location
-    assert !location.success
+    assert !location.success?
   end  
 end

data/test/test_ipgeocoder.rb

@@ -42,7 +42,7 @@ class IpGeocoderTest < BaseGeocoderTest #:nodoc: all
     assert_equal "IL", location.state
     assert_equal "US", location.country_code
     assert_equal "hostip", location.provider
-    assert location.success
+    assert location.success?
   end
   
   def test_unicoded_lookup
@@ -58,7 +58,7 @@ class IpGeocoderTest < BaseGeocoderTest #:nodoc: all
     assert_nil location.state
     assert_equal "SE", location.country_code
     assert_equal "hostip", location.provider
-    assert location.success
+    assert location.success?
   end
   
   def test_failed_lookup
@@ -68,13 +68,13 @@ class IpGeocoderTest < BaseGeocoderTest #:nodoc: all
     GeoKit::Geocoders::IpGeocoder.expects(:call_geocoder_service).with(url).returns(failure)
     location = GeoKit::Geocoders::IpGeocoder.geocode("10.10.10.10")
     assert_not_nil location
-    assert !location.success
+    assert !location.success?
   end
   
   def test_invalid_ip
     location = GeoKit::Geocoders::IpGeocoder.geocode("blah")
     assert_not_nil location
-    assert !location.success
+    assert !location.success?
   end
   
   def test_service_unavailable
@@ -83,6 +83,6 @@ class IpGeocoderTest < BaseGeocoderTest #:nodoc: all
     GeoKit::Geocoders::IpGeocoder.expects(:call_geocoder_service).with(url).returns(failure)
     location = GeoKit::Geocoders::IpGeocoder.geocode("10.10.10.10")
     assert_not_nil location
-    assert !location.success
+    assert !location.success?
   end  
 end

metadata

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