geokit-premier 0.0.4

data/spec/geocoder_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe "Geocoder" do
+  
+  after(:each) do
+    Geokit::Geocoders.google_client_id = nil
+    Geokit::Geocoders.google_premier_secret_key = nil
+    Geokit::Geocoders::google = nil
+  end
+  
+
+  describe "self.google_client_id" do
+    it "should be nil by default and settable" do
+      Geokit::Geocoders.google_client_id.should == nil
+      Geokit::Geocoders.google_client_id = 'abc'
+      Geokit::Geocoders.google_client_id.should == 'abc'
+    end
+  end
+  
+  describe "self.google_premier_secret_key" do
+    it "should be nil by default and settable" do
+      Geokit::Geocoders.google_premier_secret_key.should == nil
+      Geokit::Geocoders.google_premier_secret_key = 'abc123'
+      Geokit::Geocoders.google_premier_secret_key.should == 'abc123'
+    end
+  end
+
+  describe "#sign_url" do
+    it "should encrypt the url" do
+      expected = 'http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID&signature=KrU1TzVQM7Ur0i8i7K3huiw3MsA='
+      actual = Geokit::Geocoders::Geocoder.sign_url('http://maps.googleapis.com/maps/api/geocode/json?address=New+York&sensor=false&client=clientID','vNIXE0xscrmjlyV-12Nj_BvUPaw=')
+      actual.should == expected
+    end
+    
+    it "xml example" do
+      secret = 'vNIXE0xscrmjlyV-12Nj_BvUPaw='
+      url = "http://maps.googleapis.com/maps/api/geocode/xml?address=1600+Amphitheatre+Parkway,+Mountain+View,+CA&client=gme-cenx&sensor=false"
+      expected = "http://maps.googleapis.com/maps/api/geocode/xml?address=1600+Amphitheatre+Parkway,+Mountain+View,+CA&client=gme-cenx&sensor=false&signature=1LZ2Iz3gtt-OH0uIv0nJBFGN8E8="
+      Geokit::Geocoders::Geocoder.sign_url(url,secret).should == expected
+    end
+    
+  end
+  
+  describe "#urlsafe_decode64" do
+    it "should deal with - and +" do
+      Geokit::Geocoders::Geocoder.urlsafe_decode64("a-b+c-d+").should == "k\346\376s\347~"
+    end
+  end
+
+  describe "#urlsafe_encode64" do
+    it "should deal with - and +" do
+      Geokit::Geocoders::Geocoder.urlsafe_encode64("k\346\376s\347~").should == "a-b-c-d-\n"
+    end
+  end
+  
+  describe "GoogleGeocoder3#geocode_url" do
+    
+    it "should use default if not premier" do
+      Geokit::Geocoders::google = 'abc123'
+      expected = "http://maps.google.com/maps/api/geocode/json?sensor=false&address=Ottawa"
+      Geokit::Geocoders::GoogleGeocoder3.geocode_url('Ottawa',{}).should == expected
+    end
+    
+    it "should use client if premier" do
+      Geokit::Geocoders.google_client_id = 'gme-cenx'
+      Geokit::Geocoders.google_premier_secret_key = 'ciK-I4AWUmFx5jBRIjtrL6hDC04='
+      expected = "http://maps.googleapis.com/maps/api/geocode/json?address=Ottawa&client=gme-cenx&sensor=false&oe=utf-8&signature=VG4njf1Yo59tnEvwPAMlgOoj4_0="
+      Geokit::Geocoders::GoogleGeocoder3.geocode_url('Ottawa',{}).should == expected
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'lib/geokit'
+require 'rubygems'
+require 'irb'
+require 'irb/completion'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+# Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+  # config.before(:each) { Machinist.reset_before_test }
+  
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  # config.use_transactional_fixtures = true
+
+end
+
+module IRB
+   def IRB.parse_opts
+     # Don't touch ARGV, which belongs to the app which called this module.
+   end
+end
+

data/test/test_base_geocoder.rb

@@ -0,0 +1,58 @@
+require 'test/unit'
+require 'net/http'
+require 'rubygems'
+require 'mocha'
+require 'lib/geokit'
+
+class MockSuccess < Net::HTTPSuccess #:nodoc: all
+  def initialize
+  end
+end
+
+class MockFailure < Net::HTTPServiceUnavailable #:nodoc: all
+  def initialize
+  end
+end
+
+# Base class for testing geocoders.
+class BaseGeocoderTest < Test::Unit::TestCase #:nodoc: all
+
+  class Geokit::Geocoders::TestGeocoder < Geokit::Geocoders::Geocoder
+    def self.do_get(url)
+      sleep(2)
+    end    
+  end
+
+  # Defines common test fixtures.
+  def setup
+    @address = 'San Francisco, CA'    
+    @full_address = '100 Spear St, San Francisco, CA, 94105-1522, US'   
+    @full_address_short_zip = '100 Spear St, San Francisco, CA, 94105, US' 
+    
+    @latlng = Geokit::LatLng.new(37.7742, -122.417068)
+    @success = Geokit::GeoLoc.new({:city=>"SAN FRANCISCO", :state=>"CA", :country_code=>"US", :lat=>@latlng.lat, :lng=>@latlng.lng})
+    @success.success = true    
+  end  
+  
+  def test_timeout_call_web_service
+    url = "http://www.anything.com"
+    Geokit::Geocoders::request_timeout = 1
+    assert_nil Geokit::Geocoders::TestGeocoder.call_geocoder_service(url)    
+  end
+  
+  def test_successful_call_web_service
+    url = "http://www.anything.com"
+    Geokit::Geocoders::Geocoder.expects(:do_get).with(url).returns("SUCCESS")
+    assert_equal "SUCCESS", Geokit::Geocoders::Geocoder.call_geocoder_service(url)
+  end
+  
+  def test_find_geocoder_methods
+    public_methods = Geokit::Geocoders::Geocoder.public_methods.map { |m| m.to_s }
+    assert public_methods.include?("yahoo_geocoder")
+    assert public_methods.include?("google_geocoder")
+    assert public_methods.include?("ca_geocoder")
+    assert public_methods.include?("us_geocoder")
+    assert public_methods.include?("multi_geocoder")
+    assert public_methods.include?("ip_geocoder")
+  end
+end

data/test/test_bounds.rb

@@ -0,0 +1,97 @@
+require 'test/unit'
+require 'lib/geokit'
+
+class BoundsTest < Test::Unit::TestCase #:nodoc: all
+  
+  def setup
+    # This is the area in Texas
+    @sw = Geokit::LatLng.new(32.91663,-96.982841)
+    @ne = Geokit::LatLng.new(32.96302,-96.919495)
+    @bounds=Geokit::Bounds.new(@sw,@ne) 
+    @loc_a=Geokit::LatLng.new(32.918593,-96.958444) # inside bounds    
+    @loc_b=Geokit::LatLng.new(32.914144,-96.958444) # outside bouds
+    
+    # this is a cross-meridan area
+    @cross_meridian=Geokit::Bounds.normalize([30,170],[40,-170])
+    @inside_cm=Geokit::LatLng.new(35,175)
+    @inside_cm_2=Geokit::LatLng.new(35,-175)
+    @east_of_cm=Geokit::LatLng.new(35,-165)
+    @west_of_cm=Geokit::LatLng.new(35,165)
+
+  end  
+
+  def test_equality
+    assert_equal Geokit::Bounds.new(@sw,@ne), Geokit::Bounds.new(@sw,@ne)
+  end  
+  
+  def test_normalize
+    res=Geokit::Bounds.normalize(@sw,@ne)
+    assert_equal res,Geokit::Bounds.new(@sw,@ne)     
+    res=Geokit::Bounds.normalize([@sw,@ne])
+    assert_equal res,Geokit::Bounds.new(@sw,@ne)
+    res=Geokit::Bounds.normalize([@sw.lat,@sw.lng],[@ne.lat,@ne.lng])
+    assert_equal res,Geokit::Bounds.new(@sw,@ne)
+    res=Geokit::Bounds.normalize([[@sw.lat,@sw.lng],[@ne.lat,@ne.lng]])
+    assert_equal res,Geokit::Bounds.new(@sw,@ne)
+  end
+  
+  def test_point_inside_bounds
+    assert @bounds.contains?(@loc_a)
+  end
+
+  def test_point_outside_bounds
+    assert !@bounds.contains?(@loc_b) 
+  end  
+
+  def test_point_inside_bounds_cross_meridian
+    assert @cross_meridian.contains?(@inside_cm)
+    assert @cross_meridian.contains?(@inside_cm_2)
+  end
+
+  def test_point_outside_bounds_cross_meridian
+    assert !@cross_meridian.contains?(@east_of_cm)
+    assert !@cross_meridian.contains?(@west_of_cm)
+  end    
+  
+  def test_center
+    assert_in_delta 32.939828,@bounds.center.lat,0.00005
+    assert_in_delta(-96.9511763,@bounds.center.lng,0.00005)
+  end
+
+  def test_center_cross_meridian
+    assert_in_delta 35.41160, @cross_meridian.center.lat,0.00005
+    assert_in_delta 179.38112, @cross_meridian.center.lng,0.00005
+  end  
+  
+  def test_creation_from_circle
+    bounds=Geokit::Bounds.from_point_and_radius([32.939829, -96.951176],2.5)
+    inside=Geokit::LatLng.new 32.9695270000,-96.9901590000
+    outside=Geokit::LatLng.new 32.8951550000,-96.9584440000
+    assert bounds.contains?(inside)
+    assert !bounds.contains?(outside)
+  end
+  
+  def test_bounds_to_span
+    sw = Geokit::LatLng.new(32, -96)
+    ne = Geokit::LatLng.new(40, -70)
+    bounds = Geokit::Bounds.new(sw, ne)
+    
+    assert_equal Geokit::LatLng.new(8, 26), bounds.to_span
+  end
+  
+  def test_bounds_to_span_with_bounds_crossing_prime_meridian
+    sw = Geokit::LatLng.new(20, -70)
+    ne = Geokit::LatLng.new(40, 100)
+    bounds = Geokit::Bounds.new(sw, ne)
+    
+    assert_equal Geokit::LatLng.new(20, 170), bounds.to_span
+  end
+  
+  def test_bounds_to_span_with_bounds_crossing_dateline
+    sw = Geokit::LatLng.new(20, 100)
+    ne = Geokit::LatLng.new(40, -70)
+    bounds = Geokit::Bounds.new(sw, ne)
+    
+    assert_equal Geokit::LatLng.new(20, 190), bounds.to_span
+  end
+end

data/test/test_ca_geocoder.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+
+Geokit::Geocoders::geocoder_ca = "SOMEKEYVALUE"
+
+class CaGeocoderTest < BaseGeocoderTest #:nodoc: all
+  
+  CA_SUCCESS=<<-EOF
+  <?xml version="1.0" encoding="UTF-8" ?>
+  <geodata><latt>49.243086</latt><longt>-123.153684</longt></geodata>  
+  EOF
+  
+  def setup
+    @ca_full_hash = {:street_address=>"2105 West 32nd Avenue",:city=>"Vancouver", :state=>"BC"}
+    @ca_full_loc = Geokit::GeoLoc.new(@ca_full_hash)
+  end  
+  
+  def test_geocoder_with_geo_loc_with_account
+    response = MockSuccess.new
+    response.expects(:body).returns(CA_SUCCESS)
+    url = "http://geocoder.ca/?stno=2105&addresst=West+32nd+Avenue&city=Vancouver&prov=BC&auth=SOMEKEYVALUE&geoit=xml"
+    Geokit::Geocoders::CaGeocoder.expects(:call_geocoder_service).with(url).returns(response)
+    verify(Geokit::Geocoders::CaGeocoder.geocode(@ca_full_loc))    
+  end
+  
+  def test_service_unavailable
+    response = MockFailure.new
+    #Net::HTTP.expects(:get_response).with(URI.parse("http://geocoder.ca/?stno=2105&addresst=West+32nd+Avenue&city=Vancouver&prov=BC&auth=SOMEKEYVALUE&geoit=xml")).returns(response)  
+    url = "http://geocoder.ca/?stno=2105&addresst=West+32nd+Avenue&city=Vancouver&prov=BC&auth=SOMEKEYVALUE&geoit=xml" 
+    Geokit::Geocoders::CaGeocoder.expects(:call_geocoder_service).with(url).returns(response)
+    assert !Geokit::Geocoders::CaGeocoder.geocode(@ca_full_loc).success   
+  end  
+  
+  private
+  
+  def verify(location)
+    assert_equal "BC", location.state
+    assert_equal "Vancouver", location.city 
+    assert_equal "49.243086,-123.153684", location.ll 
+    assert !location.is_us? 
+  end
+end

data/test/test_geoloc.rb

@@ -0,0 +1,72 @@
+require 'test/unit'
+require 'lib/geokit'
+
+class GeoLocTest < Test::Unit::TestCase #:nodoc: all
+  
+  def setup
+    @loc = Geokit::GeoLoc.new
+  end
+  
+  def test_is_us
+    assert !@loc.is_us?
+    @loc.country_code = 'US'
+    assert @loc.is_us?
+  end
+  
+  def test_success
+    assert !@loc.success?
+    @loc.success = false
+    assert !@loc.success?
+    @loc.success = true
+    assert @loc.success?
+  end
+  
+  def test_street_number
+    @loc.street_address = '123 Spear St.'
+    assert_equal '123', @loc.street_number
+  end
+  
+  def test_street_name
+    @loc.street_address = '123 Spear St.'
+    assert_equal 'Spear St.', @loc.street_name
+  end
+  
+  def test_city
+    @loc.city = "san francisco"
+    assert_equal 'San Francisco', @loc.city
+  end
+  
+  def test_full_address
+    @loc.city = 'San Francisco'
+    @loc.state = 'CA'
+    @loc.zip = '94105'
+    @loc.country_code = 'US'
+    assert_equal 'San Francisco, CA, 94105, US', @loc.full_address
+    @loc.full_address = 'Irving, TX, 75063, US'
+    assert_equal 'Irving, TX, 75063, US', @loc.full_address
+  end
+  
+  def test_hash
+    @loc.city = 'San Francisco'
+    @loc.state = 'CA'
+    @loc.zip = '94105'
+    @loc.country_code = 'US'
+    @another = Geokit::GeoLoc.new @loc.to_hash    
+    assert_equal @loc, @another
+  end
+  
+  def test_all
+    assert_equal [@loc], @loc.all
+  end
+  
+  def test_to_yaml
+    @loc.city = 'San Francisco'
+    @loc.state = 'CA'
+    @loc.zip = '94105'
+    @loc.country_code = 'US'
+    assert_equal( 
+      "--- !ruby/object:Geokit::GeoLoc \ncity: San Francisco\ncountry_code: US\nfull_address: \nlat: \nlng: \nprecision: unknown\nprovince: \nstate: CA\nstreet_address: \nsuccess: false\nzip: \"94105\"\n", 
+      @loc.to_yaml)
+  end
+  
+end

data/test/test_geoplugin_geocoder.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), 'test_base_geocoder')
+
+class IpGeocoderTest < BaseGeocoderTest #:nodoc: all
+    
+  IP_SUCCESS=<<-EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<geoPlugin>
+    <geoplugin_city>Belo Horizonte</geoplugin_city>
+    <geoplugin_region>Minas Gerais</geoplugin_region>
+    <geoplugin_areaCode>0</geoplugin_areaCode>
+    <geoplugin_dmaCode>0</geoplugin_dmaCode>
+    <geoplugin_countryCode>BR</geoplugin_countryCode>
+    <geoplugin_countryName>Brazil</geoplugin_countryName>
+    <geoplugin_continentCode>SA</geoplugin_continentCode>
+    <geoplugin_latitude>-19.916700</geoplugin_latitude>
+    <geoplugin_longitude>-43.933300</geoplugin_longitude>
+    <geoplugin_currencyCode>BRL</geoplugin_currencyCode>
+    <geoplugin_currencySymbol>&#82;&#36;</geoplugin_currencySymbol>
+    <geoplugin_currencyConverter>2.2575001717</geoplugin_currencyConverter>
+</geoPlugin>
+    EOF
+
+  def setup
+    super
+    @success.provider = "geoPlugin"
+  end    
+  
+  def test_successful_lookup
+    success = MockSuccess.new
+    success.expects(:body).returns(IP_SUCCESS)
+    url = 'http://www.geoplugin.net/xml.gp?ip=200.150.38.66'
+    GeoKit::Geocoders::GeoPluginGeocoder.expects(:call_geocoder_service).with(url).returns(success)
+    location = GeoKit::Geocoders::GeoPluginGeocoder.geocode('200.150.38.66')
+    assert_not_nil location
+    assert_equal -19.916700, location.lat
+    assert_equal -43.933300, location.lng
+    assert_equal "Belo Horizonte", location.city
+    assert_equal "Minas Gerais", location.state
+    assert_equal "BR", location.country_code
+    assert_equal "geoPlugin", location.provider
+    assert location.success?
+  end
+
+  def test_invalid_ip
+    location = GeoKit::Geocoders::GeoPluginGeocoder.geocode("pixrum")
+    assert_not_nil location
+    assert !location.success?
+  end
+  
+  def test_service_unavailable
+    failure = MockFailure.new
+    url = 'http://www.geoplugin.net/xml.gp?ip=10.10.10.10'
+    GeoKit::Geocoders::GeoPluginGeocoder.expects(:call_geocoder_service).with(url).returns(failure)
+    location = GeoKit::Geocoders::GeoPluginGeocoder.geocode("10.10.10.10")
+    assert_not_nil location
+    assert !location.success?
+  end  
+end