geocoder 1.0.0 → 1.0.1

data/CHANGELOG.rdoc

@@ -2,6 +2,12 @@
 
 Per-release changes to Geocoder.
 
+== 1.0.1 (2011 May 17)
+
+* Add option to not rescue from certain exceptions (thanks github.com/ahmedrb).
+* Fix STI child/parent geocoding bug (thanks github.com/ogennadi).
+* Other bugfixes.
+
 == 1.0.0 (2011 May 9)
 
 * Add command line interface.

data/README.rdoc

@@ -8,7 +8,7 @@ Geocoder is a complete geocoding solution for Ruby. With Rails it adds geocoding
 * Supports multiple Ruby versions: Ruby 1.8.7, 1.9.2, and JRuby.
 * Supports multiple databases: MySQL, PostgreSQL, SQLite, and MongoDB (1.7.0 and higher).
 * Supports Rails 3. If you need to use it with Rails 2 please see the <tt>rails2</tt> branch (no longer maintained, limited feature set).
-* Works very well outside of Rails but you'll need to install either the +json+ (for MRI) or +json_pure+ (for JRuby) gem.
+* Works very well outside of Rails, you just need to install either the +json+ (for MRI) or +json_pure+ (for JRuby) gem.
 
 
 == Install
@@ -446,6 +446,13 @@ Geocoder comes with a test suite (just run <tt>rake test</tt>) that mocks Active
 http://github.com/alexreisner/geocoder_test
 
 
+== Error Handling
+
+By default Geocoder will rescue any exceptions raised by calls to the geocoding service and return an empty array (using warn() to inform you of the error). You can override this and implement custom error handling for certain exceptions by using the <tt>:always_raise</tt> option:
+
+  Geocoder::Configuration.always_raise = [SocketError, TimeoutError]
+
+
 == Known Issue
 
 You cannot use the +near+ scope with another scope that provides an +includes+ option because the +SELECT+ clause generated by +near+ will overwrite it (or vice versa). Instead, try using +joins+ and pass a <tt>:select</tt> option to the +near+ scope to get the columns you want. For example:

data/Rakefile

@@ -12,14 +12,8 @@ task :default => :test
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "geocoder #{version}"
+  rdoc.title = "Geocoder #{Geocoder::VERSION}"
   rdoc.rdoc_files.include('*.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/geocoder/configuration.rb

@@ -28,7 +28,12 @@ module Geocoder
         [:cache, nil],
 
         # prefix (string) to use for all cache keys
-        [:cache_prefix, "geocoder:"]
+        [:cache_prefix, "geocoder:"],
+
+        # exceptions that should not be rescued by default
+        # (if you want to implement custom error handling);
+        # supports SocketError and TimeoutError
+        [:always_raise, []]
       ]
     end
 

data/lib/geocoder/lookups/base.rb

@@ -90,16 +90,24 @@ module Geocoder
         eval("Geocoder::Result::#{self.class.to_s.split(":").last}")
       end
 
+      ##
+      # Raise exception instead of warning for specified exceptions.
+      #
+      def raise_error(err)
+        raise err if Geocoder::Configuration.always_raise.include?(err.class)
+      end
+
+
       ##
       # Returns a parsed search result (Ruby hash).
       #
       def fetch_data(query, reverse = false)
         begin
           parse_raw_data fetch_raw_data(query, reverse)
-        rescue SocketError
-          warn "Geocoding API connection cannot be established."
-        rescue TimeoutError
-          warn "Geocoding API not responding fast enough " +
+        rescue SocketError => err
+          raise_error(err) or warn "Geocoding API connection cannot be established."
+        rescue TimeoutError => err
+          raise_error(err) or warn "Geocoding API not responding fast enough " +
             "(see Geocoder::Configuration.timeout to set limit)."
         end
       end

data/lib/geocoder/lookups/freegeoip.rb

@@ -10,7 +10,7 @@ module Geocoder::Lookup
       # don't look up a loopback address, just return the stored result
       return [reserved_result(query)] if loopback_address?(query)
       begin
-        return [fetch_data(query, reverse)]
+        return (doc = fetch_data(query, reverse)) ? [doc] : []
       rescue StandardError # Freegeoip.net returns HTML on bad request
         return []
       end

data/lib/geocoder/models/base.rb

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

data/lib/geocoder/results/google.rb

@@ -20,6 +20,7 @@ module Geocoder::Result
           return entity['long_name']
         end
       end
+      return nil # no appropriate components found
     end
 
     def state

data/lib/geocoder/version.rb

@@ -1,3 +1,3 @@
 module Geocoder
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/fixtures/google_no_city_data.json

@@ -0,0 +1,44 @@
+{
+  "status": "OK",
+  "results": [ {
+    "types": [ "postal_code" ],
+    "formatted_address": "55100, Turkey",
+    "address_components": [{
+      "long_name": "55100",
+      "short_name": "55100",
+      "types": ["postal_code"]
+     },
+     {
+      "long_name": "Turkey",
+      "short_name": "TR",
+      "types": ["country", "political"]
+     }],
+     "geometry": {
+        "location": {
+          "lat": 41.3112221,
+          "lng": 36.3322118
+        },
+        "location_type": "APPROXIMATE",
+        "viewport": {
+          "southwest": {
+              "lat": 41.2933411,
+              "lng": 36.3066331
+          },
+          "northeast": {
+              "lat": 41.3291031,
+              "lng": 36.3577906
+          }
+        },
+        "bounds": {
+          "southwest": {
+              "lat": 41.2933411,
+              "lng": 36.3066331
+          },
+          "northeast": {
+              "lat": 41.3291031,
+              "lng": 36.3577906
+          }
+        }
+      }
+  } ]
+}

data/test/geocoder_test.rb

@@ -357,6 +357,19 @@ class GeocoderTest < Test::Unit::TestCase
   end
 
 
+  def test_always_raise_timeout_error
+    Geocoder::Configuration.always_raise = [TimeoutError]
+    assert_raise(TimeoutError) { Geocoder.search("timeout") }
+    Geocoder::Configuration.always_raise = []
+  end
+
+
+  def test_always_raise_socket_error
+    Geocoder::Configuration.always_raise = [SocketError]
+    assert_raise(SocketError) { Geocoder.search("socket_error") }
+    Geocoder::Configuration.always_raise = []
+  end
+
   # --- Google ---
 
   def test_google_result_components
@@ -370,6 +383,10 @@ class GeocoderTest < Test::Unit::TestCase
     assert_equal "Haram", result.city
   end
 
+  def test_google_city_results_returns_nil_if_no_matching_component_types
+    result = Geocoder.search("no city data").first
+    assert_equal nil, result.city
+  end
 
   # --- Yahoo ---
 

data/test/test_helper.rb

@@ -62,10 +62,12 @@ module Geocoder
       private #-----------------------------------------------------------------
       def fetch_raw_data(query, reverse = false)
         raise TimeoutError if query == "timeout"
+        raise SocketError if query == "socket_error"
         file = case query
-          when "no results";  :no_results
-          when "no locality"; :no_locality
-          else                :madison_square_garden
+          when "no results";   :no_results
+          when "no locality";  :no_locality
+          when "no city data"; :no_city_data
+          else                 :madison_square_garden
         end
         read_fixture "google_#{file}.json"
       end
@@ -75,6 +77,7 @@ module Geocoder
       private #-----------------------------------------------------------------
       def fetch_raw_data(query, reverse = false)
         raise TimeoutError if query == "timeout"
+        raise SocketError if query == "socket_error"
         file = case query
           when "no results";  :no_results
           else                :madison_square_garden
@@ -87,6 +90,7 @@ module Geocoder
       private #-----------------------------------------------------------------
       def fetch_raw_data(query, reverse = false)
         raise TimeoutError if query == "timeout"
+        raise SocketError if query == "socket_error"
         file = case query
           when "no results";  :no_results
           when "invalid key"; :invalid_key
@@ -100,6 +104,7 @@ module Geocoder
       private #-----------------------------------------------------------------
       def fetch_raw_data(query, reverse = false)
         raise TimeoutError if query == "timeout"
+        raise SocketError if query == "socket_error"
         if reverse
           read_fixture "geocoder_ca_reverse.json"
         else
@@ -116,6 +121,7 @@ module Geocoder
       private #-----------------------------------------------------------------
       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"
       end
     end
@@ -124,6 +130,7 @@ module Geocoder
       private #-----------------------------------------------------------------
       def fetch_raw_data(query, reverse = false)
         raise TimeoutError if query == "timeout"
+        raise SocketError if query == "socket_error"
         if reverse
           read_fixture "bing_reverse.json"
         else

metadata

@@ -2,82 +2,83 @@
 name: geocoder
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
-  - Alex Reisner
+- Alex Reisner
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-05-09 00:00:00 -04:00
+date: 2011-05-17 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
 description: Provides object geocoding (by street or IP address), reverse geocoding (coordinates to street address), distance queries for ActiveRecord and Mongoid, result caching, and more. Designed for Rails but works with Sinatra and other Rack frameworks too.
 email: 
-  - alex@alexreisner.com
+- alex@alexreisner.com
 executables: 
-  - geocode
+- geocode
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
-  - .gitignore
-  - CHANGELOG.rdoc
-  - LICENSE
-  - README.rdoc
-  - Rakefile
-  - bin/geocode
-  - lib/geocoder.rb
-  - lib/geocoder/cache.rb
-  - lib/geocoder/calculations.rb
-  - lib/geocoder/cli.rb
-  - lib/geocoder/configuration.rb
-  - lib/geocoder/lookups/base.rb
-  - lib/geocoder/lookups/bing.rb
-  - lib/geocoder/lookups/freegeoip.rb
-  - lib/geocoder/lookups/geocoder_ca.rb
-  - lib/geocoder/lookups/google.rb
-  - lib/geocoder/lookups/yahoo.rb
-  - lib/geocoder/lookups/yandex.rb
-  - lib/geocoder/models/active_record.rb
-  - lib/geocoder/models/base.rb
-  - lib/geocoder/models/mongoid.rb
-  - lib/geocoder/railtie.rb
-  - lib/geocoder/request.rb
-  - lib/geocoder/results/base.rb
-  - lib/geocoder/results/bing.rb
-  - lib/geocoder/results/freegeoip.rb
-  - lib/geocoder/results/geocoder_ca.rb
-  - lib/geocoder/results/google.rb
-  - lib/geocoder/results/yahoo.rb
-  - lib/geocoder/results/yandex.rb
-  - lib/geocoder/stores/active_record.rb
-  - lib/geocoder/stores/base.rb
-  - lib/geocoder/stores/mongoid.rb
-  - lib/geocoder/version.rb
-  - lib/tasks/geocoder.rake
-  - test/fixtures/bing_madison_square_garden.json
-  - test/fixtures/bing_no_results.json
-  - test/fixtures/bing_reverse.json
-  - test/fixtures/freegeoip_74_200_247_59.json
-  - test/fixtures/geocoder_ca_madison_square_garden.json
-  - test/fixtures/geocoder_ca_no_results.json
-  - test/fixtures/geocoder_ca_reverse.json
-  - test/fixtures/google_garbage.json
-  - test/fixtures/google_madison_square_garden.json
-  - test/fixtures/google_no_locality.json
-  - test/fixtures/google_no_results.json
-  - test/fixtures/yahoo_garbage.json
-  - test/fixtures/yahoo_madison_square_garden.json
-  - test/fixtures/yahoo_no_results.json
-  - test/fixtures/yandex_invalid_key.json
-  - test/fixtures/yandex_kremlin.json
-  - test/fixtures/yandex_no_results.json
-  - test/geocoder_test.rb
-  - test/test_helper.rb
+- .gitignore
+- CHANGELOG.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- bin/geocode
+- lib/geocoder.rb
+- lib/geocoder/cache.rb
+- lib/geocoder/calculations.rb
+- lib/geocoder/cli.rb
+- lib/geocoder/configuration.rb
+- lib/geocoder/lookups/base.rb
+- lib/geocoder/lookups/bing.rb
+- lib/geocoder/lookups/freegeoip.rb
+- lib/geocoder/lookups/geocoder_ca.rb
+- lib/geocoder/lookups/google.rb
+- lib/geocoder/lookups/yahoo.rb
+- lib/geocoder/lookups/yandex.rb
+- lib/geocoder/models/active_record.rb
+- lib/geocoder/models/base.rb
+- lib/geocoder/models/mongoid.rb
+- lib/geocoder/railtie.rb
+- lib/geocoder/request.rb
+- lib/geocoder/results/base.rb
+- lib/geocoder/results/bing.rb
+- lib/geocoder/results/freegeoip.rb
+- lib/geocoder/results/geocoder_ca.rb
+- lib/geocoder/results/google.rb
+- lib/geocoder/results/yahoo.rb
+- lib/geocoder/results/yandex.rb
+- lib/geocoder/stores/active_record.rb
+- lib/geocoder/stores/base.rb
+- lib/geocoder/stores/mongoid.rb
+- lib/geocoder/version.rb
+- lib/tasks/geocoder.rake
+- test/fixtures/bing_madison_square_garden.json
+- test/fixtures/bing_no_results.json
+- test/fixtures/bing_reverse.json
+- test/fixtures/freegeoip_74_200_247_59.json
+- test/fixtures/geocoder_ca_madison_square_garden.json
+- test/fixtures/geocoder_ca_no_results.json
+- test/fixtures/geocoder_ca_reverse.json
+- test/fixtures/google_garbage.json
+- test/fixtures/google_madison_square_garden.json
+- test/fixtures/google_no_city_data.json
+- test/fixtures/google_no_locality.json
+- test/fixtures/google_no_results.json
+- test/fixtures/yahoo_garbage.json
+- test/fixtures/yahoo_madison_square_garden.json
+- test/fixtures/yahoo_no_results.json
+- test/fixtures/yandex_invalid_key.json
+- test/fixtures/yandex_kremlin.json
+- test/fixtures/yandex_no_results.json
+- test/geocoder_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://www.rubygeocoder.com
 licenses: []
@@ -86,19 +87,19 @@ post_install_message:
 rdoc_options: []
 
 require_paths: 
-  - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
 
 rubyforge_project: