geocoder 1.4.9 → 1.6.7

data/lib/geocoder/lookups/baidu.rb

@@ -12,10 +12,6 @@ module Geocoder::Lookup
       ["key"]
     end
 
-    def query_url(query)
-      "#{protocol}://api.map.baidu.com/geocoder/v2/?" + url_query_string(query)
-    end
-
     # HTTP only
     def supported_protocols
       [:http]
@@ -23,26 +19,34 @@ module Geocoder::Lookup
 
     private # ---------------------------------------------------------------
 
+    def base_query_url(query)
+      "#{protocol}://api.map.baidu.com/geocoder/v2/?"
+    end
+
+    def content_key
+      'result'
+    end
+
     def results(query, reverse = false)
       return [] unless doc = fetch_data(query)
       case doc['status']
       when 0
-        return [doc['result']] unless doc['result'].blank?
+        return [doc[content_key]] unless doc[content_key].blank?
       when 1, 3, 4
         raise_error(Geocoder::Error, "server error.") ||
-          Geocoder.log(:warn, "Baidu Geocoding API error: server error.")
+          Geocoder.log(:warn, "#{name} Geocoding API error: server error.")
       when 2
         raise_error(Geocoder::InvalidRequest, "invalid request.") ||
-          Geocoder.log(:warn, "Baidu Geocoding API error: invalid request.")
+          Geocoder.log(:warn, "#{name} Geocoding API error: invalid request.")
       when 5
         raise_error(Geocoder::InvalidApiKey, "invalid api key") ||
-          Geocoder.log(:warn, "Baidu Geocoding API error: invalid api key.")
+          Geocoder.log(:warn, "#{name} Geocoding API error: invalid api key.")
       when 101, 102, 200..299
         raise_error(Geocoder::RequestDenied, "request denied") ||
-          Geocoder.log(:warn, "Baidu Geocoding API error: request denied.")
+          Geocoder.log(:warn, "#{name} Geocoding API error: request denied.")
       when 300..399
         raise_error(Geocoder::OverQueryLimitError, "over query limit.") ||
-          Geocoder.log(:warn, "Baidu Geocoding API error: over query limit.")
+          Geocoder.log(:warn, "#{name} Geocoding API error: over query limit.")
       end
       return []
     end

data/lib/geocoder/lookups/baidu_ip.rb

@@ -1,50 +1,21 @@
-require 'geocoder/lookups/base'
+require 'geocoder/lookups/baidu'
 require 'geocoder/results/baidu_ip'
 
 module Geocoder::Lookup
-  class BaiduIp < Base
+  class BaiduIp < Baidu
 
     def name
       "Baidu IP"
     end
 
-    def required_api_key_parts
-      ["key"]
-    end
-
-    def query_url(query)
-      "#{protocol}://api.map.baidu.com/location/ip?" + url_query_string(query)
-    end
+    private # ---------------------------------------------------------------
 
-    # HTTP only
-    def supported_protocols
-      [:http]
+    def base_query_url(query)
+      "#{protocol}://api.map.baidu.com/location/ip?"
     end
 
-    private # ---------------------------------------------------------------
-
-    def results(query, reverse = false)
-      return [] unless doc = fetch_data(query)
-      case doc['status']
-      when 0
-        return [doc['content']] unless doc['content'].blank?
-      when 1, 3, 4
-        raise_error(Geocoder::Error, "server error.") ||
-          Geocoder.log(:warn, "Baidu IP Geocoding API error: server error.")
-      when 2
-        raise_error(Geocoder::InvalidRequest, "invalid request.") ||
-          Geocoder.log(:warn, "Baidu IP Geocoding API error: invalid request.")
-      when 5
-        raise_error(Geocoder::InvalidApiKey, "invalid api key.") ||
-          Geocoder.log(:warn, "Baidu IP Geocoding API error: invalid api key.")
-      when 101, 102, 200..299
-        raise_error(Geocoder::RequestDenied, "request denied.") ||
-          Geocoder.log(:warn, "Baidu IP Geocoding API error: request denied.")
-      when 300..399
-        raise_error(Geocoder::OverQueryLimitError, "over query limit") ||
-          Geocoder.log(:warn, "Baidu IP Geocoding API error: over query limit.")
-      end
-      return []
+    def content_key
+      'content'
     end
 
     def query_url_params(query)

data/lib/geocoder/lookups/ban_data_gouv_fr.rb

@@ -14,15 +14,15 @@ module Geocoder::Lookup
       "https://www.openstreetmap.org/#map=19/#{coordinates.join('/')}"
     end
 
-    def query_url(query)
+    private # ---------------------------------------------------------------
+
+    def base_query_url(query)
       method = query.reverse_geocode? ? "reverse" : "search"
-      "#{protocol}://api-adresse.data.gouv.fr/#{method}/?" + url_query_string(query)
+      "#{protocol}://api-adresse.data.gouv.fr/#{method}/?"
     end
 
-    private # ---------------------------------------------------------------
-
     def any_result?(doc)
-      doc['features'].any?
+      doc['features'] and doc['features'].any?
     end
 
     def results(query)
@@ -86,6 +86,12 @@ module Geocoder::Lookup
       unless (citycode = query.options[:citycode]).nil? || !code_param_is_valid?(citycode)
         params[:citycode] = citycode.to_s
       end
+      unless (lat = query.options[:lat]).nil? || !latitude_is_valid?(lat)
+        params[:lat] = lat
+      end
+      unless (lon = query.options[:lon]).nil? || !longitude_is_valid?(lon)
+        params[:lon] = lon
+      end
       params
     end
 
@@ -126,5 +132,12 @@ module Geocoder::Lookup
       (1..99999).include?(param.to_i)
     end
 
+    def latitude_is_valid?(param)
+      param.to_f <= 90 && param.to_f >= -90
+    end
+
+    def longitude_is_valid?(param)
+      param.to_f <= 180 && param.to_f >= -180
+    end
   end
 end

data/lib/geocoder/lookups/base.rb

@@ -4,7 +4,6 @@ require 'uri'
 
 unless defined?(ActiveSupport::JSON)
   begin
-    require 'rubygems' # for Ruby 1.8
     require 'json'
   rescue LoadError
     raise LoadError, "Please install the 'json' or 'json_pure' gem to parse geocoder results."
@@ -72,8 +71,12 @@ module Geocoder
       ##
       # URL to use for querying the geocoding engine.
       #
+      # Subclasses should not modify this method. Instead they should define
+      # base_query_url and url_query_string. If absolutely necessary to
+      # subclss this method, they must also subclass #cache_key.
+      #
       def query_url(query)
-        fail
+        base_query_url(query) + url_query_string(query)
       end
 
       ##
@@ -97,6 +100,14 @@ module Geocoder
 
       private # -------------------------------------------------------------
 
+      ##
+      # String which, when concatenated with url_query_string(query)
+      # produces the full query URL. Should include the "?" a the end.
+      #
+      def base_query_url(query)
+        fail
+      end
+
       ##
       # An object with configuration data for this particular lookup.
       #
@@ -147,7 +158,14 @@ module Geocoder
       # something else (like the URL before OAuth encoding).
       #
       def cache_key(query)
-        query_url(query)
+        base_query_url(query) + hash_to_query(cache_key_params(query))
+      end
+
+      def cache_key_params(query)
+        # omit api_key and token because they may vary among requests
+        query_url_params(query).reject do |key,value|
+          key.to_s.match(/(key|token)/)
+        end
       end
 
       ##
@@ -179,6 +197,8 @@ module Geocoder
         raise_error(err) or Geocoder.log(:warn, "Geocoding API connection cannot be established.")
       rescue Errno::ECONNREFUSED => err
         raise_error(err) or Geocoder.log(:warn, "Geocoding API connection refused.")
+      rescue Geocoder::NetworkError => err
+        raise_error(err) or Geocoder.log(:warn, "Geocoding API connection is either unreacheable or reset by the peer")
       rescue Timeout::Error => err
         raise_error(err) or Geocoder.log(:warn, "Geocoding API not responding fast enough " +
           "(use Geocoder.configure(:timeout => ...) to set limit).")
@@ -191,7 +211,10 @@ module Geocoder
           JSON.parse(data)
         end
       rescue
-        raise_error(ResponseParseError.new(data)) or Geocoder.log(:warn, "Geocoding API's response was not valid JSON: #{data}")
+        unless raise_error(ResponseParseError.new(data))
+          Geocoder.log(:warn, "Geocoding API's response was not valid JSON")
+          Geocoder.log(:debug, "Raw response: #{data}")
+        end
       end
 
       ##

data/lib/geocoder/lookups/bing.rb

@@ -16,24 +16,20 @@ module Geocoder::Lookup
       ["key"]
     end
 
-    def query_url(query)
-      base_url(query) + url_query_string(query)
-    end
-
     private # ---------------------------------------------------------------
 
-    def base_url(query)
-      url = "#{protocol}://dev.virtualearth.net/REST/v1/Locations"
-
-      if !query.reverse_geocode?
+    def base_query_url(query)
+      text = CGI.escape(query.sanitized_text.strip)
+      url = "#{protocol}://dev.virtualearth.net/REST/v1/Locations/"
+      if query.reverse_geocode?
+        url + "#{text}?"
+      else
         if r = query.options[:region]
-          url << "/#{r}"
+          url << "#{r}/"
         end
         # use the more forgiving 'unstructured' query format to allow special
         # chars, newlines, brackets, typos.
-        url + "?q=" + URI.escape(query.sanitized_text.strip) + "&"
-      else
-        url + "/#{URI.escape(query.sanitized_text.strip)}?"
+        url + "?q=#{text}&"
       end
     end
 
@@ -57,7 +53,8 @@ module Geocoder::Lookup
 
     def query_url_params(query)
       {
-        key: configuration.api_key
+        key: configuration.api_key,
+        language: (query.language || configuration.language)
       }.merge(super)
     end
 

data/lib/geocoder/lookups/db_ip_com.rb

@@ -16,15 +16,18 @@ module Geocoder::Lookup
       ['api_key']
     end
 
-    def query_url(query)
-      query_params = if query.options[:params]
-        "?#{url_query_string(query)}"
-      end
+    private # ----------------------------------------------------------------
 
-      "#{protocol}://api.db-ip.com/v2/#{configuration.api_key}/#{query.sanitized_text}#{query_params}"
+    def base_query_url(query)
+      "#{protocol}://api.db-ip.com/v2/#{configuration.api_key}/#{query.sanitized_text}?"
     end
 
-    private
+    ##
+    # Same as query_url but without the api key.
+    #
+    def cache_key(query)
+      "#{protocol}://api.db-ip.com/v2/#{query.sanitized_text}?" + hash_to_query(cache_key_params(query))
+    end
 
     def results(query)
       return [] unless (doc = fetch_data(query))

data/lib/geocoder/lookups/dstk.rb

@@ -12,9 +12,11 @@ module Geocoder::Lookup
       "Data Science Toolkit"
     end
 
-    def query_url(query)
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
       host = configuration[:host] || "www.datasciencetoolkit.org"
-      "#{protocol}://#{host}/maps/api/geocode/json?" + url_query_string(query)
+      "#{protocol}://#{host}/maps/api/geocode/json?"
     end
   end
 end

data/lib/geocoder/lookups/esri.rb

@@ -4,14 +4,14 @@ require 'geocoder/esri_token'
 
 module Geocoder::Lookup
   class Esri < Base
-    
+
     def name
       "Esri"
     end
 
-    def query_url(query)
-      base_query_url(query) + url_query_string(query)
-    end
+      def supported_protocols
+        [:https]
+      end
 
     private # ---------------------------------------------------------------
 
@@ -34,17 +34,6 @@ module Geocoder::Lookup
       end
     end
 
-    def cache_key(query)
-      base_query_url(query) + hash_to_query(cache_key_params(query))
-    end
-
-    def cache_key_params(query)
-      # omit api_key and token because they may vary among requests
-      query_url_params(query).reject do |key,value|
-        [:api_key, :token].include?(key)
-      end
-    end
-
     def query_url_params(query)
       params = {
         :f => "pjson",
@@ -55,31 +44,58 @@ module Geocoder::Lookup
       else
         params[:text] = query.sanitized_text
       end
-      params[:token] = token
-      params[:forStorage] = configuration[:for_storage] if configuration[:for_storage]
+
+      params[:token] = token(query)
+
+      if for_storage_value = for_storage(query)
+        params[:forStorage] = for_storage_value
+      end
       params[:sourceCountry] = configuration[:source_country] if configuration[:source_country]
+      params[:preferredLabelValues] = configuration[:preferred_label_values] if configuration[:preferred_label_values]
+
       params.merge(super)
     end
 
-    def token
-      create_and_save_token! if !valid_token_configured? and configuration.api_key
-      configuration[:token].to_s unless configuration[:token].nil?
+    def for_storage(query)
+      if query.options.has_key?(:for_storage)
+        query.options[:for_storage]
+      else
+        configuration[:for_storage]
+      end
     end
 
-    def valid_token_configured?
-      !configuration[:token].nil? and configuration[:token].active?
+    def token(query)
+      token_instance = if query.options[:token]
+                         query.options[:token]
+                       else
+                         configuration[:token]
+                       end
+
+      if !valid_token_configured?(token_instance) && configuration.api_key
+        token_instance = create_and_save_token!(query)
+      end
+
+      token_instance.to_s unless token_instance.nil?
     end
 
-    def create_and_save_token!
-      save_token!(create_token)
+    def valid_token_configured?(token_instance)
+      !token_instance.nil? && token_instance.active?
     end
 
-    def create_token
-      Geocoder::EsriToken.generate_token(*configuration.api_key)
+    def create_and_save_token!(query)
+      token_instance = create_token
+
+      if query.options[:token]
+        query.options[:token] = token_instance
+      else
+        Geocoder.merge_into_lookup_config(:esri, token: token_instance)
+      end
+
+      token_instance
     end
 
-    def save_token!(token_instance)
-      Geocoder.merge_into_lookup_config(:esri, token: token_instance)
+    def create_token
+      Geocoder::EsriToken.generate_token(*configuration.api_key)
     end
   end
 end

data/lib/geocoder/lookups/freegeoip.rb

@@ -7,10 +7,10 @@ module Geocoder::Lookup
     def name
       "FreeGeoIP"
     end
-    
+
     def supported_protocols
       if configuration[:host]
-        [:http, :https]
+        [:https]
       else
         # use https for default host
         [:https]
@@ -23,13 +23,17 @@ module Geocoder::Lookup
 
     private # ---------------------------------------------------------------
 
+    def cache_key(query)
+      query_url(query)
+    end
+
     def parse_raw_data(raw_data)
       raw_data.match(/^<html><title>404/) ? nil : super(raw_data)
     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?
+      # don't look up a loopback or private address, just return the stored result
+      return [reserved_result(query.text)] if query.internal_ip_address?
       # note: Freegeoip.net returns plain text "Not Found" on bad request
       (doc = fetch_data(query)) ? [doc] : []
     end
@@ -40,8 +44,8 @@ module Geocoder::Lookup
         "city"         => "",
         "region_code"  => "",
         "region_name"  => "",
-        "metrocode"    => "",
-        "zipcode"      => "",
+        "metro_code"    => "",
+        "zip_code"      => "",
         "latitude"     => "0",
         "longitude"    => "0",
         "country_name" => "Reserved",
@@ -50,7 +54,7 @@ module Geocoder::Lookup
     end
 
     def host
-      configuration[:host] || "freegeoip.net"
+      configuration[:host] || "freegeoip.app"
     end
   end
 end