geocoder 1.0.2 → 1.0.3

data/CHANGELOG.rdoc

@@ -2,6 +2,13 @@
 
 Per-release changes to Geocoder.
 
+== 1.0.3 (2011 Sep 17)
+
+* Fix: rake assets:precompile (Rails 3.1) not working in some situations.
+* Update Google API URL (thanks github.com/soorajb).
+* Allow rescue from timeout with FreeGeoIP (thanks github.com/lukeledet).
+* Fix: stop double-adjusting units when using kilometers (thanks github.com/hairyheron).
+
 == 1.0.2 (2011 June 25)
 
 * Add support for MongoMapper (thanks github.com/spagalloco).

data/README.rdoc

@@ -77,9 +77,11 @@ Reverse geocoding is similar:
   reverse_geocoded_by :coordinates
   after_validation :reverse_geocode  # auto-fetch address
 
+Be sure to read <i>Latitude/Longitude Order</i> in the <i>Notes on MongoDB</i> section below on how to properly retrieve latitude/longitude coordinates from your objects.
+
 === MongoMapper
 
-MongoMapper is very similar to Mongoid, just be sure to include <tt>Geocoder::Model::Mongoid</tt>.
+MongoMapper is very similar to Mongoid, just be sure to include <tt>Geocoder::Model::MongoMapper</tt>.
 
 === Bulk Geocoding
 
@@ -266,6 +268,7 @@ Languages:: ar, eu, bg, bn, ca, cs, da, de, el, en, en-AU, en-GB, es, eu, fa, fi
 Documentation:: http://code.google.com/apis/maps/documentation/geocoding/#JSON
 Terms of Service:: http://code.google.com/apis/maps/terms.html#section_10_12
 Limitations:: "You must not use or display the Content without a corresponding Google map, unless you are explicitly permitted to do so in the Maps APIs Documentation, or through written permission from Google." "You must not pre-fetch, cache, or store any Content, except that you may store: (i) limited amounts of Content for the purpose of improving the performance of your Maps API Implementation..."
+Notes:: To use Google Premier set <tt>Geocoder::Configuration.lookup = :google_premier</tt> and <tt>Geocoder::Configuration.api_key = [key, client, channel]</tt>.
 
 ==== Yahoo (<tt>:yahoo</tt>)
 
@@ -424,6 +427,16 @@ Mongo document classes (Mongoid and MongoMapper) have a built-in +near+ scope, b
 
 Coordinates are generally printed and spoken as latitude, then logitude ([lat,lon]). Geocoder respects this convention and always expects method arguments to be given in [lat,lon] order. However, MongoDB requires that coordinates be stored in [lon,lat] order as per the GeoJSON spec (http://geojson.org/geojson-spec.html#positions), so internally they are stored "backwards." However, this does not affect order of arguments to methods when using Mongoid or MongoMapper.
 
+To access an object's coordinates in the conventional order, use the <tt>to_coordinates</tt> instance method provided by Geocoder. For example:
+
+    obj.to_coordinates  # => [37.7941013, -122.3951096] # [lat, lon]
+
+Calling <tt>obj.coordinates</tt> directly returns the internal representation of the coordinates which, in the case of MongoDB, is probably the reverse of what you want:
+
+    obj.coordinates     # => [-122.3951096, 37.7941013] # [lon, lat]
+
+For consistency with the rest of Geocoder, always use the <tt>to_coordinates</tt> method instead.
+
 
 == Distance Queries in SQLite
 

data/Rakefile

@@ -10,7 +10,7 @@ end
 
 task :default => :test
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "Geocoder #{Geocoder::VERSION}"

data/lib/geocoder.rb

@@ -56,7 +56,7 @@ module Geocoder
   # All street address lookups, default first.
   #
   def street_lookups
-    [:google, :yahoo, :bing, :geocoder_ca, :yandex]
+    [:google, :google_premier, :yahoo, :bing, :geocoder_ca, :yandex]
   end
 
   ##
@@ -91,12 +91,8 @@ module Geocoder
   # Retrieve a Lookup object from the store.
   #
   def get_lookup(name)
-    unless defined?(@lookups)
-      @lookups = {}
-    end
-    unless @lookups.include?(name)
-      @lookups[name] = spawn_lookup(name)
-    end
+    @lookups = {} unless defined?(@lookups)
+    @lookups[name] = spawn_lookup(name) unless @lookups.include?(name)
     @lookups[name]
   end
 
@@ -108,9 +104,9 @@ module Geocoder
       name = name.to_s
       require "geocoder/lookups/#{name}"
       klass = name.split("_").map{ |i| i[0...1].upcase + i[1..-1] }.join
-      eval("Geocoder::Lookup::#{klass}.new")
+      Geocoder::Lookup.const_get(klass).new
     else
-      valids = valid_lookups.map{ |l| ":#{l}" }.join(", ")
+      valids = valid_lookups.map(&:inspect).join(", ")
       raise ConfigurationError, "Please specify a valid lookup for Geocoder " +
         "(#{name.inspect} is not one of: #{valids})."
     end
@@ -120,7 +116,7 @@ module Geocoder
   # Does the given value look like an IP address?
   #
   # Does not check for actual validity, just the appearance of four
-  # dot-delimited 8-bit numbers.
+  # dot-delimited numbers.
   #
   def ip_address?(value)
     !!value.to_s.match(/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/)

data/lib/geocoder/configuration.rb

@@ -22,6 +22,7 @@ module Geocoder
         [:https_proxy, nil],
 
         # API key for geocoding service
+        # for Google Premier use a 3-element array: [key, client, channel]
         [:api_key, nil],
 
         # cache object (must respond to #[], #[]=, and #keys)
@@ -38,20 +39,20 @@ module Geocoder
     end
 
     # define getters and setters for all configuration settings
-    self.options_and_defaults.each do |o,d|
-      eval("def self.#{o}; @@#{o}; end")
-      eval("def self.#{o}=(obj); @@#{o} = obj; end")
-    end
+    self.options_and_defaults.each do |option, default|
+      class_eval(<<-END, __FILE__, __LINE__ + 1)
+
+        @@#{option} = default unless defined? @@#{option}
+
+        def self.#{option}
+          @@#{option}
+        end
 
-    ##
-    # Set all values to default.
-    #
-    def self.set_defaults
-      self.options_and_defaults.each do |o,d|
-        self.send("#{o}=", d)
-      end
+        def self.#{option}=(obj)
+          @@#{option} = obj
+        end
+
+      END
     end
   end
 end
-
-Geocoder::Configuration.set_defaults

data/lib/geocoder/lookups/base.rb

@@ -87,7 +87,7 @@ module Geocoder
       # Class of the result objects
       #
       def result_class
-        eval("Geocoder::Result::#{self.class.to_s.split(":").last}")
+        Geocoder::Result.const_get(self.class.to_s.split(":").last)
       end
 
       ##

data/lib/geocoder/lookups/bing.rb

@@ -12,7 +12,7 @@ module Geocoder::Lookup
 
     def results(query, reverse = false)
       return [] unless doc = fetch_data(query, reverse)
-      
+
       if doc['statusDescription'] == "OK"
         return doc['resourceSets'].first['estimatedTotal'] > 0 ? doc['resourceSets'].first['resources'] : []
       else

data/lib/geocoder/lookups/freegeoip.rb

@@ -11,7 +11,8 @@ module Geocoder::Lookup
       return [reserved_result(query)] if loopback_address?(query)
       begin
         return (doc = fetch_data(query, reverse)) ? [doc] : []
-      rescue StandardError # Freegeoip.net returns HTML on bad request
+      rescue StandardError => err # Freegeoip.net returns HTML on bad request
+        raise_error(err)
         return []
       end
     end

data/lib/geocoder/lookups/google.rb

@@ -31,7 +31,7 @@ module Geocoder::Lookup
         :language => Geocoder::Configuration.language,
         :key => Geocoder::Configuration.api_key
       }
-      "#{protocol}://maps.google.com/maps/api/geocode/json?" + hash_to_query(params)
+      "#{protocol}://maps.googleapis.com/maps/api/geocode/json?" + hash_to_query(params)
     end
   end
 end

data/lib/geocoder/lookups/google_premier.rb

@@ -0,0 +1,38 @@
+require 'openssl'
+require 'base64'
+require 'geocoder/lookups/google'
+require 'geocoder/results/google_premier'
+
+module Geocoder::Lookup
+  class GooglePremier < Google
+
+    private # ---------------------------------------------------------------
+
+    def query_url(query, reverse = false)
+      params = {
+        (reverse ? :latlng : :address) => query,
+        :sensor => 'false',
+        :language => Geocoder::Configuration.language,
+        :client => Geocoder::Configuration.api_key[1],
+        :channel => Geocoder::Configuration.api_key[2]
+      }.reject{ |key, value| value.nil? }
+      path = "/maps/api/geocode/json?#{hash_to_query(params)}"
+      "#{protocol}://maps.googleapis.com#{path}&signature=#{sign(path)}"
+    end
+
+    def sign(string)
+      raw_private_key = url_safe_base64_decode(Geocoder::Configuration.api_key[0])
+      digest = OpenSSL::Digest::Digest.new('sha1')
+      raw_signature = OpenSSL::HMAC.digest(digest, raw_private_key, string)
+      url_safe_base64_encode(raw_signature)
+    end
+
+    def url_safe_base64_decode(base64_string)
+      Base64.decode64(base64_string.tr('-_', '+/'))
+    end
+
+    def url_safe_base64_encode(raw)
+      Base64.encode64(raw).tr('+/', '-_').strip
+    end
+  end
+end

data/lib/geocoder/models/base.rb

@@ -31,7 +31,7 @@ module Geocoder
         unless @geocoder_options
           @geocoder_options = {}
           require "geocoder/stores/#{geocoder_file_name}"
-          include eval("Geocoder::Store::" + geocoder_module_name)
+          include Geocoder::Store.const_get(geocoder_module_name)
         end
         @geocoder_options.merge! options
       end

data/lib/geocoder/models/mongo_base.rb

@@ -38,14 +38,14 @@ module Geocoder
         unless geocoder_initialized?
           @geocoder_options = {}
           require "geocoder/stores/#{geocoder_file_name}"
-          include eval("Geocoder::Store::" + geocoder_module_name)
+          include Geocoder::Store.const_get(geocoder_module_name)
         end
         @geocoder_options.merge! options
       end
 
       def geocoder_initialized?
         begin
-          included_modules.include? eval("Geocoder::Store::" + geocoder_module_name)
+          included_modules.include? Geocoder::Store.const_get(geocoder_module_name)
         rescue NameError
           false
         end

data/lib/geocoder/railtie.rb

@@ -18,7 +18,7 @@ module Geocoder
 
   class Railtie
     def self.insert
-      if defined?(::ActiveRecord)
+      if ENV['RAILS_GROUPS'].to_s != 'assets' and defined?(::ActiveRecord)
         ::ActiveRecord::Base.extend(Model::ActiveRecord)
       end
     end

data/lib/geocoder/results/freegeoip.rb

@@ -4,7 +4,8 @@ module Geocoder::Result
   class Freegeoip < Base
 
     def address(format = :full)
-      "#{city}#{', ' + state_code unless state_code == ''} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
+      s = state_code.to_s == "" ? "" : ", #{state_code}"
+      "#{city}#{s} #{postal_code}, #{country}".sub(/^[ ,]*/, "")
     end
 
     def city

data/lib/geocoder/results/geocoder_ca.rb

@@ -51,7 +51,7 @@ module Geocoder::Result
     end
 
 
-    private # ---------------------------------------------------------------- 
+    private # ----------------------------------------------------------------
 
     def canadian_province_abbreviations
       %w[ON QC NS NB MB BC PE SK AB NL]

data/lib/geocoder/results/google.rb

@@ -82,5 +82,9 @@ module Geocoder::Result
     def geometry
       @data['geometry']
     end
+
+    def precision
+      geometry['location_type'] if geometry
+    end
   end
 end

data/lib/geocoder/results/google_premier.rb

@@ -0,0 +1,6 @@
+require 'geocoder/results/google'
+
+module Geocoder::Result
+  class GooglePremier < Google
+  end
+end

data/lib/geocoder/stores/active_record.rb

@@ -66,7 +66,6 @@ module Geocoder::Store
       # * +:exclude+ - an object to exclude (used by the +nearbys+ method)
       #
       def near_scope_options(latitude, longitude, radius = 20, options = {})
-        radius *= Geocoder::Calculations.km_in_mi if options[:units] == :km
         if connection.adapter_name.match /sqlite/i
           approx_near_scope_options(latitude, longitude, radius, options)
         else

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/test/configuration_test.rb

@@ -9,4 +9,5 @@ class ConfigurationTest < Test::Unit::TestCase
       Geocoder.search "something dumb"
     end
   end
+
 end

data/test/custom_block_test.rb

@@ -3,10 +3,6 @@ require 'test_helper'
 
 class CustomBlockTest < Test::Unit::TestCase
 
-  def setup
-    Geocoder::Configuration.set_defaults
-  end
-
   def test_geocode_with_block_runs_block
     e = Event.new(*venue_params(:msg))
     coords = [40.750354, -73.993371]

data/test/error_handling_test.rb

@@ -3,10 +3,6 @@ require 'test_helper'
 
 class ErrorHandlingTest < Test::Unit::TestCase
 
-  def setup
-    Geocoder::Configuration.set_defaults
-  end
-
   def test_does_not_choke_on_timeout
     # keep test output clean: suppress timeout warning
     orig = $VERBOSE; $VERBOSE = nil
@@ -19,13 +15,23 @@ class ErrorHandlingTest < Test::Unit::TestCase
 
   def test_always_raise_timeout_error
     Geocoder::Configuration.always_raise = [TimeoutError]
-    assert_raise(TimeoutError) { Geocoder.search("timeout") }
+    all_lookups.each do |l|
+      lookup = Geocoder.send(:get_lookup, l)
+      assert_raises TimeoutError do
+        lookup.send(:results, "timeout")
+      end
+    end
     Geocoder::Configuration.always_raise = []
   end
 
   def test_always_raise_socket_error
     Geocoder::Configuration.always_raise = [SocketError]
-    assert_raise(SocketError) { Geocoder.search("socket_error") }
+    all_lookups.each do |l|
+      lookup = Geocoder.send(:get_lookup, l)
+      assert_raises SocketError do
+        lookup.send(:results, "socket_error")
+      end
+    end
     Geocoder::Configuration.always_raise = []
   end
 end

data/test/fixtures/freegeoip_no_results.json

@@ -0,0 +1 @@
+<html><title>404: Not Found</title><body>404: Not Found</body></html>

data/test/geocoder_test.rb

@@ -3,10 +3,6 @@ require 'test_helper'
 
 class GeocoderTest < Test::Unit::TestCase
 
-  def setup
-    Geocoder::Configuration.set_defaults
-  end
-
   def test_distance_to_returns_float
     v = Venue.new(*venue_params(:msg))
     v.latitude, v.longitude = [40.750354, -73.993371]

data/test/https_test.rb

@@ -3,10 +3,6 @@ require 'test_helper'
 
 class HttpsTest < Test::Unit::TestCase
 
-  def setup
-    Geocoder::Configuration.set_defaults
-  end
-
   def test_uses_https_for_secure_query
     Geocoder::Configuration.use_https = true
     g = Geocoder::Lookup::Google.new

data/test/lookup_test.rb

@@ -4,9 +4,9 @@ require 'test_helper'
 class LookupTest < Test::Unit::TestCase
 
   def test_search_returns_empty_array_when_no_results
-    street_lookups.each do |l|
-      Geocoder::Configuration.lookup = l
-      assert_equal [], Geocoder.search("no results"),
+    all_lookups.each do |l|
+      lookup = Geocoder.send(:get_lookup, l)
+      assert_equal [], lookup.send(:results, "no results"),
         "Lookup #{l} does not return empty array when no results."
     end
   end

data/test/method_aliases_test.rb

@@ -3,10 +3,6 @@ require 'test_helper'
 
 class MethodAliasesTest < Test::Unit::TestCase
 
-  def setup
-    Geocoder::Configuration.set_defaults
-  end
-
   def test_distance_from_is_alias_for_distance_to
     v = Venue.new(*venue_params(:msg))
     v.latitude, v.longitude = [40.750354, -73.993371]

data/test/mongoid_test.rb

@@ -7,10 +7,6 @@ require 'mongoid_test_helper'
 
 class MongoidTest < Test::Unit::TestCase
 
-  def setup
-    Geocoder::Configuration.set_defaults
-  end
-
   def test_geocoded_check
     p = Place.new(*venue_params(:msg))
     p.location = [40.750354, -73.993371]

data/test/mongoid_test_helper.rb

@@ -4,9 +4,9 @@ require 'test/unit'
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-Mongoid.configure do |config| 
+Mongoid.configure do |config|
   config.logger = Logger.new($stderr, :debug)
-end 
+end
 
 ##
 # Geocoded model.

data/test/proxy_test.rb

@@ -3,10 +3,6 @@ require 'test_helper'
 
 class ProxyTest < Test::Unit::TestCase
 
-  def setup
-    Geocoder::Configuration.set_defaults
-  end
-
   def test_uses_proxy_when_specified
     Geocoder::Configuration.http_proxy = 'localhost'
     lookup = Geocoder::Lookup::Google.new

data/test/services_test.rb

@@ -1,11 +1,7 @@
 # encoding: utf-8
 require 'test_helper'
 
-class ServicesTest < Test::Unit::TestCase 
-
-  def setup
-    Geocoder::Configuration.set_defaults
-  end
+class ServicesTest < Test::Unit::TestCase
 
 
   # --- Google ---
@@ -26,6 +22,28 @@ class ServicesTest < Test::Unit::TestCase
     assert_equal nil, result.city
   end
 
+  def test_google_precision
+    result = Geocoder.search("Madison Square Garden, New York, NY").first
+    assert_equal "ROOFTOP",
+      result.precision
+  end
+
+
+  # --- Google Premier ---
+
+  def test_google_premier_result_components
+    Geocoder::Configuration.lookup = :google_premier
+    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_google_premier_query_url
+    Geocoder::Configuration.api_key = ["deadbeef", "gme-test", "test-dev"]
+    assert_equal "http://maps.googleapis.com/maps/api/geocode/json?address=Madison+Square+Garden%2C+New+York%2C+NY&channel=test-dev&client=gme-test&language=en&sensor=false&signature=doJvJqX7YJzgV9rJ0DnVkTGZqTg=",
+      Geocoder::Lookup::GooglePremier.new.send(:query_url, "Madison Square Garden, New York, NY", false)
+  end
+
 
   # --- Yahoo ---
 

data/test/test_helper.rb

@@ -73,6 +73,9 @@ module Geocoder
       end
     end
 
+    class GooglePremier < Google
+    end
+
     class Yahoo < Base
       private #-----------------------------------------------------------------
       def fetch_raw_data(query, reverse = false)
@@ -122,7 +125,11 @@ module Geocoder
       def fetch_raw_data(query, reverse = false)
         raise TimeoutError if query == "timeout"
         raise SocketError if query == "socket_error"
-        read_fixture "freegeoip_74_200_247_59.json"
+        file = case query
+          when "no results";  :no_results
+          else                "74_200_247_59"
+        end
+        read_fixture "freegeoip_#{file}.json"
       end
     end
 
@@ -224,6 +231,12 @@ end
 
 
 class Test::Unit::TestCase
+
+  def teardown
+    Geocoder.send(:remove_const, :Configuration)
+    load "geocoder/configuration.rb"
+  end
+
   def venue_params(abbrev)
     {
       :msg => ["Madison Square Garden", "4 Penn Plaza, New York, NY"]

metadata

@@ -2,7 +2,7 @@
 name: geocoder
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Alex Reisner
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-25 00:00:00 -04:00
+date: 2011-09-17 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -40,6 +40,7 @@ files:
 - lib/geocoder/lookups/freegeoip.rb
 - lib/geocoder/lookups/geocoder_ca.rb
 - lib/geocoder/lookups/google.rb
+- lib/geocoder/lookups/google_premier.rb
 - lib/geocoder/lookups/yahoo.rb
 - lib/geocoder/lookups/yandex.rb
 - lib/geocoder/models/active_record.rb
@@ -54,6 +55,7 @@ files:
 - lib/geocoder/results/freegeoip.rb
 - lib/geocoder/results/geocoder_ca.rb
 - lib/geocoder/results/google.rb
+- lib/geocoder/results/google_premier.rb
 - lib/geocoder/results/yahoo.rb
 - lib/geocoder/results/yandex.rb
 - lib/geocoder/stores/active_record.rb
@@ -71,6 +73,7 @@ files:
 - test/fixtures/bing_no_results.json
 - test/fixtures/bing_reverse.json
 - test/fixtures/freegeoip_74_200_247_59.json
+- test/fixtures/freegeoip_no_results.json
 - test/fixtures/geocoder_ca_madison_square_garden.json
 - test/fixtures/geocoder_ca_no_results.json
 - test/fixtures/geocoder_ca_reverse.json