geocoder 1.1.5 → 1.1.6

data/.travis.yml

@@ -2,6 +2,7 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - jruby-19mode
 gemfile:
   - Gemfile
   - gemfiles/Gemfile.mongoid-2.4.x
@@ -17,3 +18,6 @@ matrix:
     - rvm: 1.9.3
       gemfile: gemfiles/Gemfile.mongoid-2.4.x
       env: SSL_CERT_DIR=/etc/ssl/certs
+    - rvm: jruby-19mode
+      gemfile: gemfiles/Gemfile.mongoid-2.4.x
+      env: SSL_CERT_DIR=/etc/ssl/certs 

data/{CHANGELOG.rdoc → CHANGELOG.md}

@@ -1,8 +1,26 @@
-= Changelog
+Changelog
+=========
 
 Per-release changes to Geocoder.
 
-== 1.1.5 (2012 Nov 9)
+1.1.6 (2012 Dec 24)
+-------------------
+
+* Major changes to configuration syntax which allow for API-specific config options. Old config syntax is now DEPRECATED.
+* Add support for MaxMind API (thanks github.com/gonzoyumo).
+* Add optional Geocoder::InvalidApiKey exception for bad API credentials (Yahoo, Yandex, Bing, and Maxmind). Warn when bad key and exception not set in Geocoder.configure(:always_raise => [...]).
+* Add support for X-Real-IP and X-Forwarded-For headers (thanks github.com/konsti).
+* Add support for custom Nominatim host config: Geocoder.configure(:nominatim => {:host => "..."}).
+* Raise exception when required API key is missing or incorrect format.
+* Add support for Google's :region and :components parameters (thanks to github.com/tomlion).
+* Fix: string escaping bug in OAuth lib (thanks github.com/m0thman).
+* Fix: configured units were not always respected in SQL queries.
+* Fix: in #nearbys, don't try to exclude self if not yet persisted.
+* Fix: bug with cache stores that provided #delete but not #del.
+* Change #nearbys so that it returns nil instead of [] when object is not geocoded.
+
+1.1.5 (2012 Nov 9)
+------------------
 
 * Replace support for old Yahoo Placefinder with Yahoo BOSS (thanks github.com/pwoltman).
 * Add support for actual Mapquest API (was previously just a proxy for Nominatim), including the paid service (thanks github.com/jedschneider).
@@ -11,7 +29,8 @@ Per-release changes to Geocoder.
 * Speed up 'near' queries by adding bounding box condition (thanks github.com/mlandauer).
 * Fix: don't redefine Object#hash in Yahoo result object (thanks github.com/m0thman).
 
-== 1.1.4 (2012 Oct 2)
+1.1.4 (2012 Oct 2)
+------------------
 
 * Deprecate Geocoder::Result::Nominatim#class and #type methods. Use #place_class and #place_type instead.
 * Add support for setting arbitrary parameters in geocoding request URL.
@@ -23,7 +42,8 @@ Per-release changes to Geocoder.
 * Fix: :exclude option to .near scope when primary key != :id (thanks github.com/smisml).
 * Much code refactoring (added Geocoder::Query class and Geocoder::Sql module).
 
-== 1.1.3 (2012 Aug 26)
+1.1.3 (2012 Aug 26)
+-------------------
 
 * Add support for Mapquest geocoding service (thanks github.com/razorinc).
 * Add :test lookup for easy testing of apps using Geocoder (thanks github.com/mguterl).
@@ -36,7 +56,8 @@ Per-release changes to Geocoder.
 * Fix: bug in distance_from_sql method (error occurred when coordinates not found).
 * Fix: incompatibility with Mongoid 3.0.x (thanks github.com/petergoldstein).
 
-== 1.1.2 (2012 May 24)
+1.1.2 (2012 May 24)
+-------------------
 
 * Add ability to specify default units and distance calculation method (thanks github.com/abravalheri).
 * Add new (optional) configuration syntax (thanks github.com/abravalheri).
@@ -47,7 +68,8 @@ Per-release changes to Geocoder.
 * Fix: properly recognize IP addresses with ::ffff: prefix (thanks github.com/brian-ewell).
 * Fix: avoid exception during calculations when coordinates not known (thanks github.com/flori).
 
-== 1.1.1 (2012 Feb 16)
+1.1.1 (2012 Feb 16)
+-------------------
 
 * Add distance_from_sql class method to geocoded class (thanks github.com/dwilkie).
 * Add OverQueryLimitError and raise when relevant for Google lookup.
@@ -55,7 +77,8 @@ Per-release changes to Geocoder.
 * Fix: within_bounding_box now uses correct lat/lon DB columns (thanks github.com/kongo).
 * Fix: error accessing city in some cases with Yandex result (thanks github.com/kor6n and sld).
 
-== 1.1.0 (2011 Dec 3)
+1.1.0 (2011 Dec 3)
+------------------
 
 * A block passed to geocoded_by is now always executed, even if the geocoding service returns no results. This means you need to make sure you have results before trying to assign data to your object.
 * Fix issues with joins and row counts (issues #49, 86, and 108) by not using GROUP BY clause with ActiveRecord scopes.
@@ -67,17 +90,20 @@ Per-release changes to Geocoder.
 * Add support for API key to Geocoder.ca geocoding service (thanks github.com/ryanLonac).
 * Add support for state to Yandex results (thanks github.com/tipugin).
 
-== 1.0.5 (2011 Oct 26)
+1.0.5 (2011 Oct 26)
+-------------------
 
 * Fix error with `rake assets:precompile` (thanks github.com/Sush).
 * Fix HTTPS support (thanks github.com/rsanheim).
 * Improve cache interface.
 
-== 1.0.4 (2011 Sep 18)
+1.0.4 (2011 Sep 18)
+-------------------
 
 * Remove klass method from rake task, which could conflict with app methods (thanks github.com/mguterl).
 
-== 1.0.3 (2011 Sep 17)
+1.0.3 (2011 Sep 17)
+-------------------
 
 * Add support for Google Premier geocoding service (thanks github.com/steveh).
 * Update Google API URL (thanks github.com/soorajb).
@@ -85,19 +111,22 @@ Per-release changes to Geocoder.
 * Fix: rake assets:precompile (Rails 3.1) not working in some situations.
 * Fix: stop double-adjusting units when using kilometers (thanks github.com/hairyheron).
 
-== 1.0.2 (2011 June 25)
+1.0.2 (2011 June 25)
+--------------------
 
 * Add support for MongoMapper (thanks github.com/spagalloco).
 * Fix: user-specified coordinates field wasn't working with Mongoid (thanks github.com/thisduck).
 * Fix: invalid location given to near scope was returning all results (Active Record) or error (Mongoid) (thanks github.com/ogennadi).
 
-== 1.0.1 (2011 May 17)
+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)
+1.0.0 (2011 May 9)
+------------------
 
 * Add command line interface.
 * Add support for local proxy (thanks github.com/Olivier).
@@ -106,11 +135,13 @@ Per-release changes to Geocoder.
 * Fix single table inheritance bug (reported by github.com/enrico).
 * Fix bug when Google result supplies no city (thanks github.com/jkeen).
 
-== 0.9.13 (2011 Apr 11)
+0.9.13 (2011 Apr 11)
+--------------------
 
 * Fix "can't find special index: 2d" error when using Mongoid with Ruby 1.8.
 
-== 0.9.12 (2011 Apr 6)
+0.9.12 (2011 Apr 6)
+-------------------
 
 * Add support for Mongoid.
 * Add bearing_to/from methods to geocoded objects.
@@ -121,7 +152,8 @@ Per-release changes to Geocoder.
 * DEPRECATION: Geocoder.near should not take <tt>:limit</tt> or <tt>:offset</tt> options.
 * DEPRECATION: Change argument format of all methods that take lat/lon as separate arguments. Now you must pass the coordinates as an array [lat,lon], but you may alternatively pass a address string (will look up coordinates) or a geocoded object (or any object that implements a to_coordinates method which returns a [lat,lon] array).
 
-== 0.9.11 (2011 Mar 25)
+0.9.11 (2011 Mar 25)
+--------------------
 
 * Add support for result caching.
 * Add support for Geocoder.ca geocoding service.
@@ -131,12 +163,14 @@ Per-release changes to Geocoder.
 * DEPRECATION: <tt>Geocoder.search</tt> now returns an array instead of a single result.
 * DEPRECATION: <tt>obj.nearbys</tt> second argument is now an options hash (instead of units). Please change <tt>obj.nearbys(20, :km)</tt> to: <tt>obj.nearbys(20, :units => :km)</tt>.
 
-== 0.9.10 (2011 Mar 9)
+0.9.10 (2011 Mar 9)
+-------------------
 
 * Fix broken scopes (github.com/mikepinde).
 * Fix broken Ruby 1.9 and JRuby compatibility (don't require json gem).
 
-== 0.9.9 (2011 Mar 9)
+0.9.9 (2011 Mar 9)
+------------------
 
 * Add support for IP address geocoding via FreeGeoIp.net.
 * Add support for Yahoo PlaceFinder geocoding API.
@@ -151,7 +185,8 @@ Per-release changes to Geocoder.
 * DEPRECATION: <tt>fetch_address!</tt> has been superceded by +reverse_geocode+ (then save your object manually).
 * Fix: don't die when trying to get coordinates with a nil address (github.com/zmack).
 
-== 0.9.8 (2011 Feb 8)
+0.9.8 (2011 Feb 8)
+------------------
 
 * Include <tt>geocode:all</tt> Rake task in gem (was missing!).
 * Add <tt>Geocoder.search</tt> for access to Google's full response.
@@ -159,87 +194,105 @@ Per-release changes to Geocoder.
 * Emit warnings on Google connection problems and errors.
 * Refactor: insert Geocoder into ActiveRecord via Railtie.
 
-== 0.9.7 (2011 Feb 1)
+0.9.7 (2011 Feb 1)
+------------------
 
 * Add reverse geocoding (+reverse_geocoded_by+).
 * Prevent exception (uninitialized constant Geocoder::Net) when net/http not already required (github.com/sleepycat).
 * Refactor: split monolithic Geocoder module into several smaller ones.
 
-== 0.9.6 (2011 Jan 19)
+0.9.6 (2011 Jan 19)
+-------------------
 
 * Fix incompatibility with will_paginate gem.
 * Include table names in GROUP BY clause of nearby scope to avoid ambiguity in joins (github.com/matchu).
 
-== 0.9.5 (2010 Oct 15)
+0.9.5 (2010 Oct 15)
+-------------------
 
 * Fix broken PostgreSQL compatibility (now 100% compatible).
 * Switch from Google's XML to JSON geocoding API.
 * Separate Rails 2 and Rails 3-compatible branches.
 * Don't allow :conditions hash in 'options' argument to 'nearbys' method (was deprecated in 0.9.3).
 
-== 0.9.4 (2010 Aug 2)
+0.9.4 (2010 Aug 2)
+------------------
 
 * Google Maps API key no longer required (uses geocoder v3).
 
-== 0.9.3 (2010 Aug 2)
+0.9.3 (2010 Aug 2)
+------------------
 
 * Fix incompatibility with Rails 3 RC 1.
 * Deprecate 'options' argument to 'nearbys' method.
 * Allow inclusion of 'nearbys' in Arel method chains.
 
-== 0.9.2 (2010 Jun 3)
+0.9.2 (2010 Jun 3)
+------------------
 
 * Fix LIMIT clause bug in PostgreSQL (reported by github.com/kenzie).
 
-== 0.9.1 (2010 May 4)
+0.9.1 (2010 May 4)
+------------------
 
 * Use scope instead of named_scope in Rails 3.
 
-== 0.9.0 (2010 Apr 2)
+0.9.0 (2010 Apr 2)
+------------------
 
 * Fix bug in PostgreSQL support (caused "PGError: ERROR:  column "distance" does not exist"), reported by github.com/developish.
 
-== 0.8.9 (2010 Feb 11)
+0.8.9 (2010 Feb 11)
+-------------------
 
 * Add Rails 3 compatibility.
 * Avoid querying Google when query would be an empty string.
 
-== 0.8.8 (2009 Dec 7)
+0.8.8 (2009 Dec 7)
+------------------
 
 * Automatically select a less accurate but compatible distance algorithm when SQLite database detected (fixes SQLite incompatibility).
 
-== 0.8.7 (2009 Nov 4)
+0.8.7 (2009 Nov 4)
+------------------
 
 * Added Geocoder.geographic_center method.
 * Replaced _get_coordinates class method with read_coordinates instance method.
 
-== 0.8.6 (2009 Oct 27)
+0.8.6 (2009 Oct 27)
+-------------------
 
 * The fetch_coordinates method now assigns coordinates to attributes (behaves like fetch_coordinates! used to) and fetch_coordinates! both assigns and saves the attributes.
 * Added geocode:all rake task.
 
-== 0.8.5 (2009 Oct 26)
+0.8.5 (2009 Oct 26)
+-------------------
 
 * Avoid calling deprecated method from within Geocoder itself.
 
-== 0.8.4 (2009 Oct 23)
+0.8.4 (2009 Oct 23)
+-------------------
 
 * Deprecate <tt>find_near</tt> class method in favor of +near+ named scope.
 
-== 0.8.3 (2009 Oct 23)
+0.8.3 (2009 Oct 23)
+-------------------
 
 * Update Google URL query string parameter to reflect recent changes in Google's API.
 
-== 0.8.2 (2009 Oct 12)
+0.8.2 (2009 Oct 12)
+-------------------
 
 * Allow a model's geocoder search string method to be something other than an ActiveRecord attribute.
 * Clean up documentation.
 
-== 0.8.1 (2009 Oct 8)
+0.8.1 (2009 Oct 8)
+------------------
 
 * Extract XML-fetching code from <tt>Geocoder.search</tt> and place in Geocoder._fetch_xml (for ease of mocking).
 * Add tests for coordinate-fetching instance methods.
 
-== 0.8.0 (2009 Oct 1)
+0.8.0 (2009 Oct 1)
+------------------
 
 First release.

data/README.md

@@ -7,18 +7,20 @@ Geocoder is a complete geocoding solution for Ruby. With Rails it adds geocoding
 Compatibility
 -------------
 
-* Supports multiple Ruby versions: Ruby 1.8.7, 1.9.2, and JRuby.
+* Supports multiple Ruby versions: Ruby 1.8.7, 1.9.2, 1.9.3, 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 `rails2` branch (no longer maintained, limited feature set).
+* Supports Rails 3.x. If you need to use it with Rails 2 please see the `rails2` branch (no longer maintained, limited feature set).
 * Works very well outside of Rails, you just need to install either the `json` (for MRI) or `json_pure` (for JRuby) gem.
 
 
-Install
--------
+Installation
+------------
+
+Install Geocoder like any other Ruby gem:
 
-### As a Gem
+    gem install geocoder
 
-Add to your Gemfile:
+Or, if you're using Rails/Bundler, add this to your Gemfile:
 
     gem "geocoder"
 
@@ -26,21 +28,13 @@ and run at the command prompt:
 
     bundle install
 
-### Or As a Plugin
-
-At the command prompt:
-
-    rails plugin install git://github.com/alexreisner/geocoder.git
-
 
-Configure Object Geocoding
---------------------------
-
-In the below, note that addresses may be street or IP addresses.
+Object Geocoding
+----------------
 
 ### ActiveRecord
 
-Your model must have two attributes (database columns) for storing latitude and longitude coordinates. By default they should be called `latitude` and `longitude` but this can be changed (see "More on Configuration" below):
+Your model must have two attributes (database columns) for storing latitude and longitude coordinates. By default they should be called `latitude` and `longitude` but this can be changed (see "Model Configuration" below):
 
     rails generate migration AddLatitudeAndLongitudeToModel latitude:float longitude:float
     rake db:migrate
@@ -81,6 +75,10 @@ Reverse geocoding is similar:
     reverse_geocoded_by :coordinates
     after_validation :reverse_geocode  # auto-fetch address
 
+Once you've set up your model you'll need to create the necessary spatial indices in your database:
+
+    rake db:mongoid:create_indexes
+
 Be sure to read _Latitude/Longitude Order_ in the _Notes on MongoDB_ section below on how to properly retrieve latitude/longitude coordinates from your objects.
 
 ### MongoMapper
@@ -126,9 +124,11 @@ To find objects by location, use the following scopes:
 
 With geocoded objects you can do things like this:
 
-    obj.nearbys(30)                      # other objects within 30 miles
-    obj.distance_from([40.714,-100.234]) # distance from arbitrary point to object
-    obj.bearing_to("Paris, France")      # direction from object to arbitrary point
+    if obj.geocoded?
+      obj.nearbys(30)                      # other objects within 30 miles
+      obj.distance_from([40.714,-100.234]) # distance from arbitrary point to object
+      obj.bearing_to("Paris, France")      # direction from object to arbitrary point
+    end
 
 Some utility methods are also available:
 
@@ -181,8 +181,8 @@ To calculate accurate distance and bearing with SQLite or MongoDB:
 The `bearing_from/to` methods take a single argument which can be: a `[lat,lon]` array, a geocoded object, or a geocodable address (string). The `distance_from/to` methods also take a units argument (`:mi` or `:km`).
 
 
-More on Configuration
----------------------
+Model Configuration
+-------------------
 
 You are not stuck with using the `latitude` and `longitude` database column names (with ActiveRecord) or the `coordinates` array (Mongo) for storing coordinates. For example:
 
@@ -257,32 +257,37 @@ If you're familiar with the results returned by the geocoding service you're usi
 Geocoding Services
 ------------------
 
-By default Geocoder uses Google's geocoding API to fetch coordinates and street addresses (FreeGeoIP is used for IP address info). However there are several other APIs supported, as well as a variety of settings. Please see the listing and comparison below for details on specific geocoding services (not all settings are supported by all services). Some common configuration options are:
+By default Geocoder uses Google's geocoding API to fetch coordinates and street addresses (FreeGeoIP is the default for IP address info). However there are several other APIs supported, as well as a variety of settings. Please see the listing and comparison below for details on specific geocoding services (not all settings are supported by all services). Some common configuration options are:
 
     # config/initializers/geocoder.rb
-    Geocoder.configure do |config|
+    Geocoder.configure(
 
       # geocoding service (see below for supported options):
-      config.lookup = :yandex
+      :lookup => :yandex,
 
       # to use an API key:
-      config.api_key = "..."
+      :api_key => "...",
 
       # geocoding service request timeout, in seconds (default 3):
-      config.timeout = 5
+      :timeout => 5,
 
       # set default units to kilometers:
-      config.units = :km
+      :units => :km,
 
       # caching (see below for details):
-      config.cache = Redis.new
-      config.cache_prefix = "..."
+      :cache => Redis.new,
+      :cache_prefix => "..."
 
-    end
+    )
+
+Please see lib/geocoder/configuration.rb for a complete list of configuration options. Additionally, some lookups have their own configuration options, some of which are directly supported by Geocoder. For example, to specify a value for Google's `bounds` parameter:
+
+    # with Google:
+    Geocoder.search("Paris", :bounds => [[32.1,-95.9], [33.9,-94.3]])
 
-Please see lib/geocoder/configuration.rb for a complete list of configuration options. Additionally, some lookups have their own configuration options which are listed in the comparison chart below, and as of version 1.2.0 you can pass arbitrary parameters to any geocoding service. For example, to use Nominatim's `countrycodes` parameter:
+Please see the [source code for each lookup](https://github.com/alexreisner/geocoder/tree/master/lib/geocoder/lookups) to learn about directly supported parameters. Parameters which are not directly supported can be specified using the `:params` option, by which you can pass arbitrary parameters to any geocoding service. For example, to use Nominatim's `countrycodes` parameter:
 
-    Geocoder::Configuration.lookup = :nominatim
+    # with Nominatim:
     Geocoder.search("Paris", :params => {:countrycodes => "gb,de,fr,es,us"})
 
 
@@ -302,13 +307,13 @@ The following is a comparison of the supported geocoding APIs. The "Limitations"
 * **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 `Geocoder::Configuration.lookup = :google_premier` and `Geocoder::Configuration.api_key = [key, client, channel]`.
+* **Notes**: To use Google Premier set `Geocoder.configure(:lookup => :google_premier, :api_key => [key, client, channel])`.
 
 #### Yahoo BOSS (`:yahoo`)
 
 Yahoo BOSS is **not a free service**. As of November 17, 2012 Yahoo no longer offers a free geocoding API.
 
-* **API key**: requires OAuth consumer key and secret (set `Geocoder::Configuration.api_key = [key, secret]`)
+* **API key**: requires OAuth consumer key and secret (set `Geocoder.configure(:api_key => [key, secret])`)
 * **Key signup**: http://developer.yahoo.com/boss/geo/
 * **Quota**: unlimited, but subject to usage fees
 * **Region**: world
@@ -368,7 +373,7 @@ Yahoo BOSS is **not a free service**. As of November 17, 2012 Yahoo no longer of
 * **API key**: required for the licensed API, do not use for open tier
 * **Quota**: ?
 * **HTTP Headers**: in order to use the licensed API you can configure the http_headers to include a referer as so:
-    `Geocoder::Configuration.http_headers = { "Referer" => "http://foo.com" }`
+    `Geocoder.configure(:http_headers => { "Referer" => "http://foo.com" })`
   You can also allow a blank referer from the API management console via mapquest but it is potentially a security risk that someone else could use your API key from another domain.
 * **Region**: world
 * **SSL support**: no
@@ -388,13 +393,24 @@ Yahoo BOSS is **not a free service**. As of November 17, 2012 Yahoo no longer of
 * **Terms of Service**: ?
 * **Limitations**: ?
 
+#### MaxMind Web Services (`:maxmind`)
+
+* **API key**: required
+* **Quota**: Request Packs can be purchased
+* **Region**: world
+* **SSL support**: yes
+* **Languages**: English
+* **Documentation**: http://www.maxmind.com/app/web_services
+* **Terms of Service**: ?
+* **Limitations**: ?
+
 
 Caching
 -------
 
 It's a good idea, when relying on any external service, to cache retrieved data. When implemented correctly it improves your app's response time and stability. It's easy to cache geocoding results with Geocoder, just configure a cache store:
 
-    Geocoder::Configuration.cache = Redis.new
+    Geocoder.configure(:cache => Redis.new)
 
 This example uses Redis, but the cache store can be any object that supports these methods:
 
@@ -407,7 +423,7 @@ Even a plain Ruby hash will work, though it's not a great choice (cleared out wh
 
 You can also set a custom prefix to be used for cache keys:
 
-    Geocoder::Configuration.cache_prefix = "..."
+    Geocoder.configure(:cache_prefix => "...")
 
 By default the prefix is `geocoder:`
 
@@ -463,7 +479,7 @@ You can use Geocoder outside of Rails by calling the `Geocoder.search` method:
 
     results = Geocoder.search("McCarren Park, Brooklyn, NY")
 
-This returns an array of `Geocoder::Result` objects with all information provided by the geocoding service. Please see above and in the code for details.
+This returns an array of `Geocoder::Result` objects with all data provided by the geocoding service.
 
 
 Testing Apps that Use Geocoder
@@ -471,7 +487,7 @@ Testing Apps that Use Geocoder
 
 When writing tests for an app that uses Geocoder it may be useful to avoid network calls and have Geocoder return consistent, configurable results. To do this, configure and use the `:test` lookup. For example:
 
-    Geocoder::Configuration.lookup = :test
+    Geocoder.configure(:lookup => :test)
 
     Geocoder::Lookup::Test.add_stub(
       "New York, NY", [
@@ -507,7 +523,6 @@ When you install the Geocoder gem it adds a `geocode` command to your shell. You
 
 There are also a number of options for setting the geocoding API, key, and language, viewing the raw JSON reponse, and more. Please run `geocode -h` for details.
 
-
 Notes on MongoDB
 ----------------
 
@@ -529,6 +544,13 @@ Calling `obj.coordinates` directly returns the internal representation of the co
 
 For consistency with the rest of Geocoder, always use the `to_coordinates` method instead.
 
+Notes on Non-Rails Frameworks
+-----------------------------
+
+If you are using Geocoder with ActiveRecord and a framework other than Rails (like Sinatra or Padrino) you will need to add this in your model before calling Geocoder methods:
+
+    extend Geocoder::Model::ActiveRecord 
+
 Optimisation of Distance Queries
 --------------------------------
 
@@ -569,15 +591,44 @@ 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 `:always_raise` option:
+By default Geocoder will rescue any exceptions raised by calls to a geocoding service and return an empty array (using warn() to inform you of the error). You can override this on a per-exception basis, and also have Geocoder raise its own exceptions for certain events (eg: API quota exceeded) by using the `:always_raise` option:
 
-    Geocoder::Configuration.always_raise = [SocketError, TimeoutError]
+    Geocoder.configure(:always_raise => [SocketError, TimeoutError])
 
 You can also do this to raise all exceptions:
 
-    Geocoder::Configuration.always_raise = :all
+    Geocoder.configure(:always_raise => :all)
+
+The raise-able exceptions are:
+
+    SocketError
+    TimeoutError
+    Geocoder::OverQueryLimitError
+    Geocoder::RequestDenied
+    Geocoder::InvalidRequest
+    Geocoder::InvalidApiKey
+
+Note that not all lookups support all exceptions.
+
+
+Troubleshooting
+---------------
+
+### Mongoid
+
+If you get one of these errors:
+
+    uninitialized constant Geocoder::Model::Mongoid
+    uninitialized constant Geocoder::Model::Mongoid::Mongo
+
+you should check your Gemfile to make sure the Mongoid gem is listed _before_ Geocoder. If Mongoid isn't loaded when Geocoder is initialized, Geocoder will not load support for Mongoid.
+
+### ActiveRecord
+
+A lot of debugging time can be saved by understanding how Geocoder works with ActiveRecord. When you use the `near` scope or the `nearbys` method of a geocoded object, Geocoder creates an ActiveModel::Relation object which adds some attributes (eg: distance, bearing) to the SELECT clause. It also adds a condition to the WHERE clause to check that distance is within the given radius. Because the SELECT clause is modified, anything else that modifies the SELECT clause may produce strange results, for example:
 
-See `lib/geocoder/exceptions.rb` for a list of raise-able exceptions.
+* using the `pluck` method (selects only a single column)
+* specifying another model through `includes` (selects columns from other tables)
 
 
 Known Issue