geocoder 1.5.1 → 1.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e556ddf944bdad35735def9028fafebcf61ee294
-  data.tar.gz: a64476b63f73c13f24e385bc090193422bb92faa
+SHA256:
+  metadata.gz: 17d8f44da8b584b65c5546df089f0c16e6d20045676d4a1fe3fef38cdf3c3c59
+  data.tar.gz: c527329b8d1f28a326092e3b3f6d2c9c143dacc2da2397fab5b4109ae7387f09
 SHA512:
-  metadata.gz: '08394b88099374e31e32306a418865b2ffecc4df707044e277072b99d9cadc6f92e1acd70fc18884128f381e28c2c42571f66eb3968a983e214a5a1ca89cf839'
-  data.tar.gz: 87dadf53fe66e26c2f3eec8bfc671b9cebaf76f50bd08f815ae8b08592bd2c87aab8fa1812ef07b282805383b81e93f9777d5224b5c86ebe412f6261fb9fe943
+  metadata.gz: 918ed290277a1aa7e57a102ad06b0cf733e1908e9f31ead6cd59c5d08e5cc5b7d2f581a9958961781e013b535763c92701ad02f2bd8268374e339a36fd75eb25
+  data.tar.gz: 14416b59a9f34890d9a466aad87a883651f13f58a1f0a972c7d48370daed0f70923b9534b13e489673dbbc19543c82fb9017dd274529ce3a587bebe1f230649d

data/CHANGELOG.md

@@ -3,6 +3,51 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.6.7 (2021 Apr 17)
+-------------------
+* Add support for Abstract API lookup (thanks github.com/randoum).
+
+1.6.6 (2021 Mar  4)
+-------------------
+* Rescue from exception on cache read/write error. Issue warning instead.
+
+1.6.5 (2021 Feb 10)
+-------------------
+* Fix backward coordinates bug in NationaalregisterNl lookup (thanks github.com/Marthyn).
+* Allow removal of single stubs in test mode (thanks github.com/jmmastey).
+* Improve results for :ban_data_gouv_fr lookup (thanks github.com/Intrepidd).
+
+1.6.4 (2020 Oct  6)
+-------------------
+* Various updates in response to geocoding API changes.
+* Refactor of Google Places Search lookup (thanks github.com/maximilientyc).
+
+1.6.3 (2020 Apr 30)
+-------------------
+* Update URL for :telize lookup (thanks github.com/alexwalling).
+* Fix bug parsing IPv6 with port (thanks github.com/gdomingu).
+
+1.6.2 (2020 Mar 16)
+-------------------
+* Add support for :nationaal_georegister_nl lookup (thanks github.com/opensourceame).
+* Add support for :uk_ordnance_survey_names lookup (thanks github.com/pezholio).
+* Refactor and fix bugs in Yandex lookup (thanks github.com/iarie and stereodenis).
+
+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).

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-11 Alex Reisner
+Copyright (c) 2009-2021 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 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
@@ -53,8 +51,8 @@ The Rest:
 * [Technical Discussions](#technical-discussions)
 * [Troubleshooting](#troubleshooting)
 * [Known Issues](#known-issues)
-* [Reporting Issues](#reporting-issues)
-* [Contributing](#contributing)
+* [Reporting Issues](https://github.com/alexreisner/geocoder/blob/master/CONTRIBUTING.md#reporting-bugs)
+* [Contributing](https://github.com/alexreisner/geocoder/blob/master/CONTRIBUTING.md#making-changes)
 
 See Also:
 
@@ -215,7 +213,7 @@ Some common options are:
       # set default units to kilometers:
       units: :km,
 
-      # caching (see [below](#caching) for details):
+      # caching (see Caching section below for details):
       cache: Redis.new,
       cache_prefix: "..."
 
@@ -534,10 +532,14 @@ With the above stub defined, any query for "New York, NY" will return the result
       ]
     )
 
+You may also delete a single stub, or reset all stubs _including the default stub_:
+
+    Geocoder::Lookup::Test.delete_stub('New York, NY')
+    Geocoder::Lookup::Test.reset
+
 Notes:
 
 - Keys must be strings (not symbols) when calling `add_stub` or `set_default_stub`. For example `'country' =>` not `:country =>`.
-- To clear stubs (e.g. prior to another spec), use `Geocoder::Lookup::Test.reset`. This will clear all stubs _including the default stub_.
 - The stubbed result objects returned by the Test lookup do not support all the methods real result objects do. If you need to test interaction with real results it may be better to use an external stubbing tool and something like WebMock or VCR to prevent network calls.
 
 
@@ -678,29 +680,4 @@ If anyone has a more elegant solution to this problem I am very interested in se
 The `near` method will not look across the 180th meridian to find objects close to a given point. In practice this is rarely an issue outside of New Zealand and certain surrounding islands. This problem does not exist with the zero-meridian. The problem is due to a shortcoming of the Haversine formula which Geocoder uses to calculate distances.
 
 
-Reporting Issues
-----------------
-
-When reporting an issue, please list the version of Geocoder you are using and any relevant information about your application (Rails version, database type and version, etc). Please describe as specifically as you can what behavior you are seeing (eg: an error message? a nil return value?).
-
-Please DO NOT use GitHub issues to ask questions about how to use Geocoder. Sites like [StackOverflow](http://www.stackoverflow.com/) are a better forum for such discussions.
-
-
-Contributing
-------------
-
-Contributions are welcome via Github pull requests. If you are new to the project and looking for a way to get involved, try picking up an issue with a "beginner-task" label. Hints about what needs to be done are usually provided.
-
-For all contributions, please respect the following guidelines:
-
-* Each pull request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request.
-* Do not commit changes to files that are irrelevant to your feature or bugfix (eg: `.gitignore`).
-* Do not add dependencies on other gems.
-* Do not add unnecessary `require` statements which could cause LoadErrors on certain systems.
-* Remember: Geocoder needs to run outside of Rails. Don't assume things like ActiveSupport are available.
-* Be willing to accept criticism and work on improving your code; Geocoder is used by thousands of developers and care must be taken not to introduce bugs.
-* Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.
-* 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-2021 Alex Reisner, released under the MIT license.

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'geocoder'
+
+if File.exist?("api_keys.yml")
+  require 'yaml'
+  @api_keys = YAML.load(File.read("api_keys.yml"), symbolize_names: true)
+  Geocoder.configure(@api_keys)
+end
+
+require 'irb'
+IRB.start

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

@@ -0,0 +1,171 @@
+module Geocoder
+  class EastingNorthing
+    attr_reader :easting, :northing, :lat_lng
+
+    def initialize(opts)
+      @easting = opts[:easting]
+      @northing = opts[:northing]
+
+      @lat_lng = to_WGS84(to_osgb_36)
+    end
+
+    private
+
+    def to_osgb_36
+      osgb_fo  = 0.9996012717
+      northing0 = -100_000.0
+      easting0 = 400_000.0
+      phi0 = deg_to_rad(49.0)
+      lambda0 = deg_to_rad(-2.0)
+      a = 6_377_563.396
+      b = 6_356_256.909
+      eSquared = ((a * a) - (b * b)) / (a * a)
+      phi = 0.0
+      lambda = 0.0
+      n = (a - b) / (a + b)
+      m = 0.0
+      phiPrime = ((northing - northing0) / (a * osgb_fo)) + phi0
+
+      while (northing - northing0 - m) >= 0.001
+        m =
+          (b * osgb_fo)\
+            * (((1 + n + ((5.0 / 4.0) * n * n) + ((5.0 / 4.0) * n * n * n))\
+              * (phiPrime - phi0))\
+              - (((3 * n) + (3 * n * n) + ((21.0 / 8.0) * n * n * n))\
+                * Math.sin(phiPrime - phi0)\
+                * Math.cos(phiPrime + phi0))\
+              + ((((15.0 / 8.0) * n * n) + ((15.0 / 8.0) * n * n * n))\
+                * Math.sin(2.0 * (phiPrime - phi0))\
+                * Math.cos(2.0 * (phiPrime + phi0)))\
+              - (((35.0 / 24.0) * n * n * n)\
+                * Math.sin(3.0 * (phiPrime - phi0))\
+                * Math.cos(3.0 * (phiPrime + phi0))))
+
+        phiPrime += (northing - northing0 - m) / (a * osgb_fo)
+      end
+
+      v = a * osgb_fo * ((1.0 - eSquared * sin_pow_2(phiPrime))**-0.5)
+      rho =
+        a\
+          * osgb_fo\
+          * (1.0 - eSquared)\
+          * ((1.0 - eSquared * sin_pow_2(phiPrime))**-1.5)
+      etaSquared = (v / rho) - 1.0
+      vii = Math.tan(phiPrime) / (2 * rho * v)
+      viii =
+        (Math.tan(phiPrime) / (24.0 * rho * (v**3.0)))\
+          * (5.0\
+            + (3.0 * tan_pow_2(phiPrime))\
+            + etaSquared\
+            - (9.0 * tan_pow_2(phiPrime) * etaSquared))
+      ix =
+        (Math.tan(phiPrime) / (720.0 * rho * (v**5.0)))\
+          * (61.0\
+            + (90.0 * tan_pow_2(phiPrime))\
+            + (45.0 * tan_pow_2(phiPrime) * tan_pow_2(phiPrime)))
+      x = sec(phiPrime) / v
+      xi =
+        (sec(phiPrime) / (6.0 * v * v * v))\
+          * ((v / rho) + (2 * tan_pow_2(phiPrime)))
+      xiii =
+        (sec(phiPrime) / (120.0 * (v**5.0)))\
+          * (5.0\
+            + (28.0 * tan_pow_2(phiPrime))\
+            + (24.0 * tan_pow_2(phiPrime) * tan_pow_2(phiPrime)))
+      xiia =
+        (sec(phiPrime) / (5040.0 * (v**7.0)))\
+          * (61.0\
+            + (662.0 * tan_pow_2(phiPrime))\
+            + (1320.0 * tan_pow_2(phiPrime) * tan_pow_2(phiPrime))\
+            + (720.0\
+              * tan_pow_2(phiPrime)\
+              * tan_pow_2(phiPrime)\
+              * tan_pow_2(phiPrime)))
+      phi =
+        phiPrime\
+          - (vii * ((easting - easting0)**2.0))\
+          + (viii * ((easting - easting0)**4.0))\
+          - (ix * ((easting - easting0)**6.0))
+      lambda =
+        lambda0\
+          + (x * (easting - easting0))\
+          - (xi * ((easting - easting0)**3.0))\
+          + (xiii * ((easting - easting0)**5.0))\
+          - (xiia * ((easting - easting0)**7.0))
+
+      [rad_to_deg(phi), rad_to_deg(lambda)]
+    end
+
+    def to_WGS84(latlng)
+      latitude = latlng[0]
+      longitude = latlng[1]
+
+      a = 6_377_563.396
+      b = 6_356_256.909
+      eSquared = ((a * a) - (b * b)) / (a * a)
+
+      phi = deg_to_rad(latitude)
+      lambda = deg_to_rad(longitude)
+      v = a / Math.sqrt(1 - eSquared * sin_pow_2(phi))
+      h = 0
+      x = (v + h) * Math.cos(phi) * Math.cos(lambda)
+      y = (v + h) * Math.cos(phi) * Math.sin(lambda)
+      z = ((1 - eSquared) * v + h) * Math.sin(phi)
+
+      tx = 446.448
+      ty = -124.157
+      tz = 542.060
+
+      s  = -0.0000204894
+      rx = deg_to_rad(0.00004172222)
+      ry = deg_to_rad(0.00006861111)
+      rz = deg_to_rad(0.00023391666)
+
+      xB = tx + (x * (1 + s)) + (-rx * y) + (ry * z)
+      yB = ty + (rz * x) + (y * (1 + s)) + (-rx * z)
+      zB = tz + (-ry * x) + (rx * y) + (z * (1 + s))
+
+      a = 6_378_137.000
+      b = 6_356_752.3141
+      eSquared = ((a * a) - (b * b)) / (a * a)
+
+      lambdaB = rad_to_deg(Math.atan(yB / xB))
+      p = Math.sqrt((xB * xB) + (yB * yB))
+      phiN = Math.atan(zB / (p * (1 - eSquared)))
+
+      (1..10).each do |_i|
+        v = a / Math.sqrt(1 - eSquared * sin_pow_2(phiN))
+        phiN1 = Math.atan((zB + (eSquared * v * Math.sin(phiN))) / p)
+        phiN = phiN1
+      end
+
+      phiB = rad_to_deg(phiN)
+
+      [phiB, lambdaB]
+    end
+
+    def deg_to_rad(degrees)
+      degrees / 180.0 * Math::PI
+    end
+
+    def rad_to_deg(r)
+      (r / Math::PI) * 180
+    end
+
+    def sin_pow_2(x)
+      Math.sin(x) * Math.sin(x)
+    end
+
+    def cos_pow_2(x)
+      Math.cos(x) * Math.cos(x)
+    end
+
+    def tan_pow_2(x)
+      Math.tan(x) * Math.tan(x)
+    end
+
+    def sec(x)
+      1.0 / Math.cos(x)
+    end
+  end
+end

data/lib/geocoder/cache.rb

@@ -18,6 +18,8 @@ module Geocoder
         when store.respond_to?(:read)
           store.read key_for(url)
       end
+    rescue => e
+      warn "Geocoder cache read error: #{e}"
     end
 
     ##
@@ -32,6 +34,8 @@ module Geocoder
         when store.respond_to?(:write)
           store.write key_for(url), value
       end
+    rescue => e
+      warn "Geocoder cache write error: #{e}"
     end
 
     ##

data/lib/geocoder/configuration.rb

@@ -1,5 +1,6 @@
 require 'singleton'
 require 'geocoder/configuration_hash'
+require 'geocoder/util'
 
 module Geocoder
 
@@ -85,7 +86,7 @@ module Geocoder
     end
 
     def configure(options)
-      @data.rmerge!(options)
+      Util.recursive_hash_merge(@data, options)
     end
 
     def initialize # :nodoc

data/lib/geocoder/configuration_hash.rb

@@ -1,11 +1,11 @@
-require 'hash_recursive_merge'
-
 module Geocoder
   class ConfigurationHash < Hash
-    include HashRecursiveMerge
-
     def method_missing(meth, *args, &block)
       has_key?(meth) ? self[meth] : super
     end
+
+    def respond_to_missing?(meth, include_private = false)
+      has_key?(meth) || super
+    end
   end
 end

data/lib/geocoder/ip_address.rb

@@ -20,7 +20,8 @@ module Geocoder
     end
 
     def valid?
-      !!((self =~ Resolv::IPv4::Regex) || (self =~ Resolv::IPv6::Regex))
+      ip = self[/(?<=\[)(.*?)(?=\])/] || self
+      !!((ip =~ Resolv::IPv4::Regex) || (ip =~ Resolv::IPv6::Regex))
     end
   end
 end

data/lib/geocoder/lookup.rb

@@ -32,11 +32,12 @@ module Geocoder
         :google_places_search,
         :bing,
         :geocoder_ca,
-        :geocoder_us,
         :yandex,
+        :nationaal_georegister_nl,
         :nominatim,
         :mapbox,
         :mapquest,
+        :uk_ordnance_survey_names,
         :opencagedata,
         :pelias,
         :pickpoint,
@@ -51,7 +52,8 @@ module Geocoder
         :ban_data_gouv_fr,
         :test,
         :latlon,
-        :amap
+        :amap,
+        :osmnames
       ]
     end
 
@@ -61,6 +63,7 @@ module Geocoder
     def ip_services
       @ip_services ||= [
         :baidu_ip,
+        :abstract_api,
         :freegeoip,
         :geoip2,
         :maxmind,
@@ -69,11 +72,13 @@ module Geocoder
         :pointpin,
         :maxmind_geoip2,
         :ipinfo_io,
+        :ipregistry,
         :ipapi_com,
         :ipdata_co,
         :db_ip_com,
         :ipstack,
-        :ip2location
+        :ip2location,
+        :ipgeolocation
       ]
     end