geocoder 1.8.1 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35c6a6d57b8ff3818e9d1b616558a8bbdc3b4b51db2b2c7dadb720eccafd27b4
-  data.tar.gz: 8e8fe1ba7cb9da58131a965d3d85589084f4d5dd70409990f49b89b83923f4e3
+  metadata.gz: 26c7b5c88c38ee619a8fdc7452014b9601db83539334353758d451d2b300faf2
+  data.tar.gz: 873c8a8148b792c43302b921665880d2f4b54cdc8ad7e4698fafee4e2a24c8b4
 SHA512:
-  metadata.gz: 0bbf04cc8488a533038783e2d250706fb2d2439de8ea1e5bf4b89950d1dd51d5e9393454540a23cb4e7fbc33b58f54fec1c71c14c98d6fbe8bb8e5caad786989
-  data.tar.gz: 92b8f5933a421b47cdededea9c8e8df8d2ec6f45cb25c8726b343a773b315929529fe821cae08868576ae2e8c5cdbc5fd1782bd2bfc8c56f36afdc1514f52b58
+  metadata.gz: c8fc1e15bfb40407c0f3bcd31030defaf9af58be2c7c49d84efaa5b8ce3828cafd54d3c2a63d08920db4f2701934ac6c3ac9df52888c27fbfd8a05036da11bb5
+  data.tar.gz: 1114e5142f8e8e358fa143fb143b0ea833c611bc2ab92bcbe0d04dc62d0965d46149651d7c3847f967c76a5997a3fba1d0d43a997aee2287268a48ac041e08c7

data/CHANGELOG.md

@@ -3,6 +3,11 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.8.2 (2023 Jul  4)
+-------------------
+* Add support for PC Miler lookup (thanks github.com/alexdean).
+* Minor fixes for :maxmind_local, :esri, and :ban_data_gouv_fr lookups.
+
 1.8.1 (2022 Sep 23)
 -------------------
 * Add support for IPBase lookup (thanks github.com/jonallured).

data/README.md

@@ -5,7 +5,6 @@ Geocoder
 
 [![Gem Version](https://badge.fury.io/rb/geocoder.svg)](http://badge.fury.io/rb/geocoder)
 [![Code Climate](https://codeclimate.com/github/alexreisner/geocoder/badges/gpa.svg)](https://codeclimate.com/github/alexreisner/geocoder)
-[![Build Status](https://travis-ci.com/alexreisner/geocoder.svg?branch=master)](https://travis-ci.com/alexreisner/geocoder)
 
 Key features:
 
@@ -368,7 +367,7 @@ If you need to expire cached content:
 ```ruby
 Geocoder::Lookup.get(Geocoder.config[:lookup]).cache.expire(:all)  # expire cached results for current Lookup
 Geocoder::Lookup.get(:nominatim).cache.expire("http://...")        # expire cached result for a specific URL
-Geocoder::Lookup.get(:nominatim).cache.expire(:all)                # expire cached results for Google Lookup
+Geocoder::Lookup.get(:nominatim).cache.expire(:all)                # expire cached results for Nominatim
 # expire all cached results for all Lookups.
 # Be aware that this methods spawns a new Lookup object for each Service
 Geocoder::Lookup.all_services.each{|service| Geocoder::Lookup.get(service).cache.expire(:all)}
@@ -376,10 +375,9 @@ Geocoder::Lookup.all_services.each{|service| Geocoder::Lookup.get(service).cache
 
 Do *not* include the prefix when passing a URL to be expired. Expiring `:all` will only expire keys with the configured prefix -- it will *not* expire every entry in your key/value store.
 
-For an example of a cache store with URL expiry, please see examples/autoexpire_cache.rb
-
 _Before you implement caching in your app please be sure that doing so does not violate the Terms of Service for your geocoding service._
 
+Not all services support caching, [check the service limitations in the API guide for more information](https://github.com/alexreisner/geocoder/blob/master/README_API_GUIDE.md).
 
 Advanced Model Configuration
 ----------------------------

data/lib/geocoder/cache.rb

@@ -4,7 +4,7 @@ module Geocoder
   class Cache
 
     def initialize(store, config)
-      @class = (Object.const_get("Geocoder::CacheStore::#{store.class}") rescue Geocoder::CacheStore::Generic)
+      @class = (Geocoder::CacheStore.const_get("#{store.class}", false) rescue Geocoder::CacheStore::Generic)
       @store_service = @class.new(store, config)
     end
 

data/lib/geocoder/ip_address.rb

@@ -9,8 +9,11 @@ module Geocoder
 
     def initialize(ip)
       ip = ip.to_string if ip.is_a?(IPAddr)
-
-      super(ip)
+      if ip.is_a?(Hash)
+        super(**ip)
+      else
+        super(ip)
+      end
     end
 
     def internal?

data/lib/geocoder/lookup.rb

@@ -66,7 +66,8 @@ module Geocoder
         :amazon_location_service,
         :geoapify,
         :photon,
-        :twogis
+        :twogis,
+        :pc_miler
       ]
     end
 

data/lib/geocoder/lookups/amazon_location_service.rb

@@ -29,10 +29,11 @@ module Geocoder::Lookup
       require_sdk
       keys = configuration.api_key
       if keys
-        @client = Aws::LocationService::Client.new(
+        @client = Aws::LocationService::Client.new(**{
+          region: keys[:region],
           access_key_id: keys[:access_key_id],
-          secret_access_key: keys[:secret_access_key],
-        )
+          secret_access_key: keys[:secret_access_key]
+        }.compact)
       else
         @client = Aws::LocationService::Client.new
       end

data/lib/geocoder/lookups/ban_data_gouv_fr.rb

@@ -125,7 +125,7 @@ module Geocoder::Lookup
     end
 
     def type_param_is_valid?(param)
-      %w(housenumber street locality village town city).include?(param.downcase)
+      %w(housenumber street locality municipality).include?(param.downcase)
     end
 
     def code_param_is_valid?(param)

data/lib/geocoder/lookups/esri.rb

@@ -23,15 +23,28 @@ module Geocoder::Lookup
     def results(query)
       return [] unless doc = fetch_data(query)
 
-      if (!query.reverse_geocode?)
-        return [] if !doc['locations'] || doc['locations'].empty?
-      end
-
       if (doc['error'].nil?)
+        if (!query.reverse_geocode?)
+          return [] if !doc['locations'] || doc['locations'].empty?
+        end
         return [ doc ]
       else
-        return []
+        case [ doc['error']['code'] ]
+        when [498]
+          raise_error(Geocoder::InvalidApiKey, doc['error']['message']) ||
+            Geocoder.log(:warn, "#{self.name} Geocoding API error: #{doc['error']['message']}")
+        when [ 403 ]
+          raise_error(Geocoder::RequestDenied, 'ESRI request denied') ||
+            Geocoder.log(:warn, "#{self.name} ESRI request denied: #{doc['error']['message']}")
+        when [ 500 ], [501]
+          raise_error(Geocoder::ServiceUnavailable, 'ESRI service unavailable') ||
+            Geocoder.log(:warn, "#{self.name} ESRI service error: #{doc['error']['message']}")
+        else
+          raise_error(Geocoder::Error, doc['error']['message']) ||
+            Geocoder.log(:warn, "#{self.name} Geocoding error: #{doc['error']['message']}")
+        end
       end
+      return []
     end
 
     def query_url_params(query)

data/lib/geocoder/lookups/pc_miler.rb

@@ -0,0 +1,85 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/pc_miler"
+require 'cgi' unless defined?(CGI) && defined?(CGI.escape)
+
+module Geocoder::Lookup
+  class PcMiler < Base
+
+    # https://developer.trimblemaps.com/restful-apis/location/single-search/single-search-api/#test-the-api-now
+    def valid_region_codes
+      # AF: Africa
+      # AS: Asia
+      # EU: Europe
+      # NA: North America
+      # OC: Oceania
+      # SA: South America
+      %w[AF AS EU NA OC SA]
+    end
+
+    def name
+      "PCMiler"
+    end
+
+    private # ---------------------------------------------------------------
+
+    def base_query_url(query)
+      region_code = region(query)
+      if !valid_region_codes.include?(region_code)
+        raise "region_code '#{region_code}' is invalid. use one of #{valid_region_codes}." \
+          "https://developer.trimblemaps.com/restful-apis/location/single-search/single-search-api/#test-the-api-now"
+      end
+
+      "#{protocol}://singlesearch.alk.com/#{region_code}/api/search?"
+    end
+
+    def results(query)
+      return [] unless data = fetch_data(query)
+      if data['Locations']
+        add_metadata_to_locations!(data)
+        data['Locations']
+      else
+        []
+      end
+    end
+
+    def add_metadata_to_locations!(data)
+      confidence = data['QueryConfidence']
+      data['Locations'].each do |location|
+        location['QueryConfidence'] = confidence
+      end
+    end
+
+    def query_url_params(query)
+      if query.reverse_geocode?
+        lat,lon = query.coordinates
+        formatted_query = "#{CGI.escape(lat)},#{CGI.escape(lon)}"
+      else
+        formatted_query = query.text.to_s
+      end
+
+      {
+        authToken: configuration.api_key,
+        query: formatted_query,
+        # to add additional metadata to response such as QueryConfidence
+        include: 'Meta'
+      }.merge(super(query))
+    end
+
+    def region(query)
+      query.options[:region] || query.options['region'] || configuration[:region] || "NA"
+    end
+
+    def check_response_for_errors!(response)
+      if response.code.to_i == 403
+        raise_error(Geocoder::RequestDenied) ||
+          Geocoder.log(:warn, "Geocoding API error: 403 API key does not exist")
+      else
+        super(response)
+      end
+    end
+
+    def supported_protocols
+      [:https]
+    end
+  end
+end

data/lib/geocoder/results/ban_data_gouv_fr.rb

@@ -275,7 +275,7 @@ module Geocoder::Result
     private
 
     def city?(result_type)
-      %w(village town city).include?(result_type)
+      result_type == 'municipality'
     end
 
   end

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/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.8.1"
+  VERSION = "1.8.2"
 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
@@ -94,16 +94,16 @@ module Geocoder
       base_url + archive_url_path(package)
     end
 
-    def archive_url_path(package)
+    def archive_edition(package)
       {
-        geolite_country_csv: "GeoLite2-Country-CSV.zip",
-        geolite_city_csv: "GeoLite2-City-CSV.zip",
-        geolite_asn_csv: "GeoLite2-ASN-CSV.zip"
+        geolite_country_csv: "GeoLite2-Country-CSV",
+        geolite_city_csv: "GeoLite2-City-CSV",
+        geolite_asn_csv: "GeoLite2-ASN-CSV"
       }[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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.2
 platform: ruby
 authors:
 - Alex Reisner
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2023-07-04 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,
@@ -94,6 +94,7 @@ files:
 - lib/geocoder/lookups/nominatim.rb
 - lib/geocoder/lookups/opencagedata.rb
 - lib/geocoder/lookups/osmnames.rb
+- lib/geocoder/lookups/pc_miler.rb
 - lib/geocoder/lookups/pelias.rb
 - lib/geocoder/lookups/photon.rb
 - lib/geocoder/lookups/pickpoint.rb
@@ -158,6 +159,7 @@ files:
 - lib/geocoder/results/nominatim.rb
 - lib/geocoder/results/opencagedata.rb
 - lib/geocoder/results/osmnames.rb
+- lib/geocoder/results/pc_miler.rb
 - lib/geocoder/results/pelias.rb
 - lib/geocoder/results/photon.rb
 - lib/geocoder/results/pickpoint.rb
@@ -188,7 +190,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
@@ -203,8 +205,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Complete geocoding solution for Ruby.
 test_files: []