geocoder 1.6.3 → 1.8.1

data/lib/geocoder/results/mapbox.rb

@@ -23,7 +23,10 @@ module Geocoder::Result
       context_part('region')
     end
 
-    alias_method :state_code, :state
+    def state_code
+      value = context_part('region', 'short_code')
+      value.split('-').last unless value.nil?
+    end
 
     def postal_code
       context_part('postcode')
@@ -33,7 +36,10 @@ module Geocoder::Result
       context_part('country')
     end
 
-    alias_method :country_code, :country
+    def country_code
+      value = context_part('country', 'short_code')
+      value.upcase unless value.nil?
+    end
 
     def neighborhood
       context_part('neighborhood')
@@ -45,8 +51,8 @@ module Geocoder::Result
 
     private
 
-    def context_part(name)
-      context.map { |c| c['text'] if c['id'] =~ Regexp.new(name) }.compact.first
+    def context_part(name, key = 'text')
+      (context.detect { |c| c['id'] =~ Regexp.new(name) } || {})[key]
     end
 
     def context

data/lib/geocoder/results/melissa_street.rb

@@ -0,0 +1,46 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class MelissaStreet < Base
+    def address(format = :full)
+      @data['FormattedAddress']
+    end
+
+    def street_address
+      @data['AddressLine1']
+    end
+
+    def suffix
+      @data['ThoroughfareTrailingType']
+    end
+
+    def number
+      @data['PremisesNumber']
+    end
+
+    def city
+      @data['Locality']
+    end
+
+    def state_code
+      @data['AdministrativeArea']
+    end
+    alias_method :state, :state_code
+
+    def country
+      @data['CountryName']
+    end
+
+    def country_code
+      @data['CountryISO3166_1_Alpha2']
+    end
+
+    def postal_code
+      @data['PostalCode']
+    end
+
+    def coordinates
+      [@data['Latitude'].to_f, @data['Longitude'].to_f]
+    end
+  end
+end

data/lib/geocoder/results/nationaal_georegister_nl.rb

@@ -8,7 +8,7 @@ module Geocoder::Result
     end
 
     def coordinates
-      @data['centroide_ll'][6..-2].split(' ').map(&:to_f)
+      @data['centroide_ll'][6..-2].split(' ').map(&:to_f).reverse
     end
 
     def formatted_address

data/lib/geocoder/results/nominatim.rb

@@ -4,12 +4,12 @@ module Geocoder::Result
   class Nominatim < Base
 
     def poi
-      return @data['address'][place_type] if @data['address'].key?(place_type)
+      return address_data[place_type] if address_data.key?(place_type)
       return nil
     end
 
     def house_number
-      @data['address']['house_number']
+      address_data['house_number']
     end
 
     def address
@@ -18,65 +18,71 @@ module Geocoder::Result
 
     def street
       %w[road pedestrian highway].each do |key|
-        return @data['address'][key] if @data['address'].key?(key)
+        return address_data[key] if address_data.key?(key)
       end
       return nil
     end
 
     def city
       %w[city town village hamlet].each do |key|
-        return @data['address'][key] if @data['address'].key?(key)
+        return address_data[key] if address_data.key?(key)
       end
       return nil
     end
 
     def village
-      @data['address']['village']
+      address_data['village']
     end
 
     def town
-      @data['address']['town']
+      address_data['town']
     end
 
     def state
-      @data['address']['state']
+      address_data['state']
     end
 
     alias_method :state_code, :state
 
     def postal_code
-      @data['address']['postcode']
+      address_data['postcode']
     end
 
     def county
-      @data['address']['county']
+      address_data['county']
     end
 
     def country
-      @data['address']['country']
+      address_data['country']
     end
 
     def country_code
-      @data['address']['country_code']
+      address_data['country_code']
     end
 
     def suburb
-      @data['address']['suburb']
+      address_data['suburb']
     end
 
     def city_district
-      @data['address']['city_district']
+      address_data['city_district']
     end
 
     def state_district
-      @data['address']['state_district']
+      address_data['state_district']
     end
 
     def neighbourhood
-      @data['address']['neighbourhood']
+      address_data['neighbourhood']
+    end
+
+    def municipality
+      address_data['municipality']
     end
 
     def coordinates
+      return [] unless @data['lat'] && @data['lon']
+
       [@data['lat'].to_f, @data['lon'].to_f]
     end
 
@@ -105,5 +111,11 @@ module Geocoder::Result
         end
       end
     end
+
+    private
+
+    def address_data
+      @data['address'] || {}
+    end
   end
 end

data/lib/geocoder/results/photon.rb

@@ -0,0 +1,119 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Photon < Base
+    def name
+      properties['name']
+    end
+
+    def address(_format = :full)
+      parts = []
+      parts << name if name
+      parts << street_address if street_address
+      parts << city
+      parts << state if state
+      parts << postal_code
+      parts << country
+
+      parts.join(', ')
+    end
+
+    def street_address
+      return unless street
+      return street unless house_number
+
+      "#{house_number} #{street}"
+    end
+
+    def house_number
+      properties['housenumber']
+    end
+
+    def street
+      properties['street']
+    end
+
+    def postal_code
+      properties['postcode']
+    end
+
+    def city
+      properties['city']
+    end
+
+    def state
+      properties['state']
+    end
+
+    def state_code
+      ''
+    end
+
+    def country
+      properties['country']
+    end
+
+    def country_code
+      ''
+    end
+
+    def coordinates
+      return unless geometry
+      return unless geometry[:coordinates]
+
+      geometry[:coordinates].reverse
+    end
+
+    def geometry
+      return unless data['geometry']
+
+      symbol_hash data['geometry']
+    end
+
+    def bounds
+      properties['extent']
+    end
+
+    # Type of the result (OSM object type), one of:
+    #
+    #   :node
+    #   :way
+    #   :relation
+    #
+    def type
+      {
+        'N' => :node,
+        'W' => :way,
+        'R' => :relation
+      }[properties['osm_type']]
+    end
+
+    def osm_id
+      properties['osm_id']
+    end
+
+    # See: https://wiki.openstreetmap.org/wiki/Tags
+    def osm_tag
+      return unless properties['osm_key']
+      return properties['osm_key'] unless properties['osm_value']
+
+      "#{properties['osm_key']}=#{properties['osm_value']}"
+    end
+
+    private
+
+    def properties
+      @properties ||= data['properties'] || {}
+    end
+
+    def symbol_hash(orig_hash)
+      {}.tap do |result|
+        orig_hash.each_key do |key|
+          next unless orig_hash[key]
+
+          result[key.to_sym] = orig_hash[key]
+        end
+      end
+    end
+  end
+end

data/lib/geocoder/results/twogis.rb

@@ -0,0 +1,76 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Twogis < Base
+    def coordinates
+      ['lat', 'lon'].map{ |i| @data['point'][i] } if @data['point']
+    end
+
+    def address(_format = :full)
+      @data['full_address_name'] || ''
+    end
+
+    def city
+      return '' unless @data['adm_div']
+      @data['adm_div'].select{|u| u["type"] == "city"}.first.try(:[], 'name') || ''
+    end
+
+    def region
+      return '' unless @data['adm_div']
+      @data['adm_div'].select{|u| u["type"] == "region"}.first.try(:[], 'name') || ''
+    end
+
+    def country
+      return '' unless @data['adm_div']
+      @data['adm_div'].select{|u| u["type"] == "country"}.first.try(:[], 'name') || ''
+    end
+
+    def district
+      return '' unless @data['adm_div']
+      @data['adm_div'].select{|u| u["type"] == "district"}.first.try(:[], 'name') || ''
+    end
+
+    def district_area
+      return '' unless @data['adm_div']
+      @data['adm_div'].select{|u| u["type"] == "district_area"}.first.try(:[], 'name') || ''
+    end
+
+    def street_address
+      @data['address_name'] || ''
+    end
+
+    def street
+      return '' unless @data['address_name']
+      @data['address_name'].split(', ').first
+    end
+
+    def street_number
+      return '' unless @data['address_name']
+      @data['address_name'].split(', ')[1] || ''
+    end
+
+    def type
+      @data['type'] || ''
+    end
+
+    def purpose_name
+      @data['purpose_name'] || ''
+    end
+
+    def building_name
+      @data['building_name'] || ''
+    end
+
+    def subtype
+      @data['subtype'] || ''
+    end
+
+    def subtype_specification
+      @data['subtype_specification'] || ''
+    end
+
+    def name
+      @data['name'] || ''
+    end
+  end
+end

data/lib/geocoder/util.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Geocoder
+  module Util
+    #
+    # Recursive version of Hash#merge!
+    #
+    # Adds the contents of +h2+ to +h1+,
+    # merging entries in +h1+ with duplicate keys with those from +h2+.
+    #
+    # Compared with Hash#merge!, this method supports nested hashes.
+    # When both +h1+ and +h2+ contains an entry with the same key,
+    # it merges and returns the values from both hashes.
+    #
+    #    h1 = {"a" => 100, "b" => 200, "c" => {"c1" => 12, "c2" => 14}}
+    #    h2 = {"b" => 254, "c" => {"c1" => 16, "c3" => 94}}
+    #    recursive_hash_merge(h1, h2)   #=> {"a" => 100, "b" => 254, "c" => {"c1" => 16, "c2" => 14, "c3" => 94}}
+    #
+    # Simply using Hash#merge! would return
+    #
+    #    h1.merge!(h2)    #=> {"a" => 100, "b" = >254, "c" => {"c1" => 16, "c3" => 94}}
+    #
+    def self.recursive_hash_merge(h1, h2)
+      h1.merge!(h2) do |_key, oldval, newval|
+        oldval.class == h1.class ? self.recursive_hash_merge(oldval, newval) : newval
+      end
+    end
+  end
+end

data/lib/geocoder/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.8.1
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2022-09-23 00:00:00.000000000 Z
 dependencies: []
 description: Object geocoding (by street or IP address), reverse geocoding (coordinates
   to street address), distance queries for ActiveRecord and Mongoid, result caching,
@@ -25,8 +25,7 @@ files:
 - README.md
 - bin/console
 - bin/geocode
-- examples/autoexpire_cache_dalli.rb
-- examples/autoexpire_cache_redis.rb
+- examples/app_defined_lookup_services.rb
 - examples/cache_bypass.rb
 - examples/reverse_geocode_job.rb
 - lib/easting_northing.rb
@@ -39,6 +38,9 @@ files:
 - lib/generators/geocoder/migration_version.rb
 - lib/geocoder.rb
 - lib/geocoder/cache.rb
+- lib/geocoder/cache_stores/base.rb
+- lib/geocoder/cache_stores/generic.rb
+- lib/geocoder/cache_stores/redis.rb
 - lib/geocoder/calculations.rb
 - lib/geocoder/cli.rb
 - lib/geocoder/configuration.rb
@@ -49,7 +51,9 @@ files:
 - lib/geocoder/kernel_logger.rb
 - lib/geocoder/logger.rb
 - lib/geocoder/lookup.rb
+- lib/geocoder/lookups/abstract_api.rb
 - lib/geocoder/lookups/amap.rb
+- lib/geocoder/lookups/amazon_location_service.rb
 - lib/geocoder/lookups/baidu.rb
 - lib/geocoder/lookups/baidu_ip.rb
 - lib/geocoder/lookups/ban_data_gouv_fr.rb
@@ -59,6 +63,7 @@ files:
 - lib/geocoder/lookups/dstk.rb
 - lib/geocoder/lookups/esri.rb
 - lib/geocoder/lookups/freegeoip.rb
+- lib/geocoder/lookups/geoapify.rb
 - lib/geocoder/lookups/geocoder_ca.rb
 - lib/geocoder/lookups/geocodio.rb
 - lib/geocoder/lookups/geoip2.rb
@@ -70,9 +75,11 @@ files:
 - lib/geocoder/lookups/here.rb
 - lib/geocoder/lookups/ip2location.rb
 - lib/geocoder/lookups/ipapi_com.rb
+- lib/geocoder/lookups/ipbase.rb
 - lib/geocoder/lookups/ipdata_co.rb
 - lib/geocoder/lookups/ipgeolocation.rb
 - lib/geocoder/lookups/ipinfo_io.rb
+- lib/geocoder/lookups/ipqualityscore.rb
 - lib/geocoder/lookups/ipregistry.rb
 - lib/geocoder/lookups/ipstack.rb
 - lib/geocoder/lookups/latlon.rb
@@ -82,11 +89,13 @@ files:
 - lib/geocoder/lookups/maxmind.rb
 - lib/geocoder/lookups/maxmind_geoip2.rb
 - lib/geocoder/lookups/maxmind_local.rb
+- lib/geocoder/lookups/melissa_street.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/photon.rb
 - lib/geocoder/lookups/pickpoint.rb
 - lib/geocoder/lookups/pointpin.rb
 - lib/geocoder/lookups/postcode_anywhere_uk.rb
@@ -95,6 +104,7 @@ files:
 - lib/geocoder/lookups/telize.rb
 - lib/geocoder/lookups/tencent.rb
 - lib/geocoder/lookups/test.rb
+- lib/geocoder/lookups/twogis.rb
 - lib/geocoder/lookups/uk_ordnance_survey_names.rb
 - lib/geocoder/lookups/yandex.rb
 - lib/geocoder/models/active_record.rb
@@ -105,7 +115,9 @@ files:
 - lib/geocoder/query.rb
 - lib/geocoder/railtie.rb
 - lib/geocoder/request.rb
+- lib/geocoder/results/abstract_api.rb
 - lib/geocoder/results/amap.rb
+- lib/geocoder/results/amazon_location_service.rb
 - lib/geocoder/results/baidu.rb
 - lib/geocoder/results/baidu_ip.rb
 - lib/geocoder/results/ban_data_gouv_fr.rb
@@ -115,6 +127,7 @@ files:
 - lib/geocoder/results/dstk.rb
 - lib/geocoder/results/esri.rb
 - lib/geocoder/results/freegeoip.rb
+- lib/geocoder/results/geoapify.rb
 - lib/geocoder/results/geocoder_ca.rb
 - lib/geocoder/results/geocodio.rb
 - lib/geocoder/results/geoip2.rb
@@ -126,9 +139,11 @@ files:
 - lib/geocoder/results/here.rb
 - lib/geocoder/results/ip2location.rb
 - lib/geocoder/results/ipapi_com.rb
+- lib/geocoder/results/ipbase.rb
 - lib/geocoder/results/ipdata_co.rb
 - lib/geocoder/results/ipgeolocation.rb
 - lib/geocoder/results/ipinfo_io.rb
+- lib/geocoder/results/ipqualityscore.rb
 - lib/geocoder/results/ipregistry.rb
 - lib/geocoder/results/ipstack.rb
 - lib/geocoder/results/latlon.rb
@@ -138,11 +153,13 @@ files:
 - lib/geocoder/results/maxmind.rb
 - lib/geocoder/results/maxmind_geoip2.rb
 - lib/geocoder/results/maxmind_local.rb
+- lib/geocoder/results/melissa_street.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/photon.rb
 - lib/geocoder/results/pickpoint.rb
 - lib/geocoder/results/pointpin.rb
 - lib/geocoder/results/postcode_anywhere_uk.rb
@@ -151,6 +168,7 @@ files:
 - lib/geocoder/results/telize.rb
 - lib/geocoder/results/tencent.rb
 - lib/geocoder/results/test.rb
+- lib/geocoder/results/twogis.rb
 - lib/geocoder/results/uk_ordnance_survey_names.rb
 - lib/geocoder/results/yandex.rb
 - lib/geocoder/sql.rb
@@ -159,8 +177,8 @@ files:
 - lib/geocoder/stores/mongo_base.rb
 - lib/geocoder/stores/mongo_mapper.rb
 - lib/geocoder/stores/mongoid.rb
+- lib/geocoder/util.rb
 - lib/geocoder/version.rb
-- lib/hash_recursive_merge.rb
 - lib/maxmind_database.rb
 - lib/tasks/geocoder.rake
 - lib/tasks/maxmind.rake
@@ -185,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Complete geocoding solution for Ruby.

data/examples/autoexpire_cache_dalli.rb

@@ -1,62 +0,0 @@
-# This class implements a cache with simple delegation to the the Dalli Memcached client
-# https://github.com/mperham/dalli
-#
-# A TTL is set on initialization
-
-class AutoexpireCacheDalli
-  def initialize(store, ttl = 86400)
-    @store = store
-    @keys = 'GeocoderDalliClientKeys'
-    @ttl = ttl
-  end
-
-  def [](url)
-    res = @store.get(url)
-    res = YAML::load(res) if res.present?
-    res
-  end
-
-  def []=(url, value)
-    if value.nil?
-      del(url)
-    else
-      key_cache_add(url) if @store.add(url, YAML::dump(value), @ttl)
-    end
-    value
-  end
-
-  def keys
-    key_cache
-  end
-
-  def del(url)
-    key_cache_delete(url) if @store.delete(url)
-  end
-
-  private
-
-  def key_cache
-    the_keys = @store.get(@keys)
-    if the_keys.nil?
-      @store.add(@keys, YAML::dump([]))
-      []
-    else
-      YAML::load(the_keys)
-    end
-  end
-
-  def key_cache_add(key)
-    @store.replace(@keys, YAML::dump(key_cache << key))
-  end
-
-  def key_cache_delete(key)
-    tmp = key_cache
-    tmp.delete(key)
-    @store.replace(@keys, YAML::dump(tmp))
-  end
-end
-
-# Here Dalli is set up as on Heroku using the Memcachier gem.
-# https://devcenter.heroku.com/articles/memcachier#ruby
-# On other setups you might have to specify your Memcached server in Dalli::Client.new
-Geocoder.configure(:cache => AutoexpireCacheDalli.new(Dalli::Client.new))

data/examples/autoexpire_cache_redis.rb

@@ -1,30 +0,0 @@
-# This class implements a cache with simple delegation to the Redis store, but
-# when it creates a key/value pair, it also sends an EXPIRE command with a TTL.
-# It should be fairly simple to do the same thing with Memcached.
-# Alternatively, this class could inherit from Redis, which would make most
-# of the below methods unnecessary.
-class AutoexpireCacheRedis
-  def initialize(store, ttl = 86400)
-    @store = store
-    @ttl = ttl
-  end
-
-  def [](url)
-    @store.get(url)
-  end
-
-  def []=(url, value)
-    @store.set(url, value)
-    @store.expire(url, @ttl)
-  end
-
-  def keys
-    @store.keys
-  end
-
-  def del(url)
-    @store.del(url)
-  end
-end
-
-Geocoder.configure(:cache => AutoexpireCacheRedis.new(Redis.new))