geocoder 1.4.3 → 1.5.0

data/lib/geocoder/lookups/geocoder_us.rb

@@ -8,20 +8,28 @@ module Geocoder::Lookup
       "Geocoder.us"
     end
 
-      def supported_protocols
-        [:http]
-      end
+    def supported_protocols
+      [:http]
+    end
+
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
+      base_query_url_with_optional_key(configuration.api_key)
+    end
 
-    def query_url(query)
+    def cache_key(query)
+      base_query_url_with_optional_key(nil) + url_query_string(query)
+    end
+
+    def base_query_url_with_optional_key(key = nil)
+      base = "#{protocol}://"
       if configuration.api_key
-        "#{protocol}://#{configuration.api_key}@geocoder.us/member/service/csv/geocode?" + url_query_string(query)
-      else
-        "#{protocol}://geocoder.us/service/csv/geocode?" + url_query_string(query)
+        base << "#{configuration.api_key}@"
       end
+      base + "geocoder.us/member/service/csv/geocode?"
     end
 
-    private
-
     def results(query)
       return [] unless doc = fetch_data(query)
       if doc[0].to_s =~ /^(\d+)\:/

data/lib/geocoder/lookups/geocodio.rb

@@ -8,11 +8,6 @@ module Geocoder::Lookup
       "Geocodio"
     end
 
-    def query_url(query)
-      path = query.reverse_geocode? ? "reverse" : "geocode"
-      "#{protocol}://api.geocod.io/v1/#{path}?#{url_query_string(query)}"
-    end
-
     def results(query)
       return [] unless doc = fetch_data(query)
       return doc["results"] if doc['error'].nil?
@@ -32,6 +27,11 @@ module Geocoder::Lookup
 
     private # ---------------------------------------------------------------
 
+    def base_query_url(query)
+      path = query.reverse_geocode? ? "reverse" : "geocode"
+      "#{protocol}://api.geocod.io/v1.3/#{path}?"
+    end
+
     def query_url_params(query)
       {
         :api_key => configuration.api_key,

data/lib/geocoder/lookups/geoportail_lu.rb

@@ -9,14 +9,14 @@ module Geocoder
         "Geoportail.lu"
       end
 
-      def query_url(query)
-        url_base_path(query) + url_query_string(query)
-      end
-
-      private
+      private # ---------------------------------------------------------------
 
-      def url_base_path(query)
-        query.reverse_geocode? ? reverse_geocode_url_base_path : search_url_base_path
+      def base_query_url(query)
+        if query.reverse_geocode?
+          reverse_geocode_url_base_path
+        else
+          search_url_base_path
+        end
       end
 
       def search_url_base_path

data/lib/geocoder/lookups/google.rb

@@ -21,12 +21,12 @@ module Geocoder::Lookup
       end
     end
 
-    def query_url(query)
-      "#{protocol}://maps.googleapis.com/maps/api/geocode/json?" + url_query_string(query)
-    end
-
     private # ---------------------------------------------------------------
 
+    def base_query_url(query)
+      "#{protocol}://maps.googleapis.com/maps/api/geocode/json?"
+    end
+
     def configure_ssl!(client)
       client.instance_eval {
         @ssl_context = OpenSSL::SSL::SSLContext.new
@@ -52,21 +52,25 @@ module Geocoder::Lookup
         raise_error(Geocoder::OverQueryLimitError) ||
           Geocoder.log(:warn, "#{name} API error: over query limit.")
       when "REQUEST_DENIED"
-        raise_error(Geocoder::RequestDenied) ||
-          Geocoder.log(:warn, "#{name} API error: request denied.")
+        raise_error(Geocoder::RequestDenied, doc['error_message']) ||
+          Geocoder.log(:warn, "#{name} API error: request denied (#{doc['error_message']}).")
       when "INVALID_REQUEST"
-        raise_error(Geocoder::InvalidRequest) ||
-          Geocoder.log(:warn, "#{name} API error: invalid request.")
+        raise_error(Geocoder::InvalidRequest, doc['error_message']) ||
+          Geocoder.log(:warn, "#{name} API error: invalid request (#{doc['error_message']}).")
       end
       return []
     end
 
     def query_url_google_params(query)
       params = {
-        (query.reverse_geocode? ? :latlng : :address) => query.sanitized_text,
         :sensor => "false",
         :language => (query.language || configuration.language)
       }
+      if query.options[:google_place_id]
+        params[:place_id] = query.sanitized_text
+      else
+        params[(query.reverse_geocode? ? :latlng : :address)] = query.sanitized_text
+      end
       unless (bounds = query.options[:bounds]).nil?
         params[:bounds] = bounds.map{ |point| "%f,%f" % point }.join('|')
       end

data/lib/geocoder/lookups/google_places_details.rb

@@ -16,12 +16,12 @@ module Geocoder
         [:https]
       end
 
-      def query_url(query)
-        "#{protocol}://maps.googleapis.com/maps/api/place/details/json?#{url_query_string(query)}"
-      end
-
       private
 
+      def base_query_url(query)
+        "#{protocol}://maps.googleapis.com/maps/api/place/details/json?"
+      end
+
       def results(query)
         return [] unless doc = fetch_data(query)
 

data/lib/geocoder/lookups/google_places_search.rb

@@ -16,12 +16,12 @@ module Geocoder
         [:https]
       end
 
-      def query_url(query)
-        "#{protocol}://maps.googleapis.com/maps/api/place/textsearch/json?#{url_query_string(query)}"
-      end
-
       private
 
+      def base_query_url(query)
+        "#{protocol}://maps.googleapis.com/maps/api/place/textsearch/json?"
+      end
+
       def query_url_google_params(query)
         {
           query: query.text,

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)
@@ -21,6 +21,16 @@ module Geocoder::Lookup
 
     private # ---------------------------------------------------------------
 
+    def cache_key(query)
+      "#{protocol}://maps.googleapis.com/maps/api/geocode/json?" + hash_to_query(cache_key_params(query))
+    end
+
+    def cache_key_params(query)
+      query_url_google_params(query).merge(super).reject do |k,v|
+        [:key, :client, :channel].include?(k)
+      end
+    end
+
     def query_url_params(query)
       query_url_google_params(query).merge(super).merge(
         :key => nil, # don't use param inherited from Google lookup

data/lib/geocoder/lookups/here.rb

@@ -12,12 +12,12 @@ module Geocoder::Lookup
       ["app_id", "app_code"]
     end
 
-    def 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?" + url_query_string(query)
-    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?"
+    end
+
     def results(query)
       return [] unless doc = fetch_data(query)
       return [] unless doc['Response'] && doc['Response']['View']

data/lib/geocoder/lookups/ip2location.rb

@@ -0,0 +1,74 @@
+require 'geocoder/lookups/base'
+require 'geocoder/results/ip2location'
+
+module Geocoder::Lookup
+  class Ip2location < Base
+
+    def name
+      "IP2LocationApi"
+    end
+
+    def supported_protocols
+      [:http, :https]
+    end
+
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
+      "#{protocol}://api.ip2location.com/?"
+    end
+
+    def query_url_params(query)
+      {
+        key: configuration.api_key ? configuration.api_key : "demo",
+        format: "json",
+        ip: query.sanitized_text
+      }.merge(super)
+    end
+
+    def results(query)
+      return [reserved_result(query.text)] if query.loopback_ip_address?
+      return [] unless doc = fetch_data(query)
+      if doc["response"] == "INVALID ACCOUNT"
+        raise_error(Geocoder::InvalidApiKey) || Geocoder.log(:warn, "INVALID ACCOUNT")
+        return []
+      else
+        return [doc]
+      end
+    end
+
+    def reserved_result(query)
+      {
+        "country_code"         => "INVALID IP ADDRESS",
+        "country_name"         => "INVALID IP ADDRESS",
+        "region_name"          => "INVALID IP ADDRESS",
+        "city_name"            => "INVALID IP ADDRESS",
+        "latitude"             => "INVALID IP ADDRESS",
+        "longitude"            => "INVALID IP ADDRESS",
+        "zip_code"             => "INVALID IP ADDRESS",
+        "time_zone"            => "INVALID IP ADDRESS",
+        "isp"                  => "INVALID IP ADDRESS",
+        "domain"               => "INVALID IP ADDRESS",
+        "net_speed"            => "INVALID IP ADDRESS",
+        "idd_code"             => "INVALID IP ADDRESS",
+        "area_code"            => "INVALID IP ADDRESS",
+        "weather_station_code" => "INVALID IP ADDRESS",
+        "weather_station_name" => "INVALID IP ADDRESS",
+        "mcc"                  => "INVALID IP ADDRESS",
+        "mnc"                  => "INVALID IP ADDRESS",
+        "mobile_brand"         => "INVALID IP ADDRESS",
+        "elevation"            => "INVALID IP ADDRESS",
+        "usage_type"           => "INVALID IP ADDRESS"
+      }
+    end
+
+    def query_url_params(query)
+      params = super
+      if configuration.has_key?(:package)
+        params.merge!(package: configuration[:package])
+      end
+      params
+    end
+
+  end
+end

data/lib/geocoder/lookups/ipapi_com.rb

@@ -8,17 +8,6 @@ module Geocoder::Lookup
       "ip-api.com"
     end
 
-    def query_url(query)
-      domain = configuration.api_key ? "pro.ip-api.com" : "ip-api.com"
-      url_ = "#{protocol}://#{domain}/json/#{query.sanitized_text}"
-
-      if (params = url_query_string(query)) && !params.empty?
-        url_ + "?" + params
-      else
-        url_
-      end
-    end
-
     def supported_protocols
       if configuration.api_key
         [:http, :https]
@@ -27,8 +16,14 @@ module Geocoder::Lookup
       end
     end
 
+    private # ----------------------------------------------------------------
 
-    private
+    def base_query_url(query)
+      domain = configuration.api_key ? "pro.ip-api.com" : "ip-api.com"
+      url = "#{protocol}://#{domain}/json/#{query.sanitized_text}"
+      url << "?" if not url_query_string(query).empty?
+      url
+    end
 
     def parse_raw_data(raw_data)
       if raw_data.chomp == "invalid key"

data/lib/geocoder/lookups/ipdata_co.rb

@@ -0,0 +1,61 @@
+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 cache_key(query)
+      query_url(query)
+    end
+
+    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/ipinfo_io.rb

@@ -8,14 +8,6 @@ module Geocoder::Lookup
       "Ipinfo.io"
     end
 
-    def query_url(query)
-      if configuration.api_key
-        "#{protocol}://ipinfo.io/#{query.sanitized_text}/geo?" + url_query_string(query)
-      else
-        "#{protocol}://ipinfo.io/#{query.sanitized_text}/geo"
-      end
-    end
-
     # HTTPS available only for paid plans
     def supported_protocols
       if configuration.api_key
@@ -27,28 +19,27 @@ module Geocoder::Lookup
 
     private # ---------------------------------------------------------------
 
+    def base_query_url(query)
+      url = "#{protocol}://ipinfo.io/#{query.sanitized_text}/geo"
+      url << "?" if configuration.api_key
+      url
+    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?
-      if (doc = fetch_data(query)).nil? or doc['code'] == 401 or empty_result?(doc)
+
+      if !(doc = fetch_data(query)).is_a?(Hash) or doc['error']
         []
       else
         [doc]
       end
     end
 
-    def empty_result?(doc)
-      !doc.is_a?(Hash) or doc.keys == ["ip"]
-    end
-
     def reserved_result(ip)
       {
-        "ip"           => ip,
-        "city"         => "",
-        "region"       => "",
-        "country"      => "",
-        "loc"          => "0,0",
-        "postal"       => ""
+        "ip" => ip,
+        "bogon" => true
       }
     end
 

data/lib/geocoder/lookups/ipstack.rb

@@ -0,0 +1,63 @@
+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
+
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
+      "#{protocol}://#{host}/#{query.sanitized_text}?"
+    end
+
+    def query_url_params(query)
+      {
+        access_key: configuration.api_key
+      }.merge(super)
+    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?
+
+      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
+  end
+end

data/lib/geocoder/lookups/latlon.rb

@@ -12,12 +12,12 @@ module Geocoder::Lookup
       ["api_key"]
     end
 
-    def query_url(query)
-      "#{protocol}://latlon.io/api/v1/#{'reverse_' if query.reverse_geocode?}geocode?#{url_query_string(query)}"
-    end
-
     private # ---------------------------------------------------------------
 
+    def base_query_url(query)
+      "#{protocol}://latlon.io/api/v1/#{'reverse_' if query.reverse_geocode?}geocode?"
+    end
+
     def results(query)
       return [] unless doc = fetch_data(query)
       if doc['error'].nil?

data/lib/geocoder/lookups/location_iq.rb

@@ -10,20 +10,38 @@ module Geocoder::Lookup
     def required_api_key_parts
       ["api_key"]
     end
-    
-    def query_url(query)
-      method = query.reverse_geocode? ? "reverse.php" : "search.php"
-      host = configuration[:host] || "locationiq.org/v1"
-      "#{protocol}://#{host}/#{method}?key=#{configuration.api_key}&" + url_query_string(query)
+
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
+      method = query.reverse_geocode? ? "reverse" : "search"
+      "#{protocol}://#{configured_host}/v1/#{method}.php?"
     end
 
-    private
+    def query_url_params(query)
+      {
+        key: configuration.api_key
+      }.merge(super)
+    end
+
+    def configured_host
+      configuration[:host] || "locationiq.org"
+    end
 
     def results(query)
       return [] unless doc = fetch_data(query)
 
-      if !doc.is_a?(Array) && doc['error'] =~ /Invalid\skey/
-        raise_error(Geocoder::InvalidApiKey, doc['error'])
+      if !doc.is_a?(Array)
+        case doc['error']
+        when "Invalid key"
+          raise_error(Geocoder::InvalidApiKey, doc['error'])
+        when "Key not active - Please write to contact@unwiredlabs.com"
+          raise_error(Geocoder::RequestDenied, doc['error'])
+        when "Rate Limited"
+          raise_error(Geocoder::OverQueryLimitError, doc['error'])
+        when "Unknown error - Please try again after some time"
+          raise_error(Geocoder::InvalidRequest, doc['error'])
+        end
       end
 
       doc.is_a?(Array) ? doc : [doc]

data/lib/geocoder/lookups/mapbox.rb

@@ -8,12 +8,12 @@ module Geocoder::Lookup
       "Mapbox"
     end
 
-    def query_url(query)
-      "#{protocol}://api.mapbox.com/geocoding/v5/#{dataset}/#{url_query_string(query)}.json?access_token=#{configuration.api_key}"
-    end
-
     private # ---------------------------------------------------------------
 
+    def base_query_url(query)
+      "#{protocol}://api.mapbox.com/geocoding/v5/#{dataset}/#{mapbox_search_term(query)}.json?"
+    end
+
     def results(query)
       return [] unless data = fetch_data(query)
       if data['features']
@@ -25,13 +25,19 @@ module Geocoder::Lookup
       end
     end
 
-    def url_query_string(query)
+    def query_url_params(query)
+      {access_token: configuration.api_key}.merge(super(query))
+    end
+
+    def mapbox_search_term(query)
       require 'cgi' unless defined?(CGI) && defined?(CGI.escape)
       if query.reverse_geocode?
         lat,lon = query.coordinates
         "#{CGI.escape lon},#{CGI.escape lat}"
       else
-        CGI.escape query.text.to_s
+        # truncate at first semicolon so Mapbox doesn't go into batch mode
+        # (see Github issue #1299)
+        CGI.escape query.text.to_s.split(';').first.to_s
       end
     end
 

data/lib/geocoder/lookups/mapquest.rb

@@ -13,14 +13,13 @@ module Geocoder::Lookup
       ["key"]
     end
 
-    def query_url(query)
+    private # ---------------------------------------------------------------
+
+    def base_query_url(query)
       domain = configuration[:open] ? "open" : "www"
-      url = "#{protocol}://#{domain}.mapquestapi.com/geocoding/v1/#{search_type(query)}?"
-      url + url_query_string(query)
+      "#{protocol}://#{domain}.mapquestapi.com/geocoding/v1/#{search_type(query)}?"
     end
 
-    private # ---------------------------------------------------------------
-
     def search_type(query)
       query.reverse_geocode? ? "reverse" : "address"
     end

data/lib/geocoder/lookups/maxmind.rb

@@ -9,12 +9,12 @@ module Geocoder::Lookup
       "MaxMind"
     end
 
-    def query_url(query)
-      "#{protocol}://geoip.maxmind.com/#{service_code}?" + url_query_string(query)
-    end
-
     private # ---------------------------------------------------------------
 
+    def base_query_url(query)
+      "#{protocol}://geoip.maxmind.com/#{service_code}?"
+    end
+
     ##
     # Return the name of the configured service, or raise an exception.
     #

data/lib/geocoder/lookups/maxmind_geoip2.rb

@@ -20,6 +20,10 @@ module Geocoder::Lookup
 
     private # ---------------------------------------------------------------
 
+    def cache_key(query)
+      query_url(query)
+    end
+
     ##
     # Return the name of the configured service, or raise an exception.
     #