README.md in geocoder-1.2.8 vs README.md in geocoder-1.2.9
- old
+ new
@@ -161,13 +161,13 @@
# look up coordinates of some location (like searching Google Maps)
Geocoder.coordinates("25 Main St, Cooperstown, NY")
=> [42.700149, -74.922767]
- # distance (in miles) between Eiffel Tower and Empire State Building
+ # distance between Eiffel Tower and Empire State Building
Geocoder::Calculations.distance_between([47.858205,2.294359], [40.748433,-73.985655])
- => 3619.77359999382
+ => 3619.77359999382 # in configured units (default miles)
# find the geographic center (aka center of gravity) of objects or points
Geocoder::Calculations.geographic_center([city1, city2, [40.22,-73.99], city4])
=> [35.14968, -90.048929]
@@ -422,12 +422,12 @@
* **Limitations**: No mass downloads, no commercial map production based on the data, no storage of data except for caching.
#### Bing (`:bing`)
* **API key**: required (set `Geocoder.configure(:lookup => :bing, :api_key => key)`)
-* **Key signup**: http://www.bingmapsportal.com
-* **Quota**: 50,000 requests/24 hrs
+* **Key signup**: https://www.microsoft.com/maps/create-a-bing-maps-key.aspx
+* **Quota**: 50,0000 requests/day (Windows app), 125,000 requests/year (non-Windows app)
* **Region**: world
* **SSL support**: no
* **Languages**: ?
* **Documentation**: http://msdn.microsoft.com/en-us/library/ff701715.aspx
* **Terms of Service**: http://www.microsoft.com/maps/product/terms.html
@@ -492,20 +492,19 @@
#### Mapquest (`:mapquest`)
* **API key**: required
* **Key signup**: http://developer.mapquest.com/web/products/open
* **Quota**: ?
-* **HTTP Headers**: in order to use the licensed API you can configure the http_headers to include a referer as so:
+* **HTTP Headers**: when using the licensed API you can specify a referer like so:
`Geocoder.configure(:http_headers => { "Referer" => "http://foo.com" })`
- You can also allow a blank referer from the API management console via mapquest but it is potentially a security risk that someone else could use your API key from another domain.
* **Region**: world
* **SSL support**: no
* **Languages**: English
* **Documentation**: http://www.mapquestapi.com/geocoding/
* **Terms of Service**: http://info.mapquest.com/terms-of-use/
* **Limitations**: ?
-* **Notes**: You can specify the licensed API by setting: `Geocoder.configure(:mapquest => {:licensed => true})` (defaults to free "open" version)
+* **Notes**: You can use the open (non-licensed) API by setting: `Geocoder.configure(:mapquest => {:open => true})` (defaults to licensed version)
#### Ovi/Nokia (`:ovi`)
* **API key**: not required, but performance restricted without it
* **Quota**: ?
@@ -516,11 +515,11 @@
* **Terms of Service**: http://www.developer.nokia.com/Develop/Maps/TC.html
* **Limitations**: ?
#### Here/Nokia (`:here`)
-* **API key**: required
+* **API key**: required (set `Geocoder.configure(:api_key => [app_id, app_code])`)
* **Quota**: Depending on the API key
* **Region**: world
* **SSL support**: yes
* **Languages**: The preferred language of address elements in the result. Language code must be provided according to RFC 4647 standard.
* **Documentation**: http://developer.here.com/rest-apis/documentation/geocoder
@@ -579,11 +578,11 @@
#### SmartyStreets (`:smarty_streets`)
* **API key**: requires auth_id and auth_token (set `Geocoder.configure(:api_key => [id, token])`)
* **Quota**: 10,000 free, 250/month then purchase at sliding scale.
* **Region**: US
-* **SSL support**: yes
+* **SSL support**: yes (required)
* **Languages**: en
* **Documentation**: http://smartystreets.com/kb/liveaddress-api/rest-endpoint
* **Terms of Service**: http://smartystreets.com/legal/terms-of-service
* **Limitations**: No reverse geocoding.
@@ -865,11 +864,11 @@
'country_code' => 'US'
}
]
)
-Now, any time Geocoder looks up "New York, NY" its results array will contain one result with the above attributes. You can also set a default stub:
+Now, any time Geocoder looks up "New York, NY" its results array will contain one result with the above attributes. You can also set a default stub, to be returned when no other stub is found for a given query:
Geocoder.configure(:lookup => :test)
Geocoder::Lookup::Test.set_default_stub(
[
@@ -883,10 +882,9 @@
'country_code' => 'US'
}
]
)
-Any query that hasn't been explicitly stubbed will return that result.
Command Line Interface
----------------------
When you install the Geocoder gem it adds a `geocode` command to your shell. You can search for a street address, IP address, postal code, coordinates, etc just like you can with the Geocoder.search method for example: