geocoder 1.1.3 → 1.1.6

data/lib/oauth_util.rb

@@ -0,0 +1,112 @@
+# A utility for signing an url using OAuth in a way that's convenient for debugging
+# Note: the standard Ruby OAuth lib is here http://github.com/mojodna/oauth
+# Source: http://gist.github.com/383159
+# License: http://gist.github.com/375593
+# Usage: see example.rb below
+#
+# NOTE: This file has been modified from the original Gist:
+#
+# 1. Fix to prevent param-array conversion, as mentioned in Gist comment.
+# 2. Query string escaping has been changed. See:
+#   https://github.com/alexreisner/geocoder/pull/360
+#
+
+require 'uri'
+require 'cgi'
+require 'openssl'
+require 'base64'
+
+class OauthUtil
+
+  attr_accessor :consumer_key, :consumer_secret, :token, :token_secret, :req_method, 
+                :sig_method, :oauth_version, :callback_url, :params, :req_url, :base_str
+
+  def initialize
+    @consumer_key = ''
+    @consumer_secret = ''
+    @token = ''
+    @token_secret = ''
+    @req_method = 'GET'
+    @sig_method = 'HMAC-SHA1'
+    @oauth_version = '1.0'
+    @callback_url = ''
+  end
+
+  # openssl::random_bytes returns non-word chars, which need to be removed. using alt method to get length
+  # ref http://snippets.dzone.com/posts/show/491
+  def nonce
+    Array.new( 5 ) { rand(256) }.pack('C*').unpack('H*').first
+  end
+
+  def percent_encode( string )
+
+    # ref http://snippets.dzone.com/posts/show/1260
+    return URI.escape( string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]") ).gsub('*', '%2A')
+  end
+
+  # @ref http://oauth.net/core/1.0/#rfc.section.9.2
+  def signature
+    key = percent_encode( @consumer_secret ) + '&' + percent_encode( @token_secret )
+
+    # ref: http://blog.nathanielbibler.com/post/63031273/openssl-hmac-vs-ruby-hmac-benchmarks
+    digest = OpenSSL::Digest::Digest.new( 'sha1' )
+    hmac = OpenSSL::HMAC.digest( digest, key, @base_str )
+
+    # ref http://groups.google.com/group/oauth-ruby/browse_thread/thread/9110ed8c8f3cae81
+    Base64.encode64( hmac ).chomp.gsub( /\n/, '' )
+  end
+
+  # sort (very important as it affects the signature), concat, and percent encode
+  # @ref http://oauth.net/core/1.0/#rfc.section.9.1.1
+  # @ref http://oauth.net/core/1.0/#9.2.1
+  # @ref http://oauth.net/core/1.0/#rfc.section.A.5.1
+  def query_string
+    pairs = []
+    @params.sort.each { | key, val | 
+      pairs.push( "#{ CGI.escape(key.to_s).gsub(/%(5B|5D)/n) { [$1].pack('H*') } }=#{ CGI.escape(val.to_s) }" )
+    }
+    pairs.join '&'
+  end
+
+  # organize params & create signature
+  def sign( parsed_url )
+
+    @params = {
+      'oauth_consumer_key' => @consumer_key,
+      'oauth_nonce' => nonce,
+      'oauth_signature_method' => @sig_method,
+      'oauth_timestamp' => Time.now.to_i.to_s,
+      'oauth_version' => @oauth_version
+    }
+
+    # if url has query, merge key/values into params obj overwriting defaults
+    if parsed_url.query
+      CGI.parse( parsed_url.query ).each do |k,v|
+        if v.is_a?(Array) && v.count == 1
+          @params[k] = v.first
+        else
+          @params[k] = v
+        end
+      end
+    end
+
+    # @ref http://oauth.net/core/1.0/#rfc.section.9.1.2
+    @req_url = parsed_url.scheme + '://' + parsed_url.host + parsed_url.path
+
+    # create base str. make it an object attr for ez debugging
+    # ref http://oauth.net/core/1.0/#anchor14
+    @base_str = [ 
+      @req_method, 
+      percent_encode( req_url ), 
+
+      # normalization is just x-www-form-urlencoded
+      percent_encode( query_string ) 
+
+    ].join( '&' )
+
+    # add signature
+    @params[ 'oauth_signature' ] = signature
+
+    return self
+  end
+end

data/test/active_record_test.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require 'test_helper'
+
+class ActiveRecordTest < Test::Unit::TestCase
+
+  def test_exclude_condition_when_model_has_a_custom_primary_key
+    venue = VenuePlus.new(*venue_params(:msg))
+
+    # just call private method directly so we don't have to stub .near scope
+    conditions = venue.class.send(:add_exclude_condition, ["fake_condition"], venue)
+
+    assert_match( /#{VenuePlus.primary_key}/, conditions.join)
+  end
+
+end

data/test/cache_test.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+require 'test_helper'
+
+class CacheTest < Test::Unit::TestCase
+
+  def test_second_occurrence_of_request_is_cache_hit
+    Geocoder.configure(:cache => {})
+    Geocoder::Lookup.all_services_except_test.each do |l|
+      Geocoder.configure(:lookup => l)
+      set_api_key!(l)
+      results = Geocoder.search("Madison Square Garden")
+      assert !results.first.cache_hit,
+        "Lookup #{l} returned erroneously cached result."
+      results = Geocoder.search("Madison Square Garden")
+      assert results.first.cache_hit,
+        "Lookup #{l} did not return cached result."
+    end
+  end
+end

data/test/calculations_test.rb

@@ -3,10 +3,10 @@ require 'test_helper'
 
 class CalculationsTest < Test::Unit::TestCase
   def setup
-    Geocoder.configure do |config|
-      config.units  = :mi
-      config.distances = :linear
-    end
+    Geocoder.configure(
+      :units => :mi,
+      :distances => :linear
+    )
   end
 
   # --- degree distance ---
@@ -185,4 +185,11 @@ class CalculationsTest < Test::Unit::TestCase
     assert !Geocoder::Calculations.coordinates_present?(Geocoder::Calculations::NAN)
     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)
+  end
 end

data/test/configuration_test.rb

@@ -7,69 +7,44 @@ class ConfigurationTest < Test::Unit::TestCase
   end
 
   def test_exception_raised_on_bad_lookup_config
-    Geocoder::Configuration.lookup = :stoopid
+    Geocoder.configure(:lookup => :stoopid)
     assert_raises Geocoder::ConfigurationError do
       Geocoder.search "something dumb"
     end
   end
 
-  # --- class method configuration ---
-  def test_configurated_by_class_method
-    Geocoder::Configuration.units = :mi
-    distance = Geocoder::Calculations.distance_between([0,0], [0,1]).round
-    assert_not_equal 111, distance
-    assert_equal      69, distance
-
-    Geocoder::Configuration.units = :km
-    distance = Geocoder::Calculations.distance_between([0,0], [0,1]).round
-    assert_equal    111, distance
-    assert_not_equal 69, distance
-
-    Geocoder::Configuration.distances = :spherical
-    angle = Geocoder::Calculations.bearing_between([50,-85], [40.750354, -73.993371]).round
-    assert_equal     136, angle
-    assert_not_equal 130, angle
+  def test_setting_with_class_method
+    Geocoder::Configuration.units = :test
+    assert_equal :test, Geocoder.config.units
+  end
 
-    Geocoder::Configuration.distances = :linear
-    angle = Geocoder::Calculations.bearing_between([50,-85], [40.750354, -73.993371]).round
-    assert_not_equal 136, angle
-    assert_equal     130, angle
+  def test_setting_with_configure_method
+    Geocoder.configure(:units => :test)
+    assert_equal :test, Geocoder.config.units
   end
 
-  # --- Geocoder#configure distances configuration ---
-  def test_geocoder_configuration
-    # DSL
+  def test_setting_with_block_syntax
+    orig = $VERBOSE; $VERBOSE = nil
     Geocoder.configure do |config|
-      config.units  = :mi
-      config.distances = :linear
+      config.units = :test
     end
+    assert_equal :test, Geocoder.config.units
+  ensure
+    $VERBOSE = orig
+  end
 
-    assert_equal Geocoder::Configuration.units, :mi
-    distance = Geocoder::Calculations.distance_between([0,0], [0,1]).round
-    assert_not_equal 111, distance
-    assert_equal      69, distance
-
-    assert_equal Geocoder::Configuration.distances, :linear
-    angle = Geocoder::Calculations.bearing_between([50,-85], [40.750354, -73.993371]).round
-    assert_not_equal 136, angle
-    assert_equal     130, angle
-
-    # Direct
-    Geocoder.configure.units  = :km
-    Geocoder.configure.distances = :spherical
-
-    assert_equal Geocoder::Configuration.units, :km
-    distance = Geocoder::Calculations.distance_between([0,0], [0,1]).round
-    assert_equal    111, distance
-    assert_not_equal 69, distance
-
-    assert_equal Geocoder::Configuration.distances, :spherical
-    angle = Geocoder::Calculations.bearing_between([50,-85], [40.750354, -73.993371]).round
-    assert_equal     136, angle
-    assert_not_equal 130, angle
+  def test_config_for_lookup
+    Geocoder.configure(
+      :timeout => 5,
+      :api_key => "aaa",
+      :google => {
+        :timeout => 2
+      }
+    )
+    assert_equal 2, Geocoder.config_for_lookup(:google).timeout
+    assert_equal "aaa", Geocoder.config_for_lookup(:google).api_key
   end
 
-  # Geocoder per-model configuration
   def test_model_configuration
     Landmark.reverse_geocoded_by :latitude, :longitude, :method => :spherical, :units => :km
     assert_equal :km,        Landmark.geocoder_options[:units]
@@ -90,7 +65,7 @@ class ConfigurationTest < Test::Unit::TestCase
     v.longitude = 0
 
     # method option > global configuration
-    Geocoder.configure.units  = :km
+    Geocoder.configure(:units => :km)
     assert_equal 69, v.distance_to([0,1], :mi).round
 
     # per-model configuration > global configuration

data/test/error_handling_test.rb

@@ -4,35 +4,39 @@ require 'test_helper'
 class ErrorHandlingTest < Test::Unit::TestCase
 
   def teardown
-    Geocoder::Configuration.always_raise = []
+    Geocoder.configure(:always_raise => [])
   end
 
   def test_does_not_choke_on_timeout
     # keep test output clean: suppress timeout warning
     orig = $VERBOSE; $VERBOSE = nil
-    all_lookups_except_test.each do |l|
-      Geocoder::Configuration.lookup = l
+    Geocoder::Lookup.all_services_except_test.each do |l|
+      Geocoder.configure(:lookup => l)
+      set_api_key!(l)
       assert_nothing_raised { Geocoder.search("timeout") }
     end
+  ensure
     $VERBOSE = orig
   end
 
   def test_always_raise_timeout_error
-    Geocoder::Configuration.always_raise = [TimeoutError]
-    all_lookups_except_test.each do |l|
-      lookup = Geocoder.send(:get_lookup, l)
+    Geocoder.configure(:always_raise => [TimeoutError])
+    Geocoder::Lookup.all_services_except_test.each do |l|
+      lookup = Geocoder::Lookup.get(l)
+      set_api_key!(l)
       assert_raises TimeoutError do
-        lookup.send(:results, "timeout")
+        lookup.send(:results, Geocoder::Query.new("timeout"))
       end
     end
   end
 
   def test_always_raise_socket_error
-    Geocoder::Configuration.always_raise = [SocketError]
-    all_lookups_except_test.each do |l|
-      lookup = Geocoder.send(:get_lookup, l)
+    Geocoder.configure(:always_raise => [SocketError])
+    Geocoder::Lookup.all_services_except_test.each do |l|
+      lookup = Geocoder::Lookup.get(l)
+      set_api_key!(l)
       assert_raises SocketError do
-        lookup.send(:results, "socket_error")
+        lookup.send(:results, Geocoder::Query.new("socket_error"))
       end
     end
   end

data/test/fixtures/bing_invalid_key

@@ -0,0 +1 @@
+{"authenticationResultCode":"InvalidCredentials","brandLogoUri":"http:\\/\\/dev.virtualearth.net\\/Branding\\/logo_powered_by.png","copyright":"Copyright \xC2\xA9 2012 Microsoft and its suppliers. All rights reserved. This API cannot be accessed and the content and any results may not be used, reproduced or transmitted in any manner without express written permission from Microsoft Corporation.","errorDetails":["Access was denied. You may have entered your credentials incorrectly, or you might not have access to the requested resource or operation."],"resourceSets":[],"statusCode":401,"statusDescription":"Unauthorized","traceId":"5c539f6e70c44b2e858741b6c932318e|EWRM001670|02.00.83.1900|"}

data/test/fixtures/mapquest_madison_square_garden

@@ -0,0 +1,52 @@
+{
+  "results": [
+    {
+      "locations": [
+        {
+          "latLng": {
+            "lng": -73.994637,
+            "lat": 40.720409
+          },
+          "adminArea4": "New York County",
+          "adminArea5Type": "City",
+          "adminArea4Type": "County",
+          "adminArea5": "New York",
+          "street": "46 West 31st Street",
+          "adminArea1": "US",
+          "adminArea3": "NY",
+          "type": "s",
+          "displayLatLng": {
+            "lng": -73.994637,
+            "lat": 40.720409
+          },
+          "linkId": 0,
+          "postalCode": "10001",
+          "sideOfStreet": "N",
+          "dragPoint": false,
+          "adminArea1Type": "Country",
+          "geocodeQuality": "CITY",
+          "geocodeQualityCode": "A5XAX",
+          "mapUrl": "http://www.mapquestapi.com/staticmap/v3/getmap?type=map&size=225,160&pois=purple-1,40.720409,-73.994637,0,0|&center=40.720409,-73.994637&zoom=9&key=Gmjtd|luua2hu2nd,7x=o5-lz8lg&rand=604519389",
+          "adminArea3Type": "State"
+        }
+      ],
+      "providedLocation": {
+        "location": "Madison Square Garden, New York, NY"
+      }
+    }
+  ],
+  "options": {
+    "ignoreLatLngInput": false,
+    "maxResults": -1,
+    "thumbMaps": true
+  },
+  "info": {
+    "copyright": {
+      "text": "© 2012 MapQuest, Inc.",
+      "imageUrl": "http://api.mqcdn.com/res/mqlogo.gif",
+      "imageAltText": "© 2012 MapQuest, Inc."
+    },
+    "statuscode": 0,
+    "messages": []
+  }
+}

data/test/fixtures/mapquest_no_results

@@ -0,0 +1,7 @@
+{
+  "results": [
+    {
+    "locations": []
+    }
+  ]
+}

data/test/fixtures/maxmind_24_24_24_21

@@ -0,0 +1 @@
+US,

data/test/fixtures/maxmind_24_24_24_22

@@ -0,0 +1 @@
+US,NY,Jamaica,40.6915,-73.8057,

data/test/fixtures/maxmind_24_24_24_23

@@ -0,0 +1 @@
+US,NY,Jamaica,,40.6915,-73.8057,501,718,"Road Runner","Road Runner",

data/test/fixtures/maxmind_24_24_24_24

@@ -0,0 +1 @@
+US,"United States",NY,"New York",Jamaica,40.6915,-73.8057,501,718,America/New_York,NA,,"Road Runner","Road Runner",rr.com,"AS11351 Road Runner HoldCo LLC",Cable/DSL,residential,779,99,37,76,,

data/test/fixtures/maxmind_74_200_247_59

@@ -0,0 +1 @@
+US,TX,Plano,75093,33.034698,-96.813400,623,972,"Layered Technologies , US","Layered Technologies , US",

data/test/fixtures/maxmind_invalid_key

@@ -0,0 +1 @@
+,,,,,,,,,,INVALID_LICENSE_KEY

data/test/fixtures/maxmind_no_results

@@ -0,0 +1 @@
+,,,,,,,,,,IP_NOT_FOUND

data/test/fixtures/yahoo_error

@@ -0,0 +1 @@
+{"bossresponse":{"responsecode":"6000","reason":"internal error"}}

data/test/fixtures/yahoo_invalid_key

@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>\n<yahoo:error xmlns:yahoo='http://yahooapis.com/v1/base.rng'\n  xml:lang='en-US'>
+  <yahoo:description>Please provide valid credentials. OAuth oauth_problem="consumer_key_unknown", realm="yahooapis.com"</yahoo:description>\n</yahoo:error>

data/test/fixtures/yahoo_madison_square_garden

@@ -0,0 +1,52 @@
+{
+  "bossresponse": {
+    "responsecode": "200",
+    "placefinder": {
+      "start": "0",
+      "count": "1",
+      "request": "flags=JXTSR&location=Madison%20Square%20Garden%2C%20NY%2C%20NY&%unsafe%appid=%5B%22dj0yJmk9ZmZ5NXFrNGhNcEthJmQ9WVdrOVFUSlhPV2x1TjJVbWNHbzlORE0wT0RFME9UWXkmcz1jb25zdW1lcnNlY3JldCZ4PTAy%22%2C%20%22b57b1b98eb21f171231f5b441cba505261d6c9bb%22%5D&gflags=AC&locale=en_US",
+      "results": [
+        {
+          "quality": "90",
+          "latitude": "40.750381",
+          "longitude": "-73.993988",
+          "offsetlat": "40.750381",
+          "offsetlon": "-73.993988",
+          "radius": "400",
+          "boundingbox": {
+            "north": "40.750832",
+            "south": "40.749931",
+            "east": "-73.993393",
+            "west": "-73.994591"
+          },
+          "name": "Madison Square Garden",
+          "line1": "Madison Square Garden",
+          "line2": "New York, NY 10001",
+          "line3": "",
+          "line4": "United States",
+          "cross": "",
+          "house": "",
+          "street": "",
+          "xstreet": "",
+          "unittype": "",
+          "unit": "",
+          "postal": "10001",
+          "neighborhood": "Garment District|Midtown|Midtown West|Manhattan",
+          "city": "New York",
+          "county": "New York County",
+          "state": "New York",
+          "country": "United States",
+          "countrycode": "US",
+          "statecode": "NY",
+          "countycode": "",
+          "timezone": "America/New_York",
+          "areacode": "212",
+          "uzip": "10001",
+          "hash": "",
+          "woeid": "23617041",
+          "woetype": "20"
+        }
+      ]
+    }
+  }
+}

data/test/fixtures/yahoo_no_results

@@ -0,0 +1,10 @@
+{
+  "bossresponse": {
+    "responsecode": "200",
+    "placefinder": {
+      "start": "0",
+      "count": "0",
+      "request": "flags=JXTSR&location=asdfasdf28394782sdfj2983&%unsafe%appid=%5B%22dj0yJmk9ZmZ5NXFrNGhNcEthJmQ9WVdrOVFUSlhPV2x1TjJVbWNHbzlORE0wT0RFME9UWXkmcz1jb25zdW1lcnNlY3JldCZ4PTAy%22%2C%20%22b57b1b98eb21f171231f5b441cba505261d6c9bb%22%5D&gflags=AC&locale=en_US"
+    }
+  }
+}

data/test/fixtures/yahoo_over_limit

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="utf-8"?> <yahoo:error xmlns:yahoo="http://yahooapis.com/v1/base.rng\ <http://yahooapis.com/v1/base.rng%5C>" xml:lang="en-US"> 
+          <yahoo:description>Rate Limit Exceeded</yahoo:description> <yahoo:detail>Key has exceeded its configured rate limit.</yahoo:detail> </yahoo:error>

data/test/https_test.rb

@@ -4,13 +4,13 @@ require 'test_helper'
 class HttpsTest < Test::Unit::TestCase
 
   def test_uses_https_for_secure_query
-    Geocoder::Configuration.use_https = true
+    Geocoder.configure(:use_https => true)
     g = Geocoder::Lookup::Google.new
-    assert_match /^https:/, g.send(:query_url, {:a => 1, :b => 2})
+    assert_match /^https:/, g.query_url(Geocoder::Query.new("test"))
   end
 
   def test_uses_http_by_default
     g = Geocoder::Lookup::Google.new
-    assert_match /^http:/, g.send(:query_url, {:a => 1, :b => 2})
+    assert_match /^http:/, g.query_url(Geocoder::Query.new("test"))
   end
 end

data/test/integration/smoke_test.rb

@@ -8,17 +8,19 @@ class SmokeTest < Test::Unit::TestCase
 
   def test_simple_zip_code_search
     result = Geocoder.search "27701"
-    assert_equal "Durham", result.first.city
-    assert_equal "North Carolina", result.first.state
+    assert_not_nil (r = result.first)
+    assert_equal "Durham", r.city
+    assert_equal "North Carolina", r.state
   end
 
   def test_simple_zip_code_search_with_ssl
-    Geocoder::Configuration.use_https = true
+    Geocoder.configure(:use_https => true)
     result = Geocoder.search "27701"
-    assert_equal "Durham", result.first.city
-    assert_equal "North Carolina", result.first.state
+    assert_not_nil (r = result.first)
+    assert_equal "Durham", r.city
+    assert_equal "North Carolina", r.state
   ensure
-    Geocoder::Configuration.use_https = false
+    Geocoder.configure(:use_https => false)
   end
 
 end