geocoder 1.5.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 48d97270ff2c0f4e7920eeb7bbab54348485d101
-  data.tar.gz: 1a446c88e27b5257bd1c39815890392700e303b1
+SHA256:
+  metadata.gz: 25d03f1aeb92b80a0ec269a1f42093bb641e468d0824d324ad5157ed9cfcb559
+  data.tar.gz: 1a23a47bfb3d4af0de14421f8b1b76e03234aee309a8be7ddb2acd91ce04c30d
 SHA512:
-  metadata.gz: d95f68de9056c0db319dbe6781e993a72ce98db3042e46fb4175ca76fa621e56def1a4bbc8594fed25a87f74f6887849c4cccb98b816765cac48e06c7e1467a8
-  data.tar.gz: 6a3439cbc7e28bc5c53b7b76b97bdfcf5d30040b74e2302ed11db60b79f9265953bc6b4437977b94995994f596a81a1968fa420d0640b2ad9a5393a6846c6d03
+  metadata.gz: e8f4fd2a60fa6ccb91f7a04a737b5720aa4e276181c202b215b5dd8c50b1746d833ace8c2a034aae1282132e62f96be518b3b366c34f03c73ffcb4cf1dd3c6ab
+  data.tar.gz: 848c835773fd172b8469eefc28646c4c5cd3176d10bfb175f5d447bd24b51982555644b7ff5d45eddb2bc04cf7820fadb2363a23cf907ad13aa930f33b5dad09

data/CHANGELOG.md

@@ -3,10 +3,31 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
-1.5.0 (2018 Aug  1)
+1.6.1 (2020 Jan 23)
 -------------------
+* Sanitize lat/lon values passed to within_bounding_box to prevent SQL injection.
+
+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).
+* Various fixes for Yandex lookup.
+
+1.5.1 (2019 Jan 23)
+-------------------
+* Add support for :tencent lookup (thanks github.com/Anders-E).
+* Add support for :smarty_streets international API (thanks github.com/ankane).
+* Remove :mapzen lookup.
+
+1.5.0 (2018 Jul 31)
+-------------------
+* Drop support for Ruby <2.0.
 * Change default street address lookup from :google to :nominatim.
-* Drop support for Ruby 1.9.
 * Cache keys no longer include API credentials. This means many entries in existing cache implementations will be invalidated.
 * Test lookup fixtures should now return `coordinates` and NOT `latitude`/`longitude` attributes (see #1258). This may break some people's tests.
 * Add support for :ip2location lookup (thanks github.com/ip2location).

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,29 +1,27 @@
 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)
 [![Build Status](https://travis-ci.org/alexreisner/geocoder.svg?branch=master)](https://travis-ci.org/alexreisner/geocoder)
-[![GitHub Issues](https://img.shields.io/github/issues/alexreisner/geocoder.svg)](https://github.com/alexreisner/geocoder/issues)
-[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 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 feaures like caching.
-* Advanced configuration allows different parameters and APIs to be used in different conditions.
+* Performance-enhancing features like caching.
 * 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
@@ -45,7 +43,7 @@ Advanced Features:
 * [Geospatial Calculations](#geospatial-calculations)
 * [Batch Geocoding](#batch-geocoding)
 * [Testing](#testing)
-* [Error Handling](#error-handing)
+* [Error Handling](#error-handling)
 * [Command Line Interface](#command-line-interface)
 
 The Rest:
@@ -224,15 +222,15 @@ Some common options are:
 Please see [`lib/geocoder/configuration.rb`](https://github.com/alexreisner/geocoder/blob/master/lib/geocoder/configuration.rb) for a complete list of configuration options. Additionally, some lookups have their own special configuration options which are directly supported by Geocoder. For example, to specify a value for Google's `bounds` parameter:
 
     # with Google:
-    Geocoder.search("Paris", bounds: [[32.1,-95.9], [33.9,-94.3]])
+    Geocoder.search("Middletown", bounds: [[40.6,-77.9], [39.9,-75.9]])
 
 Please see the [source code for each lookup](https://github.com/alexreisner/geocoder/tree/master/lib/geocoder/lookups) to learn about directly supported parameters. Parameters which are not directly supported can be specified using the `:params` option, which appends options to the query string of the geocoding request. For example:
 
     # Nominatim's `countrycodes` parameter:
-    Geocoder.search("Paris", params: {countrycodes: "gb,de,fr,es,us"})
+    Geocoder.search("Rome", params: {countrycodes: "us,ca"})
 
     # Google's `region` parameter:
-    Geocoder.search("Paris", params: {region: "..."})
+    Geocoder.search("Rome", params: {region: "..."})
 
 ### Configuring Multiple Services
 
@@ -500,9 +498,9 @@ To avoid exceeding per-day limits you can add a `LIMIT` option. However, this wi
 Testing
 -------
 
-When writing tests for an app that uses Geocoder it may be useful to avoid network calls and have Geocoder return consistent, configurable results. To do this, configure the `:test` lookup:
+When writing tests for an app that uses Geocoder it may be useful to avoid network calls and have Geocoder return consistent, configurable results. To do this, configure the `:test` lookup and/or `:ip_lookup`
 
-    Geocoder.configure(lookup: :test)
+    Geocoder.configure(lookup: :test, ip_lookup: :test)
 
 Add stubs to define the results that will be returned:
 
@@ -703,4 +701,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/calculations.rb

@@ -154,7 +154,7 @@ module Geocoder
     # Translate a bearing (float) into a compass direction (string, eg "North").
     #
     def compass_point(bearing, points = COMPASS_POINTS)
-      seg_size = 360 / points.size
+      seg_size = 360.0 / points.size
       points[((bearing + (seg_size / 2)) % 360) / seg_size]
     end
 

data/lib/geocoder/ip_address.rb

@@ -1,11 +1,24 @@
 require 'resolv'
 module Geocoder
   class IpAddress < String
+    PRIVATE_IPS = [
+      '10.0.0.0/8',
+      '172.16.0.0/12',
+      '192.168.0.0/16',
+    ].map { |ip| IPAddr.new(ip) }.freeze
+
+    def internal?
+      loopback? || private?
+    end
 
     def loopback?
       valid? and !!(self == "0.0.0.0" or self.match(/\A127\./) or self == "::1")
     end
 
+    def private?
+      valid? && PRIVATE_IPS.any? { |ip| ip.include?(self) }
+    end
+
     def valid?
       !!((self =~ Resolv::IPv4::Regex) || (self =~ Resolv::IPv6::Regex))
     end

data/lib/geocoder/lookup.rb

@@ -32,17 +32,16 @@ module Geocoder
         :google_places_search,
         :bing,
         :geocoder_ca,
-        :geocoder_us,
         :yandex,
         :nominatim,
         :mapbox,
         :mapquest,
-        :mapzen,
         :opencagedata,
         :pelias,
         :pickpoint,
         :here,
         :baidu,
+        :tencent,
         :geocodio,
         :smarty_streets,
         :postcode_anywhere_uk,
@@ -51,7 +50,8 @@ module Geocoder
         :ban_data_gouv_fr,
         :test,
         :latlon,
-        :amap
+        :amap,
+        :osmnames
       ]
     end
 
@@ -69,11 +69,13 @@ module Geocoder
         :pointpin,
         :maxmind_geoip2,
         :ipinfo_io,
+        :ipregistry,
         :ipapi_com,
         :ipdata_co,
         :db_ip_com,
         :ipstack,
-        :ip2location
+        :ip2location,
+        :ipgeolocation
       ]
     end
 

data/lib/geocoder/lookups/baidu_ip.rb

@@ -1,4 +1,4 @@
-require 'geocoder/lookups/base'
+require 'geocoder/lookups/baidu'
 require 'geocoder/results/baidu_ip'
 
 module Geocoder::Lookup

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

@@ -164,7 +164,7 @@ module Geocoder
       def cache_key_params(query)
         # omit api_key and token because they may vary among requests
         query_url_params(query).reject do |key,value|
-          key.to_s.match /(key|token)/
+          key.to_s.match(/(key|token)/)
         end
       end
 
@@ -197,6 +197,8 @@ module Geocoder
         raise_error(err) or Geocoder.log(:warn, "Geocoding API connection cannot be established.")
       rescue Errno::ECONNREFUSED => err
         raise_error(err) or Geocoder.log(:warn, "Geocoding API connection refused.")
+      rescue Geocoder::NetworkError => err
+        raise_error(err) or Geocoder.log(:warn, "Geocoding API connection is either unreacheable or reset by the peer")
       rescue Timeout::Error => err
         raise_error(err) or Geocoder.log(:warn, "Geocoding API not responding fast enough " +
           "(use Geocoder.configure(:timeout => ...) to set limit).")
@@ -209,7 +211,10 @@ module Geocoder
           JSON.parse(data)
         end
       rescue
-        raise_error(ResponseParseError.new(data)) or Geocoder.log(:warn, "Geocoding API's response was not valid JSON: #{data}")
+        unless raise_error(ResponseParseError.new(data))
+          Geocoder.log(:warn, "Geocoding API's response was not valid JSON")
+          Geocoder.log(:debug, "Raw response: #{data}")
+        end
       end
 
       ##

data/lib/geocoder/lookups/bing.rb

@@ -53,7 +53,8 @@ module Geocoder::Lookup
 
     def query_url_params(query)
       {
-        key: configuration.api_key
+        key: configuration.api_key,
+        language: (query.language || configuration.language)
       }.merge(super)
     end
 

data/lib/geocoder/lookups/esri.rb

@@ -40,31 +40,56 @@ module Geocoder::Lookup
       else
         params[:text] = query.sanitized_text
       end
-      params[:token] = token
-      params[:forStorage] = configuration[:for_storage] if configuration[:for_storage]
+
+      params[:token] = token(query)
+
+      if for_storage_value = for_storage(query)
+        params[:forStorage] = for_storage_value
+      end
       params[:sourceCountry] = configuration[:source_country] if configuration[:source_country]
       params.merge(super)
     end
 
-    def token
-      create_and_save_token! if !valid_token_configured? and configuration.api_key
-      configuration[:token].to_s unless configuration[:token].nil?
+    def for_storage(query)
+      if query.options.has_key?(:for_storage)
+        query.options[:for_storage]
+      else
+        configuration[:for_storage]
+      end
+    end
+
+    def token(query)
+      token_instance = if query.options[:token]
+                         query.options[:token]
+                       else
+                         configuration[:token]
+                       end
+
+      if !valid_token_configured?(token_instance) && configuration.api_key
+        token_instance = create_and_save_token!(query)
+      end
+
+      token_instance.to_s unless token_instance.nil?
     end
 
-    def valid_token_configured?
-      !configuration[:token].nil? and configuration[:token].active?
+    def valid_token_configured?(token_instance)
+      !token_instance.nil? && token_instance.active?
     end
 
-    def create_and_save_token!
-      save_token!(create_token)
+    def create_and_save_token!(query)
+      token_instance = create_token
+
+      if query.options[:token]
+        query.options[:token] = token_instance
+      else
+        Geocoder.merge_into_lookup_config(:esri, token: token_instance)
+      end
+
+      token_instance
     end
 
     def create_token
       Geocoder::EsriToken.generate_token(*configuration.api_key)
     end
-
-    def save_token!(token_instance)
-      Geocoder.merge_into_lookup_config(:esri, token: token_instance)
-    end
   end
 end

data/lib/geocoder/lookups/freegeoip.rb

@@ -7,10 +7,10 @@ module Geocoder::Lookup
     def name
       "FreeGeoIP"
     end
-    
+
     def supported_protocols
       if configuration[:host]
-        [:http, :https]
+        [:https]
       else
         # use https for default host
         [:https]
@@ -32,8 +32,8 @@ module Geocoder::Lookup
     end
 
     def results(query)
-      # don't look up a loopback address, just return the stored result
-      return [reserved_result(query.text)] if query.loopback_ip_address?
+      # don't look up a loopback or private address, just return the stored result
+      return [reserved_result(query.text)] if query.internal_ip_address?
       # note: Freegeoip.net returns plain text "Not Found" on bad request
       (doc = fetch_data(query)) ? [doc] : []
     end
@@ -44,8 +44,8 @@ module Geocoder::Lookup
         "city"         => "",
         "region_code"  => "",
         "region_name"  => "",
-        "metrocode"    => "",
-        "zipcode"      => "",
+        "metro_code"    => "",
+        "zip_code"      => "",
         "latitude"     => "0",
         "longitude"    => "0",
         "country_name" => "Reserved",
@@ -54,7 +54,7 @@ module Geocoder::Lookup
     end
 
     def host
-      configuration[:host] || "freegeoip.net"
+      configuration[:host] || "freegeoip.app"
     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)
@@ -28,34 +32,36 @@ module Geocoder::Lookup
       []
     end
 
-    def query_url_params(query)
+    def query_url_here_options(query, reverse_geocode)
       options = {
-        :gen=>4,
-        :app_id=>api_key,
-        :app_code=>api_code
+        gen: 9,
+        apikey: configuration.api_key,
+        language: (query.language || configuration.language)
       }
+      if reverse_geocode
+        options[:mode] = :retrieveAddresses
+        return options
+      end
 
-      if query.reverse_geocode?
-        super.merge(options).merge(
-          :prox=>query.sanitized_text,
-          :mode=>:retrieveAddresses
-        )
-      else
-        super.merge(options).merge(
-          :searchtext=>query.sanitized_text
-        )
+      unless (country = query.options[:country]).nil?
+        options[:country] = country
       end
-    end
 
-    def api_key
-      if a=configuration.api_key
-        return a.first if a.is_a?(Array)
+      unless (mapview = query.options[:bounds]).nil?
+        options[:mapview] = mapview.map{ |point| "%f,%f" % point }.join(';')
       end
+      options
     end
 
-    def api_code
-      if a=configuration.api_key
-        return a.last if a.is_a?(Array)
+    def query_url_params(query)
+      if query.reverse_geocode?
+        super.merge(query_url_here_options(query, true)).merge(
+          prox: query.sanitized_text
+        )
+      else
+        super.merge(query_url_here_options(query, false)).merge(
+          searchtext: query.sanitized_text
+        )
       end
     end
   end