geocoder 1.5.1 → 1.6.3

data/lib/geocoder/results/yandex.rb

@@ -2,78 +2,223 @@ require 'geocoder/results/base'
 
 module Geocoder::Result
   class Yandex < Base
+    # Yandex result has difficult tree structure,
+    # and presence of some nodes depends on exact search case.
+
+    # Also Yandex lacks documentation about it.
+    # See https://tech.yandex.com/maps/doc/geocoder/desc/concepts/response_structure-docpage/
+
+    # Ultimatly, we need to find Locality and/or Thoroughfare data.
+
+    # It may resides on the top (ADDRESS_DETAILS) level.
+    # example: 'Baltic Sea'
+    # "AddressDetails": {
+    #   "Locality": {
+    #     "Premise": {
+    #       "PremiseName": "Baltic Sea"
+    #     }
+    #   }
+    # }
+
+    ADDRESS_DETAILS = %w[
+      GeoObject metaDataProperty GeocoderMetaData
+      AddressDetails
+    ].freeze
+
+    # On COUNTRY_LEVEL.
+    # example: 'Potomak'
+    # "AddressDetails": {
+    #   "Country": {
+    #     "AddressLine": "reka Potomak",
+    #     "CountryNameCode": "US",
+    #     "CountryName": "United States of America",
+    #     "Locality": {
+    #       "Premise": {
+    #         "PremiseName": "reka Potomak"
+    #       }
+    #     }
+    #   }
+    # }
+
+    COUNTRY_LEVEL = %w[
+      GeoObject metaDataProperty GeocoderMetaData
+      AddressDetails Country
+    ].freeze
+
+    # On ADMIN_LEVEL (usually state or city)
+    # example: 'Moscow, Tverskaya'
+    # "AddressDetails": {
+    #   "Country": {
+    #     "AddressLine": "Moscow, Tverskaya Street",
+    #     "CountryNameCode": "RU",
+    #     "CountryName": "Russia",
+    #     "AdministrativeArea": {
+    #       "AdministrativeAreaName": "Moscow",
+    #       "Locality": {
+    #         "LocalityName": "Moscow",
+    #         "Thoroughfare": {
+    #           "ThoroughfareName": "Tverskaya Street"
+    #         }
+    #       }
+    #     }
+    #   }
+    # }
+
+    ADMIN_LEVEL = %w[
+      GeoObject metaDataProperty GeocoderMetaData
+      AddressDetails Country
+      AdministrativeArea
+    ].freeze
+
+    # On SUBADMIN_LEVEL (may refer to urban district)
+    # example: 'Moscow Region, Krasnogorsk'
+    # "AddressDetails": {
+    #   "Country": {
+    #     "AddressLine": "Moscow Region, Krasnogorsk",
+    #     "CountryNameCode": "RU",
+    #     "CountryName": "Russia",
+    #     "AdministrativeArea": {
+    #       "AdministrativeAreaName": "Moscow Region",
+    #       "SubAdministrativeArea": {
+    #         "SubAdministrativeAreaName": "gorodskoy okrug Krasnogorsk",
+    #         "Locality": {
+    #           "LocalityName": "Krasnogorsk"
+    #         }
+    #       }
+    #     }
+    #   }
+    # }
+
+    SUBADMIN_LEVEL = %w[
+      GeoObject metaDataProperty GeocoderMetaData
+      AddressDetails Country
+      AdministrativeArea
+      SubAdministrativeArea
+    ].freeze
+
+    # On DEPENDENT_LOCALITY_1 (may refer to district of city)
+    # example: 'Paris, Etienne Marcel'
+    # "AddressDetails": {
+    #   "Country": {
+    #     "AddressLine": "Île-de-France, Paris, 1er Arrondissement, Rue Étienne Marcel",
+    #     "CountryNameCode": "FR",
+    #     "CountryName": "France",
+    #     "AdministrativeArea": {
+    #       "AdministrativeAreaName": "Île-de-France",
+    #       "Locality": {
+    #         "LocalityName": "Paris",
+    #         "DependentLocality": {
+    #           "DependentLocalityName": "1er Arrondissement",
+    #           "Thoroughfare": {
+    #             "ThoroughfareName": "Rue Étienne Marcel"
+    #           }
+    #         }
+    #       }
+    #     }
+    #   }
+    # }
+
+    DEPENDENT_LOCALITY_1 = %w[
+      GeoObject metaDataProperty GeocoderMetaData
+      AddressDetails Country
+      AdministrativeArea Locality
+      DependentLocality
+    ].freeze
+
+    # On DEPENDENT_LOCALITY_2 (for special cases like turkish "mahalle")
+    # https://en.wikipedia.org/wiki/Mahalle
+    # example: 'Istanbul Mabeyinci Yokuşu 17'
+
+    # "AddressDetails": {
+    #   "Country": {
+    #     "AddressLine": "İstanbul, Fatih, Saraç İshak Mah., Mabeyinci Yokuşu, 17",
+    #     "CountryNameCode": "TR",
+    #     "CountryName": "Turkey",
+    #     "AdministrativeArea": {
+    #       "AdministrativeAreaName": "İstanbul",
+    #       "SubAdministrativeArea": {
+    #         "SubAdministrativeAreaName": "Fatih",
+    #         "Locality": {
+    #           "DependentLocality": {
+    #             "DependentLocalityName": "Saraç İshak Mah.",
+    #             "Thoroughfare": {
+    #               "ThoroughfareName": "Mabeyinci Yokuşu",
+    #               "Premise": {
+    #                 "PremiseNumber": "17"
+    #               }
+    #             }
+    #           }
+    #         }
+    #       }
+    #     }
+    #   }
+    # }
+
+    DEPENDENT_LOCALITY_2 = %w[
+      GeoObject metaDataProperty GeocoderMetaData
+      AddressDetails Country
+      AdministrativeArea
+      SubAdministrativeArea Locality
+      DependentLocality
+    ].freeze
 
     def coordinates
       @data['GeoObject']['Point']['pos'].split(' ').reverse.map(&:to_f)
     end
 
-    def address(format = :full)
+    def address(_format = :full)
       @data['GeoObject']['metaDataProperty']['GeocoderMetaData']['text']
     end
 
     def city
-      if state.empty? and address_details and address_details.has_key? 'Locality'
-        address_details['Locality']['LocalityName']
-      elsif sub_state.empty? and address_details and address_details.has_key? 'AdministrativeArea' and
-          address_details['AdministrativeArea'].has_key? 'Locality'
-        address_details['AdministrativeArea']['Locality']['LocalityName']
-      elsif not sub_state_city.empty?
-        sub_state_city
-      else
-        ""
-      end
+      result =
+        if state.empty?
+          find_in_hash(@data, *COUNTRY_LEVEL, 'Locality', 'LocalityName')
+        elsif sub_state.empty?
+          find_in_hash(@data, *ADMIN_LEVEL, 'Locality', 'LocalityName')
+        else
+          find_in_hash(@data, *SUBADMIN_LEVEL, 'Locality', 'LocalityName')
+        end
+
+      result || ""
     end
 
     def country
-      if address_details
-        address_details['CountryName']
-      else
-        ""
-      end
+      find_in_hash(@data, *COUNTRY_LEVEL, 'CountryName') || ""
     end
 
     def country_code
-      if address_details
-        address_details['CountryNameCode']
-      else
-        ""
-      end
+      find_in_hash(@data, *COUNTRY_LEVEL, 'CountryNameCode') || ""
     end
 
     def state
-      if address_details and address_details['AdministrativeArea']
-        address_details['AdministrativeArea']['AdministrativeAreaName']
-      else
-        ""
-      end
+      find_in_hash(@data, *ADMIN_LEVEL, 'AdministrativeAreaName') || ""
     end
 
     def sub_state
-      if !state.empty? and address_details and address_details['AdministrativeArea']['SubAdministrativeArea']
-        address_details['AdministrativeArea']['SubAdministrativeArea']['SubAdministrativeAreaName']
-      else
-        ""
-      end
+      return "" if state.empty?
+      find_in_hash(@data, *SUBADMIN_LEVEL, 'SubAdministrativeAreaName') || ""
     end
 
     def state_code
       ""
     end
 
-    def postal_code
-      ""
+    def street
+      thoroughfare_data.is_a?(Hash) ? thoroughfare_data['ThoroughfareName'] : ""
     end
 
-    def premise_name
-      address_details['Locality']['Premise']['PremiseName']
+    def street_number
+      premise.is_a?(Hash) ? premise.fetch('PremiseNumber', "") : ""
     end
 
-    def street
-      thoroughfare_data && thoroughfare_data['ThoroughfareName']
+    def premise_name
+      premise.is_a?(Hash) ? premise.fetch('PremiseName', "") : ""
     end
 
-    def street_number
-      thoroughfare_data && thoroughfare_data['Premise'] && thoroughfare_data['Premise']['PremiseNumber']
+    def postal_code
+      return "" unless premise.is_a?(Hash)
+      find_in_hash(premise, 'PostalCode', 'PostalCodeNumber') || ""
     end
 
     def kind
@@ -93,42 +238,55 @@ module Geocoder::Result
 
     private # ----------------------------------------------------------------
 
-    def thoroughfare_data
-      locality_data && locality_data['Thoroughfare']
+    def top_level_locality
+      find_in_hash(@data, *ADDRESS_DETAILS, 'Locality')
     end
 
-    def locality_data
-      dependent_locality && subadmin_locality && admin_locality
+    def country_level_locality
+      find_in_hash(@data, *COUNTRY_LEVEL, 'Locality')
     end
 
     def admin_locality
-      address_details && address_details['AdministrativeArea'] &&
-        address_details['AdministrativeArea']['Locality']
+      find_in_hash(@data, *ADMIN_LEVEL, 'Locality')
     end
 
     def subadmin_locality
-      address_details && address_details['AdministrativeArea'] &&
-        address_details['AdministrativeArea']['SubAdministrativeArea'] &&
-        address_details['AdministrativeArea']['SubAdministrativeArea']['Locality']
+      find_in_hash(@data, *SUBADMIN_LEVEL, 'Locality')
     end
 
     def dependent_locality
-      address_details && address_details['AdministrativeArea'] &&
-        address_details['AdministrativeArea']['SubAdministrativeArea'] &&
-        address_details['AdministrativeArea']['SubAdministrativeArea']['Locality'] &&
-        address_details['AdministrativeArea']['SubAdministrativeArea']['Locality']['DependentLocality']
+      find_in_hash(@data, *DEPENDENT_LOCALITY_1) ||
+        find_in_hash(@data, *DEPENDENT_LOCALITY_2)
+    end
+
+    def locality_data
+      dependent_locality || subadmin_locality || admin_locality ||
+        country_level_locality || top_level_locality
+    end
+
+    def thoroughfare_data
+      locality_data['Thoroughfare'] if locality_data.is_a?(Hash)
     end
 
-    def address_details
-      @data['GeoObject']['metaDataProperty']['GeocoderMetaData']['AddressDetails']['Country']
+    def premise
+      if thoroughfare_data.is_a?(Hash)
+        thoroughfare_data['Premise']
+      elsif locality_data.is_a?(Hash)
+        locality_data['Premise']
+      end
     end
 
-    def sub_state_city
-      if !sub_state.empty? and address_details and address_details['AdministrativeArea']['SubAdministrativeArea'].has_key? 'Locality'
-        address_details['AdministrativeArea']['SubAdministrativeArea']['Locality']['LocalityName'] || ""
-      else
-        ""
+    def find_in_hash(source, *keys)
+      key = keys.shift
+      result = source[key]
+
+      if keys.empty?
+        return result
+      elsif !result.is_a?(Hash)
+        return nil
       end
+
+      find_in_hash(result, *keys)
     end
   end
 end

data/lib/geocoder/sql.rb

@@ -44,13 +44,13 @@ module Geocoder
     end
 
     def within_bounding_box(sw_lat, sw_lng, ne_lat, ne_lng, lat_attr, lon_attr)
-      spans = "#{lat_attr} BETWEEN #{sw_lat} AND #{ne_lat} AND "
+      spans = "#{lat_attr} BETWEEN #{sw_lat.to_f} AND #{ne_lat.to_f} AND "
       # handle box that spans 180 longitude
       if sw_lng.to_f > ne_lng.to_f
-        spans + "(#{lon_attr} BETWEEN #{sw_lng} AND 180 OR " +
-        "#{lon_attr} BETWEEN -180 AND #{ne_lng})"
+        spans + "(#{lon_attr} BETWEEN #{sw_lng.to_f} AND 180 OR " +
+        "#{lon_attr} BETWEEN -180 AND #{ne_lng.to_f})"
       else
-        spans + "#{lon_attr} BETWEEN #{sw_lng} AND #{ne_lng}"
+        spans + "#{lon_attr} BETWEEN #{sw_lng.to_f} AND #{ne_lng.to_f}"
       end
     end
 

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.5.1"
+  VERSION = "1.6.3"
 end

data/lib/hash_recursive_merge.rb

@@ -60,9 +60,8 @@ module HashRecursiveMerge
   #    h1.merge(h2)     #=> {"a" => 100, "b" = >254, "c" => {"c1" => 16, "c3" => 94}}
   # 
   def rmerge(other_hash)
-    r = {}
     merge(other_hash) do |key, oldval, newval|
-      r[key] = oldval.class == self.class ? oldval.rmerge(newval) : newval
+      oldval.class == self.class ? oldval.rmerge(newval) : newval
     end
   end
 

data/lib/maxmind_database.rb

@@ -96,9 +96,9 @@ module Geocoder
 
     def archive_url_path(package)
       {
-        geolite_country_csv: "GeoIPCountryCSV.zip",
-        geolite_city_csv: "GeoLiteCity_CSV/GeoLiteCity-latest.zip",
-        geolite_asn_csv: "asnum/GeoIPASNum2.zip"
+        geolite_country_csv: "GeoLite2-Country-CSV.zip",
+        geolite_city_csv: "GeoLite2-City-CSV.zip",
+        geolite_asn_csv: "GeoLite2-ASN-CSV.zip"
       }[package]
     end
 

metadata

@@ -1,19 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.3
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies: []
-description: Provides object geocoding (by street or IP address), reverse geocoding
-  (coordinates to street address), distance queries for ActiveRecord and Mongoid,
-  result caching, and more. Designed for Rails but works with Sinatra and other Rack
-  frameworks too.
+description: Object geocoding (by street or IP address), reverse geocoding (coordinates
+  to street address), distance queries for ActiveRecord and Mongoid, result caching,
+  and more. Designed for Rails but works with Sinatra and other Rack frameworks too.
 email:
 - alex@alexreisner.com
 executables:
@@ -24,11 +23,13 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- bin/console
 - bin/geocode
 - examples/autoexpire_cache_dalli.rb
 - examples/autoexpire_cache_redis.rb
 - examples/cache_bypass.rb
 - examples/reverse_geocode_job.rb
+- lib/easting_northing.rb
 - lib/generators/geocoder/config/config_generator.rb
 - lib/generators/geocoder/config/templates/initializer.rb
 - lib/generators/geocoder/maxmind/geolite_city_generator.rb
@@ -59,7 +60,6 @@ files:
 - lib/geocoder/lookups/esri.rb
 - lib/geocoder/lookups/freegeoip.rb
 - lib/geocoder/lookups/geocoder_ca.rb
-- lib/geocoder/lookups/geocoder_us.rb
 - lib/geocoder/lookups/geocodio.rb
 - lib/geocoder/lookups/geoip2.rb
 - lib/geocoder/lookups/geoportail_lu.rb
@@ -71,7 +71,9 @@ files:
 - lib/geocoder/lookups/ip2location.rb
 - lib/geocoder/lookups/ipapi_com.rb
 - lib/geocoder/lookups/ipdata_co.rb
+- lib/geocoder/lookups/ipgeolocation.rb
 - lib/geocoder/lookups/ipinfo_io.rb
+- lib/geocoder/lookups/ipregistry.rb
 - lib/geocoder/lookups/ipstack.rb
 - lib/geocoder/lookups/latlon.rb
 - lib/geocoder/lookups/location_iq.rb
@@ -80,8 +82,10 @@ files:
 - lib/geocoder/lookups/maxmind.rb
 - lib/geocoder/lookups/maxmind_geoip2.rb
 - lib/geocoder/lookups/maxmind_local.rb
+- lib/geocoder/lookups/nationaal_georegister_nl.rb
 - lib/geocoder/lookups/nominatim.rb
 - lib/geocoder/lookups/opencagedata.rb
+- lib/geocoder/lookups/osmnames.rb
 - lib/geocoder/lookups/pelias.rb
 - lib/geocoder/lookups/pickpoint.rb
 - lib/geocoder/lookups/pointpin.rb
@@ -91,6 +95,7 @@ files:
 - lib/geocoder/lookups/telize.rb
 - lib/geocoder/lookups/tencent.rb
 - lib/geocoder/lookups/test.rb
+- lib/geocoder/lookups/uk_ordnance_survey_names.rb
 - lib/geocoder/lookups/yandex.rb
 - lib/geocoder/models/active_record.rb
 - lib/geocoder/models/base.rb
@@ -111,7 +116,6 @@ files:
 - lib/geocoder/results/esri.rb
 - lib/geocoder/results/freegeoip.rb
 - lib/geocoder/results/geocoder_ca.rb
-- lib/geocoder/results/geocoder_us.rb
 - lib/geocoder/results/geocodio.rb
 - lib/geocoder/results/geoip2.rb
 - lib/geocoder/results/geoportail_lu.rb
@@ -123,7 +127,9 @@ files:
 - lib/geocoder/results/ip2location.rb
 - lib/geocoder/results/ipapi_com.rb
 - lib/geocoder/results/ipdata_co.rb
+- lib/geocoder/results/ipgeolocation.rb
 - lib/geocoder/results/ipinfo_io.rb
+- lib/geocoder/results/ipregistry.rb
 - lib/geocoder/results/ipstack.rb
 - lib/geocoder/results/latlon.rb
 - lib/geocoder/results/location_iq.rb
@@ -132,8 +138,10 @@ files:
 - lib/geocoder/results/maxmind.rb
 - lib/geocoder/results/maxmind_geoip2.rb
 - lib/geocoder/results/maxmind_local.rb
+- lib/geocoder/results/nationaal_georegister_nl.rb
 - lib/geocoder/results/nominatim.rb
 - lib/geocoder/results/opencagedata.rb
+- lib/geocoder/results/osmnames.rb
 - lib/geocoder/results/pelias.rb
 - lib/geocoder/results/pickpoint.rb
 - lib/geocoder/results/pointpin.rb
@@ -143,6 +151,7 @@ files:
 - lib/geocoder/results/telize.rb
 - lib/geocoder/results/tencent.rb
 - lib/geocoder/results/test.rb
+- lib/geocoder/results/uk_ordnance_survey_names.rb
 - lib/geocoder/results/yandex.rb
 - lib/geocoder/sql.rb
 - lib/geocoder/stores/active_record.rb
@@ -161,11 +170,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/alexreisner/geocoder
   changelog_uri: https://github.com/alexreisner/geocoder/blob/master/CHANGELOG.md
-post_install_message: |2+
-
-
-  NOTE: Geocoder's default IP address lookup has changed from FreeGeoIP.net to IPInfo.io. If you explicitly specify :freegeoip in your configuration you must choose a different IP lookup before FreeGeoIP is discontinued on July 1, 2018. If you do not explicitly specify :freegeoip you do not need to change anything.
-
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -180,8 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Complete geocoding solution for Ruby.