geocoder 1.4.9 → 1.5.0

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.
     #

data/lib/geocoder/lookups/nominatim.rb

@@ -12,13 +12,13 @@ module Geocoder::Lookup
       "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"
-      "#{protocol}://#{configured_host}/#{method}?" + url_query_string(query)
+      "#{protocol}://#{configured_host}/#{method}?"
     end
 
-    private # ---------------------------------------------------------------
-
     def configured_host
       configuration[:host] || "nominatim.openstreetmap.org"
     end

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,6 +44,7 @@ module Geocoder::Lookup
     def query_url_params(query)
       params = {
         :q => query.sanitized_text,
+        :key => configuration.api_key,
         :language => (query.language || configuration.language)
       }.merge(super)
 

data/lib/geocoder/lookups/pelias.rb

@@ -11,16 +11,16 @@ 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 = {

data/lib/geocoder/lookups/pickpoint.rb

@@ -15,12 +15,18 @@ module Geocoder::Lookup
       ["api_key"]
     end
 
-    def query_url(query)
+    private # ----------------------------------------------------------------
+
+    def base_query_url(query)
       method = query.reverse_geocode? ? "reverse" : "forward"
-      "#{protocol}://api.pickpoint.io/v1/#{method}?key=#{configuration.api_key}&" + url_query_string(query)
+      "#{protocol}://api.pickpoint.io/v1/#{method}?"
     end
 
-    private
+    def query_url_params(query)
+      params = {
+        key: configuration.api_key
+      }.merge(super)
+    end
 
     def results(query)
       return [] unless doc = fetch_data(query)

data/lib/geocoder/lookups/pointpin.rb

@@ -13,10 +13,14 @@ module Geocoder::Lookup
     end
 
     def query_url(query)
-      "#{ protocol }://geo.pointp.in/#{ api_key }/json/#{ query.sanitized_text }"
+      "#{protocol}://geo.pointp.in/#{configuration.api_key}/json/#{query.sanitized_text}"
     end
 
-  private
+    private # ----------------------------------------------------------------
+
+    def cache_key(query)
+      "#{protocol}://geo.pointp.in/json/#{query.sanitized_text}"
+    end
 
     def results(query)
       # don't look up a loopback address, just return the stored result
@@ -46,6 +50,7 @@ module Geocoder::Lookup
       parsed_data.keys.include?('error')
     end
 
+    # TODO: replace this hash with what's actually returned by Pointpin
     def reserved_result(ip)
       {
         "ip"           => ip,
@@ -60,9 +65,5 @@ module Geocoder::Lookup
         "country_code" => "RD"
       }
     end
-
-    def api_key
-      configuration.api_key
-    end
   end
 end

data/lib/geocoder/lookups/postcode_anywhere_uk.rb

@@ -4,7 +4,6 @@ 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'
 
@@ -16,11 +15,11 @@ module Geocoder::Lookup
       %w(key)
     end
 
-    def query_url(query)
-      format('%s://%s?%s', protocol, BASE_URL_GEOCODE_V2_00, url_query_string(query))
-    end
+    private # ----------------------------------------------------------------
 
-    private
+    def base_query_url(query)
+      "#{protocol}://services.postcodeanywhere.co.uk/Geocoding/UK/Geocode/v2.00/json.ws?"
+    end
 
     def results(query)
       response = fetch_data(query)

data/lib/geocoder/lookups/postcodes_io.rb

@@ -8,15 +8,18 @@ module Geocoder::Lookup
     end
 
     def query_url(query)
-      str = query.sanitized_text.gsub(/\s/, '')
-      format('%s://%s/%s', protocol, 'api.postcodes.io/postcodes', str)
+      "#{protocol}://api.postcodes.io/postcodes/#{query.sanitized_text.gsub(/\s/, '')}"
     end
 
     def supported_protocols
       [:https]
     end
 
-    private
+    private # ----------------------------------------------------------------
+
+    def cache_key(query)
+      query_url(query)
+    end
 
     def results(query)
       response = fetch_data(query)

data/lib/geocoder/lookups/smarty_streets.rb

@@ -11,14 +11,6 @@ module Geocoder::Lookup
       %w(auti-id auth-token)
     end
 
-    def query_url(query)
-      if zipcode_only?(query)
-        "#{protocol}://us-zipcode.api.smartystreets.com/lookup?#{url_query_string(query)}"
-      else
-        "#{protocol}://us-street.api.smartystreets.com/street-address?#{url_query_string(query)}"
-      end
-    end
-
     # required by API as of 26 March 2015
     def supported_protocols
       [:https]
@@ -26,6 +18,14 @@ module Geocoder::Lookup
 
     private # ---------------------------------------------------------------
 
+    def base_query_url(query)
+      if zipcode_only?(query)
+        "#{protocol}://us-zipcode.api.smartystreets.com/lookup?"
+      else
+        "#{protocol}://us-street.api.smartystreets.com/street-address?"
+      end
+    end
+
     def zipcode_only?(query)
       !query.text.is_a?(Array) and query.to_s.strip =~ /\A\d{5}(-\d{4})?\Z/
     end

data/lib/geocoder/lookups/telize.rb

@@ -29,6 +29,10 @@ module Geocoder::Lookup
 
     private # ---------------------------------------------------------------
 
+    def cache_key(query)
+      query_url(query)[/(.*)\?.*/, 1]
+    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?
@@ -44,7 +48,23 @@ module Geocoder::Lookup
     end
 
     def reserved_result(ip)
-      {"message" => "Input string is not a valid IP address", "code" => 401}
+      {
+        "ip" => ip,
+        "latitude" => 0,
+        "longitude" => 0,
+        "city" => "",
+        "timezone" => "",
+        "asn" => 0,
+        "region" => "",
+        "offset" => 0,
+        "organization" => "",
+        "country_code" => "",
+        "country_code3" => "",
+        "postal_code" => "",
+        "continent_code" => "",
+        "country" => "",
+        "region_code" => ""
+      }
     end
 
     def api_key

data/lib/geocoder/lookups/yandex.rb

@@ -12,16 +12,16 @@ module Geocoder::Lookup
       "http://maps.yandex.ru/?ll=#{coordinates.reverse.join(',')}"
     end
 
-    def query_url(query)
-      "#{protocol}://geocode-maps.yandex.ru/1.x/?" + url_query_string(query)
-    end
-    
     def supported_protocols
       [:https]
     end
 
     private # ---------------------------------------------------------------
 
+    def base_query_url(query)
+      "#{protocol}://geocode-maps.yandex.ru/1.x/?"
+    end
+
     def results(query)
       return [] unless doc = fetch_data(query)
       if err = doc['error']

data/lib/geocoder/results/baidu.rb

@@ -11,34 +11,34 @@ module Geocoder::Result
       @data['formatted_address']
     end
 
-    def state
-      province
-    end
-    
     def province
-      @data['addressComponent']['province']
+      @data['addressComponent'] and @data['addressComponent']['province'] or ""
     end
 
+    alias_method :state, :province
+
     def city
-      @data['addressComponent']['city']
+      @data['addressComponent'] and @data['addressComponent']['city'] or ""
     end
 
     def district
-      @data['addressComponent']['district']
+      @data['addressComponent'] and @data['addressComponent']['district'] or ""
     end
 
     def street
-      @data['addressComponent']['street']
+      @data['addressComponent'] and @data['addressComponent']['street'] or ""
     end
 
     def street_number
-      @data['addressComponent']['street_number']
+      @data['addressComponent'] and @data['addressComponent']['street_number']
     end
 
     def formatted_address
-      @data['formatted_address']
+      @data['formatted_address'] or ""
     end
 
+    alias_method :address, :formatted_address
+
     def address_components
       @data['addressComponent']
     end

data/lib/geocoder/results/base.rb

@@ -20,8 +20,20 @@ module Geocoder
       ##
       # A string in the given format.
       #
+      # This default implementation dumbly follows the United States address
+      # format and will return incorrect results for most countries. Some APIs
+      # return properly formatted addresses and those should be funneled
+      # through this method.
+      #
       def address(format = :full)
-        fail
+        if state_code.to_s != ""
+          s = ", #{state_code}"
+        elsif state.to_s != ""
+          s = ", #{state}"
+        else
+          s = ""
+        end
+        "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, '')
       end
 
       ##

data/lib/geocoder/results/bing.rb

@@ -24,7 +24,7 @@ module Geocoder::Result
     alias_method :country_code, :country
 
     def postal_code
-      @data['address']['postalCode']
+      @data['address']['postalCode'].to_s
     end
 
     def coordinates

data/lib/geocoder/results/db_ip_com.rb

@@ -7,11 +7,6 @@ module Geocoder::Result
       ['latitude', 'longitude'].map{ |coordinate_name| @data[coordinate_name] }
     end
 
-    def address(format = :full)
-      s = state_code.to_s == "" ? "" : ", #{state_code}"
-      "#{city}#{s} #{zip_code}, #{country_name}".sub(/^[ ,]*/, "")
-    end
-
     def city
       @data['city']
     end

data/lib/geocoder/results/freegeoip.rb

@@ -3,11 +3,6 @@ require 'geocoder/results/base'
 module Geocoder::Result
   class Freegeoip < Base
 
-    def address(format = :full)
-      s = state_code.to_s == "" ? "" : ", #{state_code}"
-      "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
-    end
-
     def city
       @data['city']
     end

data/lib/geocoder/results/geocoder_ca.rb

@@ -16,17 +16,17 @@ module Geocoder::Result
     end
 
     def city
-      @data['city']
+      @data['city'] or (@data['standard'] and @data['standard']['city']) or ""
     end
 
     def state
-      @data['prov']
+      @data['prov'] or (@data['standard'] and @data['standard']['prov']) or ""
     end
 
     alias_method :state_code, :state
 
     def postal_code
-      @data['postal']
+      @data['postal'] or (@data['standard'] and @data['standard']['postal']) or ""
     end
 
     def country

data/lib/geocoder/results/geoip2.rb

@@ -3,10 +3,6 @@ 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
         %w[latitude longitude].map do |l|

data/lib/geocoder/results/geoportail_lu.rb

@@ -59,11 +59,13 @@ module Geocoder::Result
     private
 
     def geolocalized?
-      try_to_extract('coordinates', geomlonlat).present?
+      !!try_to_extract('coordinates', geomlonlat)
     end
 
-    def try_to_extract(key, nullable_hash)
-      nullable_hash.try(:[], key)
+    def try_to_extract(key, hash)
+      if hash.is_a?(Hash) and hash.include?(key)
+        hash[key]
+      end
     end
   end
 end