geocoder 1.6.4 → 1.8.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +61 -0
- data/LICENSE +1 -1
- data/README.md +329 -235
- data/examples/app_defined_lookup_services.rb +22 -0
- data/lib/generators/geocoder/config/templates/initializer.rb +6 -1
- data/lib/geocoder/cache.rb +16 -33
- data/lib/geocoder/cache_stores/base.rb +40 -0
- data/lib/geocoder/cache_stores/generic.rb +35 -0
- data/lib/geocoder/cache_stores/redis.rb +34 -0
- data/lib/geocoder/configuration.rb +17 -4
- data/lib/geocoder/ip_address.rb +9 -0
- data/lib/geocoder/lookup.rb +33 -4
- data/lib/geocoder/lookups/abstract_api.rb +46 -0
- data/lib/geocoder/lookups/amap.rb +2 -2
- data/lib/geocoder/lookups/amazon_location_service.rb +55 -0
- data/lib/geocoder/lookups/ban_data_gouv_fr.rb +1 -1
- data/lib/geocoder/lookups/base.rb +2 -1
- data/lib/geocoder/lookups/bing.rb +1 -1
- data/lib/geocoder/lookups/esri.rb +18 -5
- data/lib/geocoder/lookups/freegeoip.rb +8 -6
- data/lib/geocoder/lookups/geoapify.rb +78 -0
- data/lib/geocoder/lookups/geoip2.rb +4 -0
- data/lib/geocoder/lookups/geoportail_lu.rb +1 -1
- data/lib/geocoder/lookups/google_places_details.rb +20 -0
- data/lib/geocoder/lookups/google_places_search.rb +20 -3
- data/lib/geocoder/lookups/here.rb +25 -20
- data/lib/geocoder/lookups/ip2location.rb +10 -6
- data/lib/geocoder/lookups/ipbase.rb +49 -0
- data/lib/geocoder/lookups/ipdata_co.rb +1 -1
- data/lib/geocoder/lookups/ipqualityscore.rb +50 -0
- data/lib/geocoder/lookups/location_iq.rb +5 -1
- data/lib/geocoder/lookups/maxmind_local.rb +7 -1
- data/lib/geocoder/lookups/melissa_street.rb +41 -0
- data/lib/geocoder/lookups/pc_miler.rb +85 -0
- data/lib/geocoder/lookups/photon.rb +89 -0
- data/lib/geocoder/lookups/test.rb +5 -0
- data/lib/geocoder/lookups/twogis.rb +58 -0
- data/lib/geocoder/lookups/uk_ordnance_survey_names.rb +1 -1
- data/lib/geocoder/lookups/yandex.rb +3 -3
- data/lib/geocoder/results/abstract_api.rb +146 -0
- data/lib/geocoder/results/amazon_location_service.rb +57 -0
- data/lib/geocoder/results/ban_data_gouv_fr.rb +27 -2
- data/lib/geocoder/results/esri.rb +5 -2
- data/lib/geocoder/results/geoapify.rb +179 -0
- data/lib/geocoder/results/here.rb +20 -25
- data/lib/geocoder/results/ipbase.rb +40 -0
- data/lib/geocoder/results/ipqualityscore.rb +54 -0
- data/lib/geocoder/results/ipregistry.rb +4 -8
- data/lib/geocoder/results/mapbox.rb +10 -4
- data/lib/geocoder/results/melissa_street.rb +46 -0
- data/lib/geocoder/results/nationaal_georegister_nl.rb +1 -1
- data/lib/geocoder/results/nominatim.rb +24 -16
- data/lib/geocoder/results/pc_miler.rb +98 -0
- data/lib/geocoder/results/photon.rb +119 -0
- data/lib/geocoder/results/twogis.rb +76 -0
- data/lib/geocoder/version.rb +1 -1
- data/lib/maxmind_database.rb +8 -8
- data/lib/tasks/maxmind.rake +1 -1
- metadata +28 -8
- data/examples/autoexpire_cache_dalli.rb +0 -62
- data/examples/autoexpire_cache_redis.rb +0 -30
data/README.md
CHANGED
@@ -5,7 +5,6 @@ Geocoder
|
|
5
5
|
|
6
6
|
[![Gem Version](https://badge.fury.io/rb/geocoder.svg)](http://badge.fury.io/rb/geocoder)
|
7
7
|
[![Code Climate](https://codeclimate.com/github/alexreisner/geocoder/badges/gpa.svg)](https://codeclimate.com/github/alexreisner/geocoder)
|
8
|
-
[![Build Status](https://travis-ci.org/alexreisner/geocoder.svg?branch=master)](https://travis-ci.org/alexreisner/geocoder)
|
9
8
|
|
10
9
|
Key features:
|
11
10
|
|
@@ -18,9 +17,9 @@ Key features:
|
|
18
17
|
|
19
18
|
Compatibility:
|
20
19
|
|
21
|
-
* Ruby versions: 2.
|
20
|
+
* Ruby versions: 2.1+, and JRuby.
|
22
21
|
* Databases: MySQL, PostgreSQL, SQLite, and MongoDB.
|
23
|
-
* Rails:
|
22
|
+
* Rails: 5.x, 6.x, and 7.x.
|
24
23
|
* Works outside of Rails with the `json` (for MRI) or `json_pure` (for JRuby) gem.
|
25
24
|
|
26
25
|
|
@@ -51,8 +50,8 @@ The Rest:
|
|
51
50
|
* [Technical Discussions](#technical-discussions)
|
52
51
|
* [Troubleshooting](#troubleshooting)
|
53
52
|
* [Known Issues](#known-issues)
|
54
|
-
* [Reporting Issues](#reporting-
|
55
|
-
* [Contributing](#
|
53
|
+
* [Reporting Issues](https://github.com/alexreisner/geocoder/blob/master/CONTRIBUTING.md#reporting-bugs)
|
54
|
+
* [Contributing](https://github.com/alexreisner/geocoder/blob/master/CONTRIBUTING.md#making-changes)
|
56
55
|
|
57
56
|
See Also:
|
58
57
|
|
@@ -64,23 +63,29 @@ Basic Search
|
|
64
63
|
|
65
64
|
In its simplest form, Geocoder takes an address and searches for its latitude/longitude coordinates:
|
66
65
|
|
67
|
-
|
68
|
-
|
69
|
-
|
66
|
+
```ruby
|
67
|
+
results = Geocoder.search("Paris")
|
68
|
+
results.first.coordinates
|
69
|
+
# => [48.856614, 2.3522219] # latitude and longitude
|
70
|
+
```
|
70
71
|
|
71
72
|
The reverse is possible too. Given coordinates, it finds an address:
|
72
73
|
|
73
|
-
|
74
|
-
|
75
|
-
|
74
|
+
```ruby
|
75
|
+
results = Geocoder.search([48.856614, 2.3522219])
|
76
|
+
results.first.address
|
77
|
+
# => "Hôtel de Ville, 75004 Paris, France"
|
78
|
+
```
|
76
79
|
|
77
|
-
You can also look up the location of an IP
|
80
|
+
You can also look up the location of an IP address:
|
78
81
|
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
82
|
+
```ruby
|
83
|
+
results = Geocoder.search("172.56.21.89")
|
84
|
+
results.first.coordinates
|
85
|
+
# => [30.267153, -97.7430608]
|
86
|
+
results.first.country
|
87
|
+
# => "United States"
|
88
|
+
```
|
84
89
|
|
85
90
|
**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).
|
86
91
|
|
@@ -92,30 +97,40 @@ To automatically geocode your objects:
|
|
92
97
|
|
93
98
|
**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:
|
94
99
|
|
95
|
-
|
96
|
-
|
97
|
-
|
100
|
+
```ruby
|
101
|
+
def address
|
102
|
+
[street, city, state, country].compact.join(', ')
|
103
|
+
end
|
104
|
+
```
|
98
105
|
|
99
106
|
**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.)
|
100
107
|
|
101
108
|
**3.** In your model, tell geocoder where to find the object's address:
|
102
109
|
|
103
|
-
|
110
|
+
```ruby
|
111
|
+
geocoded_by :address
|
112
|
+
```
|
104
113
|
|
105
114
|
This adds a `geocode` method which you can invoke via callback:
|
106
115
|
|
107
|
-
|
116
|
+
```ruby
|
117
|
+
after_validation :geocode
|
118
|
+
```
|
108
119
|
|
109
120
|
Reverse geocoding (given lat/lon coordinates, find an address) is similar:
|
110
121
|
|
111
|
-
|
112
|
-
|
122
|
+
```ruby
|
123
|
+
reverse_geocoded_by :latitude, :longitude
|
124
|
+
after_validation :reverse_geocode
|
125
|
+
```
|
113
126
|
|
114
127
|
With any geocoded objects, you can do the following:
|
115
128
|
|
116
|
-
|
117
|
-
|
118
|
-
|
129
|
+
```ruby
|
130
|
+
obj.distance_to([43.9,-98.6]) # distance from obj to point
|
131
|
+
obj.bearing_to([43.9,-98.6]) # bearing from obj to point
|
132
|
+
obj.bearing_from(obj2) # bearing from obj2 to obj
|
133
|
+
```
|
119
134
|
|
120
135
|
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.
|
121
136
|
|
@@ -123,18 +138,24 @@ The `bearing_from/to` methods take a single argument which can be: a `[lat,lon]`
|
|
123
138
|
|
124
139
|
Before you can call `geocoded_by` you'll need to include the necessary module using one of the following:
|
125
140
|
|
126
|
-
|
127
|
-
|
141
|
+
```ruby
|
142
|
+
include Geocoder::Model::Mongoid
|
143
|
+
include Geocoder::Model::MongoMapper
|
144
|
+
```
|
128
145
|
|
129
146
|
### Latitude/Longitude Order in MongoDB
|
130
147
|
|
131
148
|
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:
|
132
149
|
|
133
|
-
|
150
|
+
```ruby
|
151
|
+
obj.to_coordinates # => [37.7941013, -122.3951096] # [lat, lon]
|
152
|
+
```
|
134
153
|
|
135
154
|
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:
|
136
155
|
|
137
|
-
|
156
|
+
```ruby
|
157
|
+
obj.coordinates # => [-122.3951096, 37.7941013] # [lon, lat]
|
158
|
+
```
|
138
159
|
|
139
160
|
So, be careful.
|
140
161
|
|
@@ -142,7 +163,9 @@ So, be careful.
|
|
142
163
|
|
143
164
|
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:
|
144
165
|
|
145
|
-
|
166
|
+
```ruby
|
167
|
+
extend Geocoder::Model::ActiveRecord
|
168
|
+
```
|
146
169
|
|
147
170
|
|
148
171
|
Geospatial Database Queries
|
@@ -152,19 +175,23 @@ Geospatial Database Queries
|
|
152
175
|
|
153
176
|
To find objects by location, use the following scopes:
|
154
177
|
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
178
|
+
```ruby
|
179
|
+
Venue.near('Omaha, NE, US') # venues within 20 miles of Omaha
|
180
|
+
Venue.near([40.71, -100.23], 50) # venues within 50 miles of a point
|
181
|
+
Venue.near([40.71, -100.23], 50, units: :km) # venues within 50 kilometres of a point
|
182
|
+
Venue.geocoded # venues with coordinates
|
183
|
+
Venue.not_geocoded # venues without coordinates
|
184
|
+
```
|
160
185
|
|
161
186
|
With geocoded objects you can do things like this:
|
162
187
|
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
188
|
+
```ruby
|
189
|
+
if obj.geocoded?
|
190
|
+
obj.nearbys(30) # other objects within 30 miles
|
191
|
+
obj.distance_from([40.714,-100.234]) # distance from arbitrary point to object
|
192
|
+
obj.bearing_to("Paris, France") # direction from object to arbitrary point
|
193
|
+
end
|
194
|
+
```
|
168
195
|
|
169
196
|
### For MongoDB-backed models:
|
170
197
|
|
@@ -176,8 +203,10 @@ Geocoding HTTP Requests
|
|
176
203
|
|
177
204
|
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:
|
178
205
|
|
179
|
-
|
180
|
-
|
206
|
+
```ruby
|
207
|
+
# returns Geocoder::Result object
|
208
|
+
result = request.location
|
209
|
+
```
|
181
210
|
|
182
211
|
**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).
|
183
212
|
|
@@ -191,71 +220,82 @@ Geocoder supports a variety of street and IP address geocoding services. The def
|
|
191
220
|
|
192
221
|
To create a Rails initializer with sample configuration:
|
193
222
|
|
194
|
-
|
223
|
+
```sh
|
224
|
+
rails generate geocoder:config
|
225
|
+
```
|
195
226
|
|
196
227
|
Some common options are:
|
197
228
|
|
198
|
-
|
199
|
-
|
229
|
+
```ruby
|
230
|
+
# config/initializers/geocoder.rb
|
231
|
+
Geocoder.configure(
|
232
|
+
# street address geocoding service (default :nominatim)
|
233
|
+
lookup: :yandex,
|
200
234
|
|
201
|
-
|
202
|
-
|
235
|
+
# IP address geocoding service (default :ipinfo_io)
|
236
|
+
ip_lookup: :maxmind,
|
203
237
|
|
204
|
-
|
205
|
-
|
238
|
+
# to use an API key:
|
239
|
+
api_key: "...",
|
206
240
|
|
207
|
-
|
208
|
-
|
241
|
+
# geocoding service request timeout, in seconds (default 3):
|
242
|
+
timeout: 5,
|
209
243
|
|
210
|
-
|
211
|
-
|
244
|
+
# set default units to kilometers:
|
245
|
+
units: :km,
|
212
246
|
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
247
|
+
# caching (see Caching section below for details):
|
248
|
+
cache: Redis.new,
|
249
|
+
cache_options: {
|
250
|
+
expiration: 1.day, # Defaults to `nil`
|
251
|
+
prefix: "another_key:" # Defaults to `geocoder:`
|
252
|
+
}
|
253
|
+
)
|
254
|
+
```
|
221
255
|
|
222
256
|
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:
|
223
257
|
|
224
|
-
|
225
|
-
|
258
|
+
```ruby
|
259
|
+
# with Google:
|
260
|
+
Geocoder.search("Middletown", bounds: [[40.6,-77.9], [39.9,-75.9]])
|
261
|
+
```
|
226
262
|
|
227
263
|
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:
|
228
264
|
|
229
|
-
|
230
|
-
|
265
|
+
```ruby
|
266
|
+
# Nominatim's `countrycodes` parameter:
|
267
|
+
Geocoder.search("Rome", params: {countrycodes: "us,ca"})
|
231
268
|
|
232
|
-
|
233
|
-
|
269
|
+
# Google's `region` parameter:
|
270
|
+
Geocoder.search("Rome", params: {region: "..."})
|
271
|
+
```
|
234
272
|
|
235
273
|
### Configuring Multiple Services
|
236
274
|
|
237
275
|
You can configure multiple geocoding services at once by using the service's name as a key for a sub-configuration hash, like this:
|
238
276
|
|
239
|
-
|
277
|
+
```ruby
|
278
|
+
Geocoder.configure(
|
240
279
|
|
241
|
-
|
242
|
-
|
280
|
+
timeout: 2,
|
281
|
+
cache: Redis.new,
|
243
282
|
|
244
|
-
|
245
|
-
|
246
|
-
|
247
|
-
|
283
|
+
yandex: {
|
284
|
+
api_key: "...",
|
285
|
+
timeout: 5
|
286
|
+
},
|
248
287
|
|
249
|
-
|
250
|
-
|
251
|
-
|
288
|
+
baidu: {
|
289
|
+
api_key: "..."
|
290
|
+
},
|
252
291
|
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
292
|
+
maxmind: {
|
293
|
+
api_key: "...",
|
294
|
+
service: :omni
|
295
|
+
}
|
257
296
|
|
258
|
-
|
297
|
+
)
|
298
|
+
```
|
259
299
|
|
260
300
|
Lookup-specific settings override global settings so, in this example, the timeout for all lookups is 2 seconds, except for Yandex which is 5.
|
261
301
|
|
@@ -267,12 +307,16 @@ Performance and Optimization
|
|
267
307
|
|
268
308
|
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:
|
269
309
|
|
270
|
-
|
310
|
+
```ruby
|
311
|
+
add_index :table, [:latitude, :longitude]
|
312
|
+
```
|
271
313
|
|
272
314
|
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:
|
273
315
|
|
274
|
-
|
275
|
-
|
316
|
+
```ruby
|
317
|
+
include Geocoder::Model::Mongoid
|
318
|
+
geocoded_by :address, skip_index: true
|
319
|
+
```
|
276
320
|
|
277
321
|
### Avoiding Unnecessary API Requests
|
278
322
|
|
@@ -283,13 +327,17 @@ Geocoding only needs to be performed under certain conditions. To avoid unnecess
|
|
283
327
|
|
284
328
|
The exact code will vary depending on the method you use for your geocodable string, but it would be something like this:
|
285
329
|
|
286
|
-
|
330
|
+
```ruby
|
331
|
+
after_validation :geocode, if: ->(obj){ obj.address.present? and obj.address_changed? }
|
332
|
+
```
|
287
333
|
|
288
334
|
### Caching
|
289
335
|
|
290
336
|
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:
|
291
337
|
|
292
|
-
|
338
|
+
```ruby
|
339
|
+
Geocoder.configure(cache: Redis.new)
|
340
|
+
```
|
293
341
|
|
294
342
|
This example uses Redis, but the cache store can be any object that supports these methods:
|
295
343
|
|
@@ -300,71 +348,91 @@ This example uses Redis, but the cache store can be any object that supports the
|
|
300
348
|
|
301
349
|
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).
|
302
350
|
|
351
|
+
When using Rails use the Generic cache store as an adapter around `Rails.cache`:
|
352
|
+
|
353
|
+
```ruby
|
354
|
+
Geocoder.configure(cache: Geocoder::CacheStore::Generic.new(Rails.cache, {}))
|
355
|
+
```
|
356
|
+
|
303
357
|
You can also set a custom prefix to be used for cache keys:
|
304
358
|
|
305
|
-
|
359
|
+
```ruby
|
360
|
+
Geocoder.configure(cache_options: { prefix: "..." })
|
361
|
+
```
|
306
362
|
|
307
363
|
By default the prefix is `geocoder:`
|
308
364
|
|
309
365
|
If you need to expire cached content:
|
310
366
|
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
367
|
+
```ruby
|
368
|
+
Geocoder::Lookup.get(Geocoder.config[:lookup]).cache.expire(:all) # expire cached results for current Lookup
|
369
|
+
Geocoder::Lookup.get(:nominatim).cache.expire("http://...") # expire cached result for a specific URL
|
370
|
+
Geocoder::Lookup.get(:nominatim).cache.expire(:all) # expire cached results for Nominatim
|
371
|
+
# expire all cached results for all Lookups.
|
372
|
+
# Be aware that this methods spawns a new Lookup object for each Service
|
373
|
+
Geocoder::Lookup.all_services.each{|service| Geocoder::Lookup.get(service).cache.expire(:all)}
|
374
|
+
```
|
317
375
|
|
318
376
|
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.
|
319
377
|
|
320
|
-
For an example of a cache store with URL expiry, please see examples/autoexpire_cache.rb
|
321
|
-
|
322
378
|
_Before you implement caching in your app please be sure that doing so does not violate the Terms of Service for your geocoding service._
|
323
379
|
|
380
|
+
Not all services support caching, [check the service limitations in the API guide for more information](https://github.com/alexreisner/geocoder/blob/master/README_API_GUIDE.md).
|
324
381
|
|
325
382
|
Advanced Model Configuration
|
326
383
|
----------------------------
|
327
384
|
|
328
385
|
You are not stuck with the `latitude` and `longitude` database column names (with ActiveRecord) or the `coordinates` array (Mongo) for storing coordinates. For example:
|
329
386
|
|
330
|
-
|
331
|
-
|
387
|
+
```ruby
|
388
|
+
geocoded_by :address, latitude: :lat, longitude: :lon # ActiveRecord
|
389
|
+
geocoded_by :address, coordinates: :coords # MongoDB
|
390
|
+
```
|
332
391
|
|
333
392
|
For reverse geocoding, you can specify the attribute where the address will be stored. For example:
|
334
393
|
|
335
|
-
|
336
|
-
|
394
|
+
```ruby
|
395
|
+
reverse_geocoded_by :latitude, :longitude, address: :loc # ActiveRecord
|
396
|
+
reverse_geocoded_by :coordinates, address: :street_address # MongoDB
|
397
|
+
```
|
337
398
|
|
338
399
|
To specify geocoding parameters in your model:
|
339
400
|
|
340
|
-
|
401
|
+
```ruby
|
402
|
+
geocoded_by :address, params: {region: "..."}
|
403
|
+
```
|
341
404
|
|
342
405
|
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:
|
343
406
|
|
344
|
-
|
407
|
+
```ruby
|
408
|
+
geocoded_by :address, lookup: lambda{ |obj| obj.geocoder_lookup }
|
345
409
|
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
|
410
|
+
def geocoder_lookup
|
411
|
+
if country_code == "RU"
|
412
|
+
:yandex
|
413
|
+
elsif country_code == "CN"
|
414
|
+
:baidu
|
415
|
+
else
|
416
|
+
:nominatim
|
417
|
+
end
|
418
|
+
end
|
419
|
+
```
|
355
420
|
|
356
421
|
### Custom Result Handling
|
357
422
|
|
358
423
|
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:
|
359
424
|
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
425
|
+
```ruby
|
426
|
+
reverse_geocoded_by :latitude, :longitude do |obj,results|
|
427
|
+
if geo = results.first
|
428
|
+
obj.city = geo.city
|
429
|
+
obj.zipcode = geo.postal_code
|
430
|
+
obj.country = geo.country_code
|
431
|
+
end
|
432
|
+
end
|
433
|
+
|
434
|
+
after_validation :reverse_geocode
|
435
|
+
```
|
368
436
|
|
369
437
|
Every `Geocoder::Result` object, `result`, provides the following data:
|
370
438
|
|
@@ -390,23 +458,26 @@ You can apply both forward and reverse geocoding to the same model (i.e. users c
|
|
390
458
|
|
391
459
|
For example:
|
392
460
|
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
|
461
|
+
```ruby
|
462
|
+
class Venue
|
463
|
+
# build an address from street, city, and state attributes
|
464
|
+
geocoded_by :address_from_components
|
397
465
|
|
398
|
-
|
399
|
-
|
400
|
-
|
466
|
+
# store the fetched address in the full_address attribute
|
467
|
+
reverse_geocoded_by :latitude, :longitude, address: :full_address
|
468
|
+
end
|
469
|
+
```
|
401
470
|
|
402
471
|
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:
|
403
472
|
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
|
473
|
+
```ruby
|
474
|
+
class Venue
|
475
|
+
geocoded_by :address,
|
476
|
+
latitude: :fetched_latitude,
|
477
|
+
longitude: :fetched_longitude
|
478
|
+
reverse_geocoded_by :latitude, :longitude
|
479
|
+
end
|
480
|
+
```
|
410
481
|
|
411
482
|
|
412
483
|
Advanced Database Queries
|
@@ -416,21 +487,29 @@ Advanced Database Queries
|
|
416
487
|
|
417
488
|
The default `near` search looks for objects within a circle. To search within a doughnut or ring use the `:min_radius` option:
|
418
489
|
|
419
|
-
|
490
|
+
```ruby
|
491
|
+
Venue.near("Austin, TX", 200, min_radius: 40)
|
492
|
+
```
|
420
493
|
|
421
494
|
To search within a rectangle (note that results will *not* include `distance` and `bearing` attributes):
|
422
495
|
|
423
|
-
|
424
|
-
|
425
|
-
|
496
|
+
```ruby
|
497
|
+
sw_corner = [40.71, 100.23]
|
498
|
+
ne_corner = [36.12, 88.65]
|
499
|
+
Venue.within_bounding_box(sw_corner, ne_corner)
|
500
|
+
```
|
426
501
|
|
427
502
|
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:
|
428
503
|
|
429
|
-
|
504
|
+
```ruby
|
505
|
+
Venue.near([40.71, 99.23], :effective_radius)
|
506
|
+
```
|
430
507
|
|
431
508
|
If you store multiple sets of coordinates for each object, you can specify latitude and longitude columns to use for a search:
|
432
509
|
|
433
|
-
|
510
|
+
```ruby
|
511
|
+
Venue.near("Paris", 50, latitude: :secondary_latitude, longitude: :secondary_longitude)
|
512
|
+
```
|
434
513
|
|
435
514
|
### Distance and Bearing
|
436
515
|
|
@@ -450,9 +529,11 @@ Results are automatically sorted by distance from the search point, closest to f
|
|
450
529
|
|
451
530
|
You can convert these to compass point names via provided method:
|
452
531
|
|
453
|
-
|
454
|
-
|
455
|
-
|
532
|
+
```ruby
|
533
|
+
Geocoder::Calculations.compass_point(355) # => "N"
|
534
|
+
Geocoder::Calculations.compass_point(45) # => "NE"
|
535
|
+
Geocoder::Calculations.compass_point(208) # => "SW"
|
536
|
+
```
|
456
537
|
|
457
538
|
_Note: when running queries on SQLite, `distance` and `bearing` are provided for consistency only. They are not very accurate._
|
458
539
|
|
@@ -464,13 +545,15 @@ Geospatial Calculations
|
|
464
545
|
|
465
546
|
The `Geocoder::Calculations` module contains some useful methods:
|
466
547
|
|
467
|
-
|
468
|
-
|
469
|
-
|
548
|
+
```ruby
|
549
|
+
# find the distance between two arbitrary points
|
550
|
+
Geocoder::Calculations.distance_between([47.858205,2.294359], [40.748433,-73.985655])
|
551
|
+
=> 3619.77359999382 # in configured units (default miles)
|
470
552
|
|
471
|
-
|
472
|
-
|
473
|
-
|
553
|
+
# find the geographic center (aka center of gravity) of objects or points
|
554
|
+
Geocoder::Calculations.geographic_center([city1, city2, [40.22,-73.99], city4])
|
555
|
+
=> [35.14968, -90.048929]
|
556
|
+
```
|
474
557
|
|
475
558
|
See [the code](https://github.com/alexreisner/geocoder/blob/master/lib/geocoder/calculations.rb) for more!
|
476
559
|
|
@@ -480,19 +563,27 @@ Batch Geocoding
|
|
480
563
|
|
481
564
|
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:
|
482
565
|
|
483
|
-
|
566
|
+
```sh
|
567
|
+
rake geocode:all CLASS=YourModel
|
568
|
+
```
|
484
569
|
|
485
570
|
If you need reverse geocoding instead, call the task with REVERSE=true:
|
486
571
|
|
487
|
-
|
572
|
+
```sh
|
573
|
+
rake geocode:all CLASS=YourModel REVERSE=true
|
574
|
+
```
|
488
575
|
|
489
576
|
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:
|
490
577
|
|
491
|
-
|
578
|
+
```sh
|
579
|
+
rake geocode:all CLASS=YourModel SLEEP=0.25 BATCH=100
|
580
|
+
```
|
492
581
|
|
493
582
|
To avoid exceeding per-day limits you can add a `LIMIT` option. However, this will ignore the `BATCH` value, if provided.
|
494
583
|
|
495
|
-
|
584
|
+
```sh
|
585
|
+
rake geocode:all CLASS=YourModel LIMIT=1000
|
586
|
+
```
|
496
587
|
|
497
588
|
|
498
589
|
Testing
|
@@ -500,42 +591,54 @@ Testing
|
|
500
591
|
|
501
592
|
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 and/or `:ip_lookup`
|
502
593
|
|
503
|
-
|
594
|
+
```ruby
|
595
|
+
Geocoder.configure(lookup: :test, ip_lookup: :test)
|
596
|
+
```
|
504
597
|
|
505
598
|
Add stubs to define the results that will be returned:
|
506
599
|
|
507
|
-
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
600
|
+
```ruby
|
601
|
+
Geocoder::Lookup::Test.add_stub(
|
602
|
+
"New York, NY", [
|
603
|
+
{
|
604
|
+
'coordinates' => [40.7143528, -74.0059731],
|
605
|
+
'address' => 'New York, NY, USA',
|
606
|
+
'state' => 'New York',
|
607
|
+
'state_code' => 'NY',
|
608
|
+
'country' => 'United States',
|
609
|
+
'country_code' => 'US'
|
610
|
+
}
|
611
|
+
]
|
612
|
+
)
|
613
|
+
```
|
519
614
|
|
520
615
|
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:
|
521
616
|
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
|
532
|
-
|
533
|
-
|
617
|
+
```ruby
|
618
|
+
Geocoder::Lookup::Test.set_default_stub(
|
619
|
+
[
|
620
|
+
{
|
621
|
+
'coordinates' => [40.7143528, -74.0059731],
|
622
|
+
'address' => 'New York, NY, USA',
|
623
|
+
'state' => 'New York',
|
624
|
+
'state_code' => 'NY',
|
625
|
+
'country' => 'United States',
|
626
|
+
'country_code' => 'US'
|
627
|
+
}
|
628
|
+
]
|
629
|
+
)
|
630
|
+
```
|
631
|
+
|
632
|
+
You may also delete a single stub, or reset all stubs _including the default stub_:
|
633
|
+
|
634
|
+
```ruby
|
635
|
+
Geocoder::Lookup::Test.delete_stub('New York, NY')
|
636
|
+
Geocoder::Lookup::Test.reset
|
637
|
+
```
|
534
638
|
|
535
639
|
Notes:
|
536
640
|
|
537
641
|
- Keys must be strings (not symbols) when calling `add_stub` or `set_default_stub`. For example `'country' =>` not `:country =>`.
|
538
|
-
- To clear stubs (e.g. prior to another spec), use `Geocoder::Lookup::Test.reset`. This will clear all stubs _including the default stub_.
|
539
642
|
- 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.
|
540
643
|
|
541
644
|
|
@@ -544,21 +647,27 @@ Error Handling
|
|
544
647
|
|
545
648
|
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:
|
546
649
|
|
547
|
-
|
650
|
+
```ruby
|
651
|
+
Geocoder.configure(always_raise: [SocketError, Timeout::Error])
|
652
|
+
```
|
548
653
|
|
549
654
|
You can also do this to raise all exceptions:
|
550
655
|
|
551
|
-
|
656
|
+
```ruby
|
657
|
+
Geocoder.configure(always_raise: :all)
|
658
|
+
```
|
552
659
|
|
553
660
|
The raise-able exceptions are:
|
554
661
|
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
|
662
|
+
```ruby
|
663
|
+
SocketError
|
664
|
+
Timeout::Error
|
665
|
+
Geocoder::OverQueryLimitError
|
666
|
+
Geocoder::RequestDenied
|
667
|
+
Geocoder::InvalidRequest
|
668
|
+
Geocoder::InvalidApiKey
|
669
|
+
Geocoder::ServiceUnavailable
|
670
|
+
```
|
562
671
|
|
563
672
|
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.
|
564
673
|
|
@@ -568,15 +677,17 @@ Command Line Interface
|
|
568
677
|
|
569
678
|
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:
|
570
679
|
|
571
|
-
|
572
|
-
|
573
|
-
|
574
|
-
|
575
|
-
|
576
|
-
|
577
|
-
|
578
|
-
|
579
|
-
|
680
|
+
```sh
|
681
|
+
$ geocode 29.951,-90.081
|
682
|
+
Latitude: 29.952211
|
683
|
+
Longitude: -90.080563
|
684
|
+
Full address: 1500 Sugar Bowl Dr, New Orleans, LA 70112, USA
|
685
|
+
City: New Orleans
|
686
|
+
State/province: Louisiana
|
687
|
+
Postal code: 70112
|
688
|
+
Country: United States
|
689
|
+
Map: http://maps.google.com/maps?q=29.952211,-90.080563
|
690
|
+
```
|
580
691
|
|
581
692
|
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.
|
582
693
|
|
@@ -612,8 +723,10 @@ Troubleshooting
|
|
612
723
|
|
613
724
|
If you get one of these errors:
|
614
725
|
|
615
|
-
|
616
|
-
|
726
|
+
```ruby
|
727
|
+
uninitialized constant Geocoder::Model::Mongoid
|
728
|
+
uninitialized constant Geocoder::Model::Mongoid::Mongo
|
729
|
+
```
|
617
730
|
|
618
731
|
you should check your Gemfile to make sure the Mongoid gem is listed _before_ Geocoder. If Mongoid isn't loaded when Geocoder is initialized, Geocoder will not load support for Mongoid.
|
619
732
|
|
@@ -632,19 +745,23 @@ If your application requires quick geocoding responses you will probably need to
|
|
632
745
|
|
633
746
|
For IP address lookups in Rails applications, it is generally NOT a good idea to run `request.location` during a synchronous page load without understanding the speed/behavior of your configured lookup. If the lookup becomes slow, so will your website.
|
634
747
|
|
635
|
-
For the most part, the speed of geocoding requests has little to do with the Geocoder gem. Please take the time to learn about your configured lookup
|
748
|
+
For the most part, the speed of geocoding requests has little to do with the Geocoder gem. Please take the time to learn about your configured lookup before posting performance-related issues.
|
636
749
|
|
637
750
|
### Unexpected Responses from Geocoding Services
|
638
751
|
|
639
752
|
Take a look at the server's raw response. You can do this by getting the request URL in an app console:
|
640
753
|
|
641
|
-
|
754
|
+
```ruby
|
755
|
+
Geocoder::Lookup.get(:nominatim).query_url(Geocoder::Query.new("..."))
|
756
|
+
```
|
642
757
|
|
643
758
|
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.
|
644
759
|
|
645
760
|
You can also fetch the response in the console:
|
646
761
|
|
647
|
-
|
762
|
+
```ruby
|
763
|
+
Geocoder::Lookup.get(:nominatim).send(:fetch_raw_data, Geocoder::Query.new("..."))
|
764
|
+
```
|
648
765
|
|
649
766
|
|
650
767
|
Known Issues
|
@@ -660,14 +777,16 @@ You cannot use the `near` scope with another scope that provides an `includes` o
|
|
660
777
|
|
661
778
|
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:
|
662
779
|
|
663
|
-
|
664
|
-
|
665
|
-
|
780
|
+
```ruby
|
781
|
+
# Pass a :select option to the near scope to get the columns you want.
|
782
|
+
# Instead of City.near(...).includes(:venues), try:
|
783
|
+
City.near("Omaha, NE", 20, select: "cities.*, venues.*").joins(:venues)
|
666
784
|
|
667
|
-
|
668
|
-
|
669
|
-
|
670
|
-
|
785
|
+
# This preload call will normally trigger two queries regardless of the
|
786
|
+
# number of results; one query on hotels, and one query on administrators.
|
787
|
+
# Instead of Hotel.near(...).includes(:administrator), try:
|
788
|
+
Hotel.near("London, UK", 50).joins(:administrator).preload(:administrator)
|
789
|
+
```
|
671
790
|
|
672
791
|
If anyone has a more elegant solution to this problem I am very interested in seeing it.
|
673
792
|
|
@@ -676,29 +795,4 @@ If anyone has a more elegant solution to this problem I am very interested in se
|
|
676
795
|
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.
|
677
796
|
|
678
797
|
|
679
|
-
|
680
|
-
----------------
|
681
|
-
|
682
|
-
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?).
|
683
|
-
|
684
|
-
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.
|
685
|
-
|
686
|
-
|
687
|
-
Contributing
|
688
|
-
------------
|
689
|
-
|
690
|
-
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.
|
691
|
-
|
692
|
-
For all contributions, please respect the following guidelines:
|
693
|
-
|
694
|
-
* Each pull request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request.
|
695
|
-
* Do not commit changes to files that are irrelevant to your feature or bugfix (eg: `.gitignore`).
|
696
|
-
* Do not add dependencies on other gems.
|
697
|
-
* Do not add unnecessary `require` statements which could cause LoadErrors on certain systems.
|
698
|
-
* Remember: Geocoder needs to run outside of Rails. Don't assume things like ActiveSupport are available.
|
699
|
-
* 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.
|
700
|
-
* Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.
|
701
|
-
* 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.
|
702
|
-
|
703
|
-
|
704
|
-
Copyright :copyright: 2009-2020 Alex Reisner, released under the MIT license.
|
798
|
+
Copyright :copyright: 2009-2021 Alex Reisner, released under the MIT license.
|