bw-geocoder 1.2.5

data/test/integration/http_client_test.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+$: << File.join(File.dirname(__FILE__), "..", "..", "lib")
+require 'pathname'
+require 'rubygems'
+require 'test/unit'
+require 'geocoder'
+require 'yaml'
+
+class HttpClientTest < Test::Unit::TestCase
+  def setup
+    @api_keys = YAML.load_file("api_keys.yml")
+  end
+
+  def test_http_basic_auth
+    Geocoder.configure(lookup: :geocoder_us, api_key: @api_keys["geocoder_us"])
+    results = Geocoder.search "27701"
+    assert_not_nil results.first
+  end
+
+  def test_ssl
+    Geocoder.configure(lookup: :esri, use_https: true)
+    results = Geocoder.search "27701"
+    assert_not_nil results.first
+  end
+
+  def test_ssl_opt_out
+    Geocoder.configure(ip_lookup: :telize, use_https: true)
+    results = Geocoder.search "74.200.247.59"
+    assert_not_nil results.first
+  end
+end

data/test/mongoid_test_helper.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'test/unit'
+require 'test_helper'
+require 'mongoid'
+require 'geocoder/models/mongoid'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+if (::Mongoid::VERSION >= "3")
+  Mongoid.logger = Logger.new($stderr, :debug)
+else
+  Mongoid.configure do |config|
+    config.logger = Logger.new($stderr, :debug)
+  end
+end
+
+##
+# Geocoded model.
+#
+class PlaceUsingMongoid
+  include Mongoid::Document
+  include Geocoder::Model::Mongoid
+
+  geocoded_by :address, :coordinates => :location
+  field :name
+  field :address
+  field :location, :type => Array
+
+  def initialize(name, address)
+    super()
+    write_attribute :name, name
+    write_attribute :address, address
+  end
+end
+
+class PlaceUsingMongoidWithoutIndex
+  include Mongoid::Document
+  include Geocoder::Model::Mongoid
+
+  field :location, :type => Array
+  geocoded_by :location, :skip_index => true
+end

data/test/test_helper.rb

@@ -0,0 +1,386 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+class MysqlConnection
+  def adapter_name
+    "mysql"
+  end
+end
+
+##
+# Simulate enough of ActiveRecord::Base that objects can be used for testing.
+#
+module ActiveRecord
+  class Base
+
+    def initialize
+      @attributes = {}
+    end
+
+    def read_attribute(attr_name)
+      @attributes[attr_name.to_sym]
+    end
+
+    def write_attribute(attr_name, value)
+      @attributes[attr_name.to_sym] = value
+    end
+
+    def update_attribute(attr_name, value)
+      write_attribute(attr_name.to_sym, value)
+    end
+
+    def self.scope(*args); end
+
+    def self.connection
+      MysqlConnection.new
+    end
+
+    def method_missing(name, *args, &block)
+      if name.to_s[-1..-1] == "="
+        write_attribute name.to_s[0...-1], *args
+      else
+        read_attribute name
+      end
+    end
+
+    class << self
+      def table_name
+        'test_table_name'
+      end
+
+      def primary_key
+        :id
+      end
+    end
+
+  end
+end
+
+# simulate Rails module so Railtie gets loaded
+module Rails
+end
+
+# Require Geocoder after ActiveRecord simulator.
+require 'geocoder'
+require "geocoder/lookups/base"
+
+##
+# Mock HTTP request to geocoding service.
+#
+module Geocoder
+  module Lookup
+    class Base
+      private
+      def fixture_exists?(filename)
+        File.exist?(File.join("test", "fixtures", filename))
+      end
+
+      def read_fixture(file)
+        filepath = File.join("test", "fixtures", file)
+        s = File.read(filepath).strip.gsub(/\n\s*/, "")
+        s.instance_eval do
+          def body; self; end
+          def code; "200"; end
+        end
+        s
+      end
+
+      ##
+      # Fixture to use if none match the given query.
+      #
+      def default_fixture_filename
+        "#{fixture_prefix}_madison_square_garden"
+      end
+
+      def fixture_prefix
+        handle
+      end
+
+      def fixture_for_query(query)
+        label = query.reverse_geocode? ? "reverse" : query.text.gsub(/[ \.]/, "_")
+        filename = "#{fixture_prefix}_#{label}"
+        fixture_exists?(filename) ? filename : default_fixture_filename
+      end
+
+      remove_method(:make_api_request)
+
+      def make_api_request(query)
+        raise TimeoutError if query.text == "timeout"
+        raise SocketError if query.text == "socket_error"
+        raise Errno::ECONNREFUSED if query.text == "connection_refused"
+        read_fixture fixture_for_query(query)
+      end
+    end
+
+    class GooglePremier
+      private
+      def fixture_prefix
+        "google"
+      end
+    end
+
+    class GooglePlacesDetails
+      private
+      def fixture_prefix
+        "google_places_details"
+      end
+    end
+
+    class Dstk
+      private
+      def fixture_prefix
+        "google"
+      end
+    end
+
+    class Yandex
+      private
+      def default_fixture_filename
+        "yandex_kremlin"
+      end
+    end
+
+    class Freegeoip
+      private
+      def default_fixture_filename
+        "freegeoip_74_200_247_59"
+      end
+    end
+
+    class Telize
+      private
+      def default_fixture_filename
+        "telize_74_200_247_59"
+      end
+    end
+
+    class Pointpin
+      private
+      def default_fixture_filename
+        "pointpin_80_111_555_555"
+      end
+    end
+
+    class Maxmind
+      private
+      def default_fixture_filename
+        "maxmind_74_200_247_59"
+      end
+    end
+
+    class MaxmindLocal
+      private
+
+      remove_method(:results)
+
+      def results query
+        return [] if query.to_s == "no results"
+
+        if query.to_s == '127.0.0.1'
+          []
+        else
+          [{:request=>"8.8.8.8", :ip=>"8.8.8.8", :country_code2=>"US", :country_code3=>"USA", :country_name=>"United States", :continent_code=>"NA", :region_name=>"CA", :city_name=>"Mountain View", :postal_code=>"94043", :latitude=>37.41919999999999, :longitude=>-122.0574, :dma_code=>807, :area_code=>650, :timezone=>"America/Los_Angeles"}]
+        end
+      end
+    end
+
+    class Baidu
+      private
+      def default_fixture_filename
+        "baidu_shanghai_pearl_tower"
+      end
+    end
+
+    class BaiduIp
+      private
+      def default_fixture_filename
+        "baidu_ip_202_198_16_3"
+      end
+    end
+
+    class Geocodio
+      private
+      def default_fixture_filename
+        "geocodio_1101_pennsylvania_ave"
+      end
+    end
+
+    class Okf
+      private
+      def default_fixture_filename
+        "okf_kirstinmaki"
+      end
+    end
+  end
+end
+
+##
+# Geocoded model.
+#
+class Place < ActiveRecord::Base
+  geocoded_by :address
+
+  def initialize(name, address)
+    super()
+    write_attribute :name, name
+    write_attribute :address, address
+  end
+end
+
+##
+# Geocoded model.
+# - Has user-defined primary key (not just 'id')
+#
+class PlaceWithCustomPrimaryKey < Place
+
+  class << self
+    def primary_key
+      :custom_primary_key_id
+    end
+  end
+
+end
+
+class PlaceReverseGeocoded < ActiveRecord::Base
+  reverse_geocoded_by :latitude, :longitude
+
+  def initialize(name, latitude, longitude)
+    super()
+    write_attribute :name, name
+    write_attribute :latitude, latitude
+    write_attribute :longitude, longitude
+  end
+end
+
+class PlaceWithCustomResultsHandling < ActiveRecord::Base
+  geocoded_by :address do |obj,results|
+    if result = results.first
+      obj.coords_string = "#{result.latitude},#{result.longitude}"
+    else
+      obj.coords_string = "NOT FOUND"
+    end
+  end
+
+  def initialize(name, address)
+    super()
+    write_attribute :name, name
+    write_attribute :address, address
+  end
+end
+
+class PlaceReverseGeocodedWithCustomResultsHandling < ActiveRecord::Base
+  reverse_geocoded_by :latitude, :longitude do |obj,results|
+    if result = results.first
+      obj.country = result.country_code
+    end
+  end
+
+  def initialize(name, latitude, longitude)
+    super()
+    write_attribute :name, name
+    write_attribute :latitude, latitude
+    write_attribute :longitude, longitude
+  end
+end
+
+class PlaceWithForwardAndReverseGeocoding < ActiveRecord::Base
+  geocoded_by :address, :latitude => :lat, :longitude => :lon
+  reverse_geocoded_by :lat, :lon, :address => :location
+
+  def initialize(name)
+    super()
+    write_attribute :name, name
+  end
+end
+
+class PlaceWithCustomLookup < ActiveRecord::Base
+  geocoded_by :address, :lookup => :nominatim do |obj,results|
+    if result = results.first
+      obj.result_class = result.class
+    end
+  end
+
+  def initialize(name, address)
+    super()
+    write_attribute :name, name
+    write_attribute :address, address
+  end
+end
+
+class PlaceWithCustomLookupProc < ActiveRecord::Base
+  geocoded_by :address, :lookup => lambda{|obj| obj.custom_lookup } do |obj,results|
+    if result = results.first
+      obj.result_class = result.class
+    end
+  end
+
+  def custom_lookup
+    :nominatim
+  end
+
+  def initialize(name, address)
+    super()
+    write_attribute :name, name
+    write_attribute :address, address
+  end
+end
+
+class PlaceReverseGeocodedWithCustomLookup < ActiveRecord::Base
+  reverse_geocoded_by :latitude, :longitude, :lookup => :nominatim do |obj,results|
+    if result = results.first
+      obj.result_class = result.class
+    end
+  end
+
+  def initialize(name, latitude, longitude)
+    super()
+    write_attribute :name, name
+    write_attribute :latitude, latitude
+    write_attribute :longitude, longitude
+  end
+end
+
+
+class GeocoderTestCase < Test::Unit::TestCase
+
+  def setup
+    super
+    Geocoder::Configuration.instance.set_defaults
+    Geocoder.configure(:maxmind => {:service => :city_isp_org})
+  end
+
+  def geocoded_object_params(abbrev)
+    {
+      :msg => ["Madison Square Garden", "4 Penn Plaza, New York, NY"]
+    }[abbrev]
+  end
+
+  def reverse_geocoded_object_params(abbrev)
+    {
+      :msg => ["Madison Square Garden", 40.750354, -73.993371]
+    }[abbrev]
+  end
+
+  def set_api_key!(lookup_name)
+    lookup = Geocoder::Lookup.get(lookup_name)
+    if lookup.required_api_key_parts.size == 1
+      key = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
+    elsif lookup.required_api_key_parts.size > 1
+      key = lookup.required_api_key_parts
+    else
+      key = nil
+    end
+    Geocoder.configure(:api_key => key)
+  end
+end
+
+class MockHttpResponse
+  attr_reader :code, :body
+  def initialize(options = {})
+    @code = options[:code].to_s
+    @body = options[:body]
+  end
+end

data/test/unit/active_record_test.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+$: << File.join(File.dirname(__FILE__), "..")
+require 'test_helper'
+
+class ActiveRecordTest < GeocoderTestCase
+
+  def test_exclude_condition_when_model_has_a_custom_primary_key
+    venue = PlaceWithCustomPrimaryKey.new(*geocoded_object_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( /#{PlaceWithCustomPrimaryKey.primary_key}/, conditions.join)
+  end
+
+end

data/test/unit/cache_test.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+$: << File.join(File.dirname(__FILE__), "..")
+require 'test_helper'
+
+class CacheTest < GeocoderTestCase
+
+  def test_second_occurrence_of_request_is_cache_hit
+    Geocoder.configure(:cache => {})
+    Geocoder::Lookup.all_services_except_test.each do |l|
+      next if l == :maxmind_local # local, does not use cache
+      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
+
+  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