geocoder 1.4.5 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aafaf6b62b506a191b17fcdde0bb1b325769fc8a
-  data.tar.gz: 61f40f9ac0c89f3bcf25ff417515b60b2421f14c
+  metadata.gz: 581d1e425470b88287f22a34b3290577ae9b2f3c
+  data.tar.gz: bec7133e542e5da09e6f66828fce5b793c599db3
 SHA512:
-  metadata.gz: 0ee51c45355b969282a51fd79725e5fae1538dc56a5b60e659c0b2d3e072c72e83886f9d0d145928e977ed457d4753f5e0cbd424c0fe5c673d1f741a11a200d2
-  data.tar.gz: 6e4816464c910b0be21bc75d78c2290aabb44b1563af5bac86e6db48b6bae83a5b62c80b8c88c21240b0f8d45c75079e79557698e3aa8ebca4dccfbd99208eb3
+  metadata.gz: b81c979316bfafed7ccc6806ac7eb0441a4a94103769132f01a4614c5629ac2c0ae555cc2cfa6311bca85c4f9791636db2d62eeafd1a031722ca1b2cb6fec28a
+  data.tar.gz: 68e7fd710e2b3558dc25f5714cf8d69b9ed3fbcfc1ab7811a1c692e4a1533bdc0192efd121ae4812c91294d269f123fdd96793cf1ecac1930e8101236b6a1eef

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.4.6 (2018 Feb 28)
+-------------------
+* Add support for :ipdata_co lookup (thanks github.com/roschaefer).
+* Update for Rails 5.2 compatibility (thanks github.com/stevenharman).
+
 1.4.5 (2017 Nov 29)
 -------------------
 * Add support for :pickpoint lookup (thanks github.com/cylon-v).

data/README.md

@@ -662,11 +662,11 @@ Data Science Toolkit provides an API whose response format is like Google's but
 
 * **API key**: required
 * **Quota**: 2,500 free requests/day then purchase $0.0005 for each, also has volume pricing and plans.
-* **Region**: US
+* **Region**: USA & Canada
 * **SSL support**: yes
 * **Languages**: en
-* **Documentation**: http://geocod.io/docs
-* **Terms of Service**: http://geocod.io/terms-of-use
+* **Documentation**: https://geocod.io/docs/
+* **Terms of Service**: https://geocod.io/terms-of-use/
 * **Limitations**: No restrictions on use
 
 #### SmartyStreets (`:smarty_streets`)
@@ -856,6 +856,18 @@ This uses the PostcodeAnywhere UK Geocode service, this will geocode any string
 * **Documentation**: https://db-ip.com/api/doc.php
 * **Terms of Service**: https://db-ip.com/tos.php
 
+#### Ipdata.co (`:ipdata_co`)
+
+* **API key**: optional, see: https://ipdata.co/pricing.html
+* **Quota**: 1500/day (up to 600k with paid API keys)
+* **Region**: world
+* **SSL support**: yes
+* **Languages**: English
+* **Documentation**: https://ipdata.co/docs.html
+* **Terms of Service**: https://ipdata.co/terms.html
+* **Limitations**: ?
+
+
 ### IP Address Local Database Services
 
 #### MaxMind Local (`:maxmind_local`) - EXPERIMENTAL
@@ -1067,6 +1079,7 @@ Notes:
 
 - Keys must be strings not symbols when calling `add_stub` or `set_default_stub`. For example `'latitude' =>` not `:latitude =>`.
 - 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.
 
 
 Command Line Interface

data/lib/geocoder/lookup.rb

@@ -71,6 +71,7 @@ module Geocoder
         :maxmind_geoip2,
         :ipinfo_io,
         :ipapi_com,
+        :ipdata_co,
         :db_ip_com
       ]
     end

data/lib/geocoder/lookups/bing.rb

@@ -44,6 +44,11 @@ module Geocoder::Lookup
         return doc['resourceSets'].first['estimatedTotal'] > 0 ? doc['resourceSets'].first['resources'] : []
       elsif doc['statusCode'] == 401 and doc["authenticationResultCode"] == "InvalidCredentials"
         raise_error(Geocoder::InvalidApiKey) || Geocoder.log(:warn, "Invalid Bing API key.")
+      elsif doc['statusCode'] == 403
+        raise_error(Geocoder::RequestDenied) || Geocoder.log(:warn, "Bing Geocoding API error: Forbidden Request")
+      elsif [500, 503].include?(doc['statusCode'])
+        raise_error(Geocoder::ServiceUnavailable) ||
+          Geocoder.log(:warn, "Bing Geocoding API error: Service Unavailable")
       else
         Geocoder.log(:warn, "Bing Geocoding API error: #{doc['statusCode']} (#{doc['statusDescription']}).")
       end

data/lib/geocoder/lookups/geocodio.rb

@@ -10,7 +10,7 @@ module Geocoder::Lookup
 
     def query_url(query)
       path = query.reverse_geocode? ? "reverse" : "geocode"
-      "#{protocol}://api.geocod.io/v1/#{path}?#{url_query_string(query)}"
+      "#{protocol}://api.geocod.io/v1.2/#{path}?#{url_query_string(query)}"
     end
 
     def results(query)

data/lib/geocoder/lookups/google_premier.rb

@@ -11,7 +11,7 @@ module Geocoder::Lookup
     end
 
     def required_api_key_parts
-      ["private key", "client", "channel"]
+      ["private key"]
     end
 
     def query_url(query)

data/lib/geocoder/lookups/ipdata_co.rb

@@ -0,0 +1,57 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/ipdata_co'
+
+module Geocoder::Lookup
+  class IpdataCo < Base
+
+    def name
+      "ipdata.co"
+    end
+
+    def supported_protocols
+      [:https]
+    end
+
+    def query_url(query)
+      "#{protocol}://#{host}/#{query.sanitized_text}"
+    end
+
+    private # ---------------------------------------------------------------
+
+    def results(query)
+      Geocoder.configure(:ipdata_co => {:http_headers => { "api-key" => configuration.api_key }}) if configuration.api_key
+      # don't look up a loopback address, just return the stored result
+      return [reserved_result(query.text)] if query.loopback_ip_address?
+      # note: Ipdata.co returns plain text on bad request
+      (doc = fetch_data(query)) ? [doc] : []
+    end
+
+    def reserved_result(ip)
+      {
+        "ip"           => ip,
+        "city"         => "",
+        "region_code"  => "",
+        "region_name"  => "",
+        "metrocode"    => "",
+        "zipcode"      => "",
+        "latitude"     => "0",
+        "longitude"    => "0",
+        "country_name" => "Reserved",
+        "country_code" => "RD"
+      }
+    end
+
+    def host
+      "api.ipdata.co"
+    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
+  end
+end

data/lib/geocoder/lookups/location_iq.rb

@@ -16,6 +16,10 @@ module Geocoder::Lookup
       "#{protocol}://locationiq.org/v1/#{method}.php?key=#{configuration.api_key}&" + url_query_string(query)
     end
 
+    def supported_protocols
+      [:http, :https]
+    end
+
     private
 
     def results(query)

data/lib/geocoder/lookups/nominatim.rb

@@ -9,7 +9,7 @@ module Geocoder::Lookup
     end
 
     def map_link_url(coordinates)
-      "http://www.openstreetmap.org/?lat=#{coordinates[0]}&lon=#{coordinates[1]}&zoom=15&layers=M"
+      "https://www.openstreetmap.org/?lat=#{coordinates[0]}&lon=#{coordinates[1]}&zoom=15&layers=M"
     end
 
     def query_url(query)
@@ -18,6 +18,10 @@ module Geocoder::Lookup
       "#{protocol}://#{host}/#{method}?" + url_query_string(query)
     end
 
+    def supported_protocols
+      [:https]
+    end
+
     private # ---------------------------------------------------------------
 
     def results(query)

data/lib/geocoder/request.rb

@@ -81,7 +81,18 @@ module Geocoder
     end
 
     def geocoder_remove_port_from_addresses(ip_addresses)
-      ip_addresses.map { |ip| ip.split(':').first }
+      ip_addresses.map do |ip|
+        # IPv4
+        if ip.count('.') > 0
+          ip.split(':').first
+        # IPv6 bracket notation
+        elsif match = ip.match(/\[(\S+)\]/)
+          match.captures.first
+        # IPv6 bare notation
+        else
+          ip
+        end
+      end
     end
 
     def geocoder_reject_non_ipv4_addresses(ip_addresses)

data/lib/geocoder/results/ipdata_co.rb

@@ -0,0 +1,45 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class IpdataCo < Base
+
+    def address(format = :full)
+      s = state_code.to_s == "" ? "" : ", #{state_code}"
+      "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
+    end
+
+    def city
+      @data['city']
+    end
+
+    def state
+      @data['region']
+    end
+
+    def state_code
+      @data['region_code']
+    end
+
+    def country
+      @data['country_name']
+    end
+
+    def country_code
+      @data['country_code']
+    end
+
+    def postal_code
+      @data['postal']
+    end
+
+    def self.response_attributes
+      %w[ip asn organisation currency currency_symbol calling_code flag time_zone is_eu]
+    end
+
+    response_attributes.each do |a|
+      define_method a do
+        @data[a]
+      end
+    end
+  end
+end

data/lib/geocoder/stores/active_record.rb

@@ -87,8 +87,6 @@ module Geocoder::Store
         end
       end
 
-      private # ----------------------------------------------------------------
-
       ##
       # Get options hash suitable for passing to ActiveRecord.find to get
       # records within a radius (in kilometers) of the given point.
@@ -168,6 +166,8 @@ module Geocoder::Store
         }
       end
 
+      private # ----------------------------------------------------------------
+
       ##
       # SQL for calculating distance based on the current database's
       # capabilities (trig functions?).

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.4.5"
+  VERSION = "1.4.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.4.6
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2018-02-28 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,
@@ -69,6 +69,7 @@ files:
 - lib/geocoder/lookups/google_premier.rb
 - lib/geocoder/lookups/here.rb
 - lib/geocoder/lookups/ipapi_com.rb
+- lib/geocoder/lookups/ipdata_co.rb
 - lib/geocoder/lookups/ipinfo_io.rb
 - lib/geocoder/lookups/latlon.rb
 - lib/geocoder/lookups/location_iq.rb
@@ -119,6 +120,7 @@ files:
 - lib/geocoder/results/google_premier.rb
 - lib/geocoder/results/here.rb
 - lib/geocoder/results/ipapi_com.rb
+- lib/geocoder/results/ipdata_co.rb
 - lib/geocoder/results/ipinfo_io.rb
 - lib/geocoder/results/latlon.rb
 - lib/geocoder/results/location_iq.rb