geocoder 1.6.6 → 1.8.5

data/lib/geocoder/results/pc_miler.rb

@@ -0,0 +1,98 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class PcMiler < Base
+    # sample response:
+    # https://singlesearch.alk.com/na/api/search?authToken=<TOKEN>&include=Meta&query=Feasterville
+    #
+    #   {
+    #     "Err": 0,
+    #     "ErrString": "OK",
+    #     "QueryConfidence": 1,
+    #     "TimeInMilliseconds": 93,
+    #     "GridDataVersion": "GRD_ALK.NA.2023.01.18.29.1.1",
+    #     "CommitID": "pcmws-22.08.11.0-1778-g586da49bd1b: 05/30/2023 20:14",
+    #     "Locations": [
+    #       {
+    #         "Address": {
+    #           "StreetAddress": "",
+    #           "LocalArea": "",
+    #           "City": "Feasterville",
+    #           "State": "PA",
+    #           "StateName": "Pennsylvania",
+    #           "Zip": "19053",
+    #           "County": "Bucks",
+    #           "Country": "US",
+    #           "CountryFullName": "United States",
+    #           "SPLC": null
+    #         },
+    #         "Coords": {
+    #           "Lat": "40.150025",
+    #           "Lon": "-75.002511"
+    #         },
+    #         "StreetCoords": {
+    #           "Lat": "40.150098",
+    #           "Lon": "-75.002827"
+    #         },
+    #         "Region": 4,
+    #         "POITypeID": 0,
+    #         "PersistentPOIID": -1,
+    #         "SiteID": -1,
+    #         "ResultType": 4,
+    #         "ShortString": "Feasterville",
+    #         "GridID": 37172748,
+    #         "LinkID": 188,
+    #         "Percent": 6291,
+    #         "TimeZone": "GMT-4:00 EDT"
+    #       }
+    #     ]
+    #   }
+
+    def address(format=:unused)
+      [street, city, state, postal_code, country]
+      .map { |i| i == '' ? nil : i }
+      .compact
+      .join(', ')
+    end
+
+    def coordinates
+      coords = data["Coords"] || {}
+      [coords["Lat"].to_f, coords["Lon"].to_f]
+    end
+
+    def street
+      address_data["StreetAddress"]
+    end
+
+    def city
+      address_data["City"]
+    end
+
+    def state
+      address_data["StateName"]
+    end
+
+    def state_code
+      address_data["State"]
+    end
+
+    def postal_code
+      address_data["Zip"]
+    end
+
+    def country
+      address_data["CountryFullName"]
+    end
+
+    def country_code
+      address_data["Country"]
+    end
+
+    private
+
+    def address_data
+      data["Address"] || {}
+    end
+  end
+end
+

data/lib/geocoder/results/pdok_nl.rb

@@ -0,0 +1,62 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class PdokNl < Base
+
+    def response_attributes
+      @data
+    end
+
+    def coordinates
+      @data['centroide_ll'][6..-2].split(' ').map(&:to_f).reverse
+    end
+
+    def formatted_address
+      @data['weergavenaam']
+    end
+
+    alias_method :address, :formatted_address
+
+    def province
+      @data['provincienaam']
+    end
+
+    alias_method :state, :province
+
+    def city
+      @data['woonplaatsnaam']
+    end
+
+    def district
+      @data['gemeentenaam']
+    end
+
+    def street
+      @data['straatnaam']
+    end
+
+    def street_number
+      @data['huis_nlt']
+    end
+
+    def address_components
+      @data
+    end
+
+    def state_code
+      @data['provinciecode']
+    end
+
+    def postal_code
+      @data['postcode']
+    end
+
+    def country
+      "Netherlands"
+    end
+
+    def country_code
+      "NL"
+    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/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.6.6"
+  VERSION = "1.8.5"
 end

data/lib/maxmind_database.rb

@@ -6,9 +6,9 @@ module Geocoder
     extend self
 
     def download(package, dir = "tmp")
-      filepath = File.expand_path(File.join(dir, archive_filename(package)))
+      filepath = File.expand_path(File.join(dir, "#{archive_edition(package)}.zip"))
       open(filepath, 'wb') do |file|
-        uri = URI.parse(archive_url(package))
+        uri = URI.parse(base_url(package))
         Net::HTTP.start(uri.host, uri.port) do |http|
           http.request_get(uri.path) do |resp|
             # TODO: show progress
@@ -35,6 +35,14 @@ module Geocoder
       p[s..-1]
     end
 
+    def archive_edition(package)
+      {
+        geolite_country_csv: "GeoLite2-Country-CSV",
+        geolite_city_csv: "GeoLite2-City-CSV",
+        geolite_asn_csv: "GeoLite2-ASN-CSV"
+      }[package]
+    end
+
     private # -------------------------------------------------------------
 
     def table_columns(table_name)
@@ -94,16 +102,8 @@ module Geocoder
       base_url + archive_url_path(package)
     end
 
-    def archive_url_path(package)
-      {
-        geolite_country_csv: "GeoLite2-Country-CSV.zip",
-        geolite_city_csv: "GeoLite2-City-CSV.zip",
-        geolite_asn_csv: "GeoLite2-ASN-CSV.zip"
-      }[package]
-    end
-
-    def base_url
-      "http://geolite.maxmind.com/download/geoip/database/"
+    def base_url(edition)
+      "https://download.maxmind.com/app/geoip_download?edition_id=#{edition}&license_key=#{ENV['LICENSE_KEY']}&suffix=zip"
     end
   end
 end

data/lib/tasks/maxmind.rake

@@ -54,7 +54,7 @@ module MaxmindTask
     end
     require 'fileutils'
     p = "geolite_#{package}_csv".intern
-    archive_filename = Geocoder::MaxmindDatabase.archive_filename(p)
+    archive_filename = "#{Geocoder::MaxmindDatabase.archive_edition(p)}.zip"
     Zip::File.open(File.join(options[:dir], archive_filename)).each do |entry|
       filepath = File.join(options[:dir], entry.name)
       if File.exist? filepath

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.6.6
+  version: 1.8.5
 platform: ruby
 authors:
 - Alex Reisner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
-dependencies: []
+date: 2024-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 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.
@@ -25,8 +53,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 +66,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,16 +79,19 @@ 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/azure.rb
 - lib/geocoder/lookups/baidu.rb
 - lib/geocoder/lookups/baidu_ip.rb
 - lib/geocoder/lookups/ban_data_gouv_fr.rb
 - lib/geocoder/lookups/base.rb
 - lib/geocoder/lookups/bing.rb
 - lib/geocoder/lookups/db_ip_com.rb
-- 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
@@ -69,10 +102,14 @@ files:
 - lib/geocoder/lookups/google_premier.rb
 - lib/geocoder/lookups/here.rb
 - lib/geocoder/lookups/ip2location.rb
+- lib/geocoder/lookups/ip2location_io.rb
+- lib/geocoder/lookups/ip2location_lite.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 +119,15 @@ 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/pc_miler.rb
+- lib/geocoder/lookups/pdok_nl.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 +136,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,16 +147,19 @@ 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/azure.rb
 - lib/geocoder/results/baidu.rb
 - lib/geocoder/results/baidu_ip.rb
 - lib/geocoder/results/ban_data_gouv_fr.rb
 - lib/geocoder/results/base.rb
 - lib/geocoder/results/bing.rb
 - lib/geocoder/results/db_ip_com.rb
-- 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
@@ -125,10 +170,14 @@ files:
 - lib/geocoder/results/google_premier.rb
 - lib/geocoder/results/here.rb
 - lib/geocoder/results/ip2location.rb
+- lib/geocoder/results/ip2location_io.rb
+- lib/geocoder/results/ip2location_lite.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 +187,15 @@ 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/pc_miler.rb
+- lib/geocoder/results/pdok_nl.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 +204,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
@@ -170,7 +224,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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -185,8 +239,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Complete geocoding solution for Ruby.
 test_files: []

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))