geocoder 1.4.8 → 1.6.0

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of geocoder might be problematic. Click here for more details.

Files changed (92) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +31 -0
  3. data/LICENSE +1 -1
  4. data/README.md +355 -950
  5. data/examples/autoexpire_cache_redis.rb +2 -0
  6. data/lib/generators/geocoder/config/templates/initializer.rb +1 -1
  7. data/lib/geocoder/calculations.rb +1 -1
  8. data/lib/geocoder/cli.rb +2 -2
  9. data/lib/geocoder/configuration.rb +1 -1
  10. data/lib/geocoder/exceptions.rb +1 -1
  11. data/lib/geocoder/ip_address.rb +14 -1
  12. data/lib/geocoder/lookup.rb +7 -5
  13. data/lib/geocoder/lookups/amap.rb +7 -3
  14. data/lib/geocoder/lookups/baidu.rb +14 -10
  15. data/lib/geocoder/lookups/baidu_ip.rb +7 -36
  16. data/lib/geocoder/lookups/ban_data_gouv_fr.rb +17 -4
  17. data/lib/geocoder/lookups/base.rb +27 -4
  18. data/lib/geocoder/lookups/bing.rb +10 -13
  19. data/lib/geocoder/lookups/db_ip_com.rb +9 -6
  20. data/lib/geocoder/lookups/dstk.rb +4 -2
  21. data/lib/geocoder/lookups/esri.rb +39 -29
  22. data/lib/geocoder/lookups/freegeoip.rb +11 -7
  23. data/lib/geocoder/lookups/geocoder_ca.rb +4 -4
  24. data/lib/geocoder/lookups/geocodio.rb +5 -5
  25. data/lib/geocoder/lookups/geoportail_lu.rb +7 -7
  26. data/lib/geocoder/lookups/google.rb +8 -8
  27. data/lib/geocoder/lookups/google_places_details.rb +4 -4
  28. data/lib/geocoder/lookups/google_places_search.rb +4 -4
  29. data/lib/geocoder/lookups/google_premier.rb +10 -0
  30. data/lib/geocoder/lookups/here.rb +29 -23
  31. data/lib/geocoder/lookups/ip2location.rb +67 -0
  32. data/lib/geocoder/lookups/ipapi_com.rb +9 -13
  33. data/lib/geocoder/lookups/ipdata_co.rb +9 -4
  34. data/lib/geocoder/lookups/ipgeolocation.rb +63 -0
  35. data/lib/geocoder/lookups/ipinfo_io.rb +11 -29
  36. data/lib/geocoder/lookups/ipregistry.rb +68 -0
  37. data/lib/geocoder/lookups/ipstack.rb +11 -12
  38. data/lib/geocoder/lookups/latlon.rb +4 -4
  39. data/lib/geocoder/lookups/location_iq.rb +10 -4
  40. data/lib/geocoder/lookups/mapbox.rb +7 -6
  41. data/lib/geocoder/lookups/mapquest.rb +4 -5
  42. data/lib/geocoder/lookups/maxmind.rb +6 -6
  43. data/lib/geocoder/lookups/maxmind_geoip2.rb +8 -7
  44. data/lib/geocoder/lookups/nominatim.rb +4 -4
  45. data/lib/geocoder/lookups/opencagedata.rb +6 -5
  46. data/lib/geocoder/lookups/osmnames.rb +57 -0
  47. data/lib/geocoder/lookups/pelias.rb +8 -9
  48. data/lib/geocoder/lookups/pickpoint.rb +9 -3
  49. data/lib/geocoder/lookups/pointpin.rb +10 -9
  50. data/lib/geocoder/lookups/postcode_anywhere_uk.rb +4 -5
  51. data/lib/geocoder/lookups/postcodes_io.rb +31 -0
  52. data/lib/geocoder/lookups/smarty_streets.rb +20 -10
  53. data/lib/geocoder/lookups/telize.rb +23 -3
  54. data/lib/geocoder/lookups/tencent.rb +59 -0
  55. data/lib/geocoder/lookups/yandex.rb +6 -6
  56. data/lib/geocoder/query.rb +14 -0
  57. data/lib/geocoder/railtie.rb +1 -1
  58. data/lib/geocoder/results/baidu.rb +10 -14
  59. data/lib/geocoder/results/ban_data_gouv_fr.rb +1 -1
  60. data/lib/geocoder/results/base.rb +13 -1
  61. data/lib/geocoder/results/bing.rb +1 -1
  62. data/lib/geocoder/results/db_ip_com.rb +0 -5
  63. data/lib/geocoder/results/freegeoip.rb +0 -5
  64. data/lib/geocoder/results/geocoder_ca.rb +3 -3
  65. data/lib/geocoder/results/geoip2.rb +4 -4
  66. data/lib/geocoder/results/geoportail_lu.rb +5 -3
  67. data/lib/geocoder/results/here.rb +4 -1
  68. data/lib/geocoder/results/ip2location.rb +22 -0
  69. data/lib/geocoder/results/ipdata_co.rb +0 -5
  70. data/lib/geocoder/results/ipgeolocation.rb +59 -0
  71. data/lib/geocoder/results/ipregistry.rb +308 -0
  72. data/lib/geocoder/results/maxmind.rb +0 -5
  73. data/lib/geocoder/results/maxmind_local.rb +0 -5
  74. data/lib/geocoder/results/osmnames.rb +56 -0
  75. data/lib/geocoder/results/postcodes_io.rb +40 -0
  76. data/lib/geocoder/results/smarty_streets.rb +48 -18
  77. data/lib/geocoder/results/telize.rb +0 -5
  78. data/lib/geocoder/results/tencent.rb +72 -0
  79. data/lib/geocoder/results/test.rb +1 -1
  80. data/lib/geocoder/stores/active_record.rb +1 -3
  81. data/lib/geocoder/version.rb +1 -1
  82. data/lib/hash_recursive_merge.rb +1 -2
  83. data/lib/maxmind_database.rb +3 -3
  84. metadata +17 -18
  85. data/lib/geocoder/lookups/geocoder_us.rb +0 -43
  86. data/lib/geocoder/lookups/mapzen.rb +0 -15
  87. data/lib/geocoder/lookups/okf.rb +0 -44
  88. data/lib/geocoder/lookups/ovi.rb +0 -62
  89. data/lib/geocoder/results/geocoder_us.rb +0 -39
  90. data/lib/geocoder/results/mapzen.rb +0 -5
  91. data/lib/geocoder/results/okf.rb +0 -106
  92. data/lib/geocoder/results/ovi.rb +0 -71
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 854db8cc60efe7a71d336d5001d509a69e1abd13
4
- data.tar.gz: e75d9237cd4fc8399b19308434bca339e2a538c1
2
+ SHA256:
3
+ metadata.gz: 0d1523b73c17cd042f5af380ea44d2711c66684928aee867490f539cc3507582
4
+ data.tar.gz: c63760a1b75b7ce43d785736ffb6b0afcace52f3283ee4365b4d7af269822603
5
5
  SHA512:
6
- metadata.gz: b10a62001c292e4829aa71e44846c8d2a3272095de360ba09b8cb1469692158bd4a8b0745053433b316e60edf6c7720487c45f9cea303067d44c8d2883b65f6d
7
- data.tar.gz: 0b6f87527cf3fa4034b080423a3c195a56c34de80cc3069b103710a14af562e46e446da2e65fbb2f7df62e424be9e6623924f4087b343767617ebb0bfa091be3
6
+ metadata.gz: 96048af2e42535ec2091a21d29eac9c4ebb3f8a3081762b34c3c97a72215ce8f4312ee5f9f072153ef530370580e609996946b4afa23aa89b1973c942c18417f
7
+ data.tar.gz: d3993aa69ba09c543e24215c290e9e7a5b56db0c49b065ece947d3b53eeecb6a8014c8c7737138939ba7cdb67acba36a6d537c081ad86fcbf707eff9cf97e5b3
@@ -3,6 +3,37 @@ Changelog
3
3
 
4
4
  Major changes to Geocoder for each release. Please see the Git log for complete list of changes.
5
5
 
6
+ 1.6.0 (2020 Jan 6)
7
+ -------------------
8
+ * Drop support for Rails 3.x.
9
+ * Add support for :osmnames lookup (thanks github.com/zacviandier).
10
+ * Add support for :ipgeolocation IP lookup (thanks github.com/ahsannawaz111).
11
+
12
+ 1.5.2 (2019 Oct 3)
13
+ -------------------
14
+ * Add support for :ipregistry lookup (thanks github.com/ipregistry).
15
+ * Various fixes for Yandex lookup.
16
+
17
+ 1.5.1 (2019 Jan 23)
18
+ -------------------
19
+ * Add support for :tencent lookup (thanks github.com/Anders-E).
20
+ * Add support for :smarty_streets international API (thanks github.com/ankane).
21
+ * Remove :mapzen lookup.
22
+
23
+ 1.5.0 (2018 Jul 31)
24
+ -------------------
25
+ * Drop support for Ruby <2.0.
26
+ * Change default street address lookup from :google to :nominatim.
27
+ * Cache keys no longer include API credentials. This means many entries in existing cache implementations will be invalidated.
28
+ * Test lookup fixtures should now return `coordinates` and NOT `latitude`/`longitude` attributes (see #1258). This may break some people's tests.
29
+ * Add support for :ip2location lookup (thanks github.com/ip2location).
30
+ * Remove :ovi and :okf lookups.
31
+
32
+ 1.4.9 (2018 May 27)
33
+ -------------------
34
+ * Fix regression in :geoip2 lookup.
35
+ * Add support for Postcodes.io lookup (thanks github.com/sledge909).
36
+
6
37
  1.4.8 (2018 May 21)
7
38
  -------------------
8
39
  * Change default IP address lookup from :freegeoip to :ipinfo_io.
data/LICENSE CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2009-11 Alex Reisner
1
+ Copyright (c) 2009-2020 Alex Reisner
2
2
 
3
3
  Permission is hereby granted, free of charge, to any person obtaining
4
4
  a copy of this software and associated documentation files (the
data/README.md CHANGED
@@ -1,137 +1,180 @@
1
1
  Geocoder
2
2
  ========
3
3
 
4
- 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")`.
4
+ **Complete geocoding solution for Ruby.**
5
5
 
6
- _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)._
6
+ [![Gem Version](https://badge.fury.io/rb/geocoder.svg)](http://badge.fury.io/rb/geocoder)
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
+ [![GitHub Issues](https://img.shields.io/github/issues/alexreisner/geocoder.svg)](https://github.com/alexreisner/geocoder/issues)
10
+ [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
7
11
 
12
+ Key features:
8
13
 
9
- Compatibility
10
- -------------
14
+ * Forward and reverse geocoding.
15
+ * IP address geocoding.
16
+ * Connects to more than 40 APIs worldwide.
17
+ * Performance-enhancing features like caching.
18
+ * Integrates with ActiveRecord and Mongoid.
19
+ * Basic geospatial queries: search within radius (or rectangle, or ring).
11
20
 
12
- * Supports multiple Ruby versions: Ruby 1.9.3, 2.x, and JRuby.
13
- * Supports multiple databases: MySQL, PostgreSQL, SQLite, and MongoDB (1.7.0 and higher).
14
- * 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).
15
- * Works very well outside of Rails, you just need to install either the `json` (for MRI) or `json_pure` (for JRuby) gem.
21
+ Compatibility:
16
22
 
23
+ * Ruby versions: 2.x, and JRuby.
24
+ * Databases: MySQL, PostgreSQL, SQLite, and MongoDB.
25
+ * Rails: 4, 5, and 6.
26
+ * Works outside of Rails with the `json` (for MRI) or `json_pure` (for JRuby) gem.
17
27
 
18
- Note on Rails 4.1 and Greater
19
- -----------------------------
20
-
21
- 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.
22
28
 
29
+ Table of Contents
30
+ -----------------
23
31
 
24
- Installation
25
- ------------
32
+ Basic Features:
26
33
 
27
- Install Geocoder like any other Ruby gem:
34
+ * [Basic Search](#basic-search)
35
+ * [Geocoding Objects](#geocoding-objects)
36
+ * [Geospatial Database Queries](#geospatial-database-queries)
37
+ * [Geocoding HTTP Requests](#geocoding-http-requests)
38
+ * [Geocoding Service ("Lookup") Configuration](#geocoding-service-lookup-configuration)
28
39
 
29
- gem install geocoder
40
+ Advanced Features:
30
41
 
31
- Or, if you're using Rails/Bundler, add this to your Gemfile:
42
+ * [Performance and Optimization](#performance-and-optimization)
43
+ * [Advanced Model Configuration](#advanced-model-configuration)
44
+ * [Advanced Database Queries](#advanced-database-queries)
45
+ * [Geospatial Calculations](#geospatial-calculations)
46
+ * [Batch Geocoding](#batch-geocoding)
47
+ * [Testing](#testing)
48
+ * [Error Handling](#error-handling)
49
+ * [Command Line Interface](#command-line-interface)
32
50
 
33
- gem 'geocoder'
51
+ The Rest:
34
52
 
35
- and run at the command prompt:
53
+ * [Technical Discussions](#technical-discussions)
54
+ * [Troubleshooting](#troubleshooting)
55
+ * [Known Issues](#known-issues)
56
+ * [Reporting Issues](#reporting-issues)
57
+ * [Contributing](#contributing)
36
58
 
37
- bundle install
59
+ See Also:
38
60
 
61
+ * [Guide to Geocoding APIs](https://github.com/alexreisner/geocoder/blob/master/README_API_GUIDE.md) (formerly part of this README)
39
62
 
40
- Object Geocoding
41
- ----------------
42
63
 
43
- ### ActiveRecord
64
+ Basic Search
65
+ ------------
44
66
 
45
- 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):
67
+ In its simplest form, Geocoder takes an address and searches for its latitude/longitude coordinates:
46
68
 
47
- rails generate migration AddLatitudeAndLongitudeToModel latitude:float longitude:float
48
- rake db:migrate
69
+ results = Geocoder.search("Paris")
70
+ results.first.coordinates
71
+ => [48.856614, 2.3522219] # latitude and longitude
49
72
 
50
- 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`).
73
+ The reverse is possible too. Given coordinates, it finds an address:
51
74
 
52
- Next, your model must tell Geocoder which method returns your object's geocodable address:
75
+ results = Geocoder.search([48.856614, 2.3522219])
76
+ results.first.address
77
+ => "Hôtel de Ville, 75004 Paris, France"
53
78
 
54
- geocoded_by :full_street_address # can also be an IP address
55
- after_validation :geocode # auto-fetch coordinates
79
+ You can also look up the location of an IP addresses:
56
80
 
57
- For reverse geocoding, tell Geocoder which attributes store latitude and longitude:
81
+ results = Geocoder.search("172.56.21.89")
82
+ results.first.coordinates
83
+ => [30.267153, -97.7430608]
84
+ results.first.country
85
+ => "United States"
58
86
 
59
- reverse_geocoded_by :latitude, :longitude
60
- after_validation :reverse_geocode # auto-fetch address
87
+ **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).
61
88
 
62
- ### Mongoid
63
89
 
64
- First, your model must have an array field for storing coordinates:
90
+ Geocoding Objects
91
+ -----------------
65
92
 
66
- field :coordinates, :type => Array
93
+ To automatically geocode your objects:
67
94
 
68
- You may also want an address field, like this:
95
+ **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:
69
96
 
70
- field :address
97
+ def address
98
+ [street, city, state, country].compact.join(', ')
99
+ end
71
100
 
72
- 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.
101
+ **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.)
73
102
 
74
- Once your fields are defined, include the `Geocoder::Model::Mongoid` module and then call `geocoded_by`:
103
+ **3.** In your model, tell geocoder where to find the object's address:
75
104
 
76
- include Geocoder::Model::Mongoid
77
- geocoded_by :address # can also be an IP address
78
- after_validation :geocode # auto-fetch coordinates
105
+ geocoded_by :address
79
106
 
80
- Reverse geocoding is similar:
107
+ This adds a `geocode` method which you can invoke via callback:
81
108
 
82
- include Geocoder::Model::Mongoid
83
- reverse_geocoded_by :coordinates
84
- after_validation :reverse_geocode # auto-fetch address
109
+ after_validation :geocode
85
110
 
86
- Once you've set up your model you'll need to create the necessary spatial indices in your database:
111
+ Reverse geocoding (given lat/lon coordinates, find an address) is similar:
87
112
 
88
- rake db:mongoid:create_indexes
113
+ reverse_geocoded_by :latitude, :longitude
114
+ after_validation :reverse_geocode
89
115
 
90
- 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.
116
+ With any geocoded objects, you can do the following:
91
117
 
92
- ### MongoMapper
118
+ obj.distance_to([43.9,-98.6]) # distance from obj to point
119
+ obj.bearing_to([43.9,-98.6]) # bearing from obj to point
120
+ obj.bearing_from(obj2) # bearing from obj2 to obj
93
121
 
94
- MongoMapper is very similar to Mongoid, just be sure to include `Geocoder::Model::MongoMapper`.
122
+ 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.
95
123
 
96
- ### Mongo Indices
124
+ ### One More Thing for MongoDB!
97
125
 
98
- 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:
126
+ Before you can call `geocoded_by` you'll need to include the necessary module using one of the following:
99
127
 
100
128
  include Geocoder::Model::Mongoid
101
- geocoded_by :address, :skip_index => true
129
+ include Geocoder::Model::MongoMapper
102
130
 
103
- ### Bulk Geocoding
131
+ ### Latitude/Longitude Order in MongoDB
104
132
 
105
- 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:
133
+ 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:
106
134
 
107
- rake geocode:all CLASS=YourModel
135
+ obj.to_coordinates # => [37.7941013, -122.3951096] # [lat, lon]
108
136
 
109
- If you need reverse geocoding instead, call the task with REVERSE=true:
137
+ 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:
110
138
 
111
- rake geocode:all CLASS=YourModel REVERSE=true
139
+ obj.coordinates # => [-122.3951096, 37.7941013] # [lon, lat]
112
140
 
113
- 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:
141
+ So, be careful.
114
142
 
115
- rake geocode:all CLASS=YourModel SLEEP=0.25 BATCH=100
143
+ ### Use Outside of Rails
116
144
 
117
- 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.
145
+ 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:
118
146
 
119
- rake geocode:all CLASS=YourModel LIMIT=1000
147
+ extend Geocoder::Model::ActiveRecord
120
148
 
121
- ### Avoiding Unnecessary API Requests
122
149
 
123
- 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:
150
+ Geospatial Database Queries
151
+ ---------------------------
124
152
 
125
- * an address is present
126
- * the address has been changed since last save (or it has never been saved)
153
+ ### For ActiveRecord models:
127
154
 
128
- The exact code will vary depending on the method you use for your geocodable string, but it would be something like this:
155
+ To find objects by location, use the following scopes:
129
156
 
130
- after_validation :geocode, if: ->(obj){ obj.address.present? and obj.address_changed? }
157
+ Venue.near('Omaha, NE, US') # venues within 20 miles of Omaha
158
+ Venue.near([40.71, -100.23], 50) # venues within 50 miles of a point
159
+ Venue.near([40.71, -100.23], 50, units: :km) # venues within 50 kilometres of a point
160
+ Venue.geocoded # venues with coordinates
161
+ Venue.not_geocoded # venues without coordinates
131
162
 
163
+ With geocoded objects you can do things like this:
132
164
 
133
- Request Geocoding by IP Address
134
- -------------------------------
165
+ if obj.geocoded?
166
+ obj.nearbys(30) # other objects within 30 miles
167
+ obj.distance_from([40.714,-100.234]) # distance from arbitrary point to object
168
+ obj.bearing_to("Paris, France") # direction from object to arbitrary point
169
+ end
170
+
171
+ ### For MongoDB-backed models:
172
+
173
+ 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.
174
+
175
+
176
+ Geocoding HTTP Requests
177
+ -----------------------
135
178
 
136
179
  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:
137
180
 
@@ -140,164 +183,181 @@ Geocoder adds `location` and `safe_location` methods to the standard `Rack::Requ
140
183
 
141
184
  **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).
142
185
 
143
- 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.
186
+ 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.
144
187
 
145
- See _Advanced Geocoding_ below for more information about `Geocoder::Result` objects.
146
188
 
189
+ Geocoding Service ("Lookup") Configuration
190
+ ------------------------------------------
147
191
 
148
- Location-Aware Database Queries
149
- -------------------------------
192
+ 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).
150
193
 
151
- ### For Mongo-backed models:
194
+ To create a Rails initializer with sample configuration:
152
195
 
153
- 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.
196
+ rails generate geocoder:config
154
197
 
155
- ### For ActiveRecord models:
198
+ Some common options are:
156
199
 
157
- To find objects by location, use the following scopes:
200
+ # config/initializers/geocoder.rb
201
+ Geocoder.configure(
158
202
 
159
- Venue.near('Omaha, NE, US') # venues within 20 (default) miles of Omaha
160
- Venue.near([40.71, -100.23], 50) # venues within 50 miles of a point
161
- Venue.near([40.71, -100.23], 50, :units => :km)
162
- # venues within 50 kilometres of a point
163
- Venue.geocoded # venues with coordinates
164
- Venue.not_geocoded # venues without coordinates
203
+ # street address geocoding service (default :nominatim)
204
+ lookup: :yandex,
165
205
 
166
- by default, objects are ordered by distance. To remove the ORDER BY clause use the following:
206
+ # IP address geocoding service (default :ipinfo_io)
207
+ ip_lookup: :maxmind,
167
208
 
168
- Venue.near('Omaha', 20, :order => false)
209
+ # to use an API key:
210
+ api_key: "...",
169
211
 
170
- With geocoded objects you can do things like this:
212
+ # geocoding service request timeout, in seconds (default 3):
213
+ timeout: 5,
171
214
 
172
- if obj.geocoded?
173
- obj.nearbys(30) # other objects within 30 miles
174
- obj.distance_from([40.714,-100.234]) # distance from arbitrary point to object
175
- obj.bearing_to("Paris, France") # direction from object to arbitrary point
176
- end
215
+ # set default units to kilometers:
216
+ units: :km,
177
217
 
178
- Some utility methods are also available:
218
+ # caching (see [below](#caching) for details):
219
+ cache: Redis.new,
220
+ cache_prefix: "..."
179
221
 
180
- # look up coordinates of some location (like searching Google Maps)
181
- Geocoder.coordinates("25 Main St, Cooperstown, NY")
182
- => [42.700149, -74.922767]
222
+ )
183
223
 
184
- # distance between Eiffel Tower and Empire State Building
185
- Geocoder::Calculations.distance_between([47.858205,2.294359], [40.748433,-73.985655])
186
- => 3619.77359999382 # in configured units (default miles)
224
+ 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:
187
225
 
188
- # find the geographic center (aka center of gravity) of objects or points
189
- Geocoder::Calculations.geographic_center([city1, city2, [40.22,-73.99], city4])
190
- => [35.14968, -90.048929]
226
+ # with Google:
227
+ Geocoder.search("Middletown", bounds: [[40.6,-77.9], [39.9,-75.9]])
191
228
 
192
- Please see the code for more methods and detailed information about arguments (eg, working with kilometers).
229
+ 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:
193
230
 
231
+ # Nominatim's `countrycodes` parameter:
232
+ Geocoder.search("Rome", params: {countrycodes: "us,ca"})
194
233
 
195
- Distance and Bearing
196
- --------------------
234
+ # Google's `region` parameter:
235
+ Geocoder.search("Rome", params: {region: "..."})
197
236
 
198
- When you run a location-aware query the returned objects have two attributes added to them (only w/ ActiveRecord):
237
+ ### Configuring Multiple Services
199
238
 
200
- * `obj.distance` - number of miles from the search point to this object
201
- * `obj.bearing` - direction from the search point to this object
239
+ You can configure multiple geocoding services at once by using the service's name as a key for a sub-configuration hash, like this:
202
240
 
203
- 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:
241
+ Geocoder.configure(
204
242
 
205
- * `0` - due north
206
- * `180` - due south
207
- * `90` - due east
208
- * `270` - due west
209
- * `230.1` - southwest
210
- * `359.9` - almost due north
243
+ timeout: 2,
244
+ cache: Redis.new,
211
245
 
212
- You can convert these numbers to compass point names by using the utility method provided:
246
+ yandex: {
247
+ api_key: "...",
248
+ timeout: 5
249
+ },
213
250
 
214
- Geocoder::Calculations.compass_point(355) # => "N"
215
- Geocoder::Calculations.compass_point(45) # => "NE"
216
- Geocoder::Calculations.compass_point(208) # => "SW"
251
+ baidu: {
252
+ api_key: "..."
253
+ },
217
254
 
218
- _Note: when using SQLite `distance` and `bearing` values are provided for interface consistency only. They are not very accurate._
255
+ maxmind: {
256
+ api_key: "...",
257
+ service: :omni
258
+ }
219
259
 
220
- To calculate accurate distance and bearing with SQLite or MongoDB:
260
+ )
221
261
 
222
- obj.distance_to([43.9,-98.6]) # distance from obj to point
223
- obj.bearing_to([43.9,-98.6]) # bearing from obj to point
224
- obj.bearing_from(obj2) # bearing from obj2 to obj
262
+ Lookup-specific settings override global settings so, in this example, the timeout for all lookups is 2 seconds, except for Yandex which is 5.
225
263
 
226
- 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).
227
264
 
265
+ Performance and Optimization
266
+ ----------------------------
228
267
 
229
- Model Configuration
230
- -------------------
268
+ ### Database Indices
231
269
 
232
- 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:
270
+ 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:
233
271
 
234
- geocoded_by :address, :latitude => :lat, :longitude => :lon # ActiveRecord
235
- geocoded_by :address, :coordinates => :coords # MongoDB
272
+ add_index :table, [:latitude, :longitude]
236
273
 
237
- The `address` method can return any string you'd use to search Google Maps. For example, any of the following are acceptable:
274
+ 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:
238
275
 
239
- * "714 Green St, Big Town, MO"
240
- * "Eiffel Tower, Paris, FR"
241
- * "Paris, TX, US"
276
+ include Geocoder::Model::Mongoid
277
+ geocoded_by :address, skip_index: true
242
278
 
243
- If your model has `street`, `city`, `state`, and `country` attributes you might do something like this:
279
+ ### Avoiding Unnecessary API Requests
244
280
 
245
- geocoded_by :address
281
+ 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:
246
282
 
247
- def address
248
- [street, city, state, country].compact.join(', ')
249
- end
283
+ * an address is present
284
+ * the address has been changed since last save (or it has never been saved)
250
285
 
251
- For reverse geocoding, you can also specify an alternate name attribute where the address will be stored. For example:
286
+ The exact code will vary depending on the method you use for your geocodable string, but it would be something like this:
252
287
 
253
- reverse_geocoded_by :latitude, :longitude, :address => :location # ActiveRecord
254
- reverse_geocoded_by :coordinates, :address => :loc # MongoDB
288
+ after_validation :geocode, if: ->(obj){ obj.address.present? and obj.address_changed? }
255
289
 
256
- You can also configure a specific lookup for your model which will override the globally-configured lookup. For example:
290
+ ### Caching
257
291
 
258
- geocoded_by :address, :lookup => :yandex
292
+ 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:
259
293
 
260
- 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:
294
+ Geocoder.configure(cache: Redis.new)
261
295
 
262
- geocoded_by :address, :lookup => lambda{ |obj| obj.geocoder_lookup }
296
+ This example uses Redis, but the cache store can be any object that supports these methods:
263
297
 
264
- def geocoder_lookup
265
- if country_code == "RU"
266
- :yandex
267
- elsif country_code == "CN"
268
- :baidu
269
- else
270
- :google
271
- end
272
- end
298
+ * `store#[](key)` or `#get` or `#read` - retrieves a value
299
+ * `store#[]=(key, value)` or `#set` or `#write` - stores a value
300
+ * `store#del(url)` - deletes a value
301
+ * `store#keys` - (Optional) Returns array of keys. Used if you wish to expire the entire cache (see below).
273
302
 
303
+ 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).
274
304
 
275
- Advanced Querying
276
- -----------------
305
+ You can also set a custom prefix to be used for cache keys:
306
+
307
+ Geocoder.configure(cache_prefix: "...")
277
308
 
278
- 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:
309
+ By default the prefix is `geocoder:`
310
+
311
+ If you need to expire cached content:
312
+
313
+ Geocoder::Lookup.get(Geocoder.config[:lookup]).cache.expire(:all) # expire cached results for current Lookup
314
+ Geocoder::Lookup.get(:nominatim).cache.expire("http://...") # expire cached result for a specific URL
315
+ Geocoder::Lookup.get(:nominatim).cache.expire(:all) # expire cached results for Google Lookup
316
+ # expire all cached results for all Lookups.
317
+ # Be aware that this methods spawns a new Lookup object for each Service
318
+ Geocoder::Lookup.all_services.each{|service| Geocoder::Lookup.get(service).cache.expire(:all)}
279
319
 
280
- distance = 20
281
- center_point = [40.71, 100.23]
282
- box = Geocoder::Calculations.bounding_box(center_point, distance)
283
- Venue.within_bounding_box(box)
320
+ 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.
284
321
 
285
- 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.
322
+ For an example of a cache store with URL expiry, please see examples/autoexpire_cache.rb
286
323
 
287
- You can also specify a minimum radius (if you're using ActiveRecord and not Sqlite) to constrain the
288
- lower bound (ie. think of a donut, or ring) by using the `:min_radius` option:
324
+ _Before you implement caching in your app please be sure that doing so does not violate the Terms of Service for your geocoding service._
289
325
 
290
- box = Geocoder::Calculations.bounding_box(center_point, distance, :min_radius => 10.5)
291
326
 
292
- 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):
327
+ Advanced Model Configuration
328
+ ----------------------------
293
329
 
294
- Venue.near("Paris", 50, latitude: :secondary_latitude, longitude: :secondary_longitude)
330
+ You are not stuck with the `latitude` and `longitude` database column names (with ActiveRecord) or the `coordinates` array (Mongo) for storing coordinates. For example:
295
331
 
332
+ geocoded_by :address, latitude: :lat, longitude: :lon # ActiveRecord
333
+ geocoded_by :address, coordinates: :coords # MongoDB
296
334
 
297
- Advanced Geocoding
298
- ------------------
335
+ For reverse geocoding, you can specify the attribute where the address will be stored. For example:
299
336
 
300
- 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:
337
+ reverse_geocoded_by :latitude, :longitude, address: :loc # ActiveRecord
338
+ reverse_geocoded_by :coordinates, address: :street_address # MongoDB
339
+
340
+ To specify geocoding parameters in your model:
341
+
342
+ geocoded_by :address, params: {region: "..."}
343
+
344
+ 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:
345
+
346
+ geocoded_by :address, lookup: lambda{ |obj| obj.geocoder_lookup }
347
+
348
+ def geocoder_lookup
349
+ if country_code == "RU"
350
+ :yandex
351
+ elsif country_code == "CN"
352
+ :baidu
353
+ else
354
+ :nominatim
355
+ end
356
+ end
357
+
358
+ ### Custom Result Handling
359
+
360
+ 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:
301
361
 
302
362
  reverse_geocoded_by :latitude, :longitude do |obj,results|
303
363
  if geo = results.first
@@ -321,741 +381,130 @@ Every `Geocoder::Result` object, `result`, provides the following data:
321
381
  * `result.country` - string
322
382
  * `result.country_code` - string
323
383
 
324
- 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.)
325
-
326
-
327
- Geocoding Service ("Lookup") Configuration
328
- ------------------------------------------
329
-
330
- 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).
331
-
332
- To create a Rails initializer with an example configuration:
333
-
334
- rails generate geocoder:config
384
+ 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.
335
385
 
336
- Some common configuration options are:
337
-
338
- # config/initializers/geocoder.rb
339
- Geocoder.configure(
340
-
341
- # geocoding service (see below for supported options):
342
- :lookup => :yandex,
343
-
344
- # IP address geocoding service (see below for supported options):
345
- :ip_lookup => :maxmind,
346
-
347
- # to use an API key:
348
- :api_key => "...",
349
-
350
- # geocoding service request timeout, in seconds (default 3):
351
- :timeout => 5,
352
-
353
- # set default units to kilometers:
354
- :units => :km,
386
+ ### Forward and Reverse Geocoding in the Same Model
355
387
 
356
- # caching (see below for details):
357
- :cache => Redis.new,
358
- :cache_prefix => "..."
388
+ 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:
359
389
 
360
- )
361
-
362
- 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:
363
-
364
- # with Google:
365
- Geocoder.search("Paris", :bounds => [[32.1,-95.9], [33.9,-94.3]])
366
-
367
- 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:
368
-
369
- # with Nominatim:
370
- Geocoder.search("Paris", :params => {:countrycodes => "gb,de,fr,es,us"})
371
-
372
- Or, to search within a particular region with Google:
373
-
374
- Geocoder.search("...", :params => {:region => "..."})
390
+ * one for storing the fetched address (when reverse geocoding)
391
+ * one for providing an address to use when fetching coordinates (forward geocoding)
375
392
 
376
- Or, to use parameters in your model:
393
+ For example:
377
394
 
378
395
  class Venue
379
396
 
380
397
  # build an address from street, city, and state attributes
381
- geocoded_by :address_from_components, :params => {:region => "..."}
398
+ geocoded_by :address_from_components
382
399
 
383
400
  # store the fetched address in the full_address attribute
384
- reverse_geocoded_by :latitude, :longitude, :address => :full_address, :params => {:region => "..."}
401
+ reverse_geocoded_by :latitude, :longitude, address: :full_address
385
402
  end
386
403
 
404
+ 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:
387
405
 
388
- ### Configure Multiple Services
389
-
390
- You can configure multiple geocoding services at once, like this:
391
-
392
- Geocoder.configure(
393
-
394
- :timeout => 2,
395
- :cache => Redis.new,
396
-
397
- :yandex => {
398
- :api_key => "...",
399
- :timeout => 5
400
- },
401
-
402
- :baidu => {
403
- :api_key => "..."
404
- },
405
-
406
- :maxmind => {
407
- :api_key => "...",
408
- :service => :omni
409
- }
410
-
411
- )
412
-
413
- 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.
414
-
415
-
416
- ### Street Address Services
417
-
418
- 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.
419
-
420
- #### Google (`:google`)
421
-
422
- * **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`)
423
- * **Key signup**: https://console.developers.google.com/flows/enableapi?apiid=geocoding_backend&keyType=SERVER_SIDE
424
- * **Quota**: 2,500 requests/24 hrs, 5 requests/second
425
- * **Region**: world
426
- * **SSL support**: yes (required if key is used)
427
- * **Languages**: see https://developers.google.com/maps/faq#languagesupport
428
- * **Extra params**:
429
- * `:bounds` - pass SW and NE coordinates as an array of two arrays to bias results towards a viewport
430
- * `:google_place_id` - pass `true` if search query is a Google Place ID
431
- * **Documentation**: https://developers.google.com/maps/documentation/geocoding/intro
432
- * **Terms of Service**: http://code.google.com/apis/maps/terms.html#section_10_12
433
- * **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..."
434
-
435
- #### Google Maps API for Work (`:google_premier`)
436
-
437
- Similar to `:google`, with the following differences:
438
-
439
- * **API key**: required, plus client and channel (set `Geocoder.configure(:lookup => :google_premier, :api_key => [key, client, channel])`)
440
- * **Key signup**: https://developers.google.com/maps/documentation/business/
441
- * **Quota**: 100,000 requests/24 hrs, 10 requests/second
442
-
443
- #### Google Places Details (`:google_places_details`)
444
-
445
- 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)`.
446
-
447
- * **API key**: required
448
- * **Key signup**: https://code.google.com/apis/console/
449
- * **Quota**: 1,000 request/day, 100,000 after credit card authentication
450
- * **Region**: world
451
- * **SSL support**: yes
452
- * **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)
453
- * **Documentation**: https://developers.google.com/places/documentation/details
454
- * **Terms of Service**: https://developers.google.com/places/policies
455
- * **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."
456
-
457
- #### Google Places Search (`:google_places_search`)
458
-
459
- 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
460
-
461
- * Same specifications as Google Places Details (see above).
462
-
463
- #### Bing (`:bing`)
464
-
465
- * **API key**: required (set `Geocoder.configure(:lookup => :bing, :api_key => key)`)
466
- * **Key signup**: https://www.microsoft.com/maps/create-a-bing-maps-key.aspx
467
- * **Quota**: 50,0000 requests/day (Windows app), 125,000 requests/year (non-Windows app)
468
- * **Region**: world
469
- * **SSL support**: no
470
- * **Languages**: ?
471
- * **Documentation**: http://msdn.microsoft.com/en-us/library/ff701715.aspx
472
- * **Terms of Service**: http://www.microsoft.com/maps/product/terms.html
473
- * **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."
474
-
475
- #### Nominatim (`:nominatim`)
476
-
477
- * **API key**: none
478
- * **Quota**: 1 request/second
479
- * **Region**: world
480
- * **SSL support**: yes
481
- * **Languages**: ?
482
- * **Documentation**: http://wiki.openstreetmap.org/wiki/Nominatim
483
- * **Terms of Service**: http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy
484
- * **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)
485
-
486
- #### PickPoint (`:pickpoint`)
487
-
488
- * **API key**: required
489
- * **Key signup**: [https://pickpoint.io](https://pickpoint.io)
490
- * **Quota**: 2500 requests / day for free non-commercial usage, commercial plans are [available](https://pickpoint.io/#pricing). No rate limit.
491
- * **Region**: world
492
- * **SSL support**: required
493
- * **Languages**: worldwide
494
- * **Documentation**: [https://pickpoint.io/api-reference](https://pickpoint.io/api-reference)
495
- * **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://www.openstreetmap.org/copyright)
496
-
497
-
498
- #### LocationIQ (`:location_iq`)
499
-
500
- * **API key**: required
501
- * **Quota**: 60 requests/minute (2 req/sec, 10k req/day), then [ability to purchase more](http://locationiq.org/#pricing)
502
- * **Region**: world
503
- * **SSL support**: yes
504
- * **Languages**: ?
505
- * **Documentation**: https://locationiq.org/#docs
506
- * **Terms of Service**: https://unwiredlabs.com/tos
507
- * **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](https://www.openstreetmap.org/copyright)
508
-
509
- #### OpenCageData (`:opencagedata`)
510
-
511
- * **API key**: required
512
- * **Key signup**: http://geocoder.opencagedata.com
513
- * **Quota**: 2500 requests / day, then [ability to purchase more](https://geocoder.opencagedata.com/pricing)
514
- * **Region**: world
515
- * **SSL support**: yes
516
- * **Languages**: worldwide
517
- * **Documentation**: http://geocoder.opencagedata.com/api.html
518
- * **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://www.openstreetmap.org/copyright)
519
-
520
- #### Yandex (`:yandex`)
521
-
522
- * **API key**: optional, but without it lookup is territorially limited
523
- * **Quota**: 25000 requests / day
524
- * **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
525
- * **SSL support**: HTTPS only
526
- * **Languages**: Russian, Belarusian, Ukrainian, English, Turkish (only for maps of Turkey)
527
- * **Documentation**: http://api.yandex.com.tr/maps/doc/intro/concepts/intro.xml
528
- * **Terms of Service**: http://api.yandex.com.tr/maps/doc/intro/concepts/intro.xml#rules
529
- * **Limitations**: ?
530
-
531
- #### Geocoder.ca (`:geocoder_ca`)
532
-
533
- * **API key**: none
534
- * **Quota**: ?
535
- * **Region**: US and Canada
536
- * **SSL support**: no
537
- * **Languages**: English
538
- * **Documentation**: ?
539
- * **Terms of Service**: http://geocoder.ca/?terms=1
540
- * **Limitations**: "Under no circumstances can our data be re-distributed or re-sold by anyone to other parties without our written permission."
541
-
542
- #### Mapbox (`:mapbox`)
543
-
544
- * **API key**: required
545
- * **Dataset**: Uses `mapbox.places` dataset by default. Specify the `mapbox.places-permanent` dataset by setting: `Geocoder.configure(:mapbox => {:dataset => "mapbox.places-permanent"})`
546
- * **Key signup**: https://www.mapbox.com/pricing/
547
- * **Quota**: depends on plan
548
- * **Region**: complete coverage of US and Canada, partial coverage elsewhere (see for details: https://www.mapbox.com/developers/api/geocoding/#coverage)
549
- * **SSL support**: yes
550
- * **Languages**: English
551
- * **Extra params** (see Mapbox docs for more):
552
- * `:country` - restrict results to a specific country, e.g., `us` or `ca`
553
- * `:types` - restrict results to categories such as `address`,
554
- `neighborhood`, `postcode`
555
- * `:proximity` - bias results toward a `lng,lat`, e.g.,
556
- `params: { proximity: "-84.0,42.5" }`
557
- * **Documentation**: https://www.mapbox.com/developers/api/geocoding/
558
- * **Terms of Service**: https://www.mapbox.com/tos/
559
- * **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.
560
- * **Notes**: Currently in public beta.
561
-
562
- #### Mapquest (`:mapquest`)
563
-
564
- * **API key**: required
565
- * **Key signup**: https://developer.mapquest.com/plans
566
- * **Quota**: ?
567
- * **HTTP Headers**: when using the licensed API you can specify a referer like so:
568
- `Geocoder.configure(:http_headers => { "Referer" => "http://foo.com" })`
569
- * **Region**: world
570
- * **SSL support**: no
571
- * **Languages**: English
572
- * **Documentation**: http://www.mapquestapi.com/geocoding/
573
- * **Terms of Service**: http://info.mapquest.com/terms-of-use/
574
- * **Limitations**: ?
575
- * **Notes**: You can use the open (non-licensed) API by setting: `Geocoder.configure(:mapquest => {:open => true})` (defaults to licensed version)
576
-
577
- #### Ovi/Nokia (`:ovi`)
578
-
579
- * **API key**: not required, but performance restricted without it
580
- * **Quota**: ?
581
- * **Region**: world
582
- * **SSL support**: no
583
- * **Languages**: English
584
- * **Documentation**: http://api.maps.ovi.com/devguide/overview.html
585
- * **Terms of Service**: http://www.developer.nokia.com/Develop/Maps/TC.html
586
- * **Limitations**: ?
587
-
588
- #### Here/Nokia (`:here`)
589
-
590
- * **API key**: required (set `Geocoder.configure(:api_key => [app_id, app_code])`)
591
- * **Quota**: Depending on the API key
592
- * **Region**: world
593
- * **SSL support**: yes
594
- * **Languages**: The preferred language of address elements in the result. Language code must be provided according to RFC 4647 standard.
595
- * **Documentation**: http://developer.here.com/rest-apis/documentation/geocoder
596
- * **Terms of Service**: http://developer.here.com/faqs#l&t
597
- * **Limitations**: ?
598
-
599
- #### ESRI (`:esri`)
600
-
601
- * **API key**: optional (set `Geocoder.configure(:esri => {:api_key => ["client_id", "client_secret"]})`)
602
- * **Quota**: Required for some scenarios (see Terms of Service)
603
- * **Region**: world
604
- * **SSL support**: yes
605
- * **Languages**: English
606
- * **Documentation**: https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm
607
- * **Terms of Service**: http://www.esri.com/legal/software-license
608
- * **Limitations**: Requires API key if results will be stored. Using API key will also remove rate limit.
609
- * **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})`
610
-
611
- #### Mapzen (`:mapzen`)
612
-
613
- * **API key**: required
614
- * **Quota**: 25,000 free requests/month and [ability to purchase more](https://mapzen.com/pricing/)
615
- * **Region**: world
616
- * **SSL support**: yes
617
- * **Languages**: en; see https://mapzen.com/documentation/search/language-codes/
618
- * **Documentation**: https://mapzen.com/documentation/search/search/
619
- * **Terms of Service**: http://mapzen.com/terms
620
- * **Limitations**: [You must provide attribution](https://mapzen.com/rights/)
621
- * **Notes**: Mapzen is the primary author of Pelias and offers Pelias-as-a-service in free and paid versions https://mapzen.com/pelias.
622
-
623
- #### Pelias (`:pelias`)
624
-
625
- * **API key**: configurable (self-hosted service)
626
- * **Quota**: none (self-hosted service)
627
- * **Region**: world
628
- * **SSL support**: yes
629
- * **Languages**: en; see https://mapzen.com/documentation/search/language-codes/
630
- * **Documentation**: http://pelias.io/
631
- * **Terms of Service**: http://pelias.io/data_licenses.html
632
- * **Limitations**: See terms
633
- * **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`.
634
-
635
- #### Data Science Toolkit (`:dstk`)
636
-
637
- Data Science Toolkit provides an API whose response format is like Google's but which can be set up as a privately hosted service.
638
-
639
- * **API key**: none
640
- * **Quota**: No quota if you are self-hosting the service.
641
- * **Region**: world
642
- * **SSL support**: ?
643
- * **Languages**: en
644
- * **Documentation**: http://www.datasciencetoolkit.org/developerdocs
645
- * **Terms of Service**: http://www.datasciencetoolkit.org/developerdocs#googlestylegeocoder
646
- * **Limitations**: No reverse geocoding.
647
- * **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"})`.
648
-
649
- #### Baidu (`:baidu`)
650
-
651
- * **API key**: required
652
- * **Quota**: No quota limits for geocoding
653
- * **Region**: China
654
- * **SSL support**: no
655
- * **Languages**: Chinese (Simplified)
656
- * **Documentation**: http://developer.baidu.com/map/webservice-geocoding.htm
657
- * **Terms of Service**: http://developer.baidu.com/map/law.htm
658
- * **Limitations**: Only good for non-commercial use. For commercial usage please check http://developer.baidu.com/map/question.htm#qa0013
659
- * **Notes**: To use Baidu set `Geocoder.configure(:lookup => :baidu, :api_key => "your_api_key")`.
660
-
661
- #### Geocodio (`:geocodio`)
662
-
663
- * **API key**: required
664
- * **Quota**: 2,500 free requests/day then purchase $0.0005 for each, also has volume pricing and plans.
665
- * **Region**: USA & Canada
666
- * **SSL support**: yes
667
- * **Languages**: en
668
- * **Documentation**: https://geocod.io/docs/
669
- * **Terms of Service**: https://geocod.io/terms-of-use/
670
- * **Limitations**: No restrictions on use
671
-
672
- #### SmartyStreets (`:smarty_streets`)
673
-
674
- * **API key**: requires auth_id and auth_token (set `Geocoder.configure(:api_key => [id, token])`)
675
- * **Quota**: 250/month then purchase at sliding scale.
676
- * **Region**: US
677
- * **SSL support**: yes (required)
678
- * **Languages**: en
679
- * **Documentation**: http://smartystreets.com/kb/liveaddress-api/rest-endpoint
680
- * **Terms of Service**: http://smartystreets.com/legal/terms-of-service
681
- * **Limitations**: No reverse geocoding.
682
-
683
-
684
- #### OKF Geocoder (`:okf`)
685
-
686
- * **API key**: none
687
- * **Quota**: none
688
- * **Region**: FI
689
- * **SSL support**: no
690
- * **Languages**: fi
691
- * **Documentation**: http://books.okf.fi/geocoder/_full/
692
- * **Terms of Service**: http://www.itella.fi/liitteet/palvelutjatuotteet/yhteystietopalvelut/Postinumeropalvelut-Palvelukuvausjakayttoehdot.pdf
693
- * **Limitations**: ?
694
-
695
- #### Geoportail.lu (`:geoportail_lu`)
696
-
697
- * **API key**: none
698
- * **Quota**: none
699
- * **Region**: LU
700
- * **SSL support**: yes
701
- * **Languages**: en
702
- * **Documentation**: http://wiki.geoportail.lu/doku.php?id=en:api
703
- * **Terms of Service**: http://wiki.geoportail.lu/doku.php?id=en:mcg_1
704
- * **Limitations**: ?
705
-
706
- #### PostcodeAnywhere Uk (`:postcode_anywhere_uk`)
707
-
708
- This uses the PostcodeAnywhere UK Geocode service, this will geocode any string from UK postcode, placename, point of interest or location.
709
-
710
- * **API key**: required
711
- * **Quota**: Dependant on service plan?
712
- * **Region**: UK
713
- * **SSL support**: yes
714
- * **Languages**: English
715
- * **Documentation**: [http://www.postcodeanywhere.co.uk/Support/WebService/Geocoding/UK/Geocode/2/](http://www.postcodeanywhere.co.uk/Support/WebService/Geocoding/UK/Geocode/2/)
716
- * **Terms of Service**: ?
717
- * **Limitations**: ?
718
- * **Notes**: To use PostcodeAnywhere you must include an API key: `Geocoder.configure(:lookup => :postcode_anywhere_uk, :api_key => 'your_api_key')`.
719
-
720
- #### LatLon.io (`:latlon`)
721
-
722
- * **API key**: required
723
- * **Quota**: Depends on the user's plan (free and paid plans available)
724
- * **Region**: US
725
- * **SSL support**: yes
726
- * **Languages**: en
727
- * **Documentation**: https://latlon.io/documentation
728
- * **Terms of Service**: ?
729
- * **Limitations**: No restrictions on use
730
-
731
- #### Base Adresse Nationale FR (`:ban_data_gouv_fr`)
732
-
733
- * **API key**: none
734
- * **Quota**: none
735
- * **Region**: FR
736
- * **SSL support**: yes
737
- * **Languages**: en / fr
738
- * **Documentation**: https://adresse.data.gouv.fr/api/ (in french)
739
- * **Terms of Service**: https://adresse.data.gouv.fr/faq/ (in french)
740
- * **Limitations**: [Data licensed under Open Database License (ODbL) (you must provide attribution).](http://openstreetmap.fr/ban)
741
-
742
- #### AMap (`:amap`)
743
-
744
- - **API key**: required
745
- - **Quota**: 2000/day and 2000/minute for personal developer, 4000000/day and 60000/minute for enterprise developer, for geocoding requests
746
- - **Region**: China
747
- - **SSL support**: yes
748
- - **Languages**: Chinese (Simplified)
749
- - **Documentation**: http://lbs.amap.com/api/webservice/guide/api/georegeo
750
- - **Terms of Service**: http://lbs.amap.com/home/terms/
751
- - **Limitations**: Only good for non-commercial use. For commercial usage please check http://lbs.amap.com/home/terms/
752
- - **Notes**: To use AMap set `Geocoder.configure(:lookup => :amap, :api_key => "your_api_key")`.
753
-
754
- ### IP Address Services
755
-
756
- #### IPInfo.io (`:ipinfo_io`)
757
-
758
- * **API key**: optional - see http://ipinfo.io/pricing
759
- * **Quota**: 1,000/day - more with api key
760
- * **Region**: world
761
- * **SSL support**: no (not without access key - see http://ipinfo.io/pricing)
762
- * **Languages**: English
763
- * **Documentation**: http://ipinfo.io/developers
764
- * **Terms of Service**: http://ipinfo.io/developers
765
-
766
- #### FreeGeoIP (`:freegeoip`) - [DISCONTINUED](https://github.com/alexreisner/geocoder/wiki/Freegeoip-Discontinuation)
767
-
768
- * **API key**: none
769
- * **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.
770
- * **Region**: world
771
- * **SSL support**: no
772
- * **Languages**: English
773
- * **Documentation**: http://github.com/fiorix/freegeoip/blob/master/README.md
774
- * **Terms of Service**: ?
775
- * **Limitations**: ?
776
- * **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: "..."})`.
777
-
778
- #### Pointpin (`:pointpin`)
779
-
780
- * **API key**: required
781
- * **Quota**: 50,000/mo for €9 through 1m/mo for €49
782
- * **Region**: world
783
- * **SSL support**: yes
784
- * **Languages**: English
785
- * **Documentation**: https://pointp.in/docs/get-started
786
- * **Terms of Service**: https://pointp.in/terms
787
- * **Limitations**: ?
788
- * **Notes**: To use Pointpin set `Geocoder.configure(:ip_lookup => :pointpin, :api_key => "your_pointpin_api_key")`.
789
-
790
- #### Telize (`:telize`)
791
-
792
- * **API key**: required
793
- * **Quota**: 1,000/day for $7/mo through 100,000/day for $100/mo
794
- * **Region**: world
795
- * **SSL support**: yes
796
- * **Languages**: English
797
- * **Documentation**: https://market.mashape.com/fcambus/telize
798
- * **Terms of Service**: ?
799
- * **Limitations**: ?
800
- * **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"})`.
801
-
802
-
803
- #### MaxMind Legacy Web Services (`:maxmind`)
804
-
805
- * **API key**: required
806
- * **Quota**: Request Packs can be purchased
807
- * **Region**: world
808
- * **SSL support**: yes
809
- * **Languages**: English
810
- * **Documentation**: http://dev.maxmind.com/geoip/legacy/web-services/
811
- * **Terms of Service**: ?
812
- * **Limitations**: ?
813
- * **Notes**: You must specify which MaxMind service you are using in your configuration. For example: `Geocoder.configure(:maxmind => {:service => :omni})`.
814
-
815
- #### Baidu IP (`:baidu_ip`)
816
-
817
- * **API key**: required
818
- * **Quota**: No quota limits for geocoding
819
- * **Region**: China
820
- * **SSL support**: no
821
- * **Languages**: Chinese (Simplified)
822
- * **Documentation**: http://developer.baidu.com/map/webservice-geocoding.htm
823
- * **Terms of Service**: http://developer.baidu.com/map/law.htm
824
- * **Limitations**: Only good for non-commercial use. For commercial usage please check http://developer.baidu.com/map/question.htm#qa0013
825
- * **Notes**: To use Baidu set `Geocoder.configure(:lookup => :baidu_ip, :api_key => "your_api_key")`.
826
-
827
- #### MaxMind GeoIP2 Precision Web Services (`:maxmind_geoip2`)
828
-
829
- * **API key**: required
830
- * **Quota**: Request Packs can be purchased
831
- * **Region**: world
832
- * **SSL support**: yes
833
- * **Languages**: English
834
- * **Documentation**: http://dev.maxmind.com/geoip/geoip2/web-services/
835
- * **Terms of Service**: ?
836
- * **Limitations**: ?
837
- * **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 => ''}})`.
838
-
839
- #### Ipstack (`:ipstack`)
840
-
841
- * **API key**: required (see https://ipstack.com/product)
842
- * **Quota**: 10,000 requests per month (with free API Key, 50,000/day and up for paid plans)
843
- * **Region**: world
844
- * **SSL support**: yes ( only with paid plan )
845
- * **Languages**: English, German, Spanish, French, Japanese, Portugues (Brazil), Russian, Chinese
846
- * **Documentation**: https://ipstack.com/documentation
847
- * **Terms of Service**: ?
848
- * **Limitations**: ?
849
- * **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).
850
-
851
- #### IP-API.com (`:ipapi_com`)
852
-
853
- * **API key**: optional - see http://ip-api.com/docs/#usage_limits
854
- * **Quota**: 150/minute - unlimited with api key
855
- * **Region**: world
856
- * **SSL support**: no (not without access key - see https://signup.ip-api.com/)
857
- * **Languages**: English
858
- * **Documentation**: http://ip-api.com/docs/
859
- * **Terms of Service**: https://signup.ip-api.com/terms
860
-
861
- #### DB-IP.com (`:db_ip_com`)
862
-
863
- * **API key**: required
864
- * **Quota**: 2,500/day (with free API Key, 50,000/day and up for paid API keys)
865
- * **Region**: world
866
- * **SSL support**: yes (with paid API keys - see https://db-ip.com/api/)
867
- * **Languages**: English (English with free API key, multiple languages with paid API keys)
868
- * **Documentation**: https://db-ip.com/api/doc.php
869
- * **Terms of Service**: https://db-ip.com/tos.php
870
-
871
- #### Ipdata.co (`:ipdata_co`)
872
-
873
- * **API key**: optional, see: https://ipdata.co/pricing.html
874
- * **Quota**: 1500/day (up to 600k with paid API keys)
875
- * **Region**: world
876
- * **SSL support**: yes
877
- * **Languages**: English
878
- * **Documentation**: https://ipdata.co/docs.html
879
- * **Terms of Service**: https://ipdata.co/terms.html
880
- * **Limitations**: ?
881
-
882
-
883
- ### IP Address Local Database Services
884
-
885
- #### MaxMind Local (`:maxmind_local`) - EXPERIMENTAL
886
-
887
- 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.
888
-
889
- * **API key**: none (requires the GeoLite City database which can be downloaded from [MaxMind](http://dev.maxmind.com/geoip/legacy/geolite/))
890
- * **Quota**: none
891
- * **Region**: world
892
- * **SSL support**: N/A
893
- * **Languages**: English
894
- * **Documentation**: http://www.maxmind.com/en/city
895
- * **Terms of Service**: ?
896
- * **Limitations**: ?
897
- * **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.**
898
-
899
- **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:
900
-
901
- Geocoder.configure(ip_lookup: :maxmind_local, maxmind_local: {file: File.join('folder', 'GeoLiteCity.dat')})
902
-
903
- **To use a CSV file** you must import it into an SQL database. The GeoLite *City* and *Country* packages are supported. Configure like so:
904
-
905
- Geocoder.configure(ip_lookup: :maxmind_local, maxmind_local: {package: :city})
906
-
907
- You can generate ActiveRecord migrations and download and import data via provided rake tasks:
908
-
909
- # generate migration to create tables
910
- rails generate geocoder:maxmind:geolite_city
911
-
912
- # download, unpack, and import data
913
- rake geocoder:maxmind:geolite:load PACKAGE=city
914
-
915
- You can replace `city` with `country` in any of the above tasks, generators, and configurations.
916
-
917
- #### GeoLite2 (`:geoip2`)
918
-
919
- 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.
920
-
921
- * **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/))
922
- * **Quota**: none
923
- * **Region**: world
924
- * **SSL support**: N/A
925
- * **Languages**: English
926
- * **Documentation**: http://www.maxmind.com/en/city
927
- * **Terms of Service**: ?
928
- * **Limitations**: ?
929
- * **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:
930
-
931
- Geocoder.configure(
932
- ip_lookup: :geoip2,
933
- geoip2: {
934
- file: File.join('folder', 'GeoLite2-City.mmdb')
935
- }
936
- )
937
-
938
- 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`:
939
-
940
- Geocoder.configure(
941
- ip_lookup: :geoip2,
942
- geoip2: {
943
- lib: 'hive_geoip2',
944
- file: File.join('folder', 'GeoLite2-City.mmdb')
945
- }
946
- )
947
-
948
- Caching
949
- -------
406
+ class Venue
407
+ geocoded_by :address,
408
+ latitude: :fetched_latitude,
409
+ longitude: :fetched_longitude
410
+ reverse_geocoded_by :latitude, :longitude
411
+ end
950
412
 
951
- 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:
952
413
 
953
- Geocoder.configure(:cache => Redis.new)
414
+ Advanced Database Queries
415
+ -------------------------
954
416
 
955
- This example uses Redis, but the cache store can be any object that supports these methods:
417
+ *The following apply to ActiveRecord only. For MongoDB, please use the built-in geospatial features.*
956
418
 
957
- * `store#[](key)` or `#get` or `#read` - retrieves a value
958
- * `store#[]=(key, value)` or `#set` or `#write` - stores a value
959
- * `store#del(url)` - deletes a value
960
- * `store#keys` - (Optional) Returns array of keys. Used if you wish to expire the entire cache (see below).
419
+ The default `near` search looks for objects within a circle. To search within a doughnut or ring use the `:min_radius` option:
961
420
 
962
- 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).
421
+ Venue.near("Austin, TX", 200, min_radius: 40)
963
422
 
964
- You can also set a custom prefix to be used for cache keys:
423
+ To search within a rectangle (note that results will *not* include `distance` and `bearing` attributes):
965
424
 
966
- Geocoder.configure(:cache_prefix => "...")
425
+ sw_corner = [40.71, 100.23]
426
+ ne_corner = [36.12, 88.65]
427
+ Venue.within_bounding_box(sw_corner, ne_corner)
967
428
 
968
- By default the prefix is `geocoder:`
429
+ 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:
969
430
 
970
- If you need to expire cached content:
431
+ Venue.near([40.71, 99.23], :effective_radius)
971
432
 
972
- Geocoder::Lookup.get(Geocoder.config[:lookup]).cache.expire(:all) # expire cached results for current Lookup
973
- Geocoder::Lookup.get(:google).cache.expire("http://...") # expire cached result for a specific URL
974
- Geocoder::Lookup.get(:google).cache.expire(:all) # expire cached results for Google Lookup
975
- # expire all cached results for all Lookups.
976
- # Be aware that this methods spawns a new Lookup object for each Service
977
- Geocoder::Lookup.all_services.each{|service| Geocoder::Lookup.get(service).cache.expire(:all)}
433
+ If you store multiple sets of coordinates for each object, you can specify latitude and longitude columns to use for a search:
978
434
 
979
- 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.
980
-
981
- For an example of a cache store with URL expiry, please see examples/autoexpire_cache.rb
982
-
983
- _Before you implement caching in your app please be sure that doing so does not violate the Terms of Service for your geocoding service._
435
+ Venue.near("Paris", 50, latitude: :secondary_latitude, longitude: :secondary_longitude)
984
436
 
437
+ ### Distance and Bearing
985
438
 
986
- Forward and Reverse Geocoding in the Same Model
987
- -----------------------------------------------
439
+ When you run a geospatial query, the returned objects have two attributes added:
988
440
 
989
- 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:
441
+ * `obj.distance` - number of miles from the search point to this object
442
+ * `obj.bearing` - direction from the search point to this object
990
443
 
991
- * one for storing the fetched address (reverse geocoding)
992
- * one for providing an address to use when fetching coordinates (forward geocoding)
444
+ 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:
993
445
 
994
- For example:
446
+ * `0` - due north
447
+ * `180` - due south
448
+ * `90` - due east
449
+ * `270` - due west
450
+ * `230.1` - southwest
451
+ * `359.9` - almost due north
995
452
 
996
- class Venue
453
+ You can convert these to compass point names via provided method:
997
454
 
998
- # build an address from street, city, and state attributes
999
- geocoded_by :address_from_components
455
+ Geocoder::Calculations.compass_point(355) # => "N"
456
+ Geocoder::Calculations.compass_point(45) # => "NE"
457
+ Geocoder::Calculations.compass_point(208) # => "SW"
1000
458
 
1001
- # store the fetched address in the full_address attribute
1002
- reverse_geocoded_by :latitude, :longitude, :address => :full_address
1003
- end
459
+ _Note: when running queries on SQLite, `distance` and `bearing` are provided for consistency only. They are not very accurate._
1004
460
 
1005
- However, there can be only one set of latitude/longitude attributes, and whichever you specify last will be used. For example:
461
+ For more advanced geospatial querying, please see the [rgeo gem](https://github.com/rgeo/rgeo).
1006
462
 
1007
- class Venue
1008
463
 
1009
- geocoded_by :address,
1010
- :latitude => :fetched_latitude, # this will be overridden by the below
1011
- :longitude => :fetched_longitude # same here
464
+ Geospatial Calculations
465
+ -----------------------
1012
466
 
1013
- reverse_geocoded_by :latitude, :longitude
1014
- end
467
+ The `Geocoder::Calculations` module contains some useful methods:
1015
468
 
1016
- We don't want ambiguity when doing distance calculations -- we need a single, authoritative source for coordinates!
1017
-
1018
- Once both forward and reverse geocoding has been applied, it is possible to call them sequentially.
1019
-
1020
- For example:
1021
-
1022
- class Venue
469
+ # find the distance between two arbitrary points
470
+ Geocoder::Calculations.distance_between([47.858205,2.294359], [40.748433,-73.985655])
471
+ => 3619.77359999382 # in configured units (default miles)
1023
472
 
1024
- after_validation :geocode, :reverse_geocode
473
+ # find the geographic center (aka center of gravity) of objects or points
474
+ Geocoder::Calculations.geographic_center([city1, city2, [40.22,-73.99], city4])
475
+ => [35.14968, -90.048929]
1025
476
 
1026
- end
477
+ See [the code](https://github.com/alexreisner/geocoder/blob/master/lib/geocoder/calculations.rb) for more!
1027
478
 
1028
- 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:
1029
479
 
1030
- after_validation :geocode
480
+ Batch Geocoding
481
+ ---------------
1031
482
 
1032
- 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.
483
+ 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:
1033
484
 
1034
- For example:
485
+ rake geocode:all CLASS=YourModel
1035
486
 
1036
- class Venue
487
+ If you need reverse geocoding instead, call the task with REVERSE=true:
1037
488
 
1038
- after_validation :reverse_geocode, :if => :has_coordinates
1039
- after_validation :geocode, :if => :has_location, :unless => :has_coordinates
489
+ rake geocode:all CLASS=YourModel REVERSE=true
1040
490
 
1041
- end
491
+ 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:
1042
492
 
1043
- Use Outside of Rails
1044
- --------------------
493
+ rake geocode:all CLASS=YourModel SLEEP=0.25 BATCH=100
1045
494
 
1046
- You can use Geocoder outside of Rails by calling the `Geocoder.search` method:
495
+ To avoid exceeding per-day limits you can add a `LIMIT` option. However, this will ignore the `BATCH` value, if provided.
1047
496
 
1048
- results = Geocoder.search("McCarren Park, Brooklyn, NY")
497
+ rake geocode:all CLASS=YourModel LIMIT=1000
1049
498
 
1050
- This returns an array of `Geocoder::Result` objects with all data provided by the geocoding service.
1051
499
 
500
+ Testing
501
+ -------
1052
502
 
1053
- Testing Apps that Use Geocoder
1054
- ------------------------------
503
+ 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`
1055
504
 
1056
- 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:
505
+ Geocoder.configure(lookup: :test, ip_lookup: :test)
1057
506
 
1058
- Geocoder.configure(:lookup => :test)
507
+ Add stubs to define the results that will be returned:
1059
508
 
1060
509
  Geocoder::Lookup::Test.add_stub(
1061
510
  "New York, NY", [
@@ -1070,9 +519,7 @@ When writing tests for an app that uses Geocoder it may be useful to avoid netwo
1070
519
  ]
1071
520
  )
1072
521
 
1073
- 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:
1074
-
1075
- Geocoder.configure(:lookup => :test)
522
+ 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:
1076
523
 
1077
524
  Geocoder::Lookup::Test.set_default_stub(
1078
525
  [
@@ -1089,11 +536,35 @@ Now, any time Geocoder looks up "New York, NY" its results array will contain on
1089
536
 
1090
537
  Notes:
1091
538
 
1092
- - Keys must be strings not symbols when calling `add_stub` or `set_default_stub`. For example `'latitude' =>` not `:latitude =>`.
539
+ - Keys must be strings (not symbols) when calling `add_stub` or `set_default_stub`. For example `'country' =>` not `:country =>`.
1093
540
  - To clear stubs (e.g. prior to another spec), use `Geocoder::Lookup::Test.reset`. This will clear all stubs _including the default stub_.
1094
541
  - 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.
1095
542
 
1096
543
 
544
+ Error Handling
545
+ --------------
546
+
547
+ 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:
548
+
549
+ Geocoder.configure(always_raise: [SocketError, Timeout::Error])
550
+
551
+ You can also do this to raise all exceptions:
552
+
553
+ Geocoder.configure(always_raise: :all)
554
+
555
+ The raise-able exceptions are:
556
+
557
+ SocketError
558
+ Timeout::Error
559
+ Geocoder::OverQueryLimitError
560
+ Geocoder::RequestDenied
561
+ Geocoder::InvalidRequest
562
+ Geocoder::InvalidApiKey
563
+ Geocoder::ServiceUnavailable
564
+
565
+ 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.
566
+
567
+
1097
568
  Command Line Interface
1098
569
  ----------------------
1099
570
 
@@ -1107,63 +578,18 @@ When you install the Geocoder gem it adds a `geocode` command to your shell. You
1107
578
  State/province: Louisiana
1108
579
  Postal code: 70112
1109
580
  Country: United States
1110
- Google map: http://maps.google.com/maps?q=29.952211,-90.080563
581
+ Map: http://maps.google.com/maps?q=29.952211,-90.080563
1111
582
 
1112
583
  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.
1113
584
 
1114
- Numeric Data Types and Precision
1115
- --------------------------------
1116
-
1117
- Geocoder works with any numeric data type (e.g. float, double, decimal) on which trig (and other mathematical) functions can be performed.
1118
-
1119
- 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.
1120
-
1121
- Notes on MongoDB
1122
- ----------------
1123
-
1124
- ### The Near Method
1125
-
1126
- 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.
1127
-
1128
- ### Latitude/Longitude Order
1129
-
1130
- 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.
1131
-
1132
- To access an object's coordinates in the conventional order, use the `to_coordinates` instance method provided by Geocoder. For example:
1133
-
1134
- obj.to_coordinates # => [37.7941013, -122.3951096] # [lat, lon]
1135
-
1136
- 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:
1137
-
1138
- obj.coordinates # => [-122.3951096, 37.7941013] # [lon, lat]
1139
-
1140
- For consistency with the rest of Geocoder, always use the `to_coordinates` method instead.
1141
-
1142
- Notes on Non-Rails Frameworks
1143
- -----------------------------
1144
-
1145
- 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:
1146
-
1147
- extend Geocoder::Model::ActiveRecord
1148
-
1149
- Optimisation of Distance Queries
1150
- --------------------------------
1151
585
 
1152
- 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.
586
+ Technical Discussions
587
+ ---------------------
1153
588
 
1154
- To take advantage of this optimisation, you need to add a composite index on latitude and longitude. In your Rails migration:
1155
-
1156
- add_index :table, [:latitude, :longitude]
1157
-
1158
-
1159
- Distance Queries in SQLite
1160
- --------------------------
589
+ ### Distance Queries in SQLite
1161
590
 
1162
591
  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.
1163
592
 
1164
-
1165
- ### Discussion
1166
-
1167
593
  There are few options for finding objects near a given point in SQLite without installing extensions:
1168
594
 
1169
595
  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.
@@ -1174,37 +600,11 @@ There are few options for finding objects near a given point in SQLite without i
1174
600
 
1175
601
  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.
1176
602
 
603
+ ### Numeric Data Types and Precision
1177
604
 
1178
- Tests
1179
- -----
1180
-
1181
- 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:
1182
-
1183
- http://github.com/alexreisner/geocoder_test
1184
-
1185
-
1186
- Error Handling
1187
- --------------
1188
-
1189
- 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:
1190
-
1191
- Geocoder.configure(:always_raise => [SocketError, Timeout::Error])
1192
-
1193
- You can also do this to raise all exceptions:
1194
-
1195
- Geocoder.configure(:always_raise => :all)
1196
-
1197
- The raise-able exceptions are:
1198
-
1199
- SocketError
1200
- Timeout::Error
1201
- Geocoder::OverQueryLimitError
1202
- Geocoder::RequestDenied
1203
- Geocoder::InvalidRequest
1204
- Geocoder::InvalidApiKey
1205
- Geocoder::ServiceUnavailable
605
+ Geocoder works with any numeric data type (e.g. float, double, decimal) on which trig (and other mathematical) functions can be performed.
1206
606
 
1207
- 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.
607
+ 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.
1208
608
 
1209
609
 
1210
610
  Troubleshooting
@@ -1240,26 +640,23 @@ For the most part, the speed of geocoding requests has little to do with the Geo
1240
640
 
1241
641
  Take a look at the server's raw response. You can do this by getting the request URL in an app console:
1242
642
 
1243
- Geocoder::Lookup.get(:google).query_url(Geocoder::Query.new("..."))
643
+ Geocoder::Lookup.get(:nominatim).query_url(Geocoder::Query.new("..."))
1244
644
 
1245
- 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.
645
+ 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.
1246
646
 
1247
647
  You can also fetch the response in the console:
1248
648
 
1249
- Geocoder::Lookup.get(:google).send(:fetch_raw_data, Geocoder::Query.new("..."))
1250
-
1251
-
1252
- Reporting Issues
1253
- ----------------
649
+ Geocoder::Lookup.get(:nominatim).send(:fetch_raw_data, Geocoder::Query.new("..."))
1254
650
 
1255
- 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?).
1256
651
 
1257
- 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.
652
+ Known Issues
653
+ ------------
1258
654
 
655
+ ### Using `count` with Rails 4.1+
1259
656
 
1260
- ### Known Issues
657
+ 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.
1261
658
 
1262
- #### Using `near` with `includes`
659
+ ### Using `near` with `includes`
1263
660
 
1264
661
  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).
1265
662
 
@@ -1267,7 +664,7 @@ Instead of using `includes` to reduce the number of database queries, try using
1267
664
 
1268
665
  # Pass a :select option to the near scope to get the columns you want.
1269
666
  # Instead of City.near(...).includes(:venues), try:
1270
- City.near("Omaha, NE", 20, :select => "cities.*, venues.*").joins(:venues)
667
+ City.near("Omaha, NE", 20, select: "cities.*, venues.*").joins(:venues)
1271
668
 
1272
669
  # This preload call will normally trigger two queries regardless of the
1273
670
  # number of results; one query on hotels, and one query on administrators.
@@ -1276,11 +673,19 @@ Instead of using `includes` to reduce the number of database queries, try using
1276
673
 
1277
674
  If anyone has a more elegant solution to this problem I am very interested in seeing it.
1278
675
 
1279
- #### Using `near` with objects close to the 180th meridian
676
+ ### Using `near` with objects close to the 180th meridian
1280
677
 
1281
678
  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.
1282
679
 
1283
680
 
681
+ Reporting Issues
682
+ ----------------
683
+
684
+ 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?).
685
+
686
+ 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.
687
+
688
+
1284
689
  Contributing
1285
690
  ------------
1286
691
 
@@ -1298,4 +703,4 @@ For all contributions, please respect the following guidelines:
1298
703
  * 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.
1299
704
 
1300
705
 
1301
- Copyright (c) 2009-15 Alex Reisner, released under the MIT license
706
+ Copyright :copyright: 2009-2020 Alex Reisner, released under the MIT license.