Geocoder is a complete geocoding solution for Ruby. With Rails it adds geocoding (by street or IP address), reverse geocoding (find street address based on given coordinates), and distance calculations for ActiveRecord objects. It's as simple as calling geocode on your objects, and then using a scope like Venue.near("Billings, MT"). Since it does not rely on proprietary database functions finding geocoded objects in a given area works with out-of-the-box PostgreSQL, MySQL, and even SQLite.
Geocoder has been successfully tested with Ruby (MRI) 1.8.7, 1.9.2, and JRuby 1.5.3.
Geocoder is compatible with Rails 3. If you need to use it with Rails 2 please see the rails2 branch (no longer maintained, limited feature set).
Geocoder also works outside of Rails but you'll need to install either the json (for MRI) or json_pure (for JRuby) gem.
As a Gem
Add to your Gemfile:
and run at the command prompt:
Or As a Plugin
At the command prompt:
rails plugin install git://github.com/alexreisner/geocoder.git
Configure Object Geocoding
ActiveRecord: Your object 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):
rails generate migration AddLatitudeAndLongitudeToModel latitude:float longitude:float rake db:migrate
For reverse geocoding your model must provide a method that returns an address. This can be a single attribute, but it can also be a method that returns a string assembled from different attributes (eg: city, state, and country).
Mongoid: Define your address and coordinate fields right in the model. You also need to include the Geocoder::Model::Mongoid module before calling geocoded_by:
field :address field :latitude, :type => Float field :longitude, :type => Float include Geocoder::Model::Mongoid geocoded_by :address
In your model, tell Geocoder which method returns your object's full address:
geocoded_by :full_street_address # can also be an IP address after_validation :geocode # auto-fetch coordinates
For reverse geocoding, tell Geocoder which methods return latitude and longitude:
reverse_geocoded_by :lat, :lon after_validation :reverse_geocode # auto-fetch address
If you have just added geocoding to a class and have a lot of existing objects you can use this Rake task to geocode them all:
rake geocode:all CLASS=YourModel
Location-Aware Database Queries
To find objects by location, use the following scopes:
Venue.near('Omaha, NE, US', 20) # venues within 20 miles of Omaha Venue.near([40.71, 100.23], 20) # venues within 20 miles of a point Venue.geocoded # venues with coordinates Venue.not_geocoded # venues without coordinates
With geocoded objects you can do things like this:
obj.nearbys(30) # other objects within 30 miles obj.distance_to(40.714, -100.234) # distance from object to arbitrary point
Some utility methods are also available:
# look up coordinates of some location (like searching Google Maps) Geocoder.coordinates("25 Main St, Cooperstown, NY") => [42.700149, -74.922767] # distance (in miles) between Eiffel Tower and Empire State Building Geocoder::Calculations.distance_between( 47.858205,2.294359, 40.748433,-73.985655 ) => 3619.77359999382 # find the geographic center (aka center of gravity) of objects or points Geocoder::Calculations.geographic_center([ city1, city2, [40.22,-73.99], city4 ]) => [35.14968, -90.048929]
Please see the code for more methods and detailed information about arguments (eg, working with kilometers).
Distance and Bearing
When you run a location-aware query the returned objects have two attributes added to them:
obj.distance - number of miles from the search point to this object
obj.bearing - direction from the search point to this object
The bearing is given as a number (between 0 and 360): clockwise degrees from due north. Some examples:
0 - due north
180 - due south
90 - due east
270 - due west
230.1 - southwest
359.9 - almost due north
You can convert these numbers to compass point names by using the utility method provided:
Geocoder::Calculations.compass_point(355) # => "N" Geocoder::Calculations.compass_point(45) # => "NE" Geocoder::Calculations.compass_point(208) # => "SW"
Note: when using SQLite distance and bearing values are provided for interface consistency only. They are not accurate.
More on Configuration
You are not stuck with using the latitude and longitude database column names for storing coordinates. For example, to use lat and lon:
geocoded_by :address, :latitude => :lat, :longitude => :lon
The address method can return any string you'd use to search Google Maps. For example, any of the following are acceptable:
“714 Green St, Big Town, MO”
“Eiffel Tower, Paris, FR”
“Paris, TX, US”
If your model has street, city, state, and country attributes you might do something like this:
geocoded_by :address def address [street, city, state, country].compact.join(', ') end
For reverse geocoding you can also specify an alternate name attribute where the address will be stored, for example:
reverse_geocoded_by :lat, :lon, :address => :location
So far we have looked at shortcuts for assigning geocoding results to object attributes. However, if you need to do something fancy you can skip the auto-assignment by providing a block (takes the object to be geocoded and a Geocoder::Result object) in which you handle the parsed geocoding result any way you like, for example:
reverse_geocoded_by :lat, :lon do |obj,geo| obj.city = geo.city obj.zipcode = geo.postal_code obj.country = geo.country_code end after_validation :reverse_geocode
Every Geocoder::Result object, result, provides the following data:
result.latitude - float
result.longitude - float
result.coordinates - array of the above two
result.address - string
result.city - string
result.postal_code - string
result.country_name - string
result.country_code - string
and if you're familiar with the results returned by the geocoding service you're using, you can access even more (see code comments for details: lib/geocoder/results/*).
By default Geocoder uses Google's geocoding API to fetch coordinates and addresses. However if you wish to use Yahoo's geocoding API you can simply add this to an initializer:
# config/initializers/geocoder.rb Geocoder::Configuration.lookup = :yahoo
Street address geocoding services currently supported (valid settings for the above):
Geocoder.ca: :geocoder_ca (US and Canada only)
Note that the result objects returned by different geocoding services all implement the methods listed above. Beyond that, however, you must be familiar with your particular subclass of Geocoder::Result and the geocoding service's result structure:
To use your Google API key or Yahoo app ID:
Geocoder::Configuration.api_key = "..."
To obtain an API key (not required):
You can set the timeout used for connections to the geocoding service. The default is 3 seconds but if you want to set it to 5, for example, put the following in an initializer:
Geocoder::Configuration.timeout = 5
You can set the language used for reverse geocoding results to German, for example, by setting the following:
Geocoder::Configuration.language = :de
For a list of supported languages see the documentation for the geocoding service you're using.
If you want to use HTTPS for geocoding service connections:
Geocoder::Configuration.use_https = true
Note that currently the only service that supports HTTPS is Google.
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
This example uses Redis, but the cache store can be any object that supports these methods:
store#(key) - retrieves a value
store#=(key, value) - stores a value
store#keys - lists all keys
Even a plain Ruby hash will work, though it's not a great choice (cleared out when app is restarted, not shared between app instances, etc).
You can also set a custom prefix to be used for cache keys:
Geocoder::Configuration.cache_prefix = "..."
By default the prefix is geocoder:
If you need to expire cached content:
Geocoder.cache.expire("http://...") # expire cached result for a URL Geocoder.cache.expire(:all) # expire all cached results
Do not include the prefix when passing a URL to be expired. Expiring :all will only expire keys with the configured prefix (won't kill every entry in your key/value store).
Forward and Reverse Geocoding in the Same Model
If you apply both forward and reverse geocoding functionality to the same model (say users can supply an address or coordinates and you want to fill in whatever's missing), you will provide two address methods:
one for storing the fetched address (reverse geocoding)
one for providing an address to use when fetching coordinates (forward geocoding)
class Venue # build an address from street, city, and state attributes geocoded_by :address_from_components # store the fetched address in the full_address attribute reverse_geocoded_by :latitude, :longitude, :address => :full_address end
However, there can be only one set of latitude/longitude attributes, and whichever you specify last will be used. For example:
class Venue geocoded_by :address, :latitude => :fetched_latitude, # this will be overridden by the below :longitude => :fetched_longitude # same here reverse_geocoded_by :latitude, :longitude end
The reason for this is that we don't want ambiguity when doing distance calculations. We need a single, authoritative source for coordinates!
Request Geocoding by IP Address
Geocoder adds a location method to the standard Rack::Request object so you can easily look up the location of any HTTP request by IP address. For example, in a Rails controller or a Sinatra app:
# returns Geocoder::Result object result = request.location
Use Outside of Rails
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.
Distance Queries in SQLite
SQLite's lack of trigonometric functions requires an alternate implementation of the near scope. When using SQLite, Geocoder will automatically use a less accurate algorithm for finding objects near a given point. Results of this algorithm should not be trusted too much as it will return objects that are outside the given radius, along with inaccurate distance and bearing calculations.
There are few options for finding objects near a given point in SQLite without installing extensions:
Use a square instead of a circle for finding nearby points. For example, if you want to find points near 40.71, 100.23, search for objects with latitude between 39.71 and 41.71 and longitude between 99.23 and 101.23. One degree of latitude or longitude is at most 69 miles so divide your radius (in miles) by 69.0 to get the amount to add and subtract from your center coordinates to get the upper and lower bounds. The results will not be very accurate (you'll get points outside the desired radius), but you will get all the points within the required radius.
Load all objects into memory and compute distances between them using the Geocoder::Calculations.distance_between method. This will produce accurate results but will be very slow (and use a lot of memory) if you have a lot of objects in your database.
If you have a large number of objects (so you can't use approach #2) and you need accurate results (better than approach #1 will give), you can use a combination of the two. Get all the objects within a square around your center point, and then eliminate the ones that are too far away using Geocoder::Calculations.distance_between.
Because Geocoder needs to provide this functionality as a scope, we must go with option #1, but feel free to implement #2 or #3 if you need more accuracy.
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 :select option to the near scope to get the columns you want. For example, in Rails 2 syntax:
# instead of :includes => :venues: City.near("Omaha, NE", 20, :select => "venues.*").all(:joins => :venues)
If anyone has a more elegant solution to this problem I am very interested in seeing it.
add support for more ORMs (Mongoid, DataMapper)
add support for more geocoding services
maintain the same simple interface
Copyright © 2009-11 Alex Reisner, released under the MIT license