geokit 1.10.0 → 1.11.0

data/lib/geokit/geocoders/yandex.rb

@@ -8,7 +8,7 @@ module Geokit
       private
 
       # Template method which does the geocode lookup.
-      def self.do_geocode(address)
+      def self.do_geocode(address, _=nil)
         process :json, submit_url(address)
       end
 
@@ -22,18 +22,18 @@ module Geokit
       def self.parse_json(result)
         loc = new_loc
 
-        coll = result["response"]["GeoObjectCollection"]
-        return loc unless coll["metaDataProperty"]["GeocoderResponseMetaData"]["found"].to_i > 0
+        coll = result['response']['GeoObjectCollection']
+        return loc unless coll['metaDataProperty']['GeocoderResponseMetaData']['found'].to_i > 0
 
-        l = coll["featureMember"][0]["GeoObject"]
+        l = coll['featureMember'][0]['GeoObject']
 
         loc.success = true
-        ll = l["Point"]["pos"].split(" ")
+        ll = l['Point']['pos'].split(' ')
         loc.lng = ll.first
         loc.lat = ll.last
 
-        country = l["metaDataProperty"]["GeocoderMetaData"]["AddressDetails"]["Country"]
-        locality = country["Locality"] || country["AdministrativeArea"]["Locality"] || country["AdministrativeArea"]["SubAdministrativeArea"]["Locality"] rescue nil
+        country = l['metaDataProperty']['GeocoderMetaData']['AddressDetails']['Country']
+        locality = country['Locality'] || country['AdministrativeArea']['Locality'] || country['AdministrativeArea']['SubAdministrativeArea']['Locality'] rescue nil
         set_address_components(loc, l, country, locality)
         set_precision(loc, l, locality)
 
@@ -41,19 +41,20 @@ module Geokit
       end
 
       def self.set_address_components(loc, l, country, locality)
-        loc.country_code = country["CountryNameCode"]
-        loc.full_address = country["AddressLine"]
-        loc.street_address = l["name"]
-        loc.street_number = locality["Thoroughfare"]["Premise"]["PremiseNumber"] rescue nil
-        loc.street_name = locality["Thoroughfare"]["ThoroughfareName"] rescue nil
-        loc.city = locality["LocalityName"] rescue nil
-        loc.state_name = country["AdministrativeArea"]["AdministrativeAreaName"] rescue nil
-        loc.state ||= country["Locality"]["LocalityName"] rescue nil
+        loc.country_code = country['CountryNameCode']
+        loc.full_address = country['AddressLine']
+        loc.street_address = l['name']
+        loc.street_number = locality['Thoroughfare']['Premise']['PremiseNumber'] rescue nil
+        loc.street_name = locality['Thoroughfare']['ThoroughfareName'] rescue nil
+        loc.city = locality['LocalityName'] rescue nil
+        loc.state_name = country['AdministrativeArea']['AdministrativeAreaName'] rescue nil
+        loc.district = country['AdministrativeArea']['SubAdministrativeArea']['SubAdministrativeAreaName'] rescue nil
+        loc.state ||= country['Locality']['LocalityName'] rescue nil
       end
 
       def self.set_precision(loc, l, locality)
-        loc.precision = l["metaDataProperty"]["GeocoderMetaData"]["precision"].sub(/exact/, "building").sub(/number|near/, "address").sub(/other/, "city")
-        loc.precision = "country" unless locality
+        loc.precision = l['metaDataProperty']['GeocoderMetaData']['precision'].sub(/exact/, 'building').sub(/number|near/, 'address').sub(/other/, 'city')
+        loc.precision = 'country' unless locality
       end
     end
   end

data/lib/geokit/inflectors.rb

@@ -1,4 +1,4 @@
-require "cgi"
+require 'cgi'
 
 module Geokit
   module Inflector
@@ -9,15 +9,15 @@ module Geokit
     end
 
     def underscore(camel_cased_word)
-      camel_cased_word.to_s.gsub(/::/, "/").
+      camel_cased_word.to_s.gsub(/::/, '/').
         gsub(/([A-Z]+)([A-Z][a-z])/u, '\1_\2').
         gsub(/([a-z\d])([A-Z])/u, '\1_\2').
-        tr("-", "_").
+        tr('-', '_').
         downcase
     end
 
     def humanize(lower_case_and_underscored_word)
-      lower_case_and_underscored_word.to_s.gsub(/_id$/, "").gsub(/_/, " ").capitalize
+      lower_case_and_underscored_word.to_s.gsub(/_id$/, '').gsub(/_/, ' ').capitalize
     end
 
     def url_escape(s)
@@ -25,7 +25,7 @@ module Geokit
     end
 
     def camelize(str)
-      str.split("_").map(&:capitalize).join
+      str.split('_').map(&:capitalize).join
     end
   end
 end

data/lib/geokit/lat_lng.rb

@@ -23,7 +23,7 @@ module Geokit
     end
 
     def self.from_json(json)
-      new(json["lat"], json["lng"])
+      new(json['lat'], json['lng'])
     end
 
     # Latitude attribute setter; stored as a float.
@@ -102,7 +102,7 @@ module Geokit
       when Array
         thing.size == 2 or
           raise(ArgumentError,
-            "Must initialize with an Array with both latitude and longitude")
+            'Must initialize with an Array with both latitude and longitude')
         Geokit::LatLng.new(thing[0], thing[1])
       when LatLng # will also be true for GeoLocs
         thing
@@ -112,14 +112,15 @@ module Geokit
         else
           raise(ArgumentError,
             "#{thing} (#{thing.class}) cannot be normalized to a LatLng. " \
-            "We tried interpreting it as an array, string, etc., but no dice.")
+            'We tried interpreting it as an array, string, etc., but no dice.')
         end
       end
     end
 
     def self.from_string(thing)
       thing.strip!
-      if match = thing.match(/(\-?\d+\.?\d*)[, ] ?(\-?\d+\.?\d*)$/)
+      match = thing.match(/(\-?\d+\.?\d*)[, ] ?(\-?\d+\.?\d*)$/)
+      if match
         Geokit::LatLng.new(match[1], match[2])
       else
         res = Geokit::Geocoders::MultiGeocoder.geocode(thing)

data/lib/geokit/multi_geocoder.rb

@@ -46,7 +46,9 @@ module Geokit
       # the configuration until one of the geocoders work, only this time it's
       # going to try to reverse geocode a geographical point.
       def self.do_reverse_geocode(latlng, *args)
-        Geokit::Geocoders.provider_order.each do |provider|
+        provider_order = provider_order_for(latlng, args)
+
+        provider_order.each do |provider|
           klass = geocoder(provider)
           begin
             res = klass.send :reverse_geocode, latlng
@@ -69,7 +71,7 @@ module Geokit
         if args.last.is_a?(Hash) && args.last.key?(:provider_order)
           args.last.delete(:provider_order)
         else
-          if /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/.match(address)
+          if address.is_a?(String) && /^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})$/.match(address)
             Geokit::Geocoders.ip_provider_order
           else
             Geokit::Geocoders.provider_order

data/lib/geokit/net_adapter/net_http.rb

@@ -3,7 +3,8 @@ module Geokit
     class NetHttp
       def self.do_get(url)
         uri = URI(url)
-        req = Net::HTTP::Get.new(uri.request_uri)
+        Geokit::Geocoders.useragent ? headers = {'User-Agent' => Geokit::Geocoders.useragent} : headers = {} 
+        req = Net::HTTP::Get.new(uri.request_uri, headers)
         req.basic_auth(uri.user, uri.password) if uri.userinfo
         net_http_args = [uri.host, uri.port]
         if (proxy_uri_string = Geokit::Geocoders.proxy)
@@ -14,7 +15,7 @@ module Geokit
                             proxy_uri.password]
         end
         http = Net::HTTP.new(*net_http_args)
-        if uri.scheme == "https"
+        if uri.scheme == 'https'
           http.use_ssl = true
           http.verify_mode = Geokit::Geocoders.ssl_verify_mode
         end

data/lib/geokit/net_adapter/typhoeus.rb

@@ -2,7 +2,8 @@ module Geokit
   module NetAdapter
     class Typhoeus
       def self.do_get(url)
-        ::Typhoeus.get(url.to_s)
+        headers = Geokit::Geocoders.useragent ? {'User-Agent' => Geokit::Geocoders.useragent} : {}
+        ::Typhoeus.get(url.to_s, :headers => headers)
       end
 
       def self.success?(response)

data/lib/geokit/version.rb

@@ -1,3 +1,3 @@
 module Geokit
-  VERSION = "1.10.0"
+  VERSION = '1.11.0'
 end

data/test/coverage_loader.rb

@@ -0,0 +1,25 @@
+unless ENV['COVERAGE'] == 'off'
+  COVERAGE_THRESHOLD = 96
+  require 'simplecov'
+  require 'simplecov-rcov'
+  require 'coveralls'
+  Coveralls.wear!
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::RcovFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start do
+    add_filter '/test/'
+    add_group 'lib', 'lib'
+  end
+  SimpleCov.at_exit do
+    SimpleCov.result.format!
+    percent = SimpleCov.result.covered_percent
+    puts "Coverage is #{'%.2f' % percent}%"
+    unless percent >= COVERAGE_THRESHOLD
+      puts "Coverage must be above #{COVERAGE_THRESHOLD}%"
+      Kernel.exit(1)
+    end
+  end
+end

data/test/helper.rb

@@ -1,45 +1,22 @@
 # encoding: utf-8
 
 begin
-  require "rubygems"
-  require "bundler"
+  require 'rubygems'
+  require 'bundler'
   Bundler.setup
 rescue LoadError => e
   puts "Error loading bundler (#{e.message}): \"gem install bundler\" for bundler support."
 end
 
-require "geoip"
+require 'geoip'
 
-if ENV["COVERAGE"]
-  COVERAGE_THRESHOLD = 95
-  require "simplecov"
-  require "simplecov-rcov"
-  require "coveralls"
-  Coveralls.wear!
+require 'coverage_loader'
+require 'vcr_loader'
+require 'test/unit'
+require 'mocha/setup'
+require 'net/http'
 
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::RcovFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-  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")
+require File.join(File.dirname(__FILE__), '../lib/geokit.rb')
 
 class MockSuccess < Net::HTTPSuccess #:nodoc: all
   def initialize
@@ -58,11 +35,12 @@ class MockFailure < Net::HTTPServiceUnavailable #:nodoc: all
 end
 
 class TestHelper
-  def self.last_url(url)
-    @@url = url
-  end
-  def self.get_last_url
-    @@url
+  def self.last_url(url = nil)
+    if url
+      @@url = url
+    else
+      @@url
+    end
   end
 end
 
@@ -78,7 +56,7 @@ Geokit::Geocoders::Geocoder.class_eval do
   end
 end
 
-def assert_array_in_delta(expected_array, actual_array, delta = 0.001, message = "")
+def assert_array_in_delta(expected_array, actual_array, delta = 0.001, message = '')
   full_message = build_message(message, "<?> and\n<?> expected to be within\n<?> of each other.\n", expected_array, actual_array, delta)
   assert_block(full_message) do
     expected_array.zip(actual_array).all? do |expected_item, actual_item|
@@ -87,53 +65,6 @@ def assert_array_in_delta(expected_array, actual_array, delta = 0.001, message =
   end
 end
 
-require "vcr"
-
-VCR.configure do |c|
-  c.before_record do |i|
-    i.response.body.force_encoding("UTF-8")
-  end
-  c.cassette_library_dir = "fixtures/vcr_cassettes"
-  c.hook_into :webmock # or :fakeweb
-  # Yahoo BOSS Ignore changing params
-  c.default_cassette_options = {
-    match_requests_on: [:method,
-      VCR.request_matchers.uri_without_params(
-        :oauth_nonce, :oauth_timestamp, :oauth_signature
-      ),
-                       ],
-  }
-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
-    Geokit::Geocoders.request_timeout = 10
-    @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 assert_ll(lat_lng, lat, lng)
+  assert_equal lat_lng, Geokit::LatLng.new(lat, lng)
 end

data/test/test_base_geocoder.rb

@@ -1,33 +1,66 @@
-require File.join(File.dirname(__FILE__), "helper")
+require File.join(File.dirname(__FILE__), 'helper')
 
 # 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)
+    def self.do_get(_url)
     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"
+    @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 = Geokit::GeoLoc.new({city: 'SAN FRANCISCO', state: 'CA', country_code: 'US', lat: @latlng.lat, lng: @latlng.lng})
     @success.success = true
+
+    @keys = YAML.load(File.read('fixtures/keys.yml'))
   end
 
   def test_timeout_call_web_service
-    url = "http://www.anything.com"
+    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)
+    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
+
+  private
+
+  def geocode(address, *args)
+    options = args.pop if args.last.is_a?(Hash)
+    vcr_name = args.first
+    args = [address]
+    args << options if options && !options.empty?
+    return geocoder_class.geocode(*args) unless vcr_name
+    VCR.use_cassette(vcr_name) do
+      geocoder_class.geocode(*args)
+    end
+  end
+
+  def reverse_geocode(lat_lng, *args)
+    options = args.pop if args.last.is_a?(Hash)
+    vcr_name = args.first
+    args = [lat_lng]
+    args << options if options && !options.empty?
+    return geocoder_class.reverse_geocode(*args) unless vcr_name
+    VCR.use_cassette(vcr_name) do
+      geocoder_class.reverse_geocode(*args)
+    end
+  end
+
+  def geocoder_class
+    @geocoder_class ||= Geokit::Geocoders.const_get(self.class.name.gsub('Test', ''))
+  end
+
+  def escape(string)
+    Geokit::Inflector.url_escape(string)
   end
 end

data/test/test_bing_geocoder.rb

@@ -1,82 +1,74 @@
-require File.join(File.dirname(__FILE__), "helper")
-
-Geokit::Geocoders::BingGeocoder.key = "AuWcmtBIoPeOubm9BtcN44hTmWw_wNoJ5NEO2L0RaKrGAUE_nlwciKAqwapdq7k7"
+require File.join(File.dirname(__FILE__), 'helper')
 
 class BingGeocoderTest < BaseGeocoderTest #:nodoc: all
   def setup
+    geocoder_class.key = 'AuWcmtBIoPeOubm9BtcN44hTmWw_wNoJ5NEO2L0RaKrGAUE_nlwciKAqwapdq7k7'
     super
+    @base_url = 'https://dev.virtualearth.net/REST/v1/Locations'
   end
 
   def assert_url(expected_url)
-    assert_equal expected_url, TestHelper.get_last_url.gsub(/&oauth_[a-z_]+=[a-zA-Z0-9\-. %]+/, "")
+    assert_equal expected_url, TestHelper.last_url.gsub(/&oauth_[a-z_]+=[a-zA-Z0-9\-. %]+/, '')
   end
 
   # the testing methods themselves
   def test_bing_full_address
-    VCR.use_cassette("bing_full") do
-      key = Geokit::Geocoders::BingGeocoder.key
-    url = "https://dev.virtualearth.net/REST/v1/Locations/#{URI.escape(@full_address)}?key=#{key}&o=xml"
-    res = Geokit::Geocoders::BingGeocoder.geocode(@full_address)
-    assert_equal "CA", res.state
-    assert_equal "San Francisco", res.city
+    key = geocoder_class.key
+    url = "#{@base_url}/#{URI.escape(@full_address)}?key=#{key}&o=xml"
+    res = geocode(@full_address, :bing_full)
+    assert_equal 'CA', res.state
+    assert_equal 'San Francisco', res.city
     assert_array_in_delta [37.792332, -122.393791], res.to_a
-    assert res.country == "United States"
-    assert_equal "100 Spear St, San Francisco, CA 94105", res.full_address
-    assert_equal "bing", res.provider
+    assert res.country == 'United States'
+    assert_equal '100 Spear St, San Francisco, CA 94105', res.full_address
+    assert_equal 'bing', res.provider
     assert_url url
-    end
   end
 
   def test_bing_full_address_au
-    address = "440 King William Street, Adelaide, Australia"
-    VCR.use_cassette("bing_full_au") do
-      key = Geokit::Geocoders::BingGeocoder.key
-    url = "https://dev.virtualearth.net/REST/v1/Locations/#{URI.escape(address)}?key=#{key}&o=xml"
-    res = Geokit::Geocoders::BingGeocoder.geocode(address)
-    assert_equal "SA", res.state
-    assert_equal "Adelaide", res.city
+    address = '440 King William Street, Adelaide, Australia'
+    key = geocoder_class.key
+    url = "#{@base_url}/#{URI.escape(address)}?key=#{key}&o=xml"
+    res = geocode(address, :bing_full_au)
+    assert_equal 'SA', res.state
+    assert_equal 'Adelaide', res.city
     assert_array_in_delta [-34.934582, 138.600784], res.to_a
-    assert res.country == "Australia"
-    assert_equal "402-440 King William St, Adelaide, SA 5000", res.full_address
-    assert_equal "Australia", res.country
-    assert_equal "bing", res.provider
+    assert res.country == 'Australia'
+    assert_equal '402-440 King William St, Adelaide, SA 5000', res.full_address
+    assert_equal 'Australia', res.country
+    assert_equal 'bing', res.provider
     assert_url url
-    end
   end
 
   def test_bing_full_address_de
-    address = "Platz der Republik 1, 11011 Berlin, Germany"
-    VCR.use_cassette("bing_full_de") do
-      key = Geokit::Geocoders::BingGeocoder.key
-    url = "https://dev.virtualearth.net/REST/v1/Locations/#{URI.escape(address)}?key=#{key}&o=xml"
-    res = Geokit::Geocoders::BingGeocoder.geocode(address)
-    assert_equal "BE", res.state
-    assert_equal "Berlin", res.city
+    address = 'Platz der Republik 1, 11011 Berlin, Germany'
+    key = geocoder_class.key
+    url = "#{@base_url}/#{URI.escape(address)}?key=#{key}&o=xml"
+    res = geocode(address, :bing_full_de)
+    assert_equal 'BE', res.state
+    assert_equal 'Berlin', res.city
     assert_array_in_delta [52.518596, 13.375502], res.to_a
-    assert res.country == "Germany"
-    assert_equal "Platz der Republik 1, 10557 Berlin", res.full_address
-    assert_equal "bing", res.provider
-    assert_equal "address", res.precision
+    assert res.country == 'Germany'
+    assert_equal 'Platz der Republik 1, 10557 Berlin', res.full_address
+    assert_equal 'bing', res.provider
+    assert_equal 'address', res.precision
     assert_equal 8, res.accuracy
     assert_url url
-    end
   end
 
   def test_bing_country
-    address = "Australia"
-    VCR.use_cassette("bing_au") do
-      key = Geokit::Geocoders::BingGeocoder.key
-    url = "https://dev.virtualearth.net/REST/v1/Locations/#{URI.escape(address)}?key=#{key}&o=xml"
-    res = Geokit::Geocoders::BingGeocoder.geocode(address)
+    address = 'Australia'
+    key = geocoder_class.key
+    url = "#{@base_url}/#{URI.escape(address)}?key=#{key}&o=xml"
+    res = geocode(address, :bing_au)
     assert_equal nil, res.state
     assert_equal nil, res.city
     assert_array_in_delta [-25.585, 134.504], res.to_a
-    assert res.country == "Australia"
-    assert_equal "Australia", res.full_address
-    assert_equal "bing", res.provider
-    assert_equal "country", res.precision
+    assert res.country == 'Australia'
+    assert_equal 'Australia', res.full_address
+    assert_equal 'bing', res.provider
+    assert_equal 'country', res.precision
     assert_equal 8, res.accuracy
     assert_url url
-    end
   end
 end