graticule 2.3.0 → 2.4.0

data/test/graticule/distance_test.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+require 'test_helper'
+
+module Graticule
+  module Distance
+    class DistanceFormulaTest < Test::Unit::TestCase
+      EARTH_RADIUS_IN_MILES = 3963.1676
+      EARTH_RADIUS_IN_KILOMETERS = 6378.135
+
+      FORMULAS = [Haversine, Spherical, Vincenty]
+
+      def test_earth_radius
+        assert_equal EARTH_RADIUS_IN_MILES, EARTH_RADIUS[:miles]
+        assert_equal EARTH_RADIUS_IN_KILOMETERS, EARTH_RADIUS[:kilometers]
+      end
+
+      def test_distance
+        washington_dc = Location.new(:latitude => 38.898748, :longitude => -77.037684)
+        chicago = Location.new(:latitude => 41.85, :longitude => -87.65)
+
+        FORMULAS.each do |formula|
+          assert_in_delta formula.distance(washington_dc, chicago), formula.distance(chicago, washington_dc), 0.00001
+          assert_in_delta 594.820, formula.distance(washington_dc, chicago), 1.0
+          assert_in_delta 594.820, formula.distance(washington_dc, chicago, :miles), 1.0
+          assert_in_delta 957.275, formula.distance(washington_dc, chicago, :kilometers), 1.0
+        end
+      end
+
+      def test_distance_between_antipodal_points
+        # The Vincenty formula will be indeterminant with antipodal points.
+        # See http://mathworld.wolfram.com/AntipodalPoints.html
+        washington_dc = Location.new(:latitude => 38.898748, :longitude => -77.037684)
+        chicago = Location.new(:latitude => 41.85, :longitude => -87.65)
+
+        # First, test the deltas.
+        FORMULAS.each do |formula|
+          assert_in_delta 12450.6582171051,
+            formula.distance(chicago, chicago.antipodal_location), 1.0
+          assert_in_delta 12450.6582171051,
+            formula.distance(washington_dc, washington_dc.antipodal_location), 1.0
+          assert_in_delta 12450.6582171051,
+            formula.distance(chicago, chicago.antipodal_location, :miles), 1.0
+          assert_in_delta 12450.6582171051,
+            formula.distance(washington_dc, washington_dc.antipodal_location, :miles), 1.0
+          assert_in_delta 20037.50205960391,
+            formula.distance(chicago, chicago.antipodal_location, :kilometers), 1.0
+          assert_in_delta 20037.5020596039,
+            formula.distance(washington_dc, washington_dc.antipodal_location, :kilometers), 1.0
+        end
+
+        # Next, test Vincenty.  Vincenty will use haversine instead of returning NaN on antipodal points
+        assert_equal Haversine.distance(washington_dc, washington_dc.antipodal_location),
+          Vincenty.distance(washington_dc, washington_dc.antipodal_location)
+        assert_equal Haversine.distance(chicago, chicago.antipodal_location),
+          Vincenty.distance(chicago, chicago.antipodal_location)
+      end
+    end
+  end
+end

data/test/graticule/geocoder/freethepostcode_test.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+require 'test_helper'
+
+module Graticule
+  module Geocoder
+    class FreeThePostcodeTest < Test::Unit::TestCase
+
+      def setup
+        URI::HTTP.responses = []
+        URI::HTTP.uris = []
+        @geocoder = FreeThePostcode.new
+      end
+
+      def test_success
+        return unless prepare_response(:success)
+
+        location = Location.new(
+          :latitude => 51.503172,
+          :longitude => -0.241641)
+
+        assert_equal location, @geocoder.locate('W1A 1AA')
+      end
+
+      def test_locate_unknown_address
+        return unless prepare_response(:not_found)
+        assert_raises(AddressError) { @geocoder.locate 'Z12 9pp' }
+      end
+
+    protected
+
+      def prepare_response(id = :success)
+        URI::HTTP.responses << response('freethepostcode', id, 'txt')
+      end
+
+    end
+  end
+end

data/test/graticule/geocoder/geocoder_ca_test.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+require 'test_helper'
+
+module Graticule
+  module Geocoder
+    class GeocoderCaTest < Test::Unit::TestCase
+
+      def setup
+        URI::HTTP.responses = []
+        URI::HTTP.uris = []
+
+        @geocoder = GeocoderCa.new
+        @location = Location.new(
+          :latitude => 45.418076,
+          :longitude => -75.693293,
+          :locality => "ottawa",
+          :precision => :unknown,
+          :region => "ON",
+          :street => "200 MUTCALF  "
+        )
+      end
+
+      def test_success
+        prepare_response(:success)
+        assert_equal @location, @geocoder.locate('200 mutcalf, ottawa on')
+      end
+
+      def test_url
+        prepare_response(:success)
+        @geocoder.locate('200 mutcalf, ottawa on')
+        assert_equal 'http://geocoder.ca/?geoit=XML&locate=200%20mutcalf,%20ottawa%20on&showpostal=1&standard=1',
+                     URI::HTTP.uris.first
+      end
+
+    protected
+      def prepare_response(id)
+        URI::HTTP.responses << response('geocoder_ca', id)
+      end
+
+    end
+  end
+end

data/test/graticule/geocoder/geocoder_us_test.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+require 'test_helper'
+
+module Graticule
+  module Geocoder
+    class GeocoderUsTest < Test::Unit::TestCase
+
+      def setup
+        URI::HTTP.responses = []
+        URI::HTTP.uris = []
+
+        @geocoder = GeocoderUs.new
+        @location = Location.new(
+          :street => "1600 Pennsylvania Ave NW, Washington DC 20502",
+          :longitude => -77.037684,
+          :latitude => 38.898748
+        )
+      end
+
+      def test_success
+        prepare_response(:success)
+        assert_equal @location, @geocoder.locate('1600 Pennsylvania Ave, Washington DC')
+      end
+
+      def test_url
+        prepare_response(:success)
+        @geocoder.locate('1600 Pennsylvania Ave, Washington DC')
+        assert_equal 'http://rpc.geocoder.us/service/rest/geocode?address=1600%20Pennsylvania%20Ave,%20Washington%20DC',
+                     URI::HTTP.uris.first
+      end
+
+      def test_locate_bad_address
+        prepare_response(:unknown)
+        assert_raises(AddressError) { @geocoder.locate('yuck') }
+      end
+
+    protected
+      def prepare_response(id)
+        URI::HTTP.responses << response('geocoder_us', id)
+      end
+
+    end
+  end
+end

data/test/graticule/geocoder/geocoders.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+require 'test_helper'
+
+module Graticule
+
+  # Generic tests for all geocoders (theoretically)
+  module GeocodersTestCase
+
+    def test_success
+      return unless prepare_response(:success)
+
+      location = Location.new(
+        :street => "1600 Amphitheatre Pkwy",
+        :city => "Mountain View",
+        :state => "CA",
+        :zip => "94043",
+        :country => "US",
+        :longitude => -122.083739,
+        :latitude => 37.423021,
+        :precision => :address
+      )
+      assert_equal location, @geocoder.locate('1600 Amphitheatre Parkway, Mountain View, CA')
+    end
+
+    def test_bad_key
+      return unless prepare_response(:badkey)
+      assert_raises(CredentialsError) { @geocoder.locate('x') }
+    end
+
+    def test_locate_missing_address
+      return unless prepare_response(:missing_address)
+      assert_raises(AddressError) { @geocoder.locate 'x' }
+    end
+
+    def test_locate_server_error
+      return unless prepare_response(:server_error)
+      assert_raises(Error) { @geocoder.locate 'x' }
+    end
+
+    def test_locate_too_many_queries
+      return unless prepare_response(:limit)
+      assert_raises(CredentialsError) { @geocoder.locate 'x' }
+    end
+
+    def test_locate_unavailable_address
+      return unless prepare_response(:unavailable)
+      assert_raises(AddressError) { @geocoder.locate 'x' }
+    end
+
+    def test_locate_unknown_address
+      return unless prepare_response(:unknown_address)
+      assert_raises(AddressError) { @geocoder.locate 'x' }
+    end
+
+  end
+end

data/test/graticule/geocoder/geonames_test.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+require 'test_helper'
+
+module Graticule
+  module Geocoder
+    class GeonamesTest < Test::Unit::TestCase
+      def setup
+        URI::HTTP.responses = []
+        URI::HTTP.uris = []
+        @geocoder = Geonames.new
+      end
+
+      def test_time_zone
+        return unless prepare_response(:success)
+
+        chicago = Location.new(:latitude => 41.85, :longitude => -87.65)
+        assert_equal 'America/Chicago', @geocoder.time_zone(chicago)
+      end
+
+      def test_time_zone
+        URI::HTTP.uris = []
+        URI::HTTP.responses = []
+        URI::HTTP.responses << response('geonames', :success)
+        chicago = Location.new(:latitude => 41.85, :longitude => -87.65)
+        assert_equal 'America/Chicago', @geocoder.time_zone(chicago)
+      end
+
+      # def test_locate_server_error
+      #   return unless prepare_response(:server_error)
+      #   assert_raises(Error) { @geocoder.locate 'x' }
+      # end
+      #
+      # def test_locate_too_many_queries
+      #   return unless prepare_response(:limit)
+      #   assert_raises(CredentialsError) { @geocoder.locate 'x' }
+      # end
+      #
+      # def test_locate_unavailable_address
+      #   return unless prepare_response(:unavailable)
+      #   assert_raises(AddressError) { @geocoder.locate 'x' }
+      # end
+      #
+      # def test_locate_unknown_address
+      #   return unless prepare_response(:unknown_address)
+      #   assert_raises(AddressError) { @geocoder.locate 'x' }
+      # end
+
+    protected
+
+      def prepare_response(id = :success)
+        URI::HTTP.responses << response('geonames', id)
+      end
+
+    end
+  end
+end

data/test/graticule/geocoder/google_signed_test.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+require 'test_helper'
+
+class GoogleTest < Test::Unit::TestCase
+  def test_url_is_signed_for_business_accounts
+    geocoder = Graticule.service(:google).new("e7-fake-account-R911GuLecpVqA=", 'gme-example')
+    url = geocoder.send :make_url, :address => 'New York'
+    expected = "http://maps.googleapis.com/maps/api/geocode/json?address=New%20York&client=gme-example&sensor=false&signature=EJNTEh9SqstO1FLcbFsQ0aJrWHA="
+    assert_equal expected, url.to_s
+  end
+
+  def test_url_is_not_signed_for_normal_accounts
+    geocoder = Graticule.service(:google).new()
+    url = geocoder.send :make_url, :address => 'New York'
+    expected = "http://maps.googleapis.com/maps/api/geocode/json?address=New%20York&sensor=false"
+    assert_equal expected, url.to_s
+  end
+end
+

data/test/graticule/geocoder/google_test.rb

@@ -0,0 +1,138 @@
+# encoding: UTF-8
+require 'test_helper'
+
+module Graticule
+  module Geocoder
+    class GoogleTest < Test::Unit::TestCase
+      def setup
+        URI::HTTP.responses = []
+        URI::HTTP.uris = []
+        @geocoder = Google.new('APP_ID')
+      end
+
+      def test_success
+        return unless prepare_response(:success)
+        location = Location.new(
+          :latitude=>37.421641,
+          :longitude=>-122.0855016,
+          :street=>"1600 Amphitheatre Pkwy",
+          :locality=>"Mountain View",
+          :region=>"CA",
+          :postal_code=>"94043",
+          :country=>"US",
+          :precision=>:address
+        )
+        assert_equal location, @geocoder.locate('1600 Amphitheatre Parkway, Mountain View, CA')
+      end
+
+      # The #locate parameters are broad, so the JSON response contains
+      # multiple results at street-level precision. We expect to get the
+      # first result back, and it should not contain a postal code.
+      def test_success_multiple_results
+        return unless prepare_response(:success_multiple_results)
+        location = Location.new(
+          :latitude=>43.645337, 
+          :longitude=>-79.413208, 
+          :street=>"Queen St W", 
+          :locality=>"Toronto", 
+          :region=>"ON", 
+          :country=>"CA", 
+          :precision=>:street
+        )
+        assert_equal location, @geocoder.locate('Queen St West, Toronto, ON CA')
+      end
+
+      def test_precision_region
+        return unless prepare_response(:region)
+        location = Location.new(
+          :latitude=> 36.7782610,
+          :longitude=>-119.41793240,
+          :region=>"CA",
+          :country=>"US",
+          :precision=>:region
+        )
+        assert_equal location, @geocoder.locate('CA US')
+      end
+
+      def test_precision_country
+        return unless prepare_response(:country)
+        location = Location.new(
+          :latitude=>37.090240,
+          :longitude=>-95.7128910,
+          :country=>"US",
+          :precision=>:country
+        )
+        assert_equal location, @geocoder.locate('US')
+      end
+
+      def test_precision_locality
+        return unless prepare_response(:locality)
+        location = Location.new(
+          :latitude=>37.7749295, 
+          :longitude=>-122.4194155, 
+          :country=>"US",
+          :region=>"CA",
+          :locality=>"San Francisco",
+          :precision=>:locality
+        )
+        assert_equal location, @geocoder.locate('San Francisco, CA US')
+      end
+
+      def test_precision_street
+        return unless prepare_response(:street)
+        location = Location.new(
+          :latitude=>37.42325960000001,
+          :longitude=>-122.08563830,
+          :country=>"US",
+          :region=>"CA",
+          :street=>"Amphitheatre Pkwy",
+          :locality=>"Mountain View",
+          :precision=>:street
+        )
+        assert_equal location, @geocoder.locate('Amphitheatre Pkwy, Mountain View CA US')
+      end
+
+      def test_precision_address
+        return unless prepare_response(:address)
+        location = Location.new(
+          :latitude=>37.421641,
+          :longitude=>-122.0855016,
+          :street=>"1600 Amphitheatre Pkwy",
+          :locality=>"Mountain View",
+          :region=>"CA",
+          :postal_code=>"94043",
+          :country=>"US",
+          :precision=>:address
+        )
+        assert_equal location, @geocoder.locate('1600 Amphitheatre Parkway, Mountain View, CA')
+      end
+
+      def test_locate_server_error
+        return unless prepare_response(:server_error)
+        assert_raises(Error) { @geocoder.locate 'x' }
+      end
+
+      def test_locate_too_many_queries
+        return unless prepare_response(:limit)
+        assert_raises(CredentialsError) { @geocoder.locate 'x' }
+      end
+
+      def test_locate_zero_results
+        return unless prepare_response(:zero_results)
+        assert_raises(AddressError) { @geocoder.locate 'x' }
+      end
+
+      def test_bad_key
+        return unless prepare_response(:badkey)
+        assert_raises(CredentialsError) { @geocoder.locate('x') }
+      end
+
+    protected
+
+      def prepare_response(id = :success)
+        URI::HTTP.responses << response('google', id, 'json')
+      end
+
+    end
+  end
+end