geokit 1.6.5 → 1.6.6

data/lib/geokit/services/yahoo.rb

@@ -0,0 +1,75 @@
+module Geokit
+  module Geocoders
+    # Yahoo geocoder implementation.  Requires the Geokit::Geocoders::YAHOO variable to
+    # contain a Yahoo API key.  Conforms to the interface set by the Geocoder class.
+    class YahooGeocoder < Geocoder
+
+      private
+
+      # Template method which does the geocode lookup.
+      def self.do_geocode(address, options = {})
+        address_str = address.is_a?(GeoLoc) ? address.to_geocodeable_s : address
+        url="http://where.yahooapis.com/geocode?flags=J&appid=#{Geokit::Geocoders::yahoo}&q=#{Geokit::Inflector::url_escape(address_str)}"
+        res = self.call_geocoder_service(url)
+        return GeoLoc.new if !res.is_a?(Net::HTTPSuccess)
+        json = res.body
+        logger.debug "Yahoo geocoding. Address: #{address}. Result: #{json}"
+        return self.json2GeoLoc(json, address)
+      end
+
+      def self.json2GeoLoc(json, address)
+        results = MultiJson.load(json)
+
+        if results['ResultSet']['Error'] == 0 && results['ResultSet']['Results'] != nil && results['ResultSet']['Results'].first != nil
+          geoloc = nil
+          results['ResultSet']['Results'].each do |result|
+            extracted_geoloc = extract_geoloc(result)
+            if geoloc.nil?
+              geoloc = extracted_geoloc
+            else
+              geoloc.all.push(extracted_geoloc)
+            end
+          end
+          return geoloc
+        else
+          logger.info "Yahoo was unable to geocode address: " + address
+          return GeoLoc.new
+        end
+      end
+
+      def self.extract_geoloc(result_json)
+        geoloc = GeoLoc.new
+
+        # basic
+        geoloc.lat            = result_json['latitude']
+        geoloc.lng            = result_json['longitude']
+        geoloc.country_code   = result_json['countrycode']
+        geoloc.provider       = 'yahoo'
+
+        # extended
+        geoloc.street_address = result_json['line1'].to_s.empty? ? nil : result_json['line1']
+        geoloc.city           = result_json['city']
+        geoloc.state          = geoloc.is_us? ? result_json['statecode'] : result_json['state']
+        geoloc.zip            = result_json['postal']
+
+        geoloc.precision = case result_json['quality']
+                           when 9,10         then 'country'
+                           when 19..30       then 'state'
+                           when 39,40        then 'city'
+                           when 49,50        then 'neighborhood'
+                           when 59,60,64     then 'zip'
+                           when 74,75        then 'zip+4'
+                           when 70..72       then 'street'
+                           when 80..87       then 'address'
+                           when 62,63,90,99  then 'building'
+                           else 'unknown'
+                           end
+
+        geoloc.accuracy = %w{unknown country state state city zip zip+4 street address building}.index(geoloc.precision)
+        geoloc.success = true
+
+        return geoloc
+      end
+    end
+  end
+end

data/lib/geokit/version.rb

@@ -0,0 +1,3 @@
+module Geokit
+  VERSION = '1.6.6'
+end

data/test/helper.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+
+begin
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+rescue LoadError => e
+  puts "Error loading bundler (#{e.message}): \"gem install bundler\" for bundler support."
+end
+
+if ENV['COVERAGE']
+  COVERAGE_THRESHOLD = 84
+  require 'simplecov'
+  require 'simplecov-rcov'
+  require 'coveralls'
+  Coveralls.wear!
+
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+  SimpleCov.start do
+    add_filter '/test/'
+    add_group 'lib', 'lib'
+  end
+  SimpleCov.at_exit do
+    SimpleCov.result.format!
+    percent = SimpleCov.result.covered_percent
+    unless percent >= COVERAGE_THRESHOLD
+      puts "Coverage must be above #{COVERAGE_THRESHOLD}%. It is #{"%.2f" % percent}%"
+      Kernel.exit(1)
+    end
+  end
+end
+
+require 'test/unit'
+require 'mocha/setup'
+require 'net/http'
+
+require File.join(File.dirname(__FILE__), "../lib/geokit.rb")
+
+class MockSuccess < Net::HTTPSuccess #:nodoc: all
+  def initialize
+    @header = {}
+  end
+end
+
+class MockFailure < Net::HTTPServiceUnavailable #:nodoc: all
+  def initialize
+    @header = {}
+  end
+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'
+    @full_address = '100 Spear St, San Francisco, CA, 94105-1522, US'
+    @full_address_short_zip = '100 Spear St, San Francisco, CA, 94105, US'
+
+    @latlng = Geokit::LatLng.new(37.7742, -122.417068)
+    @success = Geokit::GeoLoc.new({:city=>"SAN FRANCISCO", :state=>"CA", :country_code=>"US", :lat=>@latlng.lat, :lng=>@latlng.lng})
+    @success.success = true
+  end
+
+  def test_timeout_call_web_service
+    url = "http://www.anything.com"
+    Geokit::Geocoders::request_timeout = 1
+    assert_nil Geokit::Geocoders::TestGeocoder.call_geocoder_service(url)
+  end
+
+  def test_successful_call_web_service
+    url = "http://www.anything.com"
+    Geokit::Geocoders::Geocoder.expects(:do_get).with(url).returns("SUCCESS")
+    assert_equal "SUCCESS", Geokit::Geocoders::Geocoder.call_geocoder_service(url)
+  end
+
+  def test_find_geocoder_methods
+    public_methods = Geokit::Geocoders::Geocoder.public_methods.map { |m| m.to_s }
+    assert public_methods.include?("yahoo_geocoder")
+    assert public_methods.include?("google_geocoder")
+    assert public_methods.include?("ca_geocoder")
+    assert public_methods.include?("us_geocoder")
+    assert public_methods.include?("multi_geocoder")
+    assert public_methods.include?("ip_geocoder")
+  end
+end

data/test/test_base_geocoder.rb

@@ -1,18 +1,4 @@
-require 'test/unit'
-require 'net/http'
-require 'rubygems'
-require 'mocha'
-require 'lib/geokit'
-
-class MockSuccess < Net::HTTPSuccess #:nodoc: all
-  def initialize
-  end
-end
-
-class MockFailure < Net::HTTPServiceUnavailable #:nodoc: all
-  def initialize
-  end
-end
+require File.join(File.dirname(__FILE__), 'helper')
 
 # Base class for testing geocoders.
 class BaseGeocoderTest < Test::Unit::TestCase #:nodoc: all

data/test/test_bounds.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'lib/geokit'
+require File.join(File.dirname(__FILE__), 'helper')
 
 class BoundsTest < Test::Unit::TestCase #:nodoc: all
 

data/test/test_ca_geocoder.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+require File.join(File.dirname(__FILE__), 'helper')
 
 Geokit::Geocoders::geocoder_ca = "SOMEKEYVALUE"
 

data/test/test_geoloc.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'lib/geokit'
+require File.join(File.dirname(__FILE__), 'helper')
 
 class GeoLocTest < Test::Unit::TestCase #:nodoc: all
 
@@ -64,9 +63,40 @@ class GeoLocTest < Test::Unit::TestCase #:nodoc: all
     @loc.state = 'CA'
     @loc.zip = '94105'
     @loc.country_code = 'US'
-    assert_equal(
-      "--- !ruby/object:Geokit::GeoLoc \ncity: San Francisco\ncountry_code: US\nfull_address: \nlat: \nlng: \nprecision: unknown\nprovince: \nstate: CA\nstreet_address: \nstreet_name: \nstreet_number: \nsub_premise: \nsuccess: false\nzip: \"94105\"\n",
-      @loc.to_yaml)
+
+    yaml = YAML::parse(@loc.to_yaml)
+    case yaml.class.to_s
+    when 'YAML::Syck::Map', 'Syck::Map'
+      tag = yaml.type_id
+      children = yaml.value.sort_by{|k, v| k.value}.flatten.map(&:value)
+    when 'Psych::Nodes::Mapping'
+      tag = yaml.tag
+      children = yaml.children.map(&:value)
+    when 'Psych::Nodes::Document'
+      tag = yaml.root.tag
+      children = yaml.root.children.map(&:value)
+    end
+    assert_match /.*object:Geokit::GeoLoc$/, tag
+    assert_equal [
+      'city', 'San Francisco',
+      'country_code', 'US',
+      'full_address', '',
+      'lat', '',
+      'lng', '',
+      'precision', 'unknown',
+      'province', '',
+      'state', 'CA',
+      'street_address', '',
+      'street_name', '',
+      'street_number', '',
+      'sub_premise', '',
+      'success', 'false',
+      'zip', '94105'
+    ], children
   end
 
+  def test_neighborhood
+    @loc.neighborhood = "SoMa"
+    assert_equal @loc.neighborhood, 'SoMa'
+  end
 end

data/test/test_geoplugin_geocoder.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+require File.join(File.dirname(__FILE__), 'helper')
 
 class IpGeocoderTest < BaseGeocoderTest #:nodoc: all
 

data/test/test_google_geocoder.rb

@@ -1,4 +1,5 @@
-require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+# encoding: UTF-8
+require File.join(File.dirname(__FILE__), 'helper')
 
 Geokit::Geocoders::google = 'Google'
 
@@ -31,6 +32,25 @@ class GoogleGeocoderTest < BaseGeocoderTest #:nodoc: all
   GOOGLE_TOO_MANY=<<-EOF.strip
   <?xml version="1.0" encoding="UTF-8"?><kml xmlns="http://earth.google.com/kml/2.0"><Response><name>100 spear st, san francisco, ca</name><Status><code>620</code><request>geocode</request></Status></Response></kml>
   EOF
+  
+  GOOGLE_UTF8_RESULT=<<-EOF
+  <?xml version="1.0" encoding="UTF-8" ?>
+  <kml xmlns="http://earth.google.com/kml/2.0"><Response>
+    <name>Mosjøen, Norway</name>
+    <Status>
+      <code>200</code>
+      <request>geocode</request>
+    </Status>
+    <Placemark id="p1">
+      <address>Mosjøen, Norway</address>
+      <AddressDetails Accuracy="4" xmlns="urn:oasis:names:tc:ciq:xsdschema:xAL:2.0"><Country><CountryNameCode>NO</CountryNameCode><CountryName>Norge</CountryName><AdministrativeArea><AdministrativeAreaName>Nordland</AdministrativeAreaName><SubAdministrativeArea><SubAdministrativeAreaName>Vefsn</SubAdministrativeAreaName><Locality><LocalityName>Mosjøen</LocalityName></Locality></SubAdministrativeArea></AdministrativeArea></Country></AddressDetails>
+      <ExtendedData>
+        <LatLonBox north="65.8551869" south="65.8186481" east="13.2574307" west="13.1293713" />
+      </ExtendedData>
+      <Point><coordinates>13.1934010,65.8369240,0</coordinates></Point>
+    </Placemark>
+  </Response></kml>
+  EOF
 
   def setup
     super
@@ -39,6 +59,8 @@ class GoogleGeocoderTest < BaseGeocoderTest #:nodoc: all
 
     @google_full_loc = Geokit::GeoLoc.new(@google_full_hash)
     @google_city_loc = Geokit::GeoLoc.new(@google_city_hash)
+    
+    @address_with_special_characters = "Mosjøen, Norway"
   end
 
   def test_google_full_address
@@ -205,7 +227,7 @@ class GoogleGeocoderTest < BaseGeocoderTest #:nodoc: all
     response = MockSuccess.new
     response.expects(:body).returns(GOOGLE_BOUNDS_BIASED_RESULT)
 
-    url = "http://maps.google.com/maps/geo?q=Winnetka&output=xml&ll=34.197693208849,-118.547160027785&spn=0.247047999999999,0.294914000000006&key=Google&oe=utf-8"
+    url = "http://maps.google.com/maps/geo?q=Winnetka&output=xml&ll=34.197693,-118.547160&spn=0.247048,0.294914&key=Google&oe=utf-8"
     Geokit::Geocoders::GoogleGeocoder.expects(:call_geocoder_service).with(url).returns(response)
 
     bounds = Geokit::Bounds.normalize([34.074081, -118.694401], [34.321129, -118.399487])
@@ -224,4 +246,19 @@ class GoogleGeocoderTest < BaseGeocoderTest #:nodoc: all
       res=Geokit::Geocoders::GoogleGeocoder.geocode(@address)
     end
   end
+  
+  def test_utf8_encoding
+    response = MockSuccess.new
+    body = GOOGLE_UTF8_RESULT
+    body = body.force_encoding('ASCII-8BIT') if body.respond_to? :force_encoding
+    response.expects(:body).returns(body)
+    url = "http://maps.google.com/maps/geo?q=#{Geokit::Inflector.url_escape(@address_with_special_characters)}&output=xml&key=Google&oe=utf-8"
+    Geokit::Geocoders::GoogleGeocoder.expects(:call_geocoder_service).with(url).returns(response)
+    res=Geokit::Geocoders::GoogleGeocoder.geocode(@address_with_special_characters)
+    assert_equal "Nordland", res.state
+    assert_equal "Mosjøen", res.city
+    assert_equal "65.836924,13.193401", res.ll
+    assert !res.is_us?
+    assert_equal "google", res.provider
+  end    
 end

data/test/test_google_geocoder3.rb

@@ -1,6 +1,10 @@
-require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+require File.join(File.dirname(__FILE__), 'helper')
 
 Geokit::Geocoders::google = 'Google'
+Geokit::Geocoders::google_client_id = nil
+Geokit::Geocoders::google_cryptographic_key = nil
+Geokit::Geocoders::google_channel = nil
+
 
 class GoogleGeocoder3Test < BaseGeocoderTest #:nodoc: all
 
@@ -372,6 +376,12 @@ class GoogleGeocoder3Test < BaseGeocoderTest #:nodoc: all
        "status": "OVER_QUERY_LIMIT"
     }
   /
+  GOOGLE3_INVALID_REQUEST=%q/
+  {
+    "results" : [],
+    "status" : "INVALID_REQUEST"
+  }
+  /
   def setup
     super
     @full_address = '100 Spear St Apt. 5, San Francisco, CA, 94105-1522, US'
@@ -383,6 +393,29 @@ class GoogleGeocoder3Test < BaseGeocoderTest #:nodoc: all
     @google_city_loc = Geokit::GeoLoc.new(@google_city_hash)
   end
 
+
+  # Example from:
+  # https://developers.google.com/maps/documentation/business/webservices#signature_examples
+  def test_google3_signature
+    cryptographic_key = 'vNIXE0xscrmjlyV-12Nj_BvUPaw='
+    query_string = '/maps/api/geocode/json?address=New+York&sensor=false&client=clientID'
+    signature = Geokit::Geocoders::GoogleGeocoder3.send(:sign_gmap_bus_api_url, query_string, cryptographic_key)
+    assert_equal 'KrU1TzVQM7Ur0i8i7K3huiw3MsA=', signature
+  end
+
+
+  # Example from:
+  # https://developers.google.com/maps/documentation/business/webservices#signature_examples
+  def test_google3_signature_and_url
+    Geokit::Geocoders::google_client_id = 'clientID'
+    Geokit::Geocoders::google_cryptographic_key = 'vNIXE0xscrmjlyV-12Nj_BvUPaw='
+    url = Geokit::Geocoders::GoogleGeocoder3.send(:submit_url, '/maps/api/geocode/json?address=New+York&sensor=false')
+    Geokit::Geocoders::google_client_id = nil
+    Geokit::Geocoders::google_cryptographic_key = nil
+    assert_equal 'http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID&signature=KrU1TzVQM7Ur0i8i7K3huiw3MsA=', url
+  end
+
+
   def test_google3_full_address
     response = MockSuccess.new
     response.expects(:body).returns(GOOGLE3_FULL)
@@ -418,7 +451,6 @@ class GoogleGeocoder3Test < BaseGeocoderTest #:nodoc: all
      Geokit::Geocoders::GoogleGeocoder3.expects(:call_geocoder_service).with(url).returns(response)
      res=Geokit::Geocoders::GoogleGeocoder3.geocode(@google_full_loc)
 
-puts res.to_hash.inspect
      assert_equal 9, res.accuracy
    end
 
@@ -469,9 +501,19 @@ puts res.to_hash.inspect
      res = Geokit::Geocoders::GoogleGeocoder3.geocode(@google_full_loc)
 
      assert_instance_of Geokit::Bounds, res.suggested_bounds
-     assert_equal Geokit::Bounds.new(Geokit::LatLng.new(37.7908019197085, -122.395348980292), Geokit::LatLng.new(37.7934998802915, -122.392651019708)), res.suggested_bounds
+     assert_equal Geokit::Bounds.new(Geokit::LatLng.new(37.7908019197085, -122.3953489802915), Geokit::LatLng.new(37.7934998802915, -122.3926510197085)), res.suggested_bounds
    end
 
+   def test_google3_suggested_bounds_url
+     bounds = Geokit::Bounds.new(
+       Geokit::LatLng.new(33.7036917, -118.6681759),
+       Geokit::LatLng.new(34.3373061, -118.1552891)
+     )
+     url = "http://maps.google.com/maps/api/geocode/json?sensor=false&address=Winnetka&bounds=33.7036917%2C-118.6681759%7C34.3373061%2C-118.1552891"
+     Geokit::Geocoders::GoogleGeocoder3.expects(:call_geocoder_service).with(url)
+     Geokit::Geocoders::GoogleGeocoder3.geocode('Winnetka', :bias => bounds)
+  end
+
    def test_service_unavailable
      response = MockFailure.new
      url = "http://maps.google.com/maps/api/geocode/json?sensor=false&address=#{Geokit::Inflector::url_escape(@address)}"
@@ -554,4 +596,14 @@ puts res.to_hash.inspect
        res=Geokit::Geocoders::GoogleGeocoder3.geocode(@address)
      end
    end
+
+   def test_invalid_request
+     response = MockSuccess.new
+     response.expects(:body).returns(GOOGLE3_INVALID_REQUEST)
+     url = "http://maps.google.com/maps/api/geocode/json?sensor=false&address=#{Geokit::Inflector.url_escape("3961 V\u00EDa Marisol")}"
+     Geokit::Geocoders::GoogleGeocoder3.expects(:call_geocoder_service).with(url).returns(response)
+     assert_raise Geokit::Geocoders::GeocodeError do
+       Geokit::Geocoders::GoogleGeocoder3.geocode("3961 V\u00EDa Marisol")
+     end
+   end
 end

data/test/test_google_reverse_geocoder.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+require File.join(File.dirname(__FILE__), 'helper')
 
 Geokit::Geocoders::google = 'Google'
 

data/test/test_inflector.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
-
-require 'test/unit'
-require 'lib/geokit'
+require File.join(File.dirname(__FILE__), 'helper')
 
 class InflectorTest < Test::Unit::TestCase #:nodoc: all
 
@@ -21,4 +19,8 @@ class InflectorTest < Test::Unit::TestCase #:nodoc: all
     assert_equal 'Borås (Abc)', Geokit::Inflector.titleize('borås (abc)')
   end
 
+  def test_url_escape
+    assert_equal '%E4%B8%8A%E6%B5%B7%E5%B8%82%E5%BE%90%E6%B1%87%E5%8C%BA%E6%BC%95%E6%BA%AA%E5%8C%97%E8%B7%AF1111%E5%8F%B7', GeoKit::Inflector.url_escape('上海市徐汇区漕溪北路1111号')
+    assert_equal '%C3%BC%C3%B6%C3%A4', Geokit::Inflector.url_escape('üöä')
+  end
 end