Nominatim
A Ruby wrapper for the Nominatim API.
This project is a fork from original Nominatim wrapper for Ruby.
Even though the version was bumped from 0.x to 1.x, the API is compatible with the original project.
Installation
Add this line to your application's Gemfile:
gem 'ruby-nominatim'
And then execute:
$ bundle
Or install it yourself as:
$ gem install ruby-nominatim
Documentation
[http://rdoc.info/gems/ruby-nominatim][documentation]
Usage
places = Nominatim.search('San Francisco').limit(10).address_details(true)
for place in places
puts "#{place.display_name} (#{place.type})"
end
puts "Found #{places.count} places."
Configuration
Nominatim.configure do |config|
config.email = 'your-email-address@example.com'
config.endpoint = 'http://open.mapquestapi.com/nominatim/v1'
end
Contributing
- Fork the repository.
- Create a topic branch.
- Add specs for your unimplemented feature or bug fix.
- Run
bundle exec rake spec
. If your specs pass, return to step 3. - Implement your feature or bug fix.
- Run
bundle exec rake spec
. If your specs fail, return to step 5. - Run
open coverage/index.html
. If your changes are not completely covered by your tests, return to step 3. - Add, commit, and push your changes.
- Submit a pull request.
Supported Ruby Versions
Nominatim is tested under 1.9.2 and 1.9.3, 2.1 and 2.2.
Copyright
Copyright (c) 2012 Jakub Svehla Copyright (c) 2012 onwards ruby-nominatim contributors
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.