andre-geokit 1.3.1 → 1.3.2

data/Rakefile

@@ -4,6 +4,14 @@ require 'rubygems'
 require 'hoe'
 require './lib/geokit.rb'
 
+# undefined method `empty?' for nil:NilClass
+# /Library/Ruby/Site/1.8/rubygems/specification.rb:886:in `validate' 
+class NilClass
+  def empty?
+    true
+  end
+end 
+
 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')

data/lib/geokit.rb

@@ -1,5 +1,5 @@
 module Geokit
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'
   # 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

@@ -564,7 +564,7 @@ module Geokit
       # The failover approach is crucial for production-grade apps, but is rarely used.
       # 98% of your geocoding calls will be successful with the first call  
       def self.do_geocode(address)
-        geocode_ip = !!/^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})?$/.match(address)
+        geocode_ip = /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/.match(address)
         provider_order = geocode_ip ? Geokit::Geocoders::ip_provider_order : Geokit::Geocoders::provider_order
         
         provider_order.each do |provider|

data/test/test_geoplugin_geocoder.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+
+class IpGeocoderTest < BaseGeocoderTest #:nodoc: all
+    
+  IP_SUCCESS=<<-EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<geoPlugin>
+    <geoplugin_city>Belo Horizonte</geoplugin_city>
+    <geoplugin_region>Minas Gerais</geoplugin_region>
+    <geoplugin_areaCode>0</geoplugin_areaCode>
+    <geoplugin_dmaCode>0</geoplugin_dmaCode>
+    <geoplugin_countryCode>BR</geoplugin_countryCode>
+    <geoplugin_countryName>Brazil</geoplugin_countryName>
+    <geoplugin_continentCode>SA</geoplugin_continentCode>
+    <geoplugin_latitude>-19.916700</geoplugin_latitude>
+    <geoplugin_longitude>-43.933300</geoplugin_longitude>
+    <geoplugin_currencyCode>BRL</geoplugin_currencyCode>
+    <geoplugin_currencySymbol>&#82;&#36;</geoplugin_currencySymbol>
+    <geoplugin_currencyConverter>2.2575001717</geoplugin_currencyConverter>
+</geoPlugin>
+    EOF
+
+  def setup
+    super
+    @success.provider = "geoPlugin"
+  end    
+  
+  def test_successful_lookup
+    success = MockSuccess.new
+    success.expects(:body).returns(IP_SUCCESS)
+    url = 'http://www.geoplugin.net/xml.gp?ip=200.150.38.66'
+    GeoKit::Geocoders::GeoPluginGeocoder.expects(:call_geocoder_service).with(url).returns(success)
+    location = GeoKit::Geocoders::GeoPluginGeocoder.geocode('200.150.38.66')
+    assert_not_nil location
+    assert_equal -19.916700, location.lat
+    assert_equal -43.933300, location.lng
+    assert_equal "Belo Horizonte", location.city
+    assert_equal "Minas Gerais", location.state
+    assert_equal "BR", location.country_code
+    assert_equal "geoPlugin", location.provider
+    assert location.success?
+  end
+
+  def test_invalid_ip
+    location = GeoKit::Geocoders::GeoPluginGeocoder.geocode("pixrum")
+    assert_not_nil location
+    assert !location.success?
+  end
+  
+  def test_service_unavailable
+    failure = MockFailure.new
+    url = 'http://www.geoplugin.net/xml.gp?ip=10.10.10.10'
+    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?
+  end  
+end

data/test/test_google_reverse_geocoder.rb

@@ -0,0 +1,49 @@
+require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+
+Geokit::Geocoders::google = 'Google'
+
+class GoogleReverseGeocoderTest < BaseGeocoderTest #:nodoc: all
+  
+  GOOGLE_REVERSE_FULL=<<-EOF.strip  
+  <?xml version="1.0" encoding="UTF-8" ?><kml xmlns="http://earth.google.com/kml/2.0"><Response><name>51.457833,7.016685</name><Status><code>200</code><request>geocode</request></Status><Placemark id="p1"><address>Porscheplatz 1, 45127 Essen, Deutschland</address><AddressDetails Accuracy="8" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>DE</CountryNameCode><CountryName>Deutschland</CountryName><AdministrativeArea><AdministrativeAreaName>Nordrhein-Westfalen</AdministrativeAreaName><SubAdministrativeArea><SubAdministrativeAreaName>Essen</SubAdministrativeAreaName><Locality><LocalityName>Essen</LocalityName><DependentLocality><DependentLocalityName>Stadtkern</DependentLocalityName><Thoroughfare><ThoroughfareName>Porscheplatz 1</ThoroughfareName></Thoroughfare><PostalCode><PostalCodeNumber>45127</PostalCodeNumber></PostalCode></DependentLocality></Locality></SubAdministrativeArea></AdministrativeArea></Country></AddressDetails><ExtendedData><LatLonBox north="51.4609805" south="51.4546853" east="7.0198324" west="7.0135372" /></ExtendedData><Point><coordinates>7.0166848,51.4578329,0</coordinates></Point></Placemark><Placemark id="p2"><address>Stadtkern, Essen, Deutschland</address><AddressDetails Accuracy="4" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>DE</CountryNameCode><CountryName>Deutschland</CountryName><AdministrativeArea><AdministrativeAreaName>Nordrhein-Westfalen</AdministrativeAreaName><SubAdministrativeArea><SubAdministrativeAreaName>Essen</SubAdministrativeAreaName><Locality><LocalityName>Essen</LocalityName><DependentLocality><DependentLocalityName>Stadtkern</DependentLocalityName></DependentLocality></Locality></SubAdministrativeArea></AdministrativeArea></Country></AddressDetails><ExtendedData><LatLonBox north="51.4630710" south="51.4506320" east="7.0193200" west="7.0026170" /></ExtendedData><Point><coordinates>7.0124328,51.4568201,0</coordinates></Point></Placemark><Placemark id="p3"><address>45127 Essen, Deutschland</address><AddressDetails Accuracy="5" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>DE</CountryNameCode><CountryName>Deutschland</CountryName><AdministrativeArea><AdministrativeAreaName>Nordrhein-Westfalen</AdministrativeAreaName><SubAdministrativeArea><SubAdministrativeAreaName>Essen</SubAdministrativeAreaName><Locality><LocalityName>Essen</LocalityName><PostalCode><PostalCodeNumber>45127</PostalCodeNumber></PostalCode></Locality></SubAdministrativeArea></AdministrativeArea></Country></AddressDetails><ExtendedData><LatLonBox north="51.4637808" south="51.4503125" east="7.0231080" west="6.9965454" /></ExtendedData><Point><coordinates>7.0104543,51.4556194,0</coordinates></Point></Placemark><Placemark id="p4"><address>Essen, Deutschland</address><AddressDetails Accuracy="4" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>DE</CountryNameCode><CountryName>Deutschland</CountryName><AdministrativeArea><AdministrativeAreaName>Nordrhein-Westfalen</AdministrativeAreaName><SubAdministrativeArea><SubAdministrativeAreaName>Essen</SubAdministrativeAreaName><Locality><LocalityName>Essen</LocalityName></Locality></SubAdministrativeArea></AdministrativeArea></Country></AddressDetails><ExtendedData><LatLonBox north="51.5342070" south="51.3475730" east="7.1376530" west="6.8943470" /></ExtendedData><Point><coordinates>7.0147614,51.4580686,0</coordinates></Point></Placemark><Placemark id="p5"><address>Essen, Deutschland</address><AddressDetails Accuracy="3" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>DE</CountryNameCode><CountryName>Deutschland</CountryName><AdministrativeArea><AdministrativeAreaName>Nordrhein-Westfalen</AdministrativeAreaName><SubAdministrativeArea><SubAdministrativeAreaName>Essen</SubAdministrativeAreaName></SubAdministrativeArea></AdministrativeArea></Country></AddressDetails><ExtendedData><LatLonBox north="51.5342070" south="51.3475730" east="7.1376530" west="6.8943470" /></ExtendedData><Point><coordinates>7.0461136,51.4508381,0</coordinates></Point></Placemark><Placemark id="p6"><address>Nordrhein-Westfalen, Deutschland</address><AddressDetails Accuracy="2" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>DE</CountryNameCode><CountryName>Deutschland</CountryName><AdministrativeArea><AdministrativeAreaName>Nordrhein-Westfalen</AdministrativeAreaName></AdministrativeArea></Country></AddressDetails><ExtendedData><LatLonBox north="52.5314170" south="50.3225720" east="9.4615950" west="5.8663566" /></ExtendedData><Point><coordinates>7.6615938,51.4332367,0</coordinates></Point></Placemark><Placemark id="p7"><address>Deutschland</address><AddressDetails Accuracy="1" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>DE</CountryNameCode><CountryName>Deutschland</CountryName></Country></AddressDetails><ExtendedData><LatLonBox north="55.0568230" south="47.2701270" east="15.0418536" west="5.8663566" /></ExtendedData><Point><coordinates>10.4515260,51.1656910,0</coordinates></Point></Placemark></Response></kml>
+  EOF
+  
+  
+  def test_google_full_address
+    response = MockSuccess.new
+    response.expects(:body).returns(GOOGLE_REVERSE_FULL)
+    
+    
+    # http://maps.google.com/maps/geo?output=xml&oe=utf-8&ll=51.4578329,7.0166848&key=asdad
+    
+    # #<Geokit::GeoLoc:0x10ec7ec
+    #      @city="Essen",
+    #      @country_code="DE",
+    #      @full_address="Porscheplatz 1, 45127 Essen, Germany",
+    #      @lat=51.4578329,
+    #      @lng=7.0166848,
+    #      @precision="address",
+    #      @provider="google",
+    #      @state="Nordrhein-Westfalen",
+    #      @street_address="Porscheplatz 1",
+    #      @success=true,
+    #      @zip="45127">
+    #     
+    
+    
+    @latlng = "51.4578329,7.0166848"
+    
+    url = "http://maps.google.com/maps/geo?ll=#{Geokit::Inflector.url_escape(@latlng)}&output=xml&key=Google&oe=utf-8"
+    Geokit::Geocoders::GoogleGeocoder.expects(:call_geocoder_service).with(url).returns(response)
+    res=Geokit::Geocoders::GoogleGeocoder.reverse_geocode(@latlng) 
+    assert_equal "Nordrhein-Westfalen", res.state
+    assert_equal "Essen", res.city 
+    assert_equal "45127", res.zip
+    assert_equal "51.4578329,7.0166848", res.ll # slightly dif from yahoo
+    assert res.is_us? == false
+    assert_equal "Porscheplatz 1, 45127 Essen, Deutschland", res.full_address #slightly different from yahoo
+    assert_equal "google", res.provider
+  end
+  
+  
+end

data/test/test_inflector.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'lib/geokit'
+
+class InflectorTest < Test::Unit::TestCase #:nodoc: all
+  
+  def test_titleize
+    assert_equal 'Sugar Grove', Geokit::Inflector.titleize('Sugar Grove')
+    assert_equal 'Sugar Grove', Geokit::Inflector.titleize('Sugar grove')
+    assert_equal 'Sugar Grove', Geokit::Inflector.titleize('sugar Grove')
+    assert_equal 'Sugar Grove', Geokit::Inflector.titleize('sugar grove')
+  end
+  
+  def test_titleize_with_unicode
+    assert_equal 'Borås', Geokit::Inflector.titleize('Borås')
+    assert_equal 'Borås', Geokit::Inflector.titleize('borås')
+    assert_equal 'Borås (Abc)', Geokit::Inflector.titleize('Borås (Abc)')
+    assert_equal 'Borås (Abc)', Geokit::Inflector.titleize('Borås (abc)')
+    assert_equal 'Borås (Abc)', Geokit::Inflector.titleize('borås (Abc)')
+    assert_equal 'Borås (Abc)', Geokit::Inflector.titleize('borås (abc)')
+  end
+   
+end

data/test/test_ipgeocoder.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+
+class IpGeocoderTest < BaseGeocoderTest #:nodoc: all
+    
+  IP_FAILURE=<<-EOF
+    Country: (Private Address) (XX)
+    City: (Private Address)
+    Latitude: 
+    Longitude:
+    EOF
+    
+  IP_SUCCESS=<<-EOF
+    Country: UNITED STATES (US)
+    City: Sugar Grove, IL
+    Latitude: 41.7696
+    Longitude: -88.4588
+    EOF
+    
+  IP_UNICODED=<<-EOF
+    Country: SWEDEN (SE)
+    City: Borås
+    Latitude: 57.7167
+    Longitude: 12.9167
+    EOF
+    
+    def setup
+      super
+      @success.provider = "hostip"
+    end    
+  
+  def test_successful_lookup
+    success = MockSuccess.new
+    success.expects(:body).returns(IP_SUCCESS)
+    url = 'http://api.hostip.info/get_html.php?ip=12.215.42.19&position=true'
+    GeoKit::Geocoders::IpGeocoder.expects(:call_geocoder_service).with(url).returns(success)
+    location = GeoKit::Geocoders::IpGeocoder.geocode('12.215.42.19')
+    assert_not_nil location
+    assert_equal 41.7696, location.lat
+    assert_equal(-88.4588, location.lng)
+    assert_equal "Sugar Grove", location.city
+    assert_equal "IL", location.state
+    assert_equal "US", location.country_code
+    assert_equal "hostip", location.provider
+    assert location.success?
+  end
+  
+  def test_unicoded_lookup
+    success = MockSuccess.new
+    success.expects(:body).returns(IP_UNICODED)
+    url = 'http://api.hostip.info/get_html.php?ip=12.215.42.19&position=true'
+    GeoKit::Geocoders::IpGeocoder.expects(:call_geocoder_service).with(url).returns(success)
+    location = GeoKit::Geocoders::IpGeocoder.geocode('12.215.42.19')
+    assert_not_nil location
+    assert_equal 57.7167, location.lat
+    assert_equal 12.9167, location.lng
+    assert_equal "Bor\303\245s", location.city
+    assert_nil location.state
+    assert_equal "SE", location.country_code
+    assert_equal "hostip", location.provider
+    assert location.success?
+  end
+  
+  def test_failed_lookup
+    failure = MockSuccess.new
+    failure.expects(:body).returns(IP_FAILURE)
+    url = 'http://api.hostip.info/get_html.php?ip=10.10.10.10&position=true'
+    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?
+  end
+  
+  def test_invalid_ip
+    location = GeoKit::Geocoders::IpGeocoder.geocode("blah")
+    assert_not_nil location
+    assert !location.success?
+  end
+  
+  def test_service_unavailable
+    failure = MockFailure.new
+    url = 'http://api.hostip.info/get_html.php?ip=10.10.10.10&position=true'
+    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?
+  end  
+end

data/test/test_multi_geocoder.rb

@@ -41,4 +41,14 @@ class MultiGeocoderTest < BaseGeocoderTest #:nodoc: all
     Geokit::Geocoders.provider_order = temp
   end
 
+  def test_blank_address
+    t1, t2 = Geokit::Geocoders.provider_order, Geokit::Geocoders.ip_provider_order # will need to reset after
+    Geokit::Geocoders.provider_order = [:google]
+    Geokit::Geocoders.ip_provider_order = [:geo_plugin]
+    Geokit::Geocoders::GoogleGeocoder.expects(:geocode).with("").returns(@failure)
+    Geokit::Geocoders::GeoPluginGeocoder.expects(:geocode).never
+    assert_equal @failure, Geokit::Geocoders::MultiGeocoder.geocode("")
+    Geokit::Geocoders.provider_order, Geokit::Geocoders.ip_provider_order = t1, t2 # reset to orig values
+  end
+
 end

data/test/test_multi_ip_geocoder.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+
+Geokit::Geocoders::ip_provider_order=[:geo_plugin,:ip]
+
+class MultiIpGeocoderTest < BaseGeocoderTest #:nodoc: all
+  
+  def setup
+    @ip_address = '10.10.10.10'
+    @success = Geokit::GeoLoc.new({:city=>"SAN FRANCISCO", :state=>"CA", :country_code=>"US", :lat=>37.7742, :lng=>-122.417068})
+    @success.success = true
+    @failure = Geokit::GeoLoc.new
+  end
+  
+  def test_successful_first
+    Geokit::Geocoders::GeoPluginGeocoder.expects(:geocode).with(@ip_address).returns(@success)
+    assert_equal @success, Geokit::Geocoders::MultiGeocoder.geocode(@ip_address)
+  end
+  
+  def test_failover
+    Geokit::Geocoders::GeoPluginGeocoder.expects(:geocode).with(@ip_address).returns(@failure)
+    Geokit::Geocoders::IpGeocoder.expects(:geocode).with(@ip_address).returns(@success)
+    assert_equal @success, Geokit::Geocoders::MultiGeocoder.geocode(@ip_address)
+  end
+  
+  def test_failure
+    Geokit::Geocoders::GeoPluginGeocoder.expects(:geocode).with(@ip_address).returns(@failure)
+    Geokit::Geocoders::IpGeocoder.expects(:geocode).with(@ip_address).returns(@failure)
+    assert_equal @failure, Geokit::Geocoders::MultiGeocoder.geocode(@ip_address)
+  end
+  
+  def test_invalid_provider
+    temp = Geokit::Geocoders::ip_provider_order
+    Geokit::Geocoders.ip_provider_order = [:bogus]
+    assert_equal @failure, Geokit::Geocoders::MultiGeocoder.geocode(@ip_address)
+    Geokit::Geocoders.ip_provider_order = temp
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: andre-geokit
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors: 
 - Andre Lewis and Bill Eisenhauer
@@ -71,8 +71,13 @@ test_files:
 - test/test_bounds.rb
 - test/test_ca_geocoder.rb
 - test/test_geoloc.rb
+- test/test_geoplugin_geocoder.rb
 - test/test_google_geocoder.rb
+- test/test_google_reverse_geocoder.rb
+- test/test_inflector.rb
+- test/test_ipgeocoder.rb
 - test/test_latlng.rb
 - test/test_multi_geocoder.rb
+- test/test_multi_ip_geocoder.rb
 - test/test_us_geocoder.rb
 - test/test_yahoo_geocoder.rb