Project

azimuth

0.0
No commit activity in last 3 years
No release in over 3 years
Simple Ruby wrapper for the MapQuest Direction API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 0.8.9
~> 2.0.5
~> 1.8.1
~> 1.9.2
 Project Readme

Azimuth

Simple Ruby wrapper for the MapQuest Directions API.

Current version: Gem Version

Build status:        Build Status

Code metrics:      Code Climate Coverage Status

Ruby support:

  • 1.9.2
  • 1.9.3
  • 2.0.0
  • 2.1.0

Installation

Install via Rubygems

gem install azimuth

or add to your Gemfile

gem 'azimuth'

Configuration

API methods are available as module methods

Azimuth.configure do |c|
  c.api_endpoint = 'http://newendpoint/'
  c.api_key = 'YOUR_MAP_QUEST_API_KEY'
end

or as client instance methods

Azimuth::Client.new(
	api_endpoint: 'http://newendpoint/',
	api_key: 'YOUR_MAP_QUEST_API_KEY',
)

Authentication

Azimuth only supports authentication via an API key.

You can request one following these steps.

Usage

locations = Azimuth.route_matrix(["48.843079, 2.314442", "48.869061, 2.383329"])
p locations
# => [{"latitude"=>48.869061, "longitude"=>2.383329, "time"=>0, "distance"=>0}]

# etc…

Features

Azimuth supports the following MapQuest Directions API methods:

Complete Azimuth public API's documentation here.

Similar libraries

Versioning

Azimuth follows the principles of semantic versioning.

  1. Patch level releases contain only bug fixes.
  2. Minor releases contain backward-compatible new features.
  3. Major new releases contain backwards-incompatible changes to the public API.

Contributing

Pull Requests are welcome !

Please refer to the Contributing guide for more details on how to run the test suite and to contribute.

Copyright

Copyright © 2014 Aylic Petit

Released under the terms of the MIT licence. See the LICENSE file for more details.