geocoder 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6e1ac31854d2fcd30eb9cecb552d2b148b17355da7b15a71130cee3a432c335
-  data.tar.gz: 8cebc67335e4d3fd263249cc441673353cf0487415ccc8a855e2b457c6631e42
+  metadata.gz: 0d1523b73c17cd042f5af380ea44d2711c66684928aee867490f539cc3507582
+  data.tar.gz: c63760a1b75b7ce43d785736ffb6b0afcace52f3283ee4365b4d7af269822603
 SHA512:
-  metadata.gz: 826c1fb83145b010b610d34e42b0719673b4c51ce755b639425e3072bdb96dddcf373e605dce9f33c34aba46e95db71f64b50a84df71c67189a81fc8426f344b
-  data.tar.gz: 698ef9a7643854cb7ac2316e22a51aed4a1a2ee763a8b65c9d7ab722566bbdcb3a95ce685389d20ecc164b3f9ccf1626deef21515d662d1339e88d28152985f7
+  metadata.gz: 96048af2e42535ec2091a21d29eac9c4ebb3f8a3081762b34c3c97a72215ce8f4312ee5f9f072153ef530370580e609996946b4afa23aa89b1973c942c18417f
+  data.tar.gz: d3993aa69ba09c543e24215c290e9e7a5b56db0c49b065ece947d3b53eeecb6a8014c8c7737138939ba7cdb67acba36a6d537c081ad86fcbf707eff9cf97e5b3

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.6.0 (2020 Jan  6)
+-------------------
+* Drop support for Rails 3.x.
+* Add support for :osmnames lookup (thanks github.com/zacviandier).
+* Add support for :ipgeolocation IP lookup (thanks github.com/ahsannawaz111).
+
 1.5.2 (2019 Oct  3)
 -------------------
 * Add support for :ipregistry lookup (thanks github.com/ipregistry).

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-11 Alex Reisner
+Copyright (c) 2009-2020 Alex Reisner
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,7 @@
 Geocoder
 ========
 
-**A complete geocoding solution for Ruby.**
+**Complete geocoding solution for Ruby.**
 
 [![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)
@@ -11,19 +11,19 @@ Geocoder
 
 Key features:
 
-* Forward and reverse geocoding, and IP address geocoding.
+* Forward and reverse geocoding.
+* IP address geocoding.
 * Connects to more than 40 APIs worldwide.
 * Performance-enhancing features like caching.
-* Advanced configuration allows different parameters and APIs to be used in different conditions.
 * Integrates with ActiveRecord and Mongoid.
 * Basic geospatial queries: search within radius (or rectangle, or ring).
 
 Compatibility:
 
-* Supports multiple Ruby versions: Ruby 2.x, and JRuby.
-* Supports multiple databases: MySQL, PostgreSQL, SQLite, and MongoDB (1.7.0 and higher).
-* Supports Rails 3, 4, and 5. If you need to use it with Rails 2 please see the `rails2` branch (no longer maintained, limited feature set).
-* Works very well outside of Rails, you just need to install either the `json` (for MRI) or `json_pure` (for JRuby) gem.
+* Ruby versions: 2.x, and JRuby.
+* Databases: MySQL, PostgreSQL, SQLite, and MongoDB.
+* Rails: 4, 5, and 6.
+* Works outside of Rails with the `json` (for MRI) or `json_pure` (for JRuby) gem.
 
 
 Table of Contents
@@ -703,4 +703,4 @@ For all contributions, please respect the following guidelines:
 * If your pull request is merged, please do not ask for an immediate release of the gem. There are many factors contributing to when releases occur (remember that they affect thousands of apps with Geocoder in their Gemfiles). If necessary, please install from the Github source until the next official release.
 
 
-Copyright (c) 2009-18 Alex Reisner, released under the MIT license.
+Copyright :copyright: 2009-2020 Alex Reisner, released under the MIT license.

data/examples/autoexpire_cache_redis.rb

@@ -1,6 +1,8 @@
 # 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

data/lib/geocoder/lookup.rb

@@ -32,7 +32,6 @@ module Geocoder
         :google_places_search,
         :bing,
         :geocoder_ca,
-        :geocoder_us,
         :yandex,
         :nominatim,
         :mapbox,
@@ -51,7 +50,8 @@ module Geocoder
         :ban_data_gouv_fr,
         :test,
         :latlon,
-        :amap
+        :amap,
+        :osmnames
       ]
     end
 
@@ -74,7 +74,8 @@ module Geocoder
         :ipdata_co,
         :db_ip_com,
         :ipstack,
-        :ip2location
+        :ip2location,
+        :ipgeolocation
       ]
     end
 

data/lib/geocoder/lookups/ban_data_gouv_fr.rb

@@ -86,6 +86,12 @@ module Geocoder::Lookup
       unless (citycode = query.options[:citycode]).nil? || !code_param_is_valid?(citycode)
         params[:citycode] = citycode.to_s
       end
+      unless (lat = query.options[:lat]).nil? || !latitude_is_valid?(lat)
+        params[:lat] = lat
+      end
+      unless (lon = query.options[:lon]).nil? || !longitude_is_valid?(lon)
+        params[:lon] = lon
+      end
       params
     end
 
@@ -126,5 +132,12 @@ module Geocoder::Lookup
       (1..99999).include?(param.to_i)
     end
 
+    def latitude_is_valid?(param)
+      param.to_f <= 90 && param.to_f >= -90
+    end
+
+    def longitude_is_valid?(param)
+      param.to_f <= 180 && param.to_f >= -180
+    end
   end
 end

data/lib/geocoder/lookups/here.rb

@@ -9,13 +9,17 @@ module Geocoder::Lookup
     end
 
     def required_api_key_parts
-      ["app_id", "app_code"]
+      ['api_key']
+    end
+
+    def supported_protocols
+      [:https]
     end
 
     private # ---------------------------------------------------------------
 
     def base_query_url(query)
-      "#{protocol}://#{if query.reverse_geocode? then 'reverse.' end}geocoder.api.here.com/6.2/#{if query.reverse_geocode? then 'reverse' end}geocode.json?"
+      "#{protocol}://#{if query.reverse_geocode? then 'reverse.' end}geocoder.ls.hereapi.com/6.2/#{if query.reverse_geocode? then 'reverse' end}geocode.json?"
     end
 
     def results(query)
@@ -31,8 +35,7 @@ module Geocoder::Lookup
     def query_url_here_options(query, reverse_geocode)
       options = {
         gen: 9,
-        app_id: api_key,
-        app_code: api_code,
+        apikey: configuration.api_key,
         language: (query.language || configuration.language)
       }
       if reverse_geocode
@@ -61,17 +64,5 @@ module Geocoder::Lookup
         )
       end
     end
-
-    def api_key
-      if (a = configuration.api_key)
-        return a.first if a.is_a?(Array)
-      end
-    end
-
-    def api_code
-      if (a = configuration.api_key)
-        return a.last if a.is_a?(Array)
-      end
-    end
   end
 end

data/lib/geocoder/lookups/ip2location.rb

@@ -19,11 +19,11 @@ module Geocoder::Lookup
     end
 
     def query_url_params(query)
-      {
-        key: configuration.api_key ? configuration.api_key : "demo",
-        format: "json",
-        ip: query.sanitized_text
-      }.merge(super)
+      params = super
+      if configuration.has_key?(:package)
+        params.merge!(package: configuration[:package])
+      end
+      params
     end
 
     def results(query)
@@ -63,13 +63,5 @@ module Geocoder::Lookup
       }
     end
 
-    def query_url_params(query)
-      params = super
-      if configuration.has_key?(:package)
-        params.merge!(package: configuration[:package])
-      end
-      params
-    end
-
   end
 end

data/lib/geocoder/lookups/ipgeolocation.rb

@@ -0,0 +1,63 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/ipgeolocation'
+
+
+module Geocoder::Lookup
+  class Ipgeolocation < Base
+
+    ERROR_CODES = {
+        404 => Geocoder::InvalidRequest,
+        401 => Geocoder::RequestDenied, # missing/invalid API key
+        101 => Geocoder::InvalidApiKey,
+        102 => Geocoder::Error,
+        103 => Geocoder::InvalidRequest,
+        104 => Geocoder::OverQueryLimitError,
+        105 => Geocoder::RequestDenied,
+        301 => Geocoder::InvalidRequest,
+        302 => Geocoder::InvalidRequest,
+        303 => Geocoder::RequestDenied,
+    }
+    ERROR_CODES.default = Geocoder::Error
+
+    def name
+      "Ipgeolocation"
+    end
+
+    def supported_protocols
+      [:https]
+    end
+
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
+      "#{protocol}://api.ipgeolocation.io/ipgeo?"
+    end
+    def query_url_params(query)
+      {
+          ip: query.sanitized_text,
+          apiKey: configuration.api_key
+      }.merge(super)
+    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 error = doc['error']
+        code = error['code']
+        msg = error['info']
+        raise_error(ERROR_CODES[code], msg ) || Geocoder.log(:warn, "Ipgeolocation Geocoding API error: #{msg}")
+        return []
+      end
+      [doc]
+    end
+
+    def reserved_result(ip)
+      {
+          "ip"           => ip,
+          "country_name" => "Reserved",
+          "country_code2" => "RD"
+      }
+    end
+  end
+end

data/lib/geocoder/lookups/osmnames.rb

@@ -0,0 +1,57 @@
+require 'cgi'
+require 'geocoder/lookups/base'
+require 'geocoder/results/osmnames'
+
+module Geocoder::Lookup
+  class Osmnames < Base
+
+    def name
+      'OSM Names'
+    end
+
+    def required_api_key_parts
+      configuration[:host] ? [] : ['key']
+    end
+
+    def supported_protocols
+      [:https]
+    end
+
+    private
+
+    def base_query_url(query)
+      "#{base_url(query)}/#{params_url(query)}.js?"
+    end
+
+    def base_url(query)
+      host = configuration[:host] || 'geocoder.tilehosting.com'
+      "#{protocol}://#{host}"
+    end
+
+    def params_url(query)
+      method, args = 'q', CGI.escape(query.sanitized_text)
+      method, args = 'r', query.coordinates.join('/') if query.reverse_geocode?
+      "#{country_limited(query)}#{method}/#{args}"
+    end
+
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      if (error = doc['message'])
+        raise_error(Geocoder::InvalidRequest, error) ||
+          Geocoder.log(:warn, "OSMNames Geocoding API error: #{error}")
+      else
+        return doc['results']
+      end
+    end
+
+    def query_url_params(query)
+      {
+        key: configuration.api_key
+      }.merge(super)
+    end
+
+    def country_limited(query)
+      "#{query.options[:country_code].downcase}/" if query.options[:country_code] && !query.reverse_geocode?
+    end
+  end
+end

data/lib/geocoder/lookups/pickpoint.rb

@@ -23,7 +23,7 @@ module Geocoder::Lookup
     end
 
     def query_url_params(query)
-      params = {
+      {
         key: configuration.api_key
       }.merge(super)
     end

data/lib/geocoder/lookups/tencent.rb

@@ -31,18 +31,18 @@ module Geocoder::Lookup
       case doc['status']
       when 0
         return [doc[content_key]]
-      when 199
-        raise error(Geocoder::InvalidApiKey, "invalid api key") ||
-        Geocoder.log(:warn, "#{name} Geocoding API error: key is not enabled for web service usage.")
-      when 311
-        raise_error(Geocoder::RequestDenied, "request denied") ||
-          Geocoder.log(:warn, "#{name} Geocoding API error: request denied.")
-      when 310, 306
-        raise_error(Geocoder::InvalidRequest, "invalid request.") ||
-          Geocoder.log(:warn, "#{name} Geocoding API error: invalid request.")
       when 311
         raise_error(Geocoder::InvalidApiKey, "invalid api key") ||
           Geocoder.log(:warn, "#{name} Geocoding API error: invalid api key.")
+      when 310
+        raise_error(Geocoder::InvalidRequest, "invalid request.") ||
+          Geocoder.log(:warn, "#{name} Geocoding API error: invalid request, invalid parameters.")
+      when 306
+        raise_error(Geocoder::InvalidRequest, "invalid request.") ||
+          Geocoder.log(:warn, "#{name} Geocoding API error: invalid request, check response for more info.")
+      when 110
+        raise_error(Geocoder::RequestDenied, "request denied.") ||
+          Geocoder.log(:warn, "#{name} Geocoding API error: request source is not authorized.")
       end
       return []
     end

data/lib/geocoder/results/baidu.rb

@@ -7,10 +7,6 @@ module Geocoder::Result
       ['lat', 'lng'].map{ |i| @data['location'][i] }
     end
 
-    def address
-      @data['formatted_address']
-    end
-
     def province
       @data['addressComponent'] and @data['addressComponent']['province'] or ""
     end

data/lib/geocoder/results/ban_data_gouv_fr.rb

@@ -7,7 +7,7 @@ module Geocoder::Result
     #### BASE METHODS ####
 
     def self.response_attributes
-      %w[limit attribution version licence type features]
+      %w[limit attribution version licence type features center]
     end
 
     response_attributes.each do |a|

data/lib/geocoder/results/ipgeolocation.rb

@@ -0,0 +1,59 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ipgeolocation < Base
+
+    def coordinates
+      [@data['latitude'].to_f, @data['longitude'].to_f]
+    end
+
+    def address(format = :full)
+      "#{city}, #{state} #{postal_code}, #{country_name}".sub(/^[ ,]*/, "")
+    end
+
+    def state
+      @data['state_prov']
+    end
+
+    def state_code
+      @data['state_prov']
+    end
+
+    def country
+      @data['country_name']
+    end
+
+    def country_code
+      @data['country_code2']
+    end
+
+    def postal_code
+      @data['zipcode']
+    end
+
+    def self.response_attributes
+      [
+          ['ip', ''],
+          ['hostname', ''],
+          ['continent_code', ''],
+          ['continent_name', ''],
+          ['country_code2', ''],
+          ['country_code3', ''],
+          ['country_name', ''],
+          ['country_capital',''],
+          ['district',''],
+          ['state_prov',''],
+          ['city', ''],
+          ['zipcode', ''],
+          ['time_zone', {}],
+          ['currency', {}]
+      ]
+    end
+
+    response_attributes.each do |attr, default|
+      define_method attr do
+        @data[attr] || default
+      end
+    end
+  end
+end

data/lib/geocoder/results/osmnames.rb

@@ -0,0 +1,56 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Osmnames < Base
+    def address
+      @data['display_name']
+    end
+
+    def coordinates
+      [@data['lat'].to_f, @data['lon'].to_f]
+    end
+
+    def viewport
+      west, south, east, north = @data['boundingbox'].map(&:to_f)
+      [south, west, north, east]
+    end
+
+    def state
+      @data['state']
+    end
+    alias_method :state_code, :state
+
+    def place_class
+      @data['class']
+    end
+
+    def place_type
+      @data['type']
+    end
+
+    def postal_code
+      ''
+    end
+
+    def country_code
+      @data['country_code']
+    end
+
+    def country
+      @data['country']
+    end
+
+    def self.response_attributes
+      %w[house_number street city name osm_id osm_type boundingbox place_rank
+      importance county rank name_suffix]
+    end
+
+    response_attributes.each do |a|
+      unless method_defined?(a)
+        define_method a do
+          @data[a]
+        end
+      end
+    end
+  end
+end

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.5.2"
+  VERSION = "1.6.0"
 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2020-01-06 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,
@@ -59,7 +59,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,6 +70,7 @@ 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
@@ -83,6 +83,7 @@ files:
 - lib/geocoder/lookups/maxmind_local.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
@@ -112,7 +113,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
@@ -124,6 +124,7 @@ 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
@@ -136,6 +137,7 @@ files:
 - lib/geocoder/results/maxmind_local.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
@@ -178,8 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Complete geocoding solution for Ruby.

data/lib/geocoder/lookups/geocoder_us.rb

@@ -1,51 +0,0 @@
-require 'geocoder/lookups/base'
-require "geocoder/results/geocoder_us"
-
-module Geocoder::Lookup
-  class GeocoderUs < Base
-
-    def name
-      "Geocoder.us"
-    end
-
-    def supported_protocols
-      [:http]
-    end
-
-    private # ----------------------------------------------------------------
-
-    def base_query_url(query)
-      base_query_url_with_optional_key(configuration.api_key)
-    end
-
-    def cache_key(query)
-      base_query_url_with_optional_key(nil) + url_query_string(query)
-    end
-
-    def base_query_url_with_optional_key(key = nil)
-      base = "#{protocol}://"
-      if configuration.api_key
-        base << "#{configuration.api_key}@"
-      end
-      base + "geocoder.us/member/service/csv/geocode?"
-    end
-
-    def results(query)
-      return [] unless doc = fetch_data(query)
-      if doc[0].to_s =~ /^(\d+)\:/
-        return []
-      else
-        return [doc.size == 5 ? ((doc[0..1] << nil) + doc[2..4]) : doc]
-      end
-    end
-
-    def query_url_params(query)
-      (query.text =~ /^\d{5}(?:-\d{4})?$/ ? {:zip => query} : {:address => query.sanitized_text}).merge(super)
-    end
-
-    def parse_raw_data(raw_data)
-      raw_data.chomp.split(',')
-    end
-  end
-end
-

data/lib/geocoder/results/geocoder_us.rb

@@ -1,39 +0,0 @@
-require 'geocoder/results/base'
-
-module Geocoder::Result
-  class GeocoderUs < Base
-    def coordinates
-      [@data[0].to_f, @data[1].to_f]
-    end
-
-    def address(format = :full)
-      "#{street_address}, #{city}, #{state} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
-    end
-
-    def street_address
-      @data[2]
-    end
-
-    def city
-      @data[3]
-    end
-
-    def state
-      @data[4]
-    end
-
-    alias_method :state_code, :state
-
-    def postal_code
-      @data[5]
-    end
-
-    def country
-      'United States'
-    end
-
-    def country_code
-      'US'
-    end
-  end
-end