README.md in geocoder-1.4.9 vs README.md in geocoder-1.5.0

- old
+ new

@@ -1,1075 +1,513 @@ Geocoder ======== -Geocoder is a complete geocoding solution for Ruby. With Rails, it adds geocoding (by street or IP address), reverse geocoding (finding street address based on given coordinates), and distance queries. It's as simple as calling `geocode` on your objects, and then using a scope like `Venue.near("Billings, MT")`. +**A complete geocoding solution for Ruby.** -_Please note that this README is for the current `HEAD` and may document features not present in the latest gem release. For this reason, you may want to instead view the README for your [particular version](https://github.com/alexreisner/geocoder/releases)._ +[![Gem Version](https://badge.fury.io/rb/geocoder.svg)](http://badge.fury.io/rb/geocoder) +[![Code Climate](https://codeclimate.com/github/alexreisner/geocoder/badges/gpa.svg)](https://codeclimate.com/github/alexreisner/geocoder) +[![Build Status](https://travis-ci.org/alexreisner/geocoder.svg?branch=master)](https://travis-ci.org/alexreisner/geocoder) +[![GitHub Issues](https://img.shields.io/github/issues/alexreisner/geocoder.svg)](https://github.com/alexreisner/geocoder/issues) +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) +Key features: -Compatibility -------------- +* Forward and reverse geocoding, and IP address geocoding. +* Connects to more than 40 APIs worldwide. +* Performance-enhancing feaures like caching. +* Advanced configuration allows different parameters and APIs to be used in different conditions. +* Integrates with ActiveRecord and Mongoid. +* Basic geospatial queries: search within radius (or rectangle, or ring). -* Supports multiple Ruby versions: Ruby 1.9.3, 2.x, and JRuby. +Compatibility: + +* Supports multiple Ruby versions: Ruby 2.x, and JRuby. * Supports multiple databases: MySQL, PostgreSQL, SQLite, and MongoDB (1.7.0 and higher). * Supports Rails 3, 4, and 5. 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. -Note on Rails 4.1 and Greater ------------------------------ +Table of Contents +----------------- -Due to [a change in ActiveRecord's `count` method](https://github.com/rails/rails/pull/10710) you will need to use `count(:all)` to explicitly count all columns ("*") when using a `near` scope. Using `near` and calling `count` with no argument will cause exceptions in many cases. +Basic Features: +* [Basic Search](#basic-search) +* [Geocoding Objects](#geocoding-objects) +* [Geospatial Database Queries](#geospatial-database-queries) +* [Geocoding HTTP Requests](#geocoding-http-requests) +* [Geocoding Service ("Lookup") Configuration](#geocoding-service-lookup-configuration) -Installation ------------- +Advanced Features: -Install Geocoder like any other Ruby gem: +* [Performance and Optimization](#performance-and-optimization) +* [Advanced Model Configuration](#advanced-model-configuration) +* [Advanced Database Queries](#advanced-database-queries) +* [Geospatial Calculations](#geospatial-calculations) +* [Batch Geocoding](#batch-geocoding) +* [Testing](#testing) +* [Error Handling](#error-handing) +* [Command Line Interface](#command-line-interface) - gem install geocoder +The Rest: -Or, if you're using Rails/Bundler, add this to your Gemfile: +* [Technical Discussions](#technical-discussions) +* [Troubleshooting](#troubleshooting) +* [Known Issues](#known-issues) +* [Reporting Issues](#reporting-issues) +* [Contributing](#contributing) - gem 'geocoder' +See Also: -and run at the command prompt: +* [Guide to Geocoding APIs](https://github.com/alexreisner/geocoder/blob/master/README_API_GUIDE.md) (formerly part of this README) - bundle install +Basic Search +------------ -Object Geocoding ----------------- +In its simplest form, Geocoder takes an address and searches for its latitude/longitude coordinates: -### ActiveRecord + results = Geocoder.search("Paris") + results.first.coordinates + => [48.856614, 2.3522219] # latitude and longitude -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): +The reverse is possible too. Given coordinates, it finds an address: - rails generate migration AddLatitudeAndLongitudeToModel latitude:float longitude:float - rake db:migrate + results = Geocoder.search([48.856614, 2.3522219]) + results.first.address + => "Hôtel de Ville, 75004 Paris, France" -For 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`). +You can also look up the location of an IP addresses: -Next, your model must tell Geocoder which method returns your object's geocodable address: + results = Geocoder.search("172.56.21.89") + results.first.coordinates + => [30.267153, -97.7430608] + results.first.country + => "United States" - geocoded_by :full_street_address # can also be an IP address - after_validation :geocode # auto-fetch coordinates +**The success and accuracy of geocoding depends entirely on the API being used to do these lookups.** Most queries work fairly well with the default configuration, but every application has different needs and every API has its particular strengths and weaknesses. If you need better coverage for your application you'll want to get familiar with the large number of supported APIs, listed in the [API Guide](https://github.com/alexreisner/geocoder/blob/master/README_API_GUIDE.md). -For reverse geocoding, tell Geocoder which attributes store latitude and longitude: - reverse_geocoded_by :latitude, :longitude - after_validation :reverse_geocode # auto-fetch address +Geocoding Objects +----------------- -### Mongoid +To automatically geocode your objects: -First, your model must have an array field for storing coordinates: +**1.** Your model must provide a method that returns an address to geocode. 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`). For example, if your model has `street`, `city`, `state`, and `country` attributes you might do something like this: - field :coordinates, :type => Array + def address + [street, city, state, country].compact.join(', ') + end -You may also want an address field, like this: +**2.** Your model must have a way to store latitude/longitude coordinates. With ActiveRecord, add two attributes/columns (of type float or decimal) called `latitude` and `longitude`. For MongoDB, use a single field (of type Array) called `coordinates` (i.e., `field :coordinates, type: Array`). (See [Advanced Model Configuration](#advanced-model-configuration) for using different attribute names.) - field :address +**3.** In your model, tell geocoder where to find the object's address: -but if you store address components (city, state, country, etc) in separate fields you can instead define a method called `address` that combines them into a single string which will be used to query the geocoding service. + geocoded_by :address -Once your fields are defined, include the `Geocoder::Model::Mongoid` module and then call `geocoded_by`: +This adds a `geocode` method which you can invoke via callback: - include Geocoder::Model::Mongoid - geocoded_by :address # can also be an IP address - after_validation :geocode # auto-fetch coordinates + after_validation :geocode -Reverse geocoding is similar: +Reverse geocoding (given lat/lon coordinates, find an address) is similar: - include Geocoder::Model::Mongoid - reverse_geocoded_by :coordinates - after_validation :reverse_geocode # auto-fetch address + reverse_geocoded_by :latitude, :longitude + after_validation :reverse_geocode -Once you've set up your model you'll need to create the necessary spatial indices in your database: +With any geocoded objects, you can do the following: - rake db:mongoid:create_indexes + obj.distance_to([43.9,-98.6]) # distance from obj to point + obj.bearing_to([43.9,-98.6]) # bearing from obj to point + obj.bearing_from(obj2) # bearing from obj2 to obj -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. +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`, `:km`, or `:nm` for nautical miles). See [Distance and Bearing](#distance-and-bearing) below for more info. -### MongoMapper +### One More Thing for MongoDB! -MongoMapper is very similar to Mongoid, just be sure to include `Geocoder::Model::MongoMapper`. +Before you can call `geocoded_by` you'll need to include the necessary module using one of the following: -### Mongo Indices - -By default, the methods `geocoded_by` and `reverse_geocoded_by` create a geospatial index. You can avoid index creation with the `:skip_index option`, for example: - include Geocoder::Model::Mongoid - geocoded_by :address, :skip_index => true + include Geocoder::Model::MongoMapper -### Bulk Geocoding +### Latitude/Longitude Order in MongoDB -If you have just added geocoding to an existing application with a lot of objects, you can use this Rake task to geocode them all: +Everywhere coordinates are passed to methods as two-element arrays, Geocoder expects them to be in the order: `[lat, lon]`. However, as per [the GeoJSON spec](http://geojson.org/geojson-spec.html#positions), MongoDB requires that coordinates be stored longitude-first (`[lon, lat]`), so internally they are stored "backwards." Geocoder's methods attempt to hide this, so calling `obj.to_coordinates` (a method added to the object by Geocoder via `geocoded_by`) returns coordinates in the conventional order: - rake geocode:all CLASS=YourModel + obj.to_coordinates # => [37.7941013, -122.3951096] # [lat, lon] -If you need reverse geocoding instead, call the task with REVERSE=true: +whereas calling the object's coordinates attribute directly (`obj.coordinates` by default) returns the internal representation which is probably the reverse of what you want: - rake geocode:all CLASS=YourModel REVERSE=true + obj.coordinates # => [-122.3951096, 37.7941013] # [lon, lat] -Geocoder will print warnings if you exceed the rate limit for your geocoding service. Some services — Google notably — enforce a per-second limit in addition to a per-day limit. To avoid exceeding the per-second limit, you can add a `SLEEP` option to pause between requests for a given amount of time. You can also load objects in batches to save memory, for example: +So, be careful. - rake geocode:all CLASS=YourModel SLEEP=0.25 BATCH=100 +### Use Outside of Rails -To avoid per-day limit issues (for example if you are trying to geocode thousands of objects and don't want to reach the limit), you can add a `LIMIT` option. Warning: This will ignore the `BATCH` value if provided. +To use 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: - rake geocode:all CLASS=YourModel LIMIT=1000 + extend Geocoder::Model::ActiveRecord -### Avoiding Unnecessary API Requests -Geocoding only needs to be performed under certain conditions. To avoid unnecessary work (and quota usage) you will probably want to geocode an object only when: +Geospatial Database Queries +--------------------------- -* an address is present -* the address has been changed since last save (or it has never been saved) - -The exact code will vary depending on the method you use for your geocodable string, but it would be something like this: - - after_validation :geocode, if: ->(obj){ obj.address.present? and obj.address_changed? } - - -Request Geocoding by IP Address -------------------------------- - -Geocoder adds `location` and `safe_location` methods 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 - -**The `location` method is vulnerable to trivial IP address spoofing via HTTP headers.** If that's a problem for your application, use `safe_location` instead, but be aware that `safe_location` will *not* try to trace a request's originating IP through proxy headers; you will instead get the location of the last proxy the request passed through, if any (excepting any proxies you have explicitly whitelisted in your Rack config). - -Note that these methods will usually return `nil` in your test and development environments because things like "localhost" and "0.0.0.0" are not an Internet IP addresses. - -See _Advanced Geocoding_ below for more information about `Geocoder::Result` objects. - - -Location-Aware Database Queries -------------------------------- - -### For Mongo-backed models: - -Please use MongoDB's [geospatial query language](https://docs.mongodb.org/manual/reference/command/geoNear/). Mongoid also provides [a DSL](http://mongoid.github.io/en/mongoid/docs/querying.html#geo_near) for doing near queries. - ### For ActiveRecord models: To find objects by location, use the following scopes: - Venue.near('Omaha, NE, US') # venues within 20 (default) miles of Omaha - Venue.near([40.71, -100.23], 50) # venues within 50 miles of a point - Venue.near([40.71, -100.23], 50, :units => :km) - # venues within 50 kilometres of a point - Venue.geocoded # venues with coordinates - Venue.not_geocoded # venues without coordinates + Venue.near('Omaha, NE, US') # venues within 20 miles of Omaha + Venue.near([40.71, -100.23], 50) # venues within 50 miles of a point + Venue.near([40.71, -100.23], 50, units: :km) # venues within 50 kilometres of a point + Venue.geocoded # venues with coordinates + Venue.not_geocoded # venues without coordinates -by default, objects are ordered by distance. To remove the ORDER BY clause use the following: - - Venue.near('Omaha', 20, :order => false) - With geocoded objects you can do things like this: 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 + 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: +### For MongoDB-backed models: - # look up coordinates of some location (like searching Google Maps) - Geocoder.coordinates("25 Main St, Cooperstown, NY") - => [42.700149, -74.922767] +Please do not use Geocoder's `near` method. Instead use MongoDB's built-in [geospatial query language](https://docs.mongodb.org/manual/reference/command/geoNear/), which is faster. Mongoid also provides [a DSL](http://mongoid.github.io/en/mongoid/docs/querying.html#geo_near) for geospatial queries. - # distance between Eiffel Tower and Empire State Building - Geocoder::Calculations.distance_between([47.858205,2.294359], [40.748433,-73.985655]) - => 3619.77359999382 # in configured units (default miles) - # 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] +Geocoding HTTP Requests +----------------------- -Please see the code for more methods and detailed information about arguments (eg, working with kilometers). +Geocoder adds `location` and `safe_location` methods 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 -Distance and Bearing --------------------- +**The `location` method is vulnerable to trivial IP address spoofing via HTTP headers.** If that's a problem for your application, use `safe_location` instead, but be aware that `safe_location` will *not* try to trace a request's originating IP through proxy headers; you will instead get the location of the last proxy the request passed through, if any (excepting any proxies you have explicitly whitelisted in your Rack config). -When you run a location-aware query the returned objects have two attributes added to them (only w/ ActiveRecord): +Note that these methods will usually return `nil` in test and development environments because things like "localhost" and "0.0.0.0" are not geocodable IP addresses. -* `obj.distance` - number of miles from the search point to this object -* `obj.bearing` - direction from the search point to this object -Results are automatically sorted by distance from the search point, closest to farthest. Bearing is given as a number of clockwise degrees from due north, for example: - -* `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 very accurate._ - -To calculate accurate distance and bearing with SQLite or MongoDB: - - obj.distance_to([43.9,-98.6]) # distance from obj to point - obj.bearing_to([43.9,-98.6]) # bearing from obj to point - obj.bearing_from(obj2) # bearing from obj2 to obj - -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`, `:km`, or `:nm` for nautical miles). - - -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: - - geocoded_by :address, :latitude => :lat, :longitude => :lon # ActiveRecord - geocoded_by :address, :coordinates => :coords # MongoDB - -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 :latitude, :longitude, :address => :location # ActiveRecord - reverse_geocoded_by :coordinates, :address => :loc # MongoDB - -You can also configure a specific lookup for your model which will override the globally-configured lookup. For example: - - geocoded_by :address, :lookup => :yandex - -You can also specify a proc if you want to choose a lookup based on a specific property of an object. For example, you can use specialized lookups for different regions: - - geocoded_by :address, :lookup => lambda{ |obj| obj.geocoder_lookup } - - def geocoder_lookup - if country_code == "RU" - :yandex - elsif country_code == "CN" - :baidu - else - :google - end - end - - -Advanced Querying ------------------ - -When querying for objects (if you're using ActiveRecord) you can also look within a square rather than a radius (circle) by using the `within_bounding_box` scope: - - distance = 20 - center_point = [40.71, 100.23] - box = Geocoder::Calculations.bounding_box(center_point, distance) - Venue.within_bounding_box(box) - -This can also dramatically improve query performance, especially when used in conjunction with indexes on the latitude/longitude columns. Note, however, that returned results do not include `distance` and `bearing` attributes. Also note that `#near` performs both bounding box and radius queries for speed. - -You can also specify a minimum radius (if you're using ActiveRecord and not Sqlite) to constrain the -lower bound (ie. think of a donut, or ring) by using the `:min_radius` option: - - box = Geocoder::Calculations.bounding_box(center_point, distance, :min_radius => 10.5) - -With ActiveRecord, you can specify alternate latitude and longitude column names for a geocoded model (useful if you store multiple sets of coordinates for each object): - - Venue.near("Paris", 50, latitude: :secondary_latitude, longitude: :secondary_longitude) - - -Advanced Geocoding ------------------- - -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 an array of `Geocoder::Result` objects) in which you handle the parsed geocoding result any way you like, for example: - - reverse_geocoded_by :latitude, :longitude do |obj,results| - if geo = results.first - obj.city = geo.city - obj.zipcode = geo.postal_code - obj.country = geo.country_code - end - 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 in the form of `[lat,lon]` -* `result.address` - string -* `result.city` - string -* `result.state` - string -* `result.state_code` - string -* `result.postal_code` - string -* `result.country` - string -* `result.country_code` - string - -If you're familiar with the results returned by the geocoding service you're using you can access even more data (call the `#data` method of any Geocoder::Result object to get the full parsed response), but you'll need to be familiar with the particular `Geocoder::Result` object you're using and the structure of your geocoding service's responses. (See below for links to geocoding service documentation.) - - Geocoding Service ("Lookup") Configuration ------------------------------------------ -Geocoder supports a variety of street and IP address geocoding services. The default lookups are `:google` for street addresses and `:ipinfo_io` for IP addresses. Please see the listing and comparison below for details on specific geocoding services (not all settings are supported by all services). +Geocoder supports a variety of street and IP address geocoding services. The default lookups are `:nominatim` for street addresses and `:ipinfo_io` for IP addresses. Please see the [API Guide](https://github.com/alexreisner/geocoder/blob/master/README_API_GUIDE.md) for details on specific geocoding services (not all settings are supported by all services). -To create a Rails initializer with an example configuration: +To create a Rails initializer with sample configuration: rails generate geocoder:config -Some common configuration options are: +Some common options are: # config/initializers/geocoder.rb Geocoder.configure( - # geocoding service (see below for supported options): - :lookup => :yandex, + # street address geocoding service (default :nominatim) + lookup: :yandex, - # IP address geocoding service (see below for supported options): - :ip_lookup => :maxmind, + # IP address geocoding service (default :ipinfo_io) + ip_lookup: :maxmind, # to use an API key: - :api_key => "...", + api_key: "...", # geocoding service request timeout, in seconds (default 3): - :timeout => 5, + timeout: 5, # set default units to kilometers: - :units => :km, + units: :km, - # caching (see below for details): - :cache => Redis.new, - :cache_prefix => "..." + # caching (see [below](#caching) for details): + cache: Redis.new, + cache_prefix: "..." ) -Please see [`lib/geocoder/configuration.rb`](https://github.com/alexreisner/geocoder/blob/master/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: +Please see [`lib/geocoder/configuration.rb`](https://github.com/alexreisner/geocoder/blob/master/lib/geocoder/configuration.rb) for a complete list of configuration options. Additionally, some lookups have their own special configuration options 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]]) + Geocoder.search("Paris", bounds: [[32.1,-95.9], [33.9,-94.3]]) -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: +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, which appends options to the query string of the geocoding request. For example: - # with Nominatim: - Geocoder.search("Paris", :params => {:countrycodes => "gb,de,fr,es,us"}) + # Nominatim's `countrycodes` parameter: + Geocoder.search("Paris", params: {countrycodes: "gb,de,fr,es,us"}) -Or, to search within a particular region with Google: + # Google's `region` parameter: + Geocoder.search("Paris", params: {region: "..."}) - Geocoder.search("...", :params => {:region => "..."}) +### Configuring Multiple Services -Or, to use parameters in your model: +You can configure multiple geocoding services at once by using the service's name as a key for a sub-configuration hash, like this: - class Venue - - # build an address from street, city, and state attributes - geocoded_by :address_from_components, :params => {:region => "..."} - - # store the fetched address in the full_address attribute - reverse_geocoded_by :latitude, :longitude, :address => :full_address, :params => {:region => "..."} - end - - -### Configure Multiple Services - -You can configure multiple geocoding services at once, like this: - Geocoder.configure( - :timeout => 2, - :cache => Redis.new, + timeout: 2, + cache: Redis.new, - :yandex => { - :api_key => "...", - :timeout => 5 + yandex: { + api_key: "...", + timeout: 5 }, - :baidu => { - :api_key => "..." + baidu: { + api_key: "..." }, - :maxmind => { - :api_key => "...", - :service => :omni + maxmind: { + api_key: "...", + service: :omni } ) -The above combines global and service-specific options and could be useful if you specify different geocoding services for different models or under different conditions. Lookup-specific settings override global settings. In the above example, the timeout for all lookups would be 2 seconds, except for Yandex which would be 5. +Lookup-specific settings override global settings so, in this example, the timeout for all lookups is 2 seconds, except for Yandex which is 5. -### Street Address Services +Performance and Optimization +---------------------------- -The following is a comparison of the supported geocoding APIs. The "Limitations" listed for each are a very brief and incomplete summary of some special limitations beyond basic data source attribution. Please read the official Terms of Service for a service before using it. +### Database Indices -#### Google (`:google`) +In MySQL and Postgres, queries use a bounding box to limit the number of points over which a more precise distance calculation needs to be done. To take advantage of this optimisation, you need to add a composite index on latitude and longitude. In your Rails migration: -* **API key**: optional, but quota is higher if key is used (use of key requires HTTPS so be sure to set: `:use_https => true` in `Geocoder.configure`) -* **Key signup**: https://console.developers.google.com/flows/enableapi?apiid=geocoding_backend&keyType=SERVER_SIDE -* **Quota**: 2,500 requests/24 hrs, 5 requests/second -* **Region**: world -* **SSL support**: yes (required if key is used) -* **Languages**: see https://developers.google.com/maps/faq#languagesupport -* **Extra params**: - * `:bounds` - pass SW and NE coordinates as an array of two arrays to bias results towards a viewport - * `:google_place_id` - pass `true` if search query is a Google Place ID -* **Documentation**: https://developers.google.com/maps/documentation/geocoding/intro -* **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..." + add_index :table, [:latitude, :longitude] -#### Google Maps API for Work (`:google_premier`) +In MongoDB, by default, the methods `geocoded_by` and `reverse_geocoded_by` create a geospatial index. You can avoid index creation with the `:skip_index option`, for example: -Similar to `:google`, with the following differences: + include Geocoder::Model::Mongoid + geocoded_by :address, skip_index: true -* **API key**: required, plus client and channel (set `Geocoder.configure(:lookup => :google_premier, :api_key => [key, client, channel])`) -* **Key signup**: https://developers.google.com/maps/documentation/business/ -* **Quota**: 100,000 requests/24 hrs, 10 requests/second +### Avoiding Unnecessary API Requests -#### Google Places Details (`:google_places_details`) +Geocoding only needs to be performed under certain conditions. To avoid unnecessary work (and quota usage) you will probably want to geocode an object only when: -The [Google Places Details API](https://developers.google.com/places/documentation/details) is not, strictly speaking, a geocoding service. It accepts a Google `place_id` and returns address information, ratings and reviews. A `place_id` can be obtained from the Google Places Search lookup (`:google_places_search`) and should be passed to Geocoder as the first search argument: `Geocoder.search("ChIJhRwB-yFawokR5Phil-QQ3zM", lookup: :google_places_details)`. +* an address is present +* the address has been changed since last save (or it has never been saved) -* **API key**: required -* **Key signup**: https://code.google.com/apis/console/ -* **Quota**: 1,000 request/day, 100,000 after credit card authentication -* **Region**: world -* **SSL support**: yes -* **Languages**: ar, eu, bg, bn, ca, cs, da, de, el, en, en-AU, en-GB, es, eu, fa, fi, fil, fr, gl, gu, hi, hr, hu, id, it, iw, ja, kn, ko, lt, lv, ml, mr, nl, no, pl, pt, pt-BR, pt-PT, ro, ru, sk, sl, sr, sv, tl, ta, te, th, tr, uk, vi, zh-CN, zh-TW (see http://spreadsheets.google.com/pub?key=p9pdwsai2hDMsLkXsoM05KQ&gid=1) -* **Documentation**: https://developers.google.com/places/documentation/details -* **Terms of Service**: https://developers.google.com/places/policies -* **Limitations**: "If your application displays Places API data on a page or view that does not also display a Google Map, you must show a "Powered by Google" logo with that data." +The exact code will vary depending on the method you use for your geocodable string, but it would be something like this: -#### Google Places Search (`:google_places_search`) + after_validation :geocode, if: ->(obj){ obj.address.present? and obj.address_changed? } -The [Google Places Search API](https://developers.google.com/places/web-service/search) is the geocoding service of Google Places API. It returns very limited location data, but it also returns a `place_id` which can be used with Google Place Details to get more detailed information. For a comparison between this and the regular Google Geocoding API, see https://maps-apis.googleblog.com/2016/11/address-geocoding-in-google-maps-apis.html +### Caching -* Same specifications as Google Places Details (see above). +When relying on any external service, it's always a good idea 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: -#### Bing (`:bing`) + Geocoder.configure(cache: Redis.new) -* **API key**: required (set `Geocoder.configure(:lookup => :bing, :api_key => key)`) -* **Key signup**: https://www.microsoft.com/maps/create-a-bing-maps-key.aspx -* **Quota**: 50,0000 requests/day (Windows app), 125,000 requests/year (non-Windows app) -* **Region**: world -* **SSL support**: no -* **Languages**: ? -* **Documentation**: http://msdn.microsoft.com/en-us/library/ff701715.aspx -* **Terms of Service**: http://www.microsoft.com/maps/product/terms.html -* **Limitations**: No country codes or state names. Must be used on "public-facing, non-password protected web sites," "in conjunction with Bing Maps or an application that integrates Bing Maps." +This example uses Redis, but the cache store can be any object that supports these methods: -#### Nominatim (`:nominatim`) +* `store#[](key)` or `#get` or `#read` - retrieves a value +* `store#[]=(key, value)` or `#set` or `#write` - stores a value +* `store#del(url)` - deletes a value +* `store#keys` - (Optional) Returns array of keys. Used if you wish to expire the entire cache (see below). -* **API key**: none -* **Quota**: 1 request/second -* **Region**: world -* **SSL support**: yes -* **Languages**: ? -* **Documentation**: http://wiki.openstreetmap.org/wiki/Nominatim -* **Terms of Service**: http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy -* **Limitations**: Please limit request rate to 1 per second and include your contact information in User-Agent headers (eg: `Geocoder.configure(:http_headers => { "User-Agent" => "your contact info" })`). [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://www.openstreetmap.org/copyright) +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). -#### PickPoint (`:pickpoint`) +You can also set a custom prefix to be used for cache keys: -* **API key**: required -* **Key signup**: [https://pickpoint.io](https://pickpoint.io) -* **Quota**: 2500 requests / day for free non-commercial usage, commercial plans are [available](https://pickpoint.io/#pricing). No rate limit. -* **Region**: world -* **SSL support**: required -* **Languages**: worldwide -* **Documentation**: [https://pickpoint.io/api-reference](https://pickpoint.io/api-reference) -* **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://www.openstreetmap.org/copyright) + Geocoder.configure(cache_prefix: "...") +By default the prefix is `geocoder:` -#### LocationIQ (`:location_iq`) +If you need to expire cached content: -* **API key**: required -* **Quota**: 60 requests/minute (2 req/sec, 10k req/day), then [ability to purchase more](http://locationiq.org/#pricing) -* **Region**: world -* **SSL support**: yes -* **Languages**: ? -* **Documentation**: https://locationiq.org/#docs -* **Terms of Service**: https://unwiredlabs.com/tos -* **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](https://www.openstreetmap.org/copyright) + Geocoder::Lookup.get(Geocoder.config[:lookup]).cache.expire(:all) # expire cached results for current Lookup + Geocoder::Lookup.get(:nominatim).cache.expire("http://...") # expire cached result for a specific URL + Geocoder::Lookup.get(:nominatim).cache.expire(:all) # expire cached results for Google Lookup + # expire all cached results for all Lookups. + # Be aware that this methods spawns a new Lookup object for each Service + Geocoder::Lookup.all_services.each{|service| Geocoder::Lookup.get(service).cache.expire(:all)} -#### OpenCageData (`:opencagedata`) +Do *not* include the prefix when passing a URL to be expired. Expiring `:all` will only expire keys with the configured prefix -- it will *not* expire every entry in your key/value store. -* **API key**: required -* **Key signup**: http://geocoder.opencagedata.com -* **Quota**: 2500 requests / day, then [ability to purchase more](https://geocoder.opencagedata.com/pricing) -* **Region**: world -* **SSL support**: yes -* **Languages**: worldwide -* **Documentation**: http://geocoder.opencagedata.com/api.html -* **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://www.openstreetmap.org/copyright) +For an example of a cache store with URL expiry, please see examples/autoexpire_cache.rb -#### Yandex (`:yandex`) +_Before you implement caching in your app please be sure that doing so does not violate the Terms of Service for your geocoding service._ -* **API key**: optional, but without it lookup is territorially limited -* **Quota**: 25000 requests / day -* **Region**: world with API key. Otherwise restricted to Russia, Ukraine, Belarus, Kazakhstan, Georgia, Abkhazia, South Ossetia, Armenia, Azerbaijan, Moldova, Turkmenistan, Tajikistan, Uzbekistan, Kyrgyzstan and Turkey -* **SSL support**: HTTPS only -* **Languages**: Russian, Belarusian, Ukrainian, English, Turkish (only for maps of Turkey) -* **Documentation**: http://api.yandex.com.tr/maps/doc/intro/concepts/intro.xml -* **Terms of Service**: http://api.yandex.com.tr/maps/doc/intro/concepts/intro.xml#rules -* **Limitations**: ? -#### Geocoder.ca (`:geocoder_ca`) +Advanced Model Configuration +---------------------------- -* **API key**: none -* **Quota**: ? -* **Region**: US and Canada -* **SSL support**: no -* **Languages**: English -* **Documentation**: ? -* **Terms of Service**: http://geocoder.ca/?terms=1 -* **Limitations**: "Under no circumstances can our data be re-distributed or re-sold by anyone to other parties without our written permission." +You are not stuck with the `latitude` and `longitude` database column names (with ActiveRecord) or the `coordinates` array (Mongo) for storing coordinates. For example: -#### Mapbox (`:mapbox`) + geocoded_by :address, latitude: :lat, longitude: :lon # ActiveRecord + geocoded_by :address, coordinates: :coords # MongoDB -* **API key**: required -* **Dataset**: Uses `mapbox.places` dataset by default. Specify the `mapbox.places-permanent` dataset by setting: `Geocoder.configure(:mapbox => {:dataset => "mapbox.places-permanent"})` -* **Key signup**: https://www.mapbox.com/pricing/ -* **Quota**: depends on plan -* **Region**: complete coverage of US and Canada, partial coverage elsewhere (see for details: https://www.mapbox.com/developers/api/geocoding/#coverage) -* **SSL support**: yes -* **Languages**: English -* **Extra params** (see Mapbox docs for more): - * `:country` - restrict results to a specific country, e.g., `us` or `ca` - * `:types` - restrict results to categories such as `address`, - `neighborhood`, `postcode` - * `:proximity` - bias results toward a `lng,lat`, e.g., - `params: { proximity: "-84.0,42.5" }` -* **Documentation**: https://www.mapbox.com/developers/api/geocoding/ -* **Terms of Service**: https://www.mapbox.com/tos/ -* **Limitations**: For `mapbox.places` dataset, must be displayed on a Mapbox map; Cache results for up to 30 days. For `mapbox.places-permanent` dataset, depends on plan. -* **Notes**: Currently in public beta. +For reverse geocoding, you can specify the attribute where the address will be stored. For example: -#### Mapquest (`:mapquest`) + reverse_geocoded_by :latitude, :longitude, address: :loc # ActiveRecord + reverse_geocoded_by :coordinates, address: :street_address # MongoDB -* **API key**: required -* **Key signup**: https://developer.mapquest.com/plans -* **Quota**: ? -* **HTTP Headers**: when using the licensed API you can specify a referer like so: - `Geocoder.configure(:http_headers => { "Referer" => "http://foo.com" })` -* **Region**: world -* **SSL support**: no -* **Languages**: English -* **Documentation**: http://www.mapquestapi.com/geocoding/ -* **Terms of Service**: http://info.mapquest.com/terms-of-use/ -* **Limitations**: ? -* **Notes**: You can use the open (non-licensed) API by setting: `Geocoder.configure(:mapquest => {:open => true})` (defaults to licensed version) +To specify geocoding parameters in your model: -#### Ovi/Nokia (`:ovi`) + geocoded_by :address, params: {region: "..."} -* **API key**: not required, but performance restricted without it -* **Quota**: ? -* **Region**: world -* **SSL support**: no -* **Languages**: English -* **Documentation**: http://api.maps.ovi.com/devguide/overview.html -* **Terms of Service**: http://www.developer.nokia.com/Develop/Maps/TC.html -* **Limitations**: ? +Supported parameters: `:lookup`, `:ip_lookup`, `:language`, and `:params`. You can specify an anonymous function if you want to set these on a per-request basis. For example, to use different lookups for objects in different regions: -#### Here/Nokia (`:here`) + geocoded_by :address, lookup: lambda{ |obj| obj.geocoder_lookup } -* **API key**: required (set `Geocoder.configure(:api_key => [app_id, app_code])`) -* **Quota**: Depending on the API key -* **Region**: world -* **SSL support**: yes -* **Languages**: The preferred language of address elements in the result. Language code must be provided according to RFC 4647 standard. -* **Documentation**: http://developer.here.com/rest-apis/documentation/geocoder -* **Terms of Service**: http://developer.here.com/faqs#l&t -* **Limitations**: ? + def geocoder_lookup + if country_code == "RU" + :yandex + elsif country_code == "CN" + :baidu + else + :nominatim + end + end -#### ESRI (`:esri`) +### Custom Result Handling -* **API key**: optional (set `Geocoder.configure(:esri => {:api_key => ["client_id", "client_secret"]})`) -* **Quota**: Required for some scenarios (see Terms of Service) -* **Region**: world -* **SSL support**: yes -* **Languages**: English -* **Documentation**: https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm -* **Terms of Service**: http://www.esri.com/legal/software-license -* **Limitations**: Requires API key if results will be stored. Using API key will also remove rate limit. -* **Notes**: You can specify which projection you want to use by setting, for example: `Geocoder.configure(:esri => {:outSR => 102100})`. If you will store results, set the flag and provide API key: `Geocoder.configure(:esri => {:api_key => ["client_id", "client_secret"], :for_storage => true})`. If you want to, you can also supply an ESRI token directly: `Geocoder.configure(:esri => {:token => Geocoder::EsriToken.new('TOKEN', Time.now + 1.day})` +So far we have seen examples where geocoding results are assigned automatically to predefined object attributes. However, you can skip the auto-assignment by providing a block which handles the parsed geocoding results any way you like, for example: -#### Mapzen (`:mapzen`) + reverse_geocoded_by :latitude, :longitude do |obj,results| + if geo = results.first + obj.city = geo.city + obj.zipcode = geo.postal_code + obj.country = geo.country_code + end + end + after_validation :reverse_geocode -* **API key**: required -* **Quota**: 25,000 free requests/month and [ability to purchase more](https://mapzen.com/pricing/) -* **Region**: world -* **SSL support**: yes -* **Languages**: en; see https://mapzen.com/documentation/search/language-codes/ -* **Documentation**: https://mapzen.com/documentation/search/search/ -* **Terms of Service**: http://mapzen.com/terms -* **Limitations**: [You must provide attribution](https://mapzen.com/rights/) -* **Notes**: Mapzen is the primary author of Pelias and offers Pelias-as-a-service in free and paid versions https://mapzen.com/pelias. +Every `Geocoder::Result` object, `result`, provides the following data: -#### Pelias (`:pelias`) +* `result.latitude` - float +* `result.longitude` - float +* `result.coordinates` - array of the above two in the form of `[lat,lon]` +* `result.address` - string +* `result.city` - string +* `result.state` - string +* `result.state_code` - string +* `result.postal_code` - string +* `result.country` - string +* `result.country_code` - string -* **API key**: configurable (self-hosted service) -* **Quota**: none (self-hosted service) -* **Region**: world -* **SSL support**: yes -* **Languages**: en; see https://mapzen.com/documentation/search/language-codes/ -* **Documentation**: http://pelias.io/ -* **Terms of Service**: http://pelias.io/data_licenses.html -* **Limitations**: See terms -* **Notes**: Configure your self-hosted pelias with the `endpoint` option: `Geocoder.configure(:lookup => :pelias, :api_key => 'your_api_key', :pelias => {:endpoint => 'self.hosted/pelias'})`. Defaults to `localhost`. +Most APIs return other data in addition to these globally-supported attributes. To directly access the full response, call the `#data` method of any Geocoder::Result object. See the [API Guide](https://github.com/alexreisner/geocoder/blob/master/README_API_GUIDE.md) for links to documentation for all geocoding services. -#### Data Science Toolkit (`:dstk`) +### Forward and Reverse Geocoding in the Same Model -Data Science Toolkit provides an API whose response format is like Google's but which can be set up as a privately hosted service. +You can apply both forward and reverse geocoding to the same model (i.e. users can supply an address or coordinates and Geocoder fills in whatever's missing) but you'll need to provide two different address methods: -* **API key**: none -* **Quota**: No quota if you are self-hosting the service. -* **Region**: world -* **SSL support**: ? -* **Languages**: en -* **Documentation**: http://www.datasciencetoolkit.org/developerdocs -* **Terms of Service**: http://www.datasciencetoolkit.org/developerdocs#googlestylegeocoder -* **Limitations**: No reverse geocoding. -* **Notes**: If you are hosting your own DSTK server you will need to configure the host name, eg: `Geocoder.configure(:lookup => :dstk, :dstk => {:host => "localhost:4567"})`. +* one for storing the fetched address (when reverse geocoding) +* one for providing an address to use when fetching coordinates (forward geocoding) -#### Baidu (`:baidu`) +For example: -* **API key**: required -* **Quota**: No quota limits for geocoding -* **Region**: China -* **SSL support**: no -* **Languages**: Chinese (Simplified) -* **Documentation**: http://developer.baidu.com/map/webservice-geocoding.htm -* **Terms of Service**: http://developer.baidu.com/map/law.htm -* **Limitations**: Only good for non-commercial use. For commercial usage please check http://developer.baidu.com/map/question.htm#qa0013 -* **Notes**: To use Baidu set `Geocoder.configure(:lookup => :baidu, :api_key => "your_api_key")`. + class Venue -#### Geocodio (`:geocodio`) + # build an address from street, city, and state attributes + geocoded_by :address_from_components -* **API key**: required -* **Quota**: 2,500 free requests/day then purchase $0.0005 for each, also has volume pricing and plans. -* **Region**: USA & Canada -* **SSL support**: yes -* **Languages**: en -* **Documentation**: https://geocod.io/docs/ -* **Terms of Service**: https://geocod.io/terms-of-use/ -* **Limitations**: No restrictions on use + # store the fetched address in the full_address attribute + reverse_geocoded_by :latitude, :longitude, address: :full_address + end -#### SmartyStreets (`:smarty_streets`) +The same goes for latitude/longitude. However, for purposes of querying the database, there can be only one authoritative set of latitude/longitude attributes for use in database queries. This is whichever you specify last. For example, here the attributes *without* the `fetched_` prefix will be authoritative: -* **API key**: requires auth_id and auth_token (set `Geocoder.configure(:api_key => [id, token])`) -* **Quota**: 250/month then purchase at sliding scale. -* **Region**: US -* **SSL support**: yes (required) -* **Languages**: en -* **Documentation**: http://smartystreets.com/kb/liveaddress-api/rest-endpoint -* **Terms of Service**: http://smartystreets.com/legal/terms-of-service -* **Limitations**: No reverse geocoding. + class Venue + geocoded_by :address, + latitude: :fetched_latitude, + longitude: :fetched_longitude + reverse_geocoded_by :latitude, :longitude + end -#### OKF Geocoder (`:okf`) +Advanced Database Queries +------------------------- -* **API key**: none -* **Quota**: none -* **Region**: FI -* **SSL support**: no -* **Languages**: fi -* **Documentation**: http://books.okf.fi/geocoder/_full/ -* **Terms of Service**: http://www.itella.fi/liitteet/palvelutjatuotteet/yhteystietopalvelut/Postinumeropalvelut-Palvelukuvausjakayttoehdot.pdf -* **Limitations**: ? +*The following apply to ActiveRecord only. For MongoDB, please use the built-in geospatial features.* -#### Geoportail.lu (`:geoportail_lu`) +The default `near` search looks for objects within a circle. To search within a doughnut or ring use the `:min_radius` option: -* **API key**: none -* **Quota**: none -* **Region**: LU -* **SSL support**: yes -* **Languages**: en -* **Documentation**: http://wiki.geoportail.lu/doku.php?id=en:api -* **Terms of Service**: http://wiki.geoportail.lu/doku.php?id=en:mcg_1 -* **Limitations**: ? + Venue.near("Austin, TX", 200, min_radius: 40) -#### Postcodes.io (`:postcodes_io`) +To search within a rectangle (note that results will *not* include `distance` and `bearing` attributes): -* **API key**: none -* **Quota**: ? -* **Region**: UK -* **SSL support**: yes -* **Languages**: English -* **Documentation**: http://postcodes.io/docs -* **Terms of Service**: ? -* **Limitations**: UK postcodes only + sw_corner = [40.71, 100.23] + ne_corner = [36.12, 88.65] + Venue.within_bounding_box(sw_corner, ne_corner) -#### PostcodeAnywhere UK (`:postcode_anywhere_uk`) +To search for objects near a certain point where each object has a different distance requirement (which is defined in the database), you can pass a column name for the radius: -This uses the PostcodeAnywhere UK Geocode service, this will geocode any string from UK postcode, placename, point of interest or location. + Venue.near([40.71, 99.23], :effective_radius) -* **API key**: required -* **Quota**: Dependant on service plan? -* **Region**: UK -* **SSL support**: yes -* **Languages**: English -* **Documentation**: http://www.postcodeanywhere.co.uk/Support/WebService/Geocoding/UK/Geocode/2/ -* **Terms of Service**: ? -* **Limitations**: ? -* **Notes**: To use PostcodeAnywhere you must include an API key: `Geocoder.configure(:lookup => :postcode_anywhere_uk, :api_key => 'your_api_key')`. +If you store multiple sets of coordinates for each object, you can specify latitude and longitude columns to use for a search: -#### LatLon.io (`:latlon`) + Venue.near("Paris", 50, latitude: :secondary_latitude, longitude: :secondary_longitude) -* **API key**: required -* **Quota**: Depends on the user's plan (free and paid plans available) -* **Region**: US -* **SSL support**: yes -* **Languages**: en -* **Documentation**: https://latlon.io/documentation -* **Terms of Service**: ? -* **Limitations**: No restrictions on use +### Distance and Bearing -#### Base Adresse Nationale FR (`:ban_data_gouv_fr`) +When you run a geospatial query, the returned objects have two attributes added: -* **API key**: none -* **Quota**: none -* **Region**: FR -* **SSL support**: yes -* **Languages**: en / fr -* **Documentation**: https://adresse.data.gouv.fr/api/ (in french) -* **Terms of Service**: https://adresse.data.gouv.fr/faq/ (in french) -* **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://openstreetmap.fr/ban) +* `obj.distance` - number of miles from the search point to this object +* `obj.bearing` - direction from the search point to this object -#### AMap (`:amap`) +Results are automatically sorted by distance from the search point, closest to farthest. Bearing is given as a number of degrees clockwise from due north, for example: -- **API key**: required -- **Quota**: 2000/day and 2000/minute for personal developer, 4000000/day and 60000/minute for enterprise developer, for geocoding requests -- **Region**: China -- **SSL support**: yes -- **Languages**: Chinese (Simplified) -- **Documentation**: http://lbs.amap.com/api/webservice/guide/api/georegeo -- **Terms of Service**: http://lbs.amap.com/home/terms/ -- **Limitations**: Only good for non-commercial use. For commercial usage please check http://lbs.amap.com/home/terms/ -- **Notes**: To use AMap set `Geocoder.configure(:lookup => :amap, :api_key => "your_api_key")`. +* `0` - due north +* `180` - due south +* `90` - due east +* `270` - due west +* `230.1` - southwest +* `359.9` - almost due north -### IP Address Services +You can convert these to compass point names via provided method: -#### IPInfo.io (`:ipinfo_io`) + Geocoder::Calculations.compass_point(355) # => "N" + Geocoder::Calculations.compass_point(45) # => "NE" + Geocoder::Calculations.compass_point(208) # => "SW" -* **API key**: optional - see http://ipinfo.io/pricing -* **Quota**: 1,000/day - more with api key -* **Region**: world -* **SSL support**: no (not without access key - see http://ipinfo.io/pricing) -* **Languages**: English -* **Documentation**: http://ipinfo.io/developers -* **Terms of Service**: http://ipinfo.io/developers +_Note: when running queries on SQLite, `distance` and `bearing` are provided for consistency only. They are not very accurate._ -#### FreeGeoIP (`:freegeoip`) - [DISCONTINUED](https://github.com/alexreisner/geocoder/wiki/Freegeoip-Discontinuation) +For more advanced geospatial querying, please see the [rgeo gem](https://github.com/rgeo/rgeo). -* **API key**: none -* **Quota**: 15,000 requests per hour. After reaching the hourly quota, all of your requests will result in HTTP 403 (Forbidden) until it clears up on the next roll over. -* **Region**: world -* **SSL support**: no -* **Languages**: English -* **Documentation**: http://github.com/fiorix/freegeoip/blob/master/README.md -* **Terms of Service**: ? -* **Limitations**: ? -* **Notes**: If you are [running your own local instance of the FreeGeoIP service](https://github.com/fiorix/freegeoip) you can configure the host like this: `Geocoder.configure(freegeoip: {host: "..."})`. -#### Pointpin (`:pointpin`) +Geospatial Calculations +----------------------- -* **API key**: required -* **Quota**: 50,000/mo for €9 through 1m/mo for €49 -* **Region**: world -* **SSL support**: yes -* **Languages**: English -* **Documentation**: https://pointp.in/docs/get-started -* **Terms of Service**: https://pointp.in/terms -* **Limitations**: ? -* **Notes**: To use Pointpin set `Geocoder.configure(:ip_lookup => :pointpin, :api_key => "your_pointpin_api_key")`. +The `Geocoder::Calculations` module contains some useful methods: -#### Telize (`:telize`) + # find the distance between two arbitrary points + Geocoder::Calculations.distance_between([47.858205,2.294359], [40.748433,-73.985655]) + => 3619.77359999382 # in configured units (default miles) -* **API key**: required -* **Quota**: 1,000/day for $7/mo through 100,000/day for $100/mo -* **Region**: world -* **SSL support**: yes -* **Languages**: English -* **Documentation**: https://market.mashape.com/fcambus/telize -* **Terms of Service**: ? -* **Limitations**: ? -* **Notes**: To use Telize set `Geocoder.configure(:ip_lookup => :telize, :api_key => "your_api_key")`. Or configure your self-hosted telize with the `host` option: `Geocoder.configure(:ip_lookup => :telize, :telize => {:host => "localhost"})`. + # 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] +See [the code](https://github.com/alexreisner/geocoder/blob/master/lib/geocoder/calculations.rb) for more! -#### MaxMind Legacy Web Services (`:maxmind`) -* **API key**: required -* **Quota**: Request Packs can be purchased -* **Region**: world -* **SSL support**: yes -* **Languages**: English -* **Documentation**: http://dev.maxmind.com/geoip/legacy/web-services/ -* **Terms of Service**: ? -* **Limitations**: ? -* **Notes**: You must specify which MaxMind service you are using in your configuration. For example: `Geocoder.configure(:maxmind => {:service => :omni})`. +Batch Geocoding +--------------- -#### Baidu IP (`:baidu_ip`) +If you have just added geocoding to an existing application with a lot of objects, you can use this Rake task to geocode them all: -* **API key**: required -* **Quota**: No quota limits for geocoding -* **Region**: China -* **SSL support**: no -* **Languages**: Chinese (Simplified) -* **Documentation**: http://developer.baidu.com/map/webservice-geocoding.htm -* **Terms of Service**: http://developer.baidu.com/map/law.htm -* **Limitations**: Only good for non-commercial use. For commercial usage please check http://developer.baidu.com/map/question.htm#qa0013 -* **Notes**: To use Baidu set `Geocoder.configure(:lookup => :baidu_ip, :api_key => "your_api_key")`. + rake geocode:all CLASS=YourModel -#### MaxMind GeoIP2 Precision Web Services (`:maxmind_geoip2`) +If you need reverse geocoding instead, call the task with REVERSE=true: -* **API key**: required -* **Quota**: Request Packs can be purchased -* **Region**: world -* **SSL support**: yes -* **Languages**: English -* **Documentation**: http://dev.maxmind.com/geoip/geoip2/web-services/ -* **Terms of Service**: ? -* **Limitations**: ? -* **Notes**: You must specify which MaxMind service you are using in your configuration, and also basic authentication. For example: `Geocoder.configure(:maxmind_geoip2 => {:service => :country, :basic_auth => {:user => '', :password => ''}})`. + rake geocode:all CLASS=YourModel REVERSE=true -#### Ipstack (`:ipstack`) +In either case, it won't try to geocode objects that are already geocoded. The task will print warnings if you exceed the rate limit for your geocoding service. Some services enforce a per-second limit in addition to a per-day limit. To avoid exceeding the per-second limit, you can add a `SLEEP` option to pause between requests for a given amount of time. You can also load objects in batches to save memory, for example: -* **API key**: required (see https://ipstack.com/product) -* **Quota**: 10,000 requests per month (with free API Key, 50,000/day and up for paid plans) -* **Region**: world -* **SSL support**: yes ( only with paid plan ) -* **Languages**: English, German, Spanish, French, Japanese, Portugues (Brazil), Russian, Chinese -* **Documentation**: https://ipstack.com/documentation -* **Terms of Service**: ? -* **Limitations**: ? -* **Notes**: To use Ipstack set `Geocoder.configure(:ip_lookup => :ipstack, :api_key => "your_ipstack_api_key")`. Supports the optional params: `:hostname`, `:security`, `:fields`, `:language` (see API documentation for details). + rake geocode:all CLASS=YourModel SLEEP=0.25 BATCH=100 -#### IP-API.com (`:ipapi_com`) +To avoid exceeding per-day limits you can add a `LIMIT` option. However, this will ignore the `BATCH` value, if provided. -* **API key**: optional - see http://ip-api.com/docs/#usage_limits -* **Quota**: 150/minute - unlimited with api key -* **Region**: world -* **SSL support**: no (not without access key - see https://signup.ip-api.com/) -* **Languages**: English -* **Documentation**: http://ip-api.com/docs/ -* **Terms of Service**: https://signup.ip-api.com/terms + rake geocode:all CLASS=YourModel LIMIT=1000 -#### DB-IP.com (`:db_ip_com`) -* **API key**: required -* **Quota**: 2,500/day (with free API Key, 50,000/day and up for paid API keys) -* **Region**: world -* **SSL support**: yes (with paid API keys - see https://db-ip.com/api/) -* **Languages**: English (English with free API key, multiple languages with paid API keys) -* **Documentation**: https://db-ip.com/api/doc.php -* **Terms of Service**: https://db-ip.com/tos.php - -#### Ipdata.co (`:ipdata_co`) - -* **API key**: optional, see: https://ipdata.co/pricing.html -* **Quota**: 1500/day (up to 600k with paid API keys) -* **Region**: world -* **SSL support**: yes -* **Languages**: English -* **Documentation**: https://ipdata.co/docs.html -* **Terms of Service**: https://ipdata.co/terms.html -* **Limitations**: ? - - -### IP Address Local Database Services - -#### MaxMind Local (`:maxmind_local`) - EXPERIMENTAL - -This lookup provides methods for geocoding IP addresses without making a call to a remote API (improves speed and availability). It works, but support is new and should not be considered production-ready. Please [report any bugs](https://github.com/alexreisner/geocoder/issues) you encounter. - -* **API key**: none (requires the GeoLite City database which can be downloaded from [MaxMind](http://dev.maxmind.com/geoip/legacy/geolite/)) -* **Quota**: none -* **Region**: world -* **SSL support**: N/A -* **Languages**: English -* **Documentation**: http://www.maxmind.com/en/city -* **Terms of Service**: ? -* **Limitations**: ? -* **Notes**: There are two supported formats for MaxMind local data: binary file, and CSV file imported into an SQL database. **You must download a database from MaxMind and set either the `:file` or `:package` configuration option for local lookups to work.** - -**To use a binary file** you must add the *geoip* (or *jgeoip* for JRuby) gem to your Gemfile or have it installed in your system, and specify the path of the MaxMind database in your configuration. For example: - - Geocoder.configure(ip_lookup: :maxmind_local, maxmind_local: {file: File.join('folder', 'GeoLiteCity.dat')}) - -**To use a CSV file** you must import it into an SQL database. The GeoLite *City* and *Country* packages are supported. Configure like so: - - Geocoder.configure(ip_lookup: :maxmind_local, maxmind_local: {package: :city}) - -You can generate ActiveRecord migrations and download and import data via provided rake tasks: - - # generate migration to create tables - rails generate geocoder:maxmind:geolite_city - - # download, unpack, and import data - rake geocoder:maxmind:geolite:load PACKAGE=city - -You can replace `city` with `country` in any of the above tasks, generators, and configurations. - -#### GeoLite2 (`:geoip2`) - -This lookup provides methods for geocoding IP addresses without making a call to a remote API (improves speed and availability). It works, but support is new and should not be considered production-ready. Please [report any bugs](https://github.com/alexreisner/geocoder/issues) you encounter. - -* **API key**: none (requires a GeoIP2 or free GeoLite2 City or Country binary database which can be downloaded from [MaxMind](http://dev.maxmind.com/geoip/geoip2/)) -* **Quota**: none -* **Region**: world -* **SSL support**: N/A -* **Languages**: English -* **Documentation**: http://www.maxmind.com/en/city -* **Terms of Service**: ? -* **Limitations**: ? -* **Notes**: **You must download a binary database file from MaxMind and set the `:file` configuration option.** The CSV format databases are not yet supported since they are still in alpha stage. Set the path to the database file in your configuration: - - Geocoder.configure( - ip_lookup: :geoip2, - geoip2: { - file: File.join('folder', 'GeoLite2-City.mmdb') - } - ) - -You must add either the *[hive_geoip2](https://rubygems.org/gems/hive_geoip2)* gem (native extension that relies on libmaxminddb) or the *[maxminddb](http://rubygems.org/gems/maxminddb)* gem (pure Ruby implementation) to your Gemfile or have it installed in your system. The pure Ruby gem (maxminddb) will be used by default. To use `hive_geoip2`: - - Geocoder.configure( - ip_lookup: :geoip2, - geoip2: { - lib: 'hive_geoip2', - file: File.join('folder', 'GeoLite2-City.mmdb') - } - ) - -Caching +Testing ------- -When relying on any external service, it's always a good idea 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: +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 the `:test` lookup: - Geocoder.configure(:cache => Redis.new) + Geocoder.configure(lookup: :test) -This example uses Redis, but the cache store can be any object that supports these methods: +Add stubs to define the results that will be returned: -* `store#[](key)` or `#get` or `#read` - retrieves a value -* `store#[]=(key, value)` or `#set` or `#write` - stores a value -* `store#del(url)` - deletes a value -* `store#keys` - (Optional) Returns array of keys. Used if you wish to expire the entire cache (see below). - -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.configure(:cache_prefix => "...") - -By default the prefix is `geocoder:` - -If you need to expire cached content: - - Geocoder::Lookup.get(Geocoder.config[:lookup]).cache.expire(:all) # expire cached results for current Lookup - Geocoder::Lookup.get(:google).cache.expire("http://...") # expire cached result for a specific URL - Geocoder::Lookup.get(:google).cache.expire(:all) # expire cached results for Google Lookup - # expire all cached results for all Lookups. - # Be aware that this methods spawns a new Lookup object for each Service - Geocoder::Lookup.all_services.each{|service| Geocoder::Lookup.get(service).cache.expire(:all)} - -Do *not* include the prefix when passing a URL to be expired. Expiring `:all` will only expire keys with the configured prefix -- it will *not* expire every entry in your key/value store. - -For an example of a cache store with URL expiry, please see examples/autoexpire_cache.rb - -_Before you implement caching in your app please be sure that doing so does not violate the Terms of Service for your geocoding service._ - - -Forward and Reverse Geocoding in the Same Model ------------------------------------------------ - -If you apply both forward and reverse geocoding functionality to the same model (i.e. 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) - -For example: - - 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 - -We don't want ambiguity when doing distance calculations -- we need a single, authoritative source for coordinates! - -Once both forward and reverse geocoding has been applied, it is possible to call them sequentially. - -For example: - - class Venue - - after_validation :geocode, :reverse_geocode - - end - -For certain geolocation services such as Google's geolocation API, this may cause issues during subsequent updates to database records if the longitude and latitude coordinates cannot be associated with a known location address (on a large body of water for example). On subsequent callbacks the following call: - - after_validation :geocode - -will alter the longitude and latitude attributes based on the location field, which would be the closest known location to the original coordinates. In this case it is better to add conditions to each call, as not to override coordinates that do not have known location addresses associated with them. - -For example: - - class Venue - - after_validation :reverse_geocode, :if => :has_coordinates - after_validation :geocode, :if => :has_location, :unless => :has_coordinates - - end - -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 data provided by the geocoding service. - - -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.configure(:lookup => :test) - Geocoder::Lookup::Test.add_stub( "New York, NY", [ { 'coordinates' => [40.7143528, -74.0059731], 'address' => 'New York, NY, USA', @@ -1079,14 +517,12 @@ 'country_code' => 'US' } ] ) -Now, any time Geocoder looks up "New York, NY" its results array will contain one result with the above attributes. Note each lookup requires an exact match to the text you provide as the first argument. The above example would, therefore, not match a request for "New York, NY, USA" and a second stub would need to be created to match that particular request. You can also set a default stub, to be returned when no other stub is found for a given query: +With the above stub defined, any query for "New York, NY" will return the results array that follows. You can also set a default stub, to be returned when no other stub matches a given query: - Geocoder.configure(:lookup => :test) - Geocoder::Lookup::Test.set_default_stub( [ { 'coordinates' => [40.7143528, -74.0059731], 'address' => 'New York, NY, USA', @@ -1098,15 +534,39 @@ ] ) Notes: -- Keys must be strings not symbols when calling `add_stub` or `set_default_stub`. For example `'latitude' =>` not `:latitude =>`. +- Keys must be strings (not symbols) when calling `add_stub` or `set_default_stub`. For example `'country' =>` not `:country =>`. - To clear stubs (e.g. prior to another spec), use `Geocoder::Lookup::Test.reset`. This will clear all stubs _including the default stub_. - The stubbed result objects returned by the Test lookup do not support all the methods real result objects do. If you need to test interaction with real results it may be better to use an external stubbing tool and something like WebMock or VCR to prevent network calls. +Error Handling +-------------- + +By default Geocoder will rescue any exceptions raised by calls to a geocoding service and return an empty array. 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.configure(always_raise: [SocketError, Timeout::Error]) + +You can also do this to raise all exceptions: + + Geocoder.configure(always_raise: :all) + +The raise-able exceptions are: + + SocketError + Timeout::Error + Geocoder::OverQueryLimitError + Geocoder::RequestDenied + Geocoder::InvalidRequest + Geocoder::InvalidApiKey + Geocoder::ServiceUnavailable + +Note that only a few of the above exceptions are raised by any given lookup, so there's no guarantee if you configure Geocoder to raise `ServiceUnavailable` that it will actually be raised under those conditions (because most APIs don't return 503 when they should; you may get a `Timeout::Error` instead). Please see the source code for your particular lookup for details. + + Command Line Interface ---------------------- When you install the Geocoder gem it adds a `geocode` command to your shell. You can search for a street address, IP address, postal code, coordinates, etc just like you can with the Geocoder.search method for example: @@ -1116,110 +576,39 @@ Full address: 1500 Sugar Bowl Dr, New Orleans, LA 70112, USA City: New Orleans State/province: Louisiana Postal code: 70112 Country: United States - Google map: http://maps.google.com/maps?q=29.952211,-90.080563 + Map: http://maps.google.com/maps?q=29.952211,-90.080563 There are also a number of options for setting the geocoding API, key, and language, viewing the raw JSON response, and more. Please run `geocode -h` for details. -Numeric Data Types and Precision --------------------------------- -Geocoder works with any numeric data type (e.g. float, double, decimal) on which trig (and other mathematical) functions can be performed. +Technical Discussions +--------------------- -A summary of the relationship between geographic precision and the number of decimal places in latitude and longitude degree values is available on [Wikipedia](http://en.wikipedia.org/wiki/Decimal_degrees#Accuracy). As an example: at the equator, latitude/longitude values with 4 decimal places give about 11 metres precision, whereas 5 decimal places gives roughly 1 metre precision. +### Distance Queries in SQLite -Notes on MongoDB ----------------- - -### The Near Method - -Mongo document classes (Mongoid and MongoMapper) have a built-in `near` scope, but since it only works two-dimensions Geocoder overrides it with its own spherical `near` method in geocoded classes. - -### Latitude/Longitude Order - -Coordinates are generally printed and spoken as latitude, then longitude ([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 `to_coordinates` instance method provided by Geocoder. For example: - - obj.to_coordinates # => [37.7941013, -122.3951096] # [lat, lon] - -Calling `obj.coordinates` 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 `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 --------------------------------- - -In MySQL and Postgres, the finding of objects near a given point is sped up by using a bounding box to limit the number of points over which a full distance calculation needs to be done. - -To take advantage of this optimisation, you need to add a composite index on latitude and longitude. In your Rails migration: - - add_index :table, [:latitude, :longitude] - - -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. - -### Discussion - There are few options for finding objects near a given point in SQLite without installing extensions: 1. 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. 2. 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. 3. 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. +### Numeric Data Types and Precision -Tests ------ +Geocoder works with any numeric data type (e.g. float, double, decimal) on which trig (and other mathematical) functions can be performed. -Geocoder comes with a test suite (just run `rake test`) that mocks ActiveRecord and is focused on testing the aspects of Geocoder that do not involve executing database queries. Geocoder uses many database engine-specific queries which must be tested against all supported databases (SQLite, MySQL, etc). Ideally this involves creating a full, working Rails application, and that seems beyond the scope of the included test suite. As such, I have created a separate repository which includes a full-blown Rails application and some utilities for easily running tests against multiple environments: +A summary of the relationship between geographic precision and the number of decimal places in latitude and longitude degree values is available on [Wikipedia](http://en.wikipedia.org/wiki/Decimal_degrees#Accuracy). As an example: at the equator, latitude/longitude values with 4 decimal places give about 11 metres precision, whereas 5 decimal places gives roughly 1 metre precision. -http://github.com/alexreisner/geocoder_test - -Error Handling --------------- - -By default Geocoder will rescue any exceptions raised by calls to a geocoding service and return an empty array. 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.configure(:always_raise => [SocketError, Timeout::Error]) - -You can also do this to raise all exceptions: - - Geocoder.configure(:always_raise => :all) - -The raise-able exceptions are: - - SocketError - Timeout::Error - Geocoder::OverQueryLimitError - Geocoder::RequestDenied - Geocoder::InvalidRequest - Geocoder::InvalidApiKey - Geocoder::ServiceUnavailable - -Note that only a few of the above exceptions are raised by any given lookup, so there's no guarantee if you configure Geocoder to raise `ServiceUnavailable` that it will actually be raised under those conditions (because most APIs don't return 503 when they should; you may get a `Timeout::Error` instead). Please see the source code for your particular lookup for details. - - Troubleshooting --------------- ### Mongoid @@ -1249,51 +638,56 @@ ### Unexpected Responses from Geocoding Services Take a look at the server's raw response. You can do this by getting the request URL in an app console: - Geocoder::Lookup.get(:google).query_url(Geocoder::Query.new("...")) + Geocoder::Lookup.get(:nominatim).query_url(Geocoder::Query.new("...")) -Replace `:google` with the lookup you are using and replace `...` with the address you are trying to geocode. Then visit the returned URL in your web browser. Often the API will return an error message that helps you resolve the problem. If, after reading the raw response, you believe there is a problem with Geocoder, please post an issue and include both the URL and raw response body. +Replace `:nominatim` with the lookup you are using and replace `...` with the address you are trying to geocode. Then visit the returned URL in your web browser. Often the API will return an error message that helps you resolve the problem. If, after reading the raw response, you believe there is a problem with Geocoder, please post an issue and include both the URL and raw response body. You can also fetch the response in the console: - Geocoder::Lookup.get(:google).send(:fetch_raw_data, Geocoder::Query.new("...")) + Geocoder::Lookup.get(:nominatim).send(:fetch_raw_data, Geocoder::Query.new("...")) -Reporting Issues ----------------- +Known Issues +------------ -When reporting an issue, please list the version of Geocoder you are using and any relevant information about your application (Rails version, database type and version, etc). Also avoid vague language like "it doesn't work." Please describe as specifically as you can what behavior you are actually seeing (eg: an error message? a nil return value?). +### Using `count` with Rails 4.1+ -Please DO NOT use GitHub issues to ask questions about how to use Geocoder. Sites like [StackOverflow](http://www.stackoverflow.com/) are a better forum for such discussions. +Due to [a change in ActiveRecord's `count` method](https://github.com/rails/rails/pull/10710) you will need to use `count(:all)` to explicitly count all columns ("*") when using a `near` scope. Using `near` and calling `count` with no argument will cause exceptions in many cases. +### Using `near` with `includes` -### Known Issues - -#### Using `near` with `includes` - 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 of using `includes` to reduce the number of database queries, try using `joins` with either the `:select` option or a call to `preload`. For example: # Pass a :select option to the near scope to get the columns you want. # Instead of City.near(...).includes(:venues), try: - City.near("Omaha, NE", 20, :select => "cities.*, venues.*").joins(:venues) + City.near("Omaha, NE", 20, select: "cities.*, venues.*").joins(:venues) # This preload call will normally trigger two queries regardless of the # number of results; one query on hotels, and one query on administrators. # Instead of Hotel.near(...).includes(:administrator), try: Hotel.near("London, UK", 50).joins(:administrator).preload(:administrator) If anyone has a more elegant solution to this problem I am very interested in seeing it. -#### Using `near` with objects close to the 180th meridian +### Using `near` with objects close to the 180th meridian The `near` method will not look across the 180th meridian to find objects close to a given point. In practice this is rarely an issue outside of New Zealand and certain surrounding islands. This problem does not exist with the zero-meridian. The problem is due to a shortcoming of the Haversine formula which Geocoder uses to calculate distances. +Reporting Issues +---------------- + +When reporting an issue, please list the version of Geocoder you are using and any relevant information about your application (Rails version, database type and version, etc). Please describe as specifically as you can what behavior you are seeing (eg: an error message? a nil return value?). + +Please DO NOT use GitHub issues to ask questions about how to use Geocoder. Sites like [StackOverflow](http://www.stackoverflow.com/) are a better forum for such discussions. + + Contributing ------------ Contributions are welcome via Github pull requests. If you are new to the project and looking for a way to get involved, try picking up an issue with a "beginner-task" label. Hints about what needs to be done are usually provided. @@ -1307,6 +701,6 @@ * Be willing to accept criticism and work on improving your code; Geocoder is used by thousands of developers and care must be taken not to introduce bugs. * Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request. * If your pull request is merged, please do not ask for an immediate release of the gem. There are many factors contributing to when releases occur (remember that they affect thousands of apps with Geocoder in their Gemfiles). If necessary, please install from the Github source until the next official release. -Copyright (c) 2009-15 Alex Reisner, released under the MIT license +Copyright (c) 2009-18 Alex Reisner, released under the MIT license.