geocoder 1.4.7 → 1.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dab954ab0ccd1f5c7829f019e78b754a950939c1
-  data.tar.gz: 8dd3db6e80446b91d9c35f9b2ad0f73a5bc28f0b
+  metadata.gz: 854db8cc60efe7a71d336d5001d509a69e1abd13
+  data.tar.gz: e75d9237cd4fc8399b19308434bca339e2a538c1
 SHA512:
-  metadata.gz: f796a95c55636b84fd46a58dd7c5e8c96ffea757270d6b8aba584abcc2634e3c30d6cce30fa6d1abf7d8ed683fecf43db6e0f1ec9512ed4b1f607786ba0289cc
-  data.tar.gz: f87b1b4860241b21a2ecebfeb8345660acf6c51d92483957eb9ec84999752588c75b4e3248366ecf591919859b8c1880c6d7d0fd29dbd67253443945cfce99a2
+  metadata.gz: b10a62001c292e4829aa71e44846c8d2a3272095de360ba09b8cb1469692158bd4a8b0745053433b316e60edf6c7720487c45f9cea303067d44c8d2883b65f6d
+  data.tar.gz: 0b6f87527cf3fa4034b080423a3c195a56c34de80cc3069b103710a14af562e46e446da2e65fbb2f7df62e424be9e6623924f4087b343767617ebb0bfa091be3

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.4.8 (2018 May 21)
+-------------------
+* Change default IP address lookup from :freegeoip to :ipinfo_io.
+* Add support for :ipstack lookup (thanks github.com/Heath101).
+* Fix incompatibility with redis-rb gem v4.0.
+
 1.4.7 (2018 Mar 13)
 -------------------
 * Allow HTTP protocol for Nominatim.

data/README.md

@@ -327,7 +327,7 @@ If you're familiar with the results returned by the geocoding service you're usi
 Geocoding Service ("Lookup") Configuration
 ------------------------------------------
 
-Geocoder supports a variety of street and IP address geocoding services. The default lookups are `:google` for street addresses and `:freegeoip` for IP addresses. Please see the listing and comparison below for details on specific geocoding services (not all settings are supported by all services).
+Geocoder supports a variety of street and IP address geocoding services. The default lookups are `:google` for street addresses and `:ipinfo_io` for IP addresses. Please see the listing and comparison below for details on specific geocoding services (not all settings are supported by all services).
 
 To create a Rails initializer with an example configuration:
 
@@ -477,7 +477,7 @@ The [Google Places Search API](https://developers.google.com/places/web-service/
 * **API key**: none
 * **Quota**: 1 request/second
 * **Region**: world
-* **SSL support**: no
+* **SSL support**: yes
 * **Languages**: ?
 * **Documentation**: http://wiki.openstreetmap.org/wiki/Nominatim
 * **Terms of Service**: http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy
@@ -753,7 +753,17 @@ This uses the PostcodeAnywhere UK Geocode service, this will geocode any string
 
 ### IP Address Services
 
-#### FreeGeoIP (`:freegeoip`)
+#### IPInfo.io (`:ipinfo_io`)
+
+* **API key**: optional - see http://ipinfo.io/pricing
+* **Quota**: 1,000/day - more with api key
+* **Region**: world
+* **SSL support**: no (not without access key - see http://ipinfo.io/pricing)
+* **Languages**: English
+* **Documentation**: http://ipinfo.io/developers
+* **Terms of Service**: http://ipinfo.io/developers
+
+#### FreeGeoIP (`:freegeoip`) - [DISCONTINUED](https://github.com/alexreisner/geocoder/wiki/Freegeoip-Discontinuation)
 
 * **API key**: none
 * **Quota**: 15,000 requests per hour. After reaching the hourly quota, all of your requests will result in HTTP 403 (Forbidden) until it clears up on the next roll over.
@@ -826,15 +836,17 @@ This uses the PostcodeAnywhere UK Geocode service, this will geocode any string
 * **Limitations**: ?
 * **Notes**: You must specify which MaxMind service you are using in your configuration, and also basic authentication. For example: `Geocoder.configure(:maxmind_geoip2 => {:service => :country, :basic_auth => {:user => '', :password => ''}})`.
 
-#### IPInfo.io (`:ipinfo_io`)
+#### Ipstack (`:ipstack`)
 
-* **API key**: optional - see http://ipinfo.io/pricing
-* **Quota**: 1,000/day - more with api key
+* **API key**: required (see https://ipstack.com/product)
+* **Quota**: 10,000 requests per month (with free API Key, 50,000/day and up for paid plans)
 * **Region**: world
-* **SSL support**: no (not without access key - see http://ipinfo.io/pricing)
-* **Languages**: English
-* **Documentation**: http://ipinfo.io/developers
-* **Terms of Service**: http://ipinfo.io/developers
+* **SSL support**: yes ( only with paid plan )
+* **Languages**: English, German, Spanish, French, Japanese, Portugues (Brazil), Russian, Chinese
+* **Documentation**: https://ipstack.com/documentation
+* **Terms of Service**: ?
+* **Limitations**: ?
+* **Notes**: To use Ipstack set `Geocoder.configure(:ip_lookup => :ipstack, :api_key => "your_ipstack_api_key")`. Supports the optional params: `:hostname`, `:security`, `:fields`, `:language` (see API documentation for details).
 
 #### IP-API.com (`:ipapi_com`)
 

data/examples/autoexpire_cache_redis.rb

@@ -8,11 +8,11 @@ class AutoexpireCacheRedis
   end
 
   def [](url)
-    @store.[](url)
+    @store.get(url)
   end
 
   def []=(url, value)
-    @store.[]=(url, value)
+    @store.set(url, value)
     @store.expire(url, @ttl)
   end
 
@@ -25,4 +25,4 @@ class AutoexpireCacheRedis
   end
 end
 
-Geocoder.configure(:cache => AutoexpireCacheRedis.new(Redis.new))
+Geocoder.configure(:cache => AutoexpireCacheRedis.new(Redis.new))

data/lib/generators/geocoder/config/templates/initializer.rb

@@ -2,7 +2,7 @@ Geocoder.configure(
   # Geocoding options
   # timeout: 3,                 # geocoding service timeout (secs)
   # lookup: :google,            # name of geocoding service (symbol)
-  # ip_lookup: :freegeoip,      # name of IP address geocoding service (symbol)
+  # ip_lookup: :ipinfo_io,      # name of IP address geocoding service (symbol)
   # language: :en,              # ISO-639 language code
   # use_https: false,           # use HTTPS for lookup requests? (if supported)
   # http_proxy: nil,            # HTTP proxy server (user:pass@host:port)

data/lib/geocoder/cache.rb

@@ -68,7 +68,7 @@ module Geocoder
     # that have non-nil values.
     #
     def keys
-      store.keys.select{ |k| k.match(/^#{prefix}/) and interpret(store[k]) }
+      store.keys.select{ |k| k.match(/^#{prefix}/) and self[k] }
     end
 
     ##

data/lib/geocoder/configuration.rb

@@ -98,7 +98,7 @@ module Geocoder
       # geocoding options
       @data[:timeout]      = 3           # geocoding service timeout (secs)
       @data[:lookup]       = :google     # name of street address geocoding service (symbol)
-      @data[:ip_lookup]    = :freegeoip  # name of IP address geocoding service (symbol)
+      @data[:ip_lookup]    = :ipinfo_io  # name of IP address geocoding service (symbol)
       @data[:language]     = :en         # ISO-639 language code
       @data[:http_headers] = {}          # HTTP headers for lookup
       @data[:use_https]    = false       # use HTTPS for lookup requests? (if supported)

data/lib/geocoder/lookup.rb

@@ -72,7 +72,8 @@ module Geocoder
         :ipinfo_io,
         :ipapi_com,
         :ipdata_co,
-        :db_ip_com
+        :db_ip_com,
+        :ipstack,
       ]
     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.2/#{path}?#{url_query_string(query)}"
+      "#{protocol}://api.geocod.io/v1.3/#{path}?#{url_query_string(query)}"
     end
 
     def results(query)

data/lib/geocoder/lookups/ipstack.rb

@@ -0,0 +1,64 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/ipstack'
+
+module Geocoder::Lookup
+  class Ipstack < Base
+
+    ERROR_CODES = {
+      404 => Geocoder::InvalidRequest,
+      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
+      "Ipstack"
+    end
+
+    def query_url(query)
+      extra_params = url_query_string(query)
+      url = "#{protocol}://#{host}/#{query.sanitized_text}?access_key=#{api_key}"
+      url << "&#{extra_params}" unless extra_params.empty?
+      url
+    end
+
+    private
+
+    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?
+
+      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, "Ipstack Geocoding API error: #{msg}")
+        return []
+      end
+      [doc]
+    end
+
+    def reserved_result(ip)
+      {
+        "ip"           => ip,
+        "country_name" => "Reserved",
+        "country_code" => "RD"
+      }
+    end
+
+    def host
+      configuration[:host] || "api.ipstack.com"
+    end
+
+    def api_key
+      configuration.api_key
+    end
+  end
+end

data/lib/geocoder/lookups/telize.rb

@@ -14,9 +14,9 @@ module Geocoder::Lookup
 
     def query_url(query)
       if configuration[:host]
-        "#{protocol}://#{configuration[:host]}/geoip/#{query.sanitized_text}"
+        "#{protocol}://#{configuration[:host]}/location/#{query.sanitized_text}"
       else
-        "#{protocol}://telize-v1.p.mashape.com/geoip/#{query.sanitized_text}?mashape-key=#{api_key}"
+        "#{protocol}://telize-v1.p.mashape.com/location/#{query.sanitized_text}?mashape-key=#{api_key}"
       end
     end
 
@@ -50,6 +50,6 @@ module Geocoder::Lookup
     def api_key
       configuration.api_key
     end
-    
+
   end
 end

data/lib/geocoder/results/geoip2.rb

@@ -64,10 +64,6 @@ module Geocoder
 
       private
 
-      def data
-        @data.to_hash
-      end
-
       def default_language
         @default_language = Geocoder.config[:language].to_s
       end

data/lib/geocoder/results/ipstack.rb

@@ -0,0 +1,60 @@
+require 'geocoder/results/base'
+
+module Geocoder::Result
+  class Ipstack < Base
+
+    def address(format = :full)
+      s = region_code.empty? ? "" : ", #{region_code}"
+      "#{city}#{s} #{zip}, #{country_name}".sub(/^[ ,]*/, "")
+    end
+
+    def state
+      @data['region_name']
+    end
+
+    def state_code
+      @data['region_code']
+    end
+
+    def country
+      @data['country_name']
+    end
+
+    def postal_code
+      @data['zip'] || @data['zipcode'] || @data['zip_code']
+    end
+
+    def self.response_attributes
+      [
+        ['ip', ''],
+        ['hostname', ''],
+        ['continent_code', ''],
+        ['continent_name', ''],
+        ['country_code', ''],
+        ['country_name', ''],
+        ['region_code', ''],
+        ['region_name', ''],
+        ['city', ''],
+        ['zip', ''],
+        ['latitude', 0],
+        ['longitude', 0],
+        ['location', {}],
+        ['time_zone', {}],
+        ['currency', {}],
+        ['connection', {}],
+        ['security', {}],
+      ]
+    end
+
+    response_attributes.each do |attr, default|
+      define_method attr do
+        @data[attr] || default
+      end
+    end
+
+    def metro_code
+      Geocoder.log(:warn, "Ipstack does not implement `metro_code` in api results.  Please discontinue use.")
+      0 # no longer implemented by ipstack
+    end
+  end
+end

data/lib/geocoder/stores/base.rb

@@ -90,7 +90,7 @@ module Geocoder
           return
         end
 
-        query_options = [:lookup, :ip_lookup, :language].inject({}) do |hash, key|
+        query_options = [:lookup, :ip_lookup, :language, :params].inject({}) do |hash, key|
           if options.has_key?(key)
             val = options[key]
             hash[key] = val.respond_to?(:call) ? val.call(self) : val

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.4.7"
+  VERSION = "1.4.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocoder
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.4.8
 platform: ruby
 authors:
 - Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-05-21 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,
@@ -71,6 +71,7 @@ files:
 - lib/geocoder/lookups/ipapi_com.rb
 - lib/geocoder/lookups/ipdata_co.rb
 - lib/geocoder/lookups/ipinfo_io.rb
+- lib/geocoder/lookups/ipstack.rb
 - lib/geocoder/lookups/latlon.rb
 - lib/geocoder/lookups/location_iq.rb
 - lib/geocoder/lookups/mapbox.rb
@@ -122,6 +123,7 @@ files:
 - lib/geocoder/results/ipapi_com.rb
 - lib/geocoder/results/ipdata_co.rb
 - lib/geocoder/results/ipinfo_io.rb
+- lib/geocoder/results/ipstack.rb
 - lib/geocoder/results/latlon.rb
 - lib/geocoder/results/location_iq.rb
 - lib/geocoder/results/mapbox.rb
@@ -159,7 +161,11 @@ licenses:
 metadata:
   source_code_uri: https://github.com/alexreisner/geocoder
   changelog_uri: https://github.com/alexreisner/geocoder/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message: |2+
+
+
+  NOTE: Geocoder's default IP address lookup has changed from FreeGeoIP.net to IPInfo.io. If you explicitly specify :freegeoip in your configuration you must choose a different IP lookup before FreeGeoIP is discontinued on July 1, 2018. If you do not explicitly specify :freegeoip you do not need to change anything.
+
 rdoc_options: []
 require_paths:
 - lib