geocoder 1.4.3 → 1.6.1

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 or private address, just return the stored result
+      return [reserved_result(query.text)] if query.internal_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.
     #
@@ -57,8 +57,8 @@ module Geocoder::Lookup
     end
 
     def results(query)
-      # don't look up a loopback address, just return the stored result
-      return [reserved_result] if query.loopback_ip_address?
+      # don't look up a loopback or private address, just return the stored result
+      return [reserved_result] if query.internal_ip_address?
       doc = fetch_data(query)
       if doc and doc.is_a?(Array)
         if !data_contains_error?(doc)

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.
     #
@@ -28,11 +32,7 @@ module Geocoder::Lookup
         return s
       else
         raise(
-          Geocoder::ConfigurationError,
-          "When using MaxMind GeoIP2 you MUST specify a service name and basic_auth: " +
-          "Geocoder.configure(:maxmind_geoip2 => {:service => ...}, " +
-          ":basic_auth => {:user ..., :password => ...}), " +
-          "where service is one of: #{services.inspect}"
+          Geocoder::ConfigurationError, "When using MaxMind GeoIP2 you must specify a service and credentials: Geocoder.configure(maxmind_geoip2: {service: ..., basic_auth: {user: ..., password: ...}}), where service is one of: #{services.inspect}"
         )
       end
     end
@@ -53,8 +53,9 @@ module Geocoder::Lookup
     end
 
     def results(query)
-      # don't look up a loopback address
-      return [] if query.loopback_ip_address?
+      # don't look up a loopback or private address, just return the stored result
+      return [] if query.internal_ip_address?
+
       doc = fetch_data(query)
       if doc
         if !data_contains_error?(doc)

data/lib/geocoder/lookups/nominatim.rb

@@ -9,16 +9,28 @@ 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)
+    private # ---------------------------------------------------------------
+
+    def base_query_url(query)
       method = query.reverse_geocode? ? "reverse" : "search"
-      host = configuration[:host] || "nominatim.openstreetmap.org"
-      "#{protocol}://#{host}/#{method}?" + url_query_string(query)
+      "#{protocol}://#{configured_host}/#{method}?"
     end
 
-    private # ---------------------------------------------------------------
+    def configured_host
+      configuration[:host] || "nominatim.openstreetmap.org"
+    end
+
+    def use_ssl?
+      # nominatim.openstreetmap.org redirects HTTP requests to HTTPS
+      if configured_host == "nominatim.openstreetmap.org"
+        true
+      else
+        super
+      end
+    end
 
     def results(query)
       return [] unless doc = fetch_data(query)

data/lib/geocoder/lookups/opencagedata.rb

@@ -8,15 +8,15 @@ module Geocoder::Lookup
       "OpenCageData"
     end
 
-    def query_url(query)
-      "#{protocol}://api.opencagedata.com/geocode/v1/json?key=#{configuration.api_key}&#{url_query_string(query)}"
-    end
-
     def required_api_key_parts
       ["key"]
     end
 
-    private
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
+      "#{protocol}://api.opencagedata.com/geocode/v1/json?"
+    end
 
     def results(query)
       return [] unless doc = fetch_data(query)
@@ -44,10 +44,11 @@ module Geocoder::Lookup
     def query_url_params(query)
       params = {
         :q => query.sanitized_text,
+        :key => configuration.api_key,
         :language => (query.language || configuration.language)
       }.merge(super)
 
-      [:countrycode, :min_confidence, :no_dedupe, :no_annotations, :no_record, :limit].each do |option|
+      [:abbrv, :countrycode, :min_confidence, :no_dedupe, :no_annotations, :no_record, :limit].each do |option|
         unless (option_value = query.options[option]).nil?
           params[option] = option_value
         end

data/lib/geocoder/lookups/osmnames.rb

@@ -0,0 +1,57 @@
+require 'cgi'
+require 'geocoder/lookups/base'
+require 'geocoder/results/osmnames'
+
+module Geocoder::Lookup
+  class Osmnames < Base
+
+    def name
+      'OSM Names'
+    end
+
+    def required_api_key_parts
+      configuration[:host] ? [] : ['key']
+    end
+
+    def supported_protocols
+      [:https]
+    end
+
+    private
+
+    def base_query_url(query)
+      "#{base_url(query)}/#{params_url(query)}.js?"
+    end
+
+    def base_url(query)
+      host = configuration[:host] || 'geocoder.tilehosting.com'
+      "#{protocol}://#{host}"
+    end
+
+    def params_url(query)
+      method, args = 'q', CGI.escape(query.sanitized_text)
+      method, args = 'r', query.coordinates.join('/') if query.reverse_geocode?
+      "#{country_limited(query)}#{method}/#{args}"
+    end
+
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      if (error = doc['message'])
+        raise_error(Geocoder::InvalidRequest, error) ||
+          Geocoder.log(:warn, "OSMNames Geocoding API error: #{error}")
+      else
+        return doc['results']
+      end
+    end
+
+    def query_url_params(query)
+      {
+        key: configuration.api_key
+      }.merge(super)
+    end
+
+    def country_limited(query)
+      "#{query.options[:country_code].downcase}/" if query.options[:country_code] && !query.reverse_geocode?
+    end
+  end
+end

data/lib/geocoder/lookups/pelias.rb

@@ -11,25 +11,24 @@ module Geocoder::Lookup
       configuration[:endpoint] || 'localhost'
     end
 
-    def query_url(query)
-      query_type = query.reverse_geocode? ? 'reverse' : 'search'
-      "#{protocol}://#{endpoint}/v1/#{query_type}?" + url_query_string(query)
-    end
-
     def required_api_key_parts
       ['search-XXXX']
     end
 
-    private
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
+      query_type = query.reverse_geocode? ? 'reverse' : 'search'
+      "#{protocol}://#{endpoint}/v1/#{query_type}?"
+    end
 
     def query_url_params(query)
       params = {
-        api_key: configuration.api_key,
-        size: 1
+        api_key: configuration.api_key
       }.merge(super)
 
       if query.reverse_geocode?
-        lat,lon = query.coordinates
+        lat, lon = query.coordinates
         params[:'point.lat'] = lat
         params[:'point.lon'] = lon
       else

data/lib/geocoder/lookups/pickpoint.rb

@@ -0,0 +1,41 @@
+require "geocoder/lookups/nominatim"
+require "geocoder/results/pickpoint"
+
+module Geocoder::Lookup
+  class Pickpoint < Nominatim
+    def name
+      "Pickpoint"
+    end
+
+    def supported_protocols
+      [:https]
+    end
+
+    def required_api_key_parts
+      ["api_key"]
+    end
+
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
+      method = query.reverse_geocode? ? "reverse" : "forward"
+      "#{protocol}://api.pickpoint.io/v1/#{method}?"
+    end
+
+    def query_url_params(query)
+      {
+        key: configuration.api_key
+      }.merge(super)
+    end
+
+    def results(query)
+      return [] unless doc = fetch_data(query)
+
+      if !doc.is_a?(Array) && doc['message'] == 'Unauthorized'
+        raise_error(Geocoder::InvalidApiKey, 'Unauthorized')
+      end
+
+      doc.is_a?(Array) ? doc : [doc]
+    end
+  end
+end