RubyGems - geocoder - Versions diffs - 1.1.3 → 1.1.4 - Mend

geocoder 1.1.3 → 1.1.4

Potentially problematic release.

This version of geocoder might be problematic. Click here for more details.

Files changed (45) hide show

data/CHANGELOG.rdoc +12 -0
data/README.md +580 -0
data/examples/autoexpire_cache.rb +30 -0
data/lib/geocoder.rb +9 -85
data/lib/geocoder/calculations.rb +1 -1
data/lib/geocoder/cli.rb +9 -10
data/lib/geocoder/configuration.rb +3 -1
data/lib/geocoder/lookup.rb +81 -0
data/lib/geocoder/lookups/base.rb +20 -32
data/lib/geocoder/lookups/bing.rb +12 -8
data/lib/geocoder/lookups/freegeoip.rb +5 -5
data/lib/geocoder/lookups/geocoder_ca.rb +13 -9
data/lib/geocoder/lookups/google.rb +19 -7
data/lib/geocoder/lookups/google_premier.rb +8 -7
data/lib/geocoder/lookups/mapquest.rb +5 -23
data/lib/geocoder/lookups/nominatim.rb +16 -13
data/lib/geocoder/lookups/test.rb +8 -6
data/lib/geocoder/lookups/yahoo.rb +49 -10
data/lib/geocoder/lookups/yandex.rb +15 -8
data/lib/geocoder/models/mongoid.rb +0 -1
data/lib/geocoder/query.rb +88 -0
data/lib/geocoder/results/mapquest.rb +2 -61
data/lib/geocoder/results/nominatim.rb +24 -3
data/lib/geocoder/sql.rb +104 -0
data/lib/geocoder/stores/active_record.rb +68 -140
data/lib/geocoder/stores/mongo_base.rb +2 -2
data/lib/geocoder/version.rb +1 -1
data/test/active_record_test.rb +15 -0
data/test/calculations_test.rb +7 -0
data/test/error_handling_test.rb +7 -7
data/test/fixtures/yahoo_madison_square_garden.json +49 -43
data/test/fixtures/yahoo_v1_madison_square_garden.json +46 -0
data/test/fixtures/yahoo_v1_no_results.json +10 -0
data/test/https_test.rb +2 -2
data/test/integration/smoke_test.rb +6 -4
data/test/lookup_test.rb +13 -6
data/test/query_test.rb +34 -0
data/test/result_test.rb +1 -1
data/test/services_test.rb +48 -7
data/test/test_helper.rb +64 -49
data/test/test_mode_test.rb +0 -1
metadata +13 -7
data/README.rdoc +0 -552
data/test/fixtures/yahoo_garbage.json +0 -50
data/test/input_handling_test.rb +0 -43

data/lib/geocoder/lookups/freegeoip.rb CHANGED

@@ -10,11 +10,11 @@ module Geocoder::Lookup
       raw_data.match(/^<html><title>404/) ? nil : super(raw_data)
     end
-    def results(query, reverse = false)
+    def results(query)
       # don't look up a loopback address, just return the stored result
-      return [reserved_result(query)] if loopback_address?(query)
+      return [reserved_result(query.text)] if query.loopback_ip_address?
       begin
-        return (doc = fetch_data(query, reverse)) ? [doc] : []
+        return (doc = fetch_data(query)) ? [doc] : []
       rescue StandardError => err # Freegeoip.net returns HTML on bad request
         raise_error(err)
         return []
@@ -36,8 +36,8 @@ module Geocoder::Lookup
       }
     end
-    def query_url(query, reverse = false)
-      "http://freegeoip.net/json/#{query}"
+    def query_url(query)
+      "http://freegeoip.net/json/#{query.sanitized_text}"
     end
   end
 end

data/lib/geocoder/lookups/geocoder_ca.rb CHANGED

@@ -6,8 +6,8 @@ module Geocoder::Lookup
     private # ---------------------------------------------------------------
-    def results(query, reverse = false)
-      return [] unless doc = fetch_data(query, reverse)
+    def results(query)
+      return [] unless doc = fetch_data(query)
       if doc['error'].nil?
         return [doc]
       elsif doc['error']['code'] == "005"
@@ -18,24 +18,28 @@ module Geocoder::Lookup
       return []
     end
-    def query_url(query, reverse = false)
-      params = {
+    def query_url_params(query)
+      params = super.merge(
         :geoit    => "xml",
         :jsonp    => 1,
         :callback => "test",
         :auth     => Geocoder::Configuration.api_key
-      }
-      if reverse
-        lat,lon = query.split(',')
+      )
+      if query.reverse_geocode?
+        lat,lon = query.coordinates
         params[:latt] = lat
         params[:longt] = lon
         params[:corner] = 1
         params[:reverse] = 1
       else
-        params[:locate] = query
+        params[:locate] = query.sanitized_text
         params[:showpostal] = 1
       end
-      "http://geocoder.ca/?" + hash_to_query(params)
+      params
+    end
+    def query_url(query)
+      "http://geocoder.ca/?" + url_query_string(query)
     end
     def parse_raw_data(raw_data)

data/lib/geocoder/lookups/google.rb CHANGED

@@ -10,8 +10,8 @@ module Geocoder::Lookup
     private # ---------------------------------------------------------------
-    def results(query, reverse = false)
-      return [] unless doc = fetch_data(query, reverse)
+    def results(query)
+      return [] unless doc = fetch_data(query)
       case doc['status']; when "OK" # OK status implies >0 results
         return doc['results']
       when "OVER_QUERY_LIMIT"
@@ -27,14 +27,26 @@ module Geocoder::Lookup
       return []
     end
-    def query_url(query, reverse = false)
+    def query_url_google_params(query)
       params = {
-        (reverse ? :latlng : :address) => query,
+        (query.reverse_geocode? ? :latlng : :address) => query.sanitized_text,
         :sensor => "false",
-        :language => Geocoder::Configuration.language,
-        :key => Geocoder::Configuration.api_key
+        :language => Geocoder::Configuration.language
       }
-      "#{protocol}://maps.googleapis.com/maps/api/geocode/json?" + hash_to_query(params)
+      unless (bounds = query.options[:bounds]).nil?
+        params[:bounds] = bounds.map{ |point| "%f,%f" % point }.join('|')
+      end
+      params
+    end
+    def query_url_params(query)
+      super.merge(query_url_google_params(query)).merge(
+        :key => Geocoder::Configuration.api_key
+      )
+    end
+    def query_url(query)
+      "#{protocol}://maps.googleapis.com/maps/api/geocode/json?" + url_query_string(query)
     end
   end
 end

data/lib/geocoder/lookups/google_premier.rb CHANGED

@@ -8,15 +8,16 @@ module Geocoder::Lookup
     private # ---------------------------------------------------------------
-    def query_url(query, reverse = false)
-      params = {
-        (reverse ? :latlng : :address) => query,
-        :sensor => 'false',
-        :language => Geocoder::Configuration.language,
+    def query_url_params(query)
+      super.merge(query_url_google_params(query)).merge(
+        :key => nil, # don't use param inherited from Google lookup
         :client => Geocoder::Configuration.api_key[1],
         :channel => Geocoder::Configuration.api_key[2]
-      }.reject{ |key, value| value.nil? }
-      path = "/maps/api/geocode/json?#{hash_to_query(params)}"
+      )
+    end
+    def query_url(query)
+      path = "/maps/api/geocode/json?" + url_query_string(query)
       "#{protocol}://maps.googleapis.com#{path}&signature=#{sign(path)}"
     end

data/lib/geocoder/lookups/mapquest.rb CHANGED

@@ -1,33 +1,15 @@
 require 'geocoder/lookups/base'
+require "geocoder/lookups/nominatim"
 require "geocoder/results/mapquest"
 module Geocoder::Lookup
-  class Mapquest < Base
+  class Mapquest < Nominatim
     private # ---------------------------------------------------------------
-    def results(query, reverse = false)
-      return [] unless doc = fetch_data(query, reverse)
-      doc.is_a?(Array) ? doc : [doc]
-    end
-    def query_url(query, reverse = false)
-      params = {
-        :format => "json",
-        :polygon => "1",
-        :addressdetails => "1",
-        :"accept-language" => Geocoder::Configuration.language
-      }
-      if (reverse)
-        method = 'reverse'
-        parts = query.split(/\s*,\s*/);
-        params[:lat] = parts[0]
-        params[:lon] = parts[1]
-      else
-        method = 'search'
-        params[:q] = query
-      end
-      "http://open.mapquestapi.com/#{method}?" + hash_to_query(params)
+    def query_url(query)
+      method = query.reverse_geocode? ? "reverse" : "search"
+      "http://open.mapquestapi.com/#{method}?" + url_query_string(query)
     end
   end
 end

data/lib/geocoder/lookups/nominatim.rb CHANGED

@@ -10,28 +10,31 @@ module Geocoder::Lookup
     private # ---------------------------------------------------------------
-    def results(query, reverse = false)
-      return [] unless doc = fetch_data(query, reverse)
+    def results(query)
+      return [] unless doc = fetch_data(query)
       doc.is_a?(Array) ? doc : [doc]
     end
-    def query_url(query, reverse = false)
-      params = {
+    def query_url_params(query)
+      params = super.merge(
         :format => "json",
         :polygon => "1",
         :addressdetails => "1",
         :"accept-language" => Geocoder::Configuration.language
-      }
-      if (reverse)
-        method = 'reverse'
-        parts = query.split(/\s*,\s*/);
-        params[:lat] = parts[0]
-        params[:lon] = parts[1]
+      )
+      if query.reverse_geocode?
+        lat,lon = query.coordinates
+        params[:lat] = lat
+        params[:lon] = lon
       else
-        method = 'search'
-        params[:q] = query
+        params[:q] = query.sanitized_text
       end
-      "http://nominatim.openstreetmap.org/#{method}?" + hash_to_query(params)
+      params
+    end
+    def query_url(query)
+      method = query.reverse_geocode? ? "reverse" : "search"
+      "http://nominatim.openstreetmap.org/#{method}?" + url_query_string(query)
     end
   end
 end

data/lib/geocoder/lookups/test.rb CHANGED

@@ -5,12 +5,14 @@ module Geocoder
   module Lookup
     class Test < Base
-      def self.add_stub(query, results)
-        stubs[query] = results
+      def self.add_stub(query_text, results)
+        stubs[query_text] = results
       end
-      def self.read_stub(query)
-        stubs.fetch(query) { raise ArgumentError, "unknown stub request #{query}" }
+      def self.read_stub(query_text)
+        stubs.fetch(query_text) {
+          raise ArgumentError, "unknown stub request #{query_text}"
+        }
       end
       def self.stubs
@@ -23,8 +25,8 @@ module Geocoder
       private
-      def results(query, reverse = false)
-        Geocoder::Lookup::Test.read_stub(query)
+      def results(query)
+        Geocoder::Lookup::Test.read_stub(query.text)
       end
     end

data/lib/geocoder/lookups/yahoo.rb CHANGED

@@ -10,25 +10,64 @@ module Geocoder::Lookup
     private # ---------------------------------------------------------------
-    def results(query, reverse = false)
-      return [] unless doc = fetch_data(query, reverse)
-      if doc = doc['ResultSet'] and doc['Error'] == 0
-        return doc['Found'] > 0 ? doc['Results'] : []
+    def results(query)
+      return [] unless doc = fetch_data(query)
+      doc = doc['ResultSet']
+      if api_version(doc).to_i == 1
+        return version_1_results(doc)
+      elsif api_version(doc).to_i == 2
+        return version_2_results(doc)
       else
         warn "Yahoo Geocoding API error: #{doc['Error']} (#{doc['ErrorMessage']})."
         return []
       end
     end
-    def query_url(query, reverse = false)
-      params = {
-        :location => query,
+    def api_version(doc)
+      if doc.include?('version')
+        return doc['version'].to_f
+      elsif doc.include?('@version')
+        return doc['@version'].to_f
+      end
+    end
+    def version_1_results(doc)
+      if doc['Error'] == 0
+        if doc['Found'] > 0
+          return doc['Results']
+        else
+          return []
+        end
+      end
+    end
+    ##
+    # Return array of results, or nil if an error.
+    #
+    def version_2_results(doc)
+      # seems to have Error == 7 when no results, though this is not documented
+      if [0, 7].include?(doc['Error'].to_i)
+        if doc['Found'].to_i > 0
+          r = doc['Result']
+          return r.is_a?(Array) ? r : [r]
+        else
+          return []
+        end
+      end
+    end
+    def query_url_params(query)
+      super.merge(
+        :location => query.sanitized_text,
         :flags => "JXTSR",
-        :gflags => "AC#{'R' if reverse}",
+        :gflags => "AC#{'R' if query.reverse_geocode?}",
         :locale => "#{Geocoder::Configuration.language}_US",
         :appid => Geocoder::Configuration.api_key
-      }
-      "http://where.yahooapis.com/geocode?" + hash_to_query(params)
+      )
+    end
+    def query_url(query)
+      "http://where.yahooapis.com/geocode?" + url_query_string(query)
     end
   end
 end

data/lib/geocoder/lookups/yandex.rb CHANGED

@@ -10,8 +10,8 @@ module Geocoder::Lookup
     private # ---------------------------------------------------------------
-    def results(query, reverse = false)
-      return [] unless doc = fetch_data(query, reverse)
+    def results(query)
+      return [] unless doc = fetch_data(query)
       if err = doc['error']
         warn "Yandex Geocoding API error: #{err['status']} (#{err['message']})."
         return []
@@ -25,15 +25,22 @@ module Geocoder::Lookup
       end
     end
-    def query_url(query, reverse = false)
-      query = query.split(",").reverse.join(",") if reverse
-      params = {
-        :geocode => query,
+    def query_url_params(query)
+      if query.reverse_geocode?
+        q = query.coordinates.reverse.join(",")
+      else
+        q = query.sanitized_text
+      end
+      super.merge(
+        :geocode => q,
         :format => "json",
         :plng => "#{Geocoder::Configuration.language}", # supports ru, uk, be
         :key => Geocoder::Configuration.api_key
-      }
-      "http://geocode-maps.yandex.ru/1.x/?" + hash_to_query(params)
+      )
+    end
+    def query_url(query)
+      "http://geocode-maps.yandex.ru/1.x/?" + url_query_string(query)
     end
   end
 end

data/lib/geocoder/models/mongoid.rb CHANGED

@@ -1,4 +1,3 @@
-require 'mongoid/version'
 require 'geocoder/models/base'
 require 'geocoder/models/mongo_base'

data/lib/geocoder/query.rb ADDED

@@ -0,0 +1,88 @@
+module Geocoder
+  class Query
+    attr_accessor :text, :options
+    def initialize(text, options = {})
+      self.text = text
+      self.options = options
+    end
+    def execute
+      lookup.search(text, options)
+    end
+    def to_s
+      text
+    end
+    def sanitized_text
+      if coordinates?
+        text.split(/\s*,\s*/).join(',')
+      else
+        text
+      end
+    end
+    ##
+    # Get a Lookup object (which communicates with the remote geocoding API)
+    # appropriate to the Query text.
+    #
+    def lookup
+      if ip_address?
+        name = Configuration.ip_lookup || Geocoder::Lookup.ip_services.first
+      else
+        name = Configuration.lookup || Geocoder::Lookup.street_services.first
+      end
+      Lookup.get(name)
+    end
+    ##
+    # Is the Query text blank? (ie, should we not bother searching?)
+    #
+    def blank?
+      !!text.to_s.match(/^\s*$/)
+    end
+    ##
+    # Does the Query text look like an IP address?
+    #
+    # Does not check for actual validity, just the appearance of four
+    # dot-delimited numbers.
+    #
+    def ip_address?
+      !!text.to_s.match(/^(::ffff:)?(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/)
+    end
+    ##
+    # Is the Query text a loopback IP address?
+    #
+    def loopback_ip_address?
+      !!(text == "0.0.0.0" or text.to_s.match(/^127/))
+    end
+    ##
+    # Does the given string look like latitude/longitude coordinates?
+    #
+    def coordinates?
+      text.is_a?(Array) or (
+        text.is_a?(String) and
+        !!text.to_s.match(/^-?[0-9\.]+, *-?[0-9\.]+$/)
+      )
+    end
+    ##
+    # Return the latitude/longitude coordinates specified in the query,
+    # or nil if none.
+    #
+    def coordinates
+      sanitized_text.split(',') if coordinates?
+    end
+    ##
+    # Should reverse geocoding be performed for this query?
+    #
+    def reverse_geocode?
+      coordinates?
+    end
+  end
+end