/open_route_client

OpenRouteService wrapper for Ruby.

Primary LanguageRubyMIT LicenseMIT

OpenRouteClient

This gem provides a Ruby wrapper for the OpenRouteService and is in the super alpha stage. I needed this API for one project and now I'll use more of it so it will probably grow.

Installation

Add this line to your application's Gemfile:

gem 'open_route_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install open_route_client

Usage

There are two simple use cases write now.

# returns location coordinates
OpenRouteClient.locate("Muzeum Narodowe, Warsaw, Poland")

# returns distance in kilometers
OpenRouteClient.fetch_distance("Muzeum Narodowe, Warsaw, Poland", "Muzeum Narodowe, Poznan, Poland")

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/open_route_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the OpenRouteClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.