geocoder 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47da8a4b65f982fc2063b17aa979e48bd0747ff8
-  data.tar.gz: e248d9065a8228d98597639be3fb03cf012dc93b
+  metadata.gz: 27a73d81025d3d5faa23e10ae7db3c1d25e9825e
+  data.tar.gz: 740a6672d7cbfd97dc9c1e22a84473007674d4c5
 SHA512:
-  metadata.gz: 5db5819f29c54c1923c31e80717ede54948f987fe086600f166a748b2b5b8c8d3cb021638f261792c95dfbeb13d7e243047e13351dc7edc205535b871b383361
-  data.tar.gz: 3bbf41ec2823259eeffe13e6d90a0aac72710a4dd4e728caca64ed9d7dc550a9306cae0bcf9cd19d9ba6b6797a7b51f1e2c9720ef0bb9f88e9878b547c951c0c
+  metadata.gz: 9ae067878ed711962248b7a63bd8e322f3f0529cef013eb667f96b2c7b51b1f2a59c0ec9437fc79fb6a7338dc569c834abae6c903cf28339562ce6a4ff8db7f6
+  data.tar.gz: 44af9419d97670067cfde24878a7b893d2f0fa6b784102277089f53c9b43d796cf90a755c261851d23b268b902f48a2217147fdff935719d3574cf4b5915ea38

data/CHANGELOG.md

@@ -3,6 +3,13 @@ Changelog
 
 Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
 
+1.2.6 (2014 Nov 8)
+-------------------
+* Add :geoip2 lookup (thanks github.com/ChristianHoj).
+* Add :okf lookup (thanks github.com/kakoni).
+* Add :postcode_anywhere_uk lookup (thanks github.com/rob-murray).
+* Properly detect IPv6 addresses (thanks github.com/sethherr and github.com/ignatiusreza).
+
 1.2.5 (2014 Sep 12)
 -------------------
 * Fix bugs in :opencagedata lookup (thanks github.com/duboff and kayakyakr).

data/README.md

@@ -384,7 +384,7 @@ The following is a comparison of the supported geocoding APIs. The "Limitations"
 
 #### Google (`:google`, `:google_premier`)
 
-* **API key**: required for Premier (do NOT use a key for the free version)
+* **API key**: required for Premier, optional for the free service (if using the free service with API key, https is required. Add `:use_https  => true` to `Geocoder.configure`)
 * **Key signup**: https://developers.google.com/maps/documentation/business/
 * **Quota**: 2,500 requests/day, 100,000 with Google Maps API Premier
 * **Region**: world
@@ -396,6 +396,20 @@ The following is a comparison of the supported geocoding APIs. The "Limitations"
 * **Limitations**: "You must not use or display the Content without a corresponding Google map, unless you are explicitly permitted to do so in the Maps APIs Documentation, or through written permission from Google." "You must not pre-fetch, cache, or store any Content, except that you may store: (i) limited amounts of Content for the purpose of improving the performance of your Maps API Implementation..."
 * **Notes**: To use Google Premier set `Geocoder.configure(:lookup => :google_premier, :api_key => [key, client, channel])`.
 
+#### Google Places Details (`:google_places_details`)
+
+The [Google Places Details API](https://developers.google.com/places/documentation/details) is not, strictly speaking, a geocoding service. It accepts a Google `place_id` and returns address information, ratings and reviews. A `place_id` can be obtained from the Google Places Autocomplete API and should be passed to Geocoder as the first search argument: `Geocoder.search("ChIJhRwB-yFawokR5Phil-QQ3zM", :lookup => :google_places_details)`.
+
+* **API key**: required
+* **Key signup**: https://code.google.com/apis/console/
+* **Quota**: 1,000 request/day, 100,000 after credit card authentication
+* **Region**: world
+* **SSL support**: yes
+* **Languages**: ar, eu, bg, bn, ca, cs, da, de, el, en, en-AU, en-GB, es, eu, fa, fi, fil, fr, gl, gu, hi, hr, hu, id, it, iw, ja, kn, ko, lt, lv, ml, mr, nl, no, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, tl, ta, te, th, tr, uk, vi, zh-CN, zh-TW (see http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1)
+* **Documentation**: https://developers.google.com/places/documentation/details
+* **Terms of Service**: https://developers.google.com/places/policies
+* **Limitations**: "If your application displays Places API data on a page or view that does not also display a Google Map, you must show a "Powered by Google" logo with that data."
+
 #### Yahoo BOSS (`:yahoo`)
 
 * **API key**: requires OAuth consumer key and secret (set `Geocoder.configure(:api_key => [key, secret])`)
@@ -410,7 +424,7 @@ The following is a comparison of the supported geocoding APIs. The "Limitations"
 
 #### Bing (`:bing`)
 
-* **API key**: required
+* **API key**: required (set `Geocoder.configure(:lookup => :bing, :api_key => key)`)
 * **Key signup**: http://www.bingmapsportal.com
 * **Quota**: 50,000 requests/24 hrs
 * **Region**: world
@@ -565,7 +579,7 @@ Data Science Toolkit provides an API whose reponse format is like Google's but w
 
 #### SmartyStreets (`:smarty_streets`)
 
-* **API key**: required
+* **API key**: requires auth_id and auth_token (set `Geocoder.configure(:api_key => [id, token])`)
 * **Quota**: 10,000 free, 250/month then purchase at sliding scale.
 * **Region**: US
 * **SSL support**: yes
@@ -574,6 +588,34 @@ Data Science Toolkit provides an API whose reponse format is like Google's but w
 * **Terms of Service**: http://smartystreets.com/legal/terms-of-service
 * **Limitations**: No reverse geocoding.
 
+
+#### OKF Geocoder (`:okf`)
+
+* **API key**: none
+* **Quota**: none
+* **Region**: FI
+* **SSL support**: no
+* **Languages**: fi
+* **Documentation**: http://books.okf.fi/geocoder/_full/
+* **Terms of Service**: http://www.itella.fi/liitteet/palvelutjatuotteet/yhteystietopalvelut/Postinumeropalvelut-Palvelukuvausjakayttoehdot.pdf
+* **Limitations**: ?
+
+
+#### PostcodeAnywhere Uk (`:postcode_anywhere_uk`)
+
+This uses the PostcodeAnywhere UK Geocode service, this will geocode any string from UK postcode, placename, point of interest or location.
+
+* **API key**: required
+* **Quota**: Dependant on service plan?
+* **Region**: UK
+* **SSL support**: yes
+* **Languages**: English
+* **Documentation**: [http://www.postcodeanywhere.co.uk/Support/WebService/Geocoding/UK/Geocode/2/](http://www.postcodeanywhere.co.uk/Support/WebService/Geocoding/UK/Geocode/2/)
+* **Terms of Service**: ?
+* **Limitations**: ?
+* **Notes**: To use PostcodeAnywhere you must include an API key: `Geocoder.configure(:lookup => :postcode_anywhere_uk, :api_key => 'your_api_key')`.
+
+
 ### IP Address Services
 
 #### FreeGeoIP (`:freegeoip`)
@@ -647,12 +689,11 @@ This lookup provides methods for geocoding IP addresses without making a call to
 
 You can generate ActiveRecord migrations and download and import data via provided rake tasks:
 
+    # generate migration to create tables
     rails generate geocoder:maxmind:geolite PACKAGE=city
 
-    rake geocoder:maxmind:geolite:download PACKAGE=city
-    rake geocoder:maxmind:geolite:extract PACKAGE=city
-    rake geocoder:maxmind:geolite:insert PACKAGE=city
-    rake geocoder:maxmind:geolite:load PACKAGE=city # runs the above three in sequence
+    # download, unpack, and import data
+    rake geocoder:maxmind:geolite:load PACKAGE=city
 
 You can replace `city` with `country` in any of the above tasks, generators, and configurations.
 
@@ -668,6 +709,36 @@ You can replace `city` with `country` in any of the above tasks, generators, and
 * **Limitations**: Only good for non-commercial use. For commercial usage please check http://developer.baidu.com/map/question.htm#qa0013
 * **Notes**: To use Baidu set `Geocoder.configure(:lookup => :baidu_ip, :api_key => "your_api_key")`.
 
+#### GeoLite2 (`:geoip2`)
+
+This lookup provides methods for geocoding IP addresses without making a call to a remote API (improves speed and availability). It works, but support is new and should not be considered production-ready. Please [report any bugs](https://github.com/alexreisner/geocoder/issues) you encounter.
+
+* **API key**: none (requires a GeoIP2 or free GeoLite2 City or Country binary database which can be downloaded from [MaxMind](http://dev.maxmind.com/geoip/geoip2/geoip2/))
+* **Quota**: none
+* **Region**: world
+* **SSL support**: N/A
+* **Languages**: English
+* **Documentation**: http://www.maxmind.com/en/city
+* **Terms of Service**: ?
+* **Limitations**: ?
+* **Notes**: **You must download a binary database file from MaxMind and set the `:file` configuration option.** The CSV format databases are not yet supported since they are still in alpha stage. Set the path to the database file in your configuration:
+
+    Geocoder.configure(
+      ip_lookup: :geoip2,
+      geoip2: {
+        file: File.join('folder', 'GeoLite2-City.mmdb')
+      }
+    )
+
+You must add either the *[hive_geoip2](https://rubygems.org/gems/hive_geoip2)* gem (native extension that relies on libmaxminddb) or the *[maxminddb](http://rubygems.org/gems/maxminddb)* gem (pure Ruby implementation) to your Gemfile or have it installed in your system. The pure Ruby gem (maxminddb) will be used by default. To use `hive_geoip2`:
+
+    Geocoder.configure(
+      ip_lookup: :geoip2, 
+      geoip2: {
+        lib: 'hive_geoip2',
+        file: File.join('folder', 'GeoLite2-City.mmdb')
+      }
+    )
 
 Caching
 -------
@@ -947,12 +1018,16 @@ A lot of debugging time can be saved by understanding how Geocoder works with Ac
 
 ### Unexpected Responses from Geocoding Services
 
-Take a look at the server's raw JSON response. You can do this by getting the request URL in an app console:
+Take a look at the server's raw response. You can do this by getting the request URL in an app console:
 
     Geocoder::Lookup.get(:google).query_url(Geocoder::Query.new("..."))
 
 Replace `:google` with the lookup you are using and replace `...` with the address you are trying to geocode. Then visit the returned URL in your web browser. Often the API will return an error message that helps you resolve the problem. If, after reading the raw response, you believe there is a problem with Geocoder, please post an issue and include both the URL and raw response body.
 
+You can also fetch the response in the console:
+
+    Geocoder::Lookup.get(:google).send(:fetch_raw_data, Geocoder::Query.new("..."))
+
 
 Reporting Issues
 ----------------

data/lib/geocoder/ip_address.rb

@@ -2,11 +2,20 @@ module Geocoder
   class IpAddress < String
 
     def loopback?
-      valid? and (self == "0.0.0.0" or self.match(/\A127\./))
+      valid? and (self == "0.0.0.0" or self.match(/\A127\./) or self == "::1")
     end
 
     def valid?
-      !!self.match(/\A(::ffff:)?(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\z/)
+      ipregex = %r{
+        \A(                                     # String Starts
+        ((::ffff:)?((\d{1,3})\.){3}\d{1,3})     # Check for IPv4
+        |                                       # .... Or
+        (\S+?(:\S+?){6}\S+)                     # Check for IPv6
+        |                                       # .... Or
+        (::1)                                   # IPv6 loopback
+        )\z                                     
+      }x
+      !!self.match(ipregex)
     end
   end
 end

data/lib/geocoder/lookup.rb

@@ -25,6 +25,7 @@ module Geocoder
         :esri,
         :google,
         :google_premier,
+        :google_places_details,
         :yahoo,
         :bing,
         :geocoder_ca,
@@ -38,6 +39,8 @@ module Geocoder
         :baidu,
         :geocodio,
         :smarty_streets,
+        :okf,
+        :postcode_anywhere_uk,
         :test
       ]
     end
@@ -49,6 +52,7 @@ module Geocoder
       [
         :baidu_ip,
         :freegeoip,
+        :geoip2,
         :maxmind,
         :maxmind_local,
         :telize,

data/lib/geocoder/lookups/geoip2.rb

@@ -0,0 +1,40 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/geoip2'
+
+module Geocoder
+  module Lookup
+    class Geoip2 < Base
+      def initialize
+        unless configuration[:file].nil?
+          begin
+            @gem_name = configuration[:lib] || 'maxminddb'
+            require @gem_name
+          rescue LoadError
+            raise "Could not load Maxmind DB dependency. To use the GeoIP2 lookup you must add the #{@gem_name} gem to your Gemfile or have it installed in your system."
+          end
+        end
+        super
+      end
+
+      def name
+        'GeoIP2'
+      end
+
+      def required_api_key_parts
+        []
+      end
+
+      private
+
+      def results(query)
+        return [] unless configuration[:file]
+        if @gem_name == 'hive_geoip2'
+          result = Hive::GeoIP2.lookup(query.to_s, configuration[:file].to_s)
+        else
+          result = MaxMindDB.new(configuration[:file].to_s).lookup(query.to_s)
+        end
+        result.nil? ? [] : [result]
+      end
+    end
+  end
+end

data/lib/geocoder/lookups/google_places_details.rb

@@ -0,0 +1,50 @@
+require "geocoder/lookups/google"
+require "geocoder/results/google_places_details"
+
+module Geocoder
+  module Lookup
+    class GooglePlacesDetails < Google
+      def name
+        "Google Places Details"
+      end
+
+      def required_api_key_parts
+        ["key"]
+      end
+
+      def use_ssl?
+        true
+      end
+
+      def query_url(query)
+        "#{protocol}://maps.googleapis.com/maps/api/place/details/json?#{url_query_string(query)}"
+      end
+
+      private
+
+      def results(query)
+        return [] unless doc = fetch_data(query)
+
+        case doc["status"]
+        when "OK"
+          return [doc["result"]]
+        when "OVER_QUERY_LIMIT"
+          raise_error(Geocoder::OverQueryLimitError) || warn("Google Places Details API error: over query limit.")
+        when "REQUEST_DENIED"
+          raise_error(Geocoder::RequestDenied) || warn("Google Places Details API error: request denied.")
+        when "INVALID_REQUEST"
+          raise_error(Geocoder::InvalidRequest) || warn("Google Places Details API error: invalid request.")
+        end
+
+        []
+      end
+
+      def query_url_google_params(query)
+        {
+          placeid: query.text,
+          language: query.language || configuration.language
+        }
+      end
+    end
+  end
+end

data/lib/geocoder/lookups/maxmind_local.rb

@@ -36,7 +36,7 @@ module Geocoder::Lookup
         addr = IPAddr.new(query.text).to_i
         q = "SELECT l.country, l.region, l.city, l.latitude, l.longitude
           FROM maxmind_geolite_city_location l WHERE l.loc_id = (SELECT b.loc_id FROM maxmind_geolite_city_blocks b
-          WHERE b.start_ip_num <= #{addr} AND #{addr} <= b.end_ip_num)"
+          WHERE b.start_ip_num <= #{addr} AND #{addr} <= b.end_ip_num LIMIT 1)"
         format_result(q, [:country_name, :region_name, :city_name, :latitude, :longitude])
       elsif configuration[:package] == :country
         addr = IPAddr.new(query.text).to_i

data/lib/geocoder/lookups/okf.rb

@@ -0,0 +1,43 @@
+require 'geocoder/lookups/base'
+require "geocoder/results/okf"
+
+module Geocoder::Lookup
+  class Okf < Base
+
+    def name
+      "Okf"
+    end
+
+    def query_url(query)
+      "#{protocol}://data.okf.fi/gis/1/geocode/json?" + url_query_string(query)
+    end
+
+    private # ---------------------------------------------------------------
+
+    def valid_response?(response)
+      status = parse_json(response.body)["status"]
+      super(response) and ['OK', 'ZERO_RESULTS'].include?(status)
+    end
+
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      case doc['status']; when "OK" # OK status implies >0 results
+        return doc['results']
+      end
+      return []
+    end
+
+    def query_url_okf_params(query)
+      params = {
+        (query.reverse_geocode? ? :latlng : :address) => query.sanitized_text,
+        :sensor => "false",
+        :language => (query.language || configuration.language)
+      }
+      params
+    end
+
+    def query_url_params(query)
+      query_url_okf_params(query).merge(super)
+    end
+  end
+end

data/lib/geocoder/lookups/postcode_anywhere_uk.rb

@@ -0,0 +1,51 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/postcode_anywhere_uk'
+
+module Geocoder::Lookup
+  class PostcodeAnywhereUk < Base
+    # API documentation: http://www.postcodeanywhere.co.uk/Support/WebService/Geocoding/UK/Geocode/2/
+    BASE_URL_GEOCODE_V2_00 = 'services.postcodeanywhere.co.uk/Geocoding/UK/Geocode/v2.00/json.ws'
+    DAILY_LIMIT_EXEEDED_ERROR_CODES = ['8', '17'] # api docs say these two codes are the same error
+    INVALID_API_KEY_ERROR_CODE = '2'
+
+    def name
+      'PostcodeAnywhereUk'
+    end
+
+    def required_api_key_parts
+      %w(key)
+    end
+
+    def query_url(query)
+      format('%s://%s?%s', protocol, BASE_URL_GEOCODE_V2_00, url_query_string(query))
+    end
+
+    private
+
+    def results(query)
+      response = fetch_data(query)
+      return [] if response.nil? || !response.is_a?(Array) || response.empty?
+
+      raise_exception_for_response(response[0]) if response[0]['Error']
+      response
+    end
+
+    def raise_exception_for_response(response)
+      case response['Error']
+      when *DAILY_LIMIT_EXEEDED_ERROR_CODES
+        raise_error(Geocoder::OverQueryLimitError, response['Cause']) || warn(response['Cause'])
+      when INVALID_API_KEY_ERROR_CODE
+        raise_error(Geocoder::InvalidApiKey, response['Cause']) || warn(response['Cause'])
+      else # anything else just raise general error with the api cause
+        raise_error(Geocoder::Error, response['Cause']) || warn(response['Cause'])
+      end
+    end
+
+    def query_url_params(query)
+      {
+        :location => query.sanitized_text,
+        :key => configuration.api_key
+      }.merge(super)
+    end
+  end
+end

data/lib/geocoder/lookups/smarty_streets.rb

@@ -8,7 +8,7 @@ module Geocoder::Lookup
     end
 
     def required_api_key_parts
-      %w(auth-token)
+      %w(auti-id auth-token)
     end
 
     def query_url(query)

data/lib/geocoder/results/geoip2.rb

@@ -0,0 +1,64 @@
+require 'geocoder/results/base'
+
+module Geocoder
+  module Result
+    class Geoip2 < Base
+      def address(format = :full)
+        s = state.to_s == '' ? '' : ", #{state_code}"
+        "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, '')
+      end
+
+      def coordinates
+        [latitude, longitude]
+      end
+
+      def latitude
+        return 0.0 unless @data['location']
+        @data['location']['latitude'].to_f
+      end
+
+      def longitude
+        return 0.0 unless @data['location']
+        @data['location']['longitude'].to_f
+      end
+
+      def city
+        return '' unless @data['city']
+        @data['city']['names']['en']
+      end
+
+      def state
+        return '' unless @data['subdivisions']
+        @data['subdivisions'][0]['names']['en']
+      end
+
+      def state_code
+        return '' unless @data['subdivisions']
+        @data['subdivisions'][0]['iso_code']
+      end
+
+      def country
+        @data['country']['names']['en']
+      end
+
+      def country_code
+        @data['country']['iso_code']
+      end
+
+      def postal_code
+        return '' unless @data['postal']
+        @data['postal']['code']
+      end
+
+      def self.response_attributes
+        %w[ip]
+      end
+
+      response_attributes.each do |a|
+        define_method a do
+          @data[a]
+        end
+      end
+    end
+  end
+end