geocoder 1.1.8 → 1.1.9

data/lib/geocoder/results/yandex.rb

@@ -12,7 +12,7 @@ module Geocoder::Result
     end
 
     def city
-      if state.empty?
+      if state.empty? and address_details.has_key? 'Locality'
         address_details['Locality']['LocalityName']
       elsif sub_state.empty?
         address_details['AdministrativeArea']['Locality']['LocalityName']

data/lib/geocoder/stores/active_record.rb

@@ -32,7 +32,7 @@ module Geocoder::Store
         # Find all objects within a radius of the given location.
         # Location may be either a string to geocode or an array of
         # coordinates (<tt>[lat,lon]</tt>). Also takes an options hash
-        # (see Geocoder::Orm::ActiveRecord::ClassMethods.near_scope_options
+        # (see Geocoder::Store::ActiveRecord::ClassMethods.near_scope_options
         # for details).
         #
         scope :near, lambda{ |location, *args|
@@ -105,6 +105,8 @@ module Geocoder::Store
       # * +:order+           - column(s) for ORDER BY SQL clause; default is distance;
       #                        set to false or nil to omit the ORDER BY clause
       # * +:exclude+         - an object to exclude (used by the +nearbys+ method)
+      # * +:distance_column+ - used to set the column name of the calculated distance.
+      # * +:bearing_column+  - used to set the column name of the calculated bearing.
       #
       def near_scope_options(latitude, longitude, radius = 20, options = {})
         if options[:units]
@@ -116,6 +118,8 @@ module Geocoder::Store
         select_bearing = options.fetch(:select_bearing, true)
         bearing = bearing_sql(latitude, longitude, options)
         distance = distance_sql(latitude, longitude, options)
+        distance_column = options.fetch(:distance_column, 'distance')
+        bearing_column = options.fetch(:bearing_column, 'bearing')
 
         b = Geocoder::Calculations.bounding_box([latitude, longitude], radius, options)
         args = b + [
@@ -132,9 +136,11 @@ module Geocoder::Store
         {
           :select => select_clause(options[:select],
                                    select_distance ? distance : nil,
-                                   select_bearing ? bearing : nil),
+                                   select_bearing ? bearing : nil,
+                                   distance_column,
+                                   bearing_column),
           :conditions => add_exclude_condition(conditions, options[:exclude]),
-          :order => options.include?(:order) ? options[:order] : "distance ASC"
+          :order => options.include?(:order) ? options[:order] : "#{distance_column} ASC"
         }
       end
 
@@ -176,7 +182,7 @@ module Geocoder::Store
       ##
       # Generate the SELECT clause.
       #
-      def select_clause(columns, distance = nil, bearing = nil)
+      def select_clause(columns, distance = nil, bearing = nil, distance_column = 'distance', bearing_column = 'bearing')
         if columns == :id_only
           return full_column_name(primary_key)
         elsif columns == :geo_only
@@ -186,11 +192,11 @@ module Geocoder::Store
         end
         if distance
           clause += ", " unless clause.empty?
-          clause += "#{distance} AS distance"
+          clause += "#{distance} AS #{distance_column}"
         end
         if bearing
           clause += ", " unless clause.empty?
-          clause += "#{bearing} AS bearing"
+          clause += "#{bearing} AS #{bearing_column}"
         end
         clause
       end

data/lib/geocoder/stores/mongo_base.rb

@@ -31,8 +31,11 @@ module Geocoder::Store
           field = geocoder_options[:coordinates]
           conds[field] = empty.clone
           conds[field]["$nearSphere"]  = coords.reverse
-          conds[field]["$maxDistance"] = \
-            Geocoder::Calculations.distance_to_radians(radius, options[:units])
+
+          if radius
+            conds[field]["$maxDistance"] = \
+              Geocoder::Calculations.distance_to_radians(radius, options[:units])
+          end
 
           if obj = options[:exclude]
             conds[:_id.ne] = obj.id

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.1.8"
+  VERSION = "1.1.9"
 end

data/lib/tasks/geocoder.rake

@@ -2,11 +2,13 @@ namespace :geocode do
   desc "Geocode all objects without coordinates."
   task :all => :environment do
     class_name = ENV['CLASS'] || ENV['class']
+    sleep_timer = ENV['SLEEP'] || ENV['sleep']
     raise "Please specify a CLASS (model)" unless class_name
     klass = class_from_string(class_name)
 
     klass.not_geocoded.each do |obj|
       obj.geocode; obj.save
+      sleep(sleep_timer.to_f) unless sleep_timer.nil?
     end
   end
 end

data/test/cache_test.rb

@@ -16,4 +16,20 @@ class CacheTest < Test::Unit::TestCase
         "Lookup #{l} did not return cached result."
     end
   end
+
+  def test_google_over_query_limit_does_not_hit_cache
+    Geocoder.configure(:cache => {})
+    Geocoder.configure(:lookup => :google)
+    set_api_key!(:google)
+    Geocoder.configure(:always_raise => :all)
+    assert_raises Geocoder::OverQueryLimitError do
+      Geocoder.search("over limit")
+    end
+    lookup = Geocoder::Lookup.get(:google)
+    assert_equal false, lookup.instance_variable_get(:@cache_hit)
+    assert_raises Geocoder::OverQueryLimitError do
+      Geocoder.search("over limit")
+    end
+    assert_equal false, lookup.instance_variable_get(:@cache_hit)
+  end
 end

data/test/calculations_test.rb

@@ -100,6 +100,17 @@ class CalculationsTest < Test::Unit::TestCase
     end
   end
 
+  # --- random point ---
+
+  def test_random_point_within_radius
+    20.times do
+      center = [51, 7] # Cologne, DE
+      radius = 10 # miles
+      random_point = Geocoder::Calculations.random_point_near(center, radius)
+      distance = Geocoder::Calculations.distance_between(center, random_point)
+      assert distance <= radius
+    end
+  end
 
   # --- bearing ---
 
@@ -157,32 +168,28 @@ class CalculationsTest < Test::Unit::TestCase
   end
 
   def test_extract_coordinates
-    result = Geocoder::Calculations.extract_coordinates([ nil, nil ])
-    assert is_nan_coordinates?(result)
+    coords = [-23,47]
+    l = Landmark.new("Madagascar", coords[0], coords[1])
+    assert_equal coords, Geocoder::Calculations.extract_coordinates(l)
+    assert_equal coords, Geocoder::Calculations.extract_coordinates(coords)
+  end
 
-    result = Geocoder::Calculations.extract_coordinates([ 1.0 / 3, 2.0 / 3 ])
-    assert_in_delta 1.0 / 3, result.first, 1E-5
-    assert_in_delta 2.0 / 3, result.last, 1E-5
+  def test_extract_nan_coordinates
+    result = Geocoder::Calculations.extract_coordinates([ nil, nil ])
+    assert_nan_coordinates?(result)
 
     result = Geocoder::Calculations.extract_coordinates(nil)
-    assert is_nan_coordinates?(result)
+    assert_nan_coordinates?(result)
 
     result = Geocoder::Calculations.extract_coordinates('')
-    assert is_nan_coordinates?(result)
+    assert_nan_coordinates?(result)
 
     result = Geocoder::Calculations.extract_coordinates([ 'nix' ])
-    assert is_nan_coordinates?(result)
+    assert_nan_coordinates?(result)
 
     o = Object.new
     result = Geocoder::Calculations.extract_coordinates(o)
-    assert is_nan_coordinates?(result)
-
-    def o.to_coordinates
-      [ 1.0 / 3, 2.0 / 3 ]
-    end
-    result = Geocoder::Calculations.extract_coordinates(o)
-    assert_in_delta 1.0 / 3, result.first, 1E-5
-    assert_in_delta 2.0 / 3, result.last, 1E-5
+    assert_nan_coordinates?(result)
   end
 
   def test_coordinates_present
@@ -192,10 +199,13 @@ class CalculationsTest < Test::Unit::TestCase
     assert !Geocoder::Calculations.coordinates_present?(3.23, nil)
   end
 
-  def test_extract_coordinates
-    coords = [-23,47]
-    l = Landmark.new("Madagascar", coords[0], coords[1])
-    assert_equal coords, Geocoder::Calculations.extract_coordinates(l)
-    assert_equal coords, Geocoder::Calculations.extract_coordinates(coords)
+  private # ------------------------------------------------------------------
+
+  def assert_nan_coordinates?(value)
+    assert value.is_a?(Array) &&
+      value.size == 2 &&
+      value[0].nan? &&
+      value[1].nan?,
+      "Expected value to be [NaN, NaN] but was #{value}"
   end
 end

data/test/fixtures/baidu_invalid_key

@@ -0,0 +1 @@
+{"results":[],"status":5,"msg":"AK Illegal or Not Exist:"}

data/test/fixtures/baidu_no_results

@@ -0,0 +1 @@
+{"status":0,"result":[]}

data/test/fixtures/baidu_reverse

@@ -0,0 +1 @@
+{"status":0,"result":{"location":{"lng":121.48789948569,"lat":31.249161555654},"formatted_address":"上海市闸北区天潼路619号","business":"七浦路,海宁路,北京东路","addressComponent":{"city":"上海市","district":"闸北区","province":"上海市","street":"天潼路","street_number":"619号"},"cityCode":289}}

data/test/fixtures/baidu_shanghai_pearl_tower

@@ -0,0 +1,12 @@
+{
+	"status":0,
+		"result":{
+			"location":{
+				"lng":116.30814954222,
+				"lat":40.056885091681
+			},
+			"precise":1,
+			"confidence":80,
+			"level":"\u5546\u52a1\u5927\u53a6"
+		}
+}

data/test/fixtures/geocoder_us_madison_square_garden

@@ -0,0 +1 @@
+40.678107, -73.897460, 4 Pennsylvania Ave, New York, NY, 11207

data/test/fixtures/geocoder_us_no_results

@@ -0,0 +1 @@
+2: couldn't find this address! sorry

data/test/fixtures/google_over_limit

@@ -0,0 +1,4 @@
+{
+  "status": "OVER_QUERY_LIMIT",
+  "results": [ ]
+}

data/test/fixtures/mapquest_error

@@ -0,0 +1,16 @@
+{
+  "results": [
+    {
+    "locations": []
+    }
+  ],
+  "info": {
+    "copyright": {
+      "text": "© 2012 MapQuest, Inc.",
+      "imageUrl": "http://api.mqcdn.com/res/mqlogo.gif",
+      "imageAltText": "© 2012 MapQuest, Inc."
+    },
+    "statuscode": 500,
+    "messages": ["Error processing request: ..."]
+  }
+}

data/test/fixtures/mapquest_invalid_api_key

@@ -0,0 +1,16 @@
+{
+  "results": [
+    {
+    "locations": []
+    }
+  ],
+  "info": {
+    "copyright": {
+      "text": "© 2012 MapQuest, Inc.",
+      "imageUrl": "http://api.mqcdn.com/res/mqlogo.gif",
+      "imageAltText": "© 2012 MapQuest, Inc."
+    },
+    "statuscode": 403,
+    "messages": ["..."]
+  }
+}

data/test/fixtures/mapquest_invalid_request

@@ -0,0 +1,16 @@
+{
+  "results": [
+    {
+    "locations": []
+    }
+  ],
+  "info": {
+    "copyright": {
+      "text": "© 2012 MapQuest, Inc.",
+      "imageUrl": "http://api.mqcdn.com/res/mqlogo.gif",
+      "imageAltText": "© 2012 MapQuest, Inc."
+    },
+    "statuscode": 400,
+    "messages": ["Illegal argument from request: ..."]
+  }
+}

data/test/fixtures/mapquest_no_results

@@ -3,5 +3,14 @@
     {
     "locations": []
     }
-  ]
+  ],
+  "info": {
+    "copyright": {
+      "text": "© 2012 MapQuest, Inc.",
+      "imageUrl": "http://api.mqcdn.com/res/mqlogo.gif",
+      "imageAltText": "© 2012 MapQuest, Inc."
+    },
+    "statuscode": 0,
+    "messages": []
+  }
 }

data/test/mongoid_test.rb

@@ -36,4 +36,11 @@ class MongoidTest < Test::Unit::TestCase
     result = PlaceWithoutIndex.index_options.keys.flatten[0] == :coordinates
     assert !result
   end
+
+  def test_nil_radius_omits_max_distance
+    location = [40.750354, -73.993371]
+    p = Place.near(location, nil)
+    key = Mongoid::VERSION >= "3" ? "location" : :location
+    assert_equal nil, p.selector[key]['$maxDistance']
+  end
 end

data/test/near_test.rb

@@ -35,6 +35,24 @@ class NearTest < Test::Unit::TestCase
     assert_no_consecutive_comma(result[:select])
   end
 
+  def test_near_scope_options_with_custom_distance_column
+    result = Event.send(:near_scope_options, 1.0, 2.0, 5, :distance_column => 'calculated_distance')
+
+    assert_no_match /AS distance/, result[:select]
+    assert_match /AS calculated_distance/, result[:select]
+    assert_no_match /\bdistance\b/, result[:order]
+    assert_match /calculated_distance/, result[:order]
+    assert_no_consecutive_comma(result[:select])
+  end
+
+  def test_near_scope_options_with_custom_bearing_column
+    result = Event.send(:near_scope_options, 1.0, 2.0, 5, :bearing_column => 'calculated_bearing')
+
+    assert_no_match /AS bearing/, result[:select]
+    assert_match /AS calculated_bearing/, result[:select]
+    assert_no_consecutive_comma(result[:select])
+  end
+
   private
 
   def assert_no_consecutive_comma(string)

data/test/proxy_test.rb

@@ -20,4 +20,17 @@ class ProxyTest < Test::Unit::TestCase
       Geocoder::Lookup::Google.new.send(:http_client)
     end
   end
+
+  def test_accepts_proxy_with_http_protocol
+    Geocoder.configure(:http_proxy => 'http://localhost')
+    lookup = Geocoder::Lookup::Google.new
+    assert lookup.send(:http_client).proxy_class?
+  end
+
+  def test_accepts_proxy_with_https_protocol
+    Geocoder.configure(:https_proxy => 'https://localhost')
+    Geocoder.configure(:use_https => true)
+    lookup = Geocoder::Lookup::Google.new
+    assert lookup.send(:http_client).proxy_class?
+  end
 end

data/test/query_test.rb

@@ -44,4 +44,9 @@ class QueryTest < Test::Unit::TestCase
     assert !Geocoder::Query.new("127 Main St.").loopback_ip_address?
     assert !Geocoder::Query.new("John Doe\n127 Main St.\nAnywhere, USA").loopback_ip_address?
   end
+
+  def test_sanitized_text_with_array
+    q = Geocoder::Query.new([43.1313,11.3131])
+    assert_equal "43.1313,11.3131", q.sanitized_text
+  end
 end

data/test/services_test.rb

@@ -98,6 +98,26 @@ class ServicesTest < Test::Unit::TestCase
       Geocoder::Lookup::GooglePremier.new.query_url(Geocoder::Query.new("Madison Square Garden, New York, NY"))
   end
 
+  # --- DSTK (Data Science Toolkit) ---
+
+  def test_dstk_result_components
+    Geocoder.configure(:lookup => :dstk, :dstk => { :host => 'NOT_AN_ACTUAL_HOST' })
+    result = Geocoder.search("Madison Square Garden, New York, NY").first
+    assert_equal "Manhattan",
+      result.address_components_of_type(:sublocality).first['long_name']
+  end
+
+  def test_dstk_query_url
+    Geocoder.configure(:lookup => :dstk, :dstk => { :host => 'NOT_AN_ACTUAL_HOST' })
+    assert_equal "http://NOT_AN_ACTUAL_HOST/maps/api/geocode/json?address=Madison+Square+Garden%2C+New+York%2C+NY&language=en&sensor=false",
+      Geocoder::Lookup::Dstk.new.query_url(Geocoder::Query.new("Madison Square Garden, New York, NY"))
+  end
+
+  def test_dstk_default_query_url
+    Geocoder.configure(:lookup => :dstk)
+    assert_equal "http://www.datasciencetoolkit.org/maps/api/geocode/json?address=Madison+Square+Garden%2C+New+York%2C+NY&language=en&sensor=false",
+      Geocoder::Lookup::Dstk.new.query_url(Geocoder::Query.new("Madison Square Garden, New York, NY"))
+  end
 
   # --- Yahoo ---
 
@@ -206,6 +226,18 @@ class ServicesTest < Test::Unit::TestCase
     end
   end
 
+  def test_maxmind_works_when_loopback_address_on_omni
+    Geocoder.configure(:ip_lookup => :maxmind, :maxmind => { :service => :omni })
+    result = Geocoder.search("127.0.0.1").first
+    assert_equal "", result.country_code
+  end
+
+  def test_maxmind_works_when_loopback_address_on_country
+    Geocoder.configure(:ip_lookup => :maxmind, :maxmind => { :service => :country })
+    result = Geocoder.search("127.0.0.1").first
+    assert_equal "", result.country_code
+  end
+
 
   # --- Bing ---
 
@@ -256,7 +288,16 @@ class ServicesTest < Test::Unit::TestCase
     lookup = Geocoder::Lookup::Mapquest.new
     query = Geocoder::Query.new("Bluffton, SC")
     res = lookup.query_url(query)
-    assert_equal "http://www.mapquestapi.com/geocoding/v1/address?key=abc123&location=Bluffton%2C+SC",
+    assert_equal "http://open.mapquestapi.com/geocoding/v1/address?key=abc123&location=Bluffton%2C+SC",
+      res
+  end
+
+  def test_api_route_licensed
+    Geocoder.configure(:lookup => :mapquest, :api_key => "abc123", :mapquest => {:licensed => true, :version => 2})
+    lookup = Geocoder::Lookup::Mapquest.new
+    query = Geocoder::Query.new("Bluffton, SC")
+    res = lookup.query_url(query)
+    assert_equal "http://www.mapquestapi.com/geocoding/v2/address?key=abc123&location=Bluffton%2C+SC",
       res
   end
 
@@ -275,6 +316,38 @@ class ServicesTest < Test::Unit::TestCase
       result.address
   end
 
+  def test_mapquest_no_results
+    Geocoder.configure(:lookup => :mapquest)
+    set_api_key!(:mapquest)
+    assert_equal [], Geocoder.search("no results")
+  end
+
+  def test_mapquest_raises_exception_when_invalid_request
+    Geocoder.configure(:always_raise => [Geocoder::InvalidRequest])
+    l = Geocoder::Lookup.get(:mapquest)
+    assert_raises Geocoder::InvalidRequest do
+      l.send(:results, Geocoder::Query.new("invalid request"))
+    end
+  end
+
+  def test_mapquest_raises_exception_when_invalid_api_key
+    Geocoder.configure(:always_raise => [Geocoder::InvalidApiKey])
+    l = Geocoder::Lookup.get(:mapquest)
+    assert_raises Geocoder::InvalidApiKey do
+      l.send(:results, Geocoder::Query.new("invalid api key"))
+    end
+  end
+
+  def test_mapquest_raises_exception_when_error
+    Geocoder.configure(:always_raise => [Geocoder::Error])
+    l = Geocoder::Lookup.get(:mapquest)
+    assert_raises Geocoder::Error do
+      l.send(:results, Geocoder::Query.new("error"))
+    end
+  end
+
+
+
   # --- Esri ---
 
   def test_esri_query_for_geocode
@@ -304,7 +377,7 @@ class ServicesTest < Test::Unit::TestCase
     assert_equal 40.75004981300049, result.coordinates[0]
     assert_equal -73.99423889799965, result.coordinates[1]
   end
-  
+
   def test_esri_results_component_when_reverse_geocoding
     Geocoder.configure(:lookup => :esri)
     result = Geocoder.search([45.423733, -75.676333]).first