geocoder 1.8.2 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26c7b5c88c38ee619a8fdc7452014b9601db83539334353758d451d2b300faf2
-  data.tar.gz: 873c8a8148b792c43302b921665880d2f4b54cdc8ad7e4698fafee4e2a24c8b4
+  metadata.gz: 447dfedeffcb5c111f6441badccf6d1c25c38a3a0fed32aaeb31151d27425a3d
+  data.tar.gz: 89b7f5b123d125ccb329d66f0172ef0a46d3176d6e215cc1a884b0a2249ae4cd
 SHA512:
-  metadata.gz: c8fc1e15bfb40407c0f3bcd31030defaf9af58be2c7c49d84efaa5b8ce3828cafd54d3c2a63d08920db4f2701934ac6c3ac9df52888c27fbfd8a05036da11bb5
-  data.tar.gz: 1114e5142f8e8e358fa143fb143b0ea833c611bc2ab92bcbe0d04dc62d0965d46149651d7c3847f967c76a5997a3fba1d0d43a997aee2287268a48ac041e08c7
+  metadata.gz: a90b21dfcc3aeb50ac94fad6eafeec0141ba320bb638912b2e0091f80beb30b306f58cc104db8a55ab47cf8a5543edbabe9372dbda7c63dcbeb560c42b92a957
+  data.tar.gz: c0489e8f2b3c4d98cf40235e2b60fc5c8d129cd74aecc65f57bfd9adee7549db804fb0bcdf6b68c14933478fd3a0ea06124350208987a575c916a0992c28adb7

data/CHANGELOG.md

@@ -3,6 +3,12 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.8.3 (2024 May  2)
+-------------------
+* Add support for IP2Location LITE lookup (thanks github.com/ip2location).
+* Add support for PDOK NL lookup (thanks github.com/opensourceame).
+* Remove support for Data Science Toolkit lookup (defunct).
+
 1.8.2 (2023 Jul  4)
 -------------------
 * Add support for PC Miler lookup (thanks github.com/alexdean).

data/README.md

@@ -734,8 +734,34 @@ you should check your Gemfile to make sure the Mongoid gem is listed _before_ Ge
 
 A lot of debugging time can be saved by understanding how Geocoder works with ActiveRecord. When you use the `near` scope or the `nearbys` method of a geocoded object, Geocoder creates an ActiveModel::Relation object which adds some attributes (eg: distance, bearing) to the SELECT clause. It also adds a condition to the WHERE clause to check that distance is within the given radius. Because the SELECT clause is modified, anything else that modifies the SELECT clause may produce strange results, for example:
 
-* using the `pluck` method (selects only a single column)
-* specifying another model through `includes` (selects columns from other tables)
+* using [`select` method (selects one or more columns)](https://api.rubyonrails.org/classes/ActiveRecord/QueryMethods.html#method-i-select)
+* using the [`pluck` method (gets an array with selecting one or more columns)](https://api.rubyonrails.org/classes/ActiveRecord/Calculations.html#method-i-pluck)
+  * The same problem will appear with [ActiveRecord's `ids` method](https://api.rubyonrails.org/classes/ActiveRecord/Calculations.html#method-i-ids).
+* specifying another model through [`includes` (selects columns from other tables)](https://api.rubyonrails.org/classes/ActiveRecord/QueryMethods.html#method-i-includes)
+  * See also Known Issues [using-near-with-includes](#using-near-with-select) section.
+
+If you get an error in the above cases, try the following:
+
+```ruby
+# Use the :select option with the near scope to get the columns you want.
+# Instead of City.near(...).select(:id, :name), try:
+City.near("Omaha, NE", 20, select: "id, name")
+
+# Pass a :select option to the near scope to get the columns you want.
+# Then, Ruby's built-in pluck method gets arrays you want.
+# Instead of City.near(...).pluck(:id) or City.near(...).ids,, try:
+City.near("Omaha, NE", 20, select: "id, name").to_a.pluck(:id, :name)
+City.near("Omaha, NE", 20, select: "id").to_a.pluck(:id)
+
+# Pass a :select option to the near scope to get the columns you want.
+# Instead of City.near(...).includes(:venues), try:
+City.near("Omaha, NE", 20, select: "cities.*, venues.*").joins(:venues)
+
+# This preload call will normally trigger two queries regardless of the
+# number of results; one query on hotels, and one query on administrators.
+# Instead of Hotel.near(...).includes(:administrator), try:
+Hotel.near("London, UK", 50).joins(:administrator).preload(:administrator)
+```
 
 ### Geocoding is Slow
 

data/lib/geocoder/lookup.rb

@@ -23,7 +23,7 @@ module Geocoder
     # For example, Amazon Location Service uses the AWS gem, not HTTP REST requests, to fetch data.
     #
     def all_services_with_http_requests
-      all_services_except_test - [:amazon_location_service]
+      all_services_except_test - [:amazon_location_service, :maxmind_local, :geoip2, :ip2location_lite]
     end
 
     ##
@@ -32,7 +32,6 @@ module Geocoder
     def street_services
       @street_services ||= [
         :location_iq,
-        :dstk,
         :esri,
         :google,
         :google_premier,
@@ -48,6 +47,7 @@ module Geocoder
         :uk_ordnance_survey_names,
         :opencagedata,
         :pelias,
+        :pdok_nl,
         :pickpoint,
         :here,
         :baidu,
@@ -94,7 +94,9 @@ module Geocoder
         :ip2location,
         :ipgeolocation,
         :ipqualityscore,
-        :ipbase
+        :ipbase,
+        :ip2location_io,
+        :ip2location_lite
       ]
     end
 

data/lib/geocoder/lookups/amazon_location_service.rb

@@ -19,7 +19,7 @@ module Geocoder::Lookup
         client.search_place_index_for_text(params.merge(text: query.text))
       end
       
-      resp.results.map(&:place)
+      resp.results
     end
 
     private

data/lib/geocoder/lookups/google_places_search.rb

@@ -49,12 +49,11 @@ module Geocoder
       end
 
       def default_fields
-        legacy = %w[id reference]
         basic = %w[business_status formatted_address geometry icon name 
           photos place_id plus_code types]
         contact = %w[opening_hours]
         atmosphere = %W[price_level rating user_ratings_total]
-        format_fields(legacy, basic, contact, atmosphere)
+        format_fields(basic, contact, atmosphere)
       end
 
       def format_fields(*fields)

data/lib/geocoder/lookups/ip2location_io.rb

@@ -0,0 +1,62 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/ip2location_io'
+
+module Geocoder::Lookup
+  class Ip2locationIo < Base
+
+    def name
+      "IP2LocationIOApi"
+    end
+
+    def required_api_key_parts
+      ['key']
+    end
+
+    def supported_protocols
+      [:http, :https]
+    end
+
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
+      "#{protocol}://api.ip2location.io/?"
+    end
+
+    def query_url_params(query)
+      super.merge(
+        key: configuration.api_key,
+        ip: query.sanitized_text,
+      )
+    end
+
+    def results(query)
+      # don't look up a loopback or private address, just return the stored result
+      return [reserved_result(query.text)] if query.internal_ip_address?
+      return [] unless doc = fetch_data(query)
+      if doc["response"] == "INVALID ACCOUNT"
+        raise_error(Geocoder::InvalidApiKey) || Geocoder.log(:warn, "INVALID ACCOUNT")
+        return []
+      else
+        return [doc]
+      end
+    end
+
+    def reserved_result(query)
+      {
+        "ip"           => "-",
+        "country_code" => "-",
+        "country_name" => "-",
+        "region_name"  => "-",
+        "city_name"    => "-",
+        "latitude"     => null,
+        "longitude"    => null,
+        "zip_code"     => "-",
+        "time_zone"    => "-",
+        "asn"          => "-",
+        "as"           => "-",
+        "is_proxy"     => false
+      }
+    end
+
+  end
+end

data/lib/geocoder/lookups/ip2location_lite.rb

@@ -0,0 +1,40 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/ip2location_lite'
+
+module Geocoder
+  module Lookup
+    class Ip2locationLite < Base
+      attr_reader :gem_name
+
+      def initialize
+        unless configuration[:file].nil?
+          begin
+            @gem_name = 'ip2location_ruby'
+            require @gem_name
+          rescue LoadError
+            raise "Could not load IP2Location DB dependency. To use the IP2LocationLite lookup you must add the #{@gem_name} gem to your Gemfile or have it installed in your system."
+          end
+        end
+        super
+      end
+
+      def name
+        'IP2LocationLite'
+      end
+
+      def required_api_key_parts
+        []
+      end
+
+      private
+
+      def results(query)
+        return [] unless configuration[:file]
+
+        i2l = Ip2location.new.open(configuration[:file].to_s)
+        result = i2l.get_all(query.to_s)
+        result.nil? ? [] : [result]
+      end
+    end
+  end
+end

data/lib/geocoder/lookups/pdok_nl.rb

@@ -0,0 +1,43 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/pdok_nl"
+
+module Geocoder::Lookup
+  class PdokNl < Base
+
+    def name
+      'pdok NL'
+    end
+
+    def supported_protocols
+      [:https]
+    end
+
+    private # ---------------------------------------------------------------
+
+    def cache_key(query)
+      base_query_url(query) + hash_to_query(query_url_params(query))
+    end
+
+    def base_query_url(query)
+      "#{protocol}://api.pdok.nl/bzk/locatieserver/search/v3_1/free?"
+    end
+
+    def valid_response?(response)
+      json   = parse_json(response.body)
+      super(response) if json
+    end
+
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      return doc['response']['docs']
+    end
+
+    def query_url_params(query)
+      {
+        fl: '*',
+        q:  query.text,
+        wt: 'json'
+      }.merge(super)
+    end
+  end
+end

data/lib/geocoder/results/amazon_location_service.rb

@@ -3,7 +3,8 @@ require 'geocoder/results/base'
 module Geocoder::Result
   class AmazonLocationService < Base
     def initialize(result)
-      @place = result
+      @place = result.place
+      super
     end
 
     def coordinates
@@ -53,5 +54,9 @@ module Geocoder::Result
     def country_code
       @place.country
     end
+
+    def place_id
+      data.place_id if data.respond_to?(:place_id)
+    end
   end
 end

data/lib/geocoder/results/ip2location_io.rb

@@ -0,0 +1,21 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ip2locationIo < Base
+
+    def address(format = :full)
+      "#{city_name} #{zip_code}, #{country_name}".sub(/^[ ,]*/, '')
+    end
+
+    def self.response_attributes
+      %w[ip country_code country_name region_name city_name latitude longitude
+        zip_code time_zone asn as is_proxy]
+    end
+
+    response_attributes.each do |attr|
+      define_method attr do
+        @data[attr] || ""
+      end
+    end
+  end
+end

data/lib/geocoder/results/ip2location_lite.rb

@@ -0,0 +1,47 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ip2locationLite < Base
+
+    def coordinates
+      [@data[:latitude], @data[:longitude]]
+    end
+
+    def city
+      @data[:city]
+    end
+
+    def state
+      @data[:region]
+    end
+
+    def state_code
+      "" # Not available in Maxmind's database
+    end
+
+    def country
+      @data[:country_long]
+    end
+
+    def country_code
+      @data[:country_short]
+    end
+
+    def postal_code
+      @data[:zipcode]
+    end
+
+    def self.response_attributes
+      %w[country_short country_long region latitude longitude isp
+        domain netspeed areacode iddcode timezone zipcode weatherstationname
+        weatherstationcode mcc mnc mobilebrand elevation usagetype addresstype
+        category district asn as]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a] || ""
+      end
+    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/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.8.2"
+  VERSION = "1.8.3"
 end

data/lib/maxmind_database.rb

@@ -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,14 +102,6 @@ module Geocoder
       base_url + archive_url_path(package)
     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
-
     def base_url(edition)
       "https://download.maxmind.com/app/geoip_download?edition_id=#{edition}&license_key=#{ENV['LICENSE_KEY']}&suffix=zip"
     end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.3
 platform: ruby
 authors:
 - Alex Reisner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-04 00:00:00.000000000 Z
-dependencies: []
+date: 2024-05-02 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.
@@ -60,7 +88,6 @@ files:
 - 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
@@ -74,6 +101,8 @@ 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
@@ -95,6 +124,7 @@ files:
 - 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
@@ -125,7 +155,6 @@ files:
 - 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
@@ -139,6 +168,8 @@ 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
@@ -160,6 +191,7 @@ files:
 - 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

data/lib/geocoder/lookups/dstk.rb

@@ -1,22 +0,0 @@
-# More information about the Data Science Toolkit can be found at:
-# http://www.datasciencetoolkit.org/. The provided APIs mimic the
-# Google geocoding api.
-
-require 'geocoder/lookups/google'
-require 'geocoder/results/dstk'
-
-module Geocoder::Lookup
-  class Dstk < Google
-
-    def name
-      "Data Science Toolkit"
-    end
-
-    private # ----------------------------------------------------------------
-
-    def base_query_url(query)
-      host = configuration[:host] || "www.datasciencetoolkit.org"
-      "#{protocol}://#{host}/maps/api/geocode/json?"
-    end
-  end
-end

data/lib/geocoder/results/dstk.rb

@@ -1,6 +0,0 @@
-require 'geocoder/results/google'
-
-module Geocoder::Result
-  class Dstk < Google
-  end
-end