azimuth 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bb19f0b0c81b19c9ef79e3e5ecd08850c9c302c
+  data.tar.gz: 9d58a7bfda4e2ff8b6a3d822e4e2e016d9f04b90
+SHA512:
+  metadata.gz: eafec56b6419352f70e9ffee73cd8ad57428bb38934212d777f2e9ac865b3fec7b6a3b88e95082e849657e59973ed80ecd225c116bdda9e5cec23475d8299e42
+  data.tar.gz: 19966e521427518e548a14b9a23663290b505efe5f0bdef8ff94a57f3b2090ef3d8f52ca03644083fd047ec37a1d4099a572dbd825c509a194c20f040ccbb531

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--quiet
+--markup=markdown
+--exclude lib/azimuth/response

data/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+## Running the test suite
+
+	bundle exec rake spec
+
+### Code quality
+
+Code quality is checked with [cane](https://github.com/square/cane) configured in `Rakefile`.
+
+Build fails if code quality thresholds **are not met**.
+
+### Code coverage
+
+When running the test suite a test coverage report is generated with [SimpleCov](https://github.com/colszowka/simplecov) in `coverage/index.html`.
+
+Build fails if coverage is below **99%**.
+
+## Writing new tests
+Azimuth uses [VCR](https://github.com/vcr/vcr) for recording and playing back API fixtures (in `spec/cassettes`) during test runs.
+
+If you need to record new cassettes you have to provide your MapQuest API key in `ENV['MAP_QUEST_API_KEY']` (stripped automaticaly from the cassette before being saved on disk).
+
+## Documentation
+
+Documentation is generated with [YARD](http://yardoc.org/).
+
+## Workflow
+
+1. Fork [Azimuth](https://github.com/sush/azimuth)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) [2014] [Aylic Petit]
+
+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.

data/README.md

@@ -0,0 +1,98 @@
+# Azimuth
+
+Simple Ruby wrapper for the [MapQuest Directions API](http://www.mapquestapi.com/directions).
+
+**Current version**: [![Gem Version](https://badge.fury.io/rb/azimuth.png)](http://badge.fury.io/rb/azimuth)
+
+**Build status**:        [![Build Status](https://secure.travis-ci.org/sush/azimuth.png?branch=master)](http://travis-ci.org/sush/azimuth)
+
+**Code metrics**:
+     [![Code Climate](https://codeclimate.com/github/sush/azimuth.png)](https://codeclimate.com/github/sush/azimuth)
+[![Coverage Status](https://coveralls.io/repos/sush/azimuth/badge.png?branch=master)](https://coveralls.io/r/sush/azimuth?branch=master)
+
+**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
+
+```ruby
+Azimuth.configure do |c|
+  c.api_endpoint = 'http://newendpoint/'
+  c.api_key = 'YOUR_MAP_QUEST_API_KEY'
+end
+```
+
+or as client instance methods
+
+```ruby
+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](http://developer.mapquest.com/web/products/open).
+
+## Usage
+
+
+```ruby
+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:
+
+- [Route Matrix](http://www.mapquestapi.com/directions/#matrix)
+
+Complete Azimuth public API's documentation [here](http://rubydoc.info/gems/azimuth/frames).
+
+
+## Similar libraries
+
+- [mapquest](https://github.com/ggordan/mapquest)
+
+## Versioning
+Azimuth follows the principles of [semantic versioning](http://semver.org).
+
+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](https://github.com/sush/azimuth/blob/master/CONTRIBUTING.md) 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](https://github.com/sush/azimuth/blob/master/LICENSE) file for more details.

data/Rakefile

@@ -0,0 +1,42 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+begin
+  require 'cane/rake_task'
+
+  desc 'Run cane to check quality metrics'
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.add_threshold 'coverage/.last_run.json', :>=, 99
+    cane.abc_glob = '{lib}/**/*.rb'
+    cane.abc_max = 15
+    cane.style_measure = 105
+    cane.style_exclude = %w[spec/spec_helper.rb]
+    cane.canefile = '.cane'
+  end
+rescue LoadError
+end
+
+namespace :doc do
+  begin
+    require 'yard'
+
+    YARD::Rake::YardocTask.new do |task|
+      task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
+      task.options = [
+        '--output-dir', 'doc/yard',
+        '--markup', 'markdown'
+      ]
+    end
+  rescue LoadError
+  end
+end
+
+Rake::Task[:spec].enhance do
+  Rake::Task[:quality].invoke
+end
+
+task :test => :spec
+task :default => :spec

data/azimuth.gemspec

@@ -0,0 +1,31 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'azimuth/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'azimuth'
+  gem.version = Azimuth::VERSION.dup
+  gem.license = 'MIT'
+
+  gem.summary = %q{MapQuest Direction API Ruby wrapper}
+  gem.description = %q{Simple Ruby wrapper for the MapQuest Direction API.}
+  gem.homepage = 'https://github.com/sush/azimuth'
+
+  gem.authors = ['Aylic Petit']
+  gem.email = ['sush@users.noreply.github.com']
+
+  gem.required_ruby_version = '>= 1.9.2'
+
+  gem.files = %w[.yardopts LICENSE README.md CONTRIBUTING.md Rakefile azimuth.gemspec]
+  gem.files += Dir.glob('{spec,lib}/**/*.rb')
+  gem.require_paths = ['lib']
+  gem.test_files = Dir.glob('spec/**/*')
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_dependency 'faraday', '~> 0.8.9'
+  gem.add_dependency 'faraday_middleware', '~> 0.9.0'
+  gem.add_dependency 'hashie', '~>2.0.5'
+  gem.add_dependency 'json', '~>1.8.1'
+  gem.add_dependency 'multi_json', '~>1.8.4'
+end

data/lib/azimuth.rb

@@ -0,0 +1,25 @@
+require 'azimuth/configuration'
+require 'azimuth/client'
+
+# Ruby wrapper for MapQuest Directions API
+module Azimuth
+  extend Configuration
+
+  class << self
+    # Delegates to Azimuth::Client#new
+    def new(options={})
+      Azimuth::Client.new(options)
+    end
+
+    # @private
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    # @private
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/azimuth/client.rb

@@ -0,0 +1,26 @@
+require 'azimuth/connection'
+require 'azimuth/request'
+
+require 'azimuth/client/route_matrix'
+
+module Azimuth
+  # Client for the MapQuest Directions API
+  #
+  # @see http://www.mapquestapi.com/directions
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS)
+
+    def initialize(options={})
+      options = Azimuth.options.merge(options)
+
+      Configuration::VALID_OPTIONS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Azimuth::Connection
+    include Azimuth::Request
+
+    include Azimuth::Client::RouteMatrix
+  end
+end

data/lib/azimuth/client/route_matrix.rb

@@ -0,0 +1,38 @@
+module Azimuth
+  class Client
+    # Methods for the Route Matrix API
+    #
+    # @see http://www.mapquestapi.com/directions/#matrix
+    module RouteMatrix
+      # Get calculation of the distances and driving times between locations.
+      # @param locations [Array] the locations
+      # @param options [Hash] optional parameters
+      # @option options [Hash] :manyToOne parameter
+      # @option options [Hash] :allToAll parameter
+      # @return [Hashie::Mash] the locations and their distance and traveling time
+      # @see http://www.mapquestapi.com/directions/#matrix
+      # @example
+      #   Azimuth.route_matrix(['48.843079, 2.314442', '48.869061, 2.383329']
+      def route_matrix(locations, options={})
+        parameters = { locations: locations, options: options }
+
+        format_response(post('routematrix', parameters))
+      end
+
+      private
+
+      def format_response(response)
+        response.locations.delete_at(0) unless response.allToAll
+
+        response.locations.each_with_index.map do |location, i|
+          Hashie::Mash.new(
+            latitude: location.latLng.lat,
+            longitude: location.latLng.lng,
+            time: response.time[i],
+            distance: response.distance[i]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/azimuth/configuration.rb

@@ -0,0 +1,43 @@
+module Azimuth
+  # Methods for Azimuth configuration
+  module Configuration
+    # Configurable options
+    VALID_OPTIONS = [
+      :api_endpoint,
+      :api_key,
+    ].freeze
+
+    # Default MapQuest Directions API endpoint
+    DEFAULT_API_ENDPOINT = 'http://www.mapquestapi.com/directions/v2/'
+
+    attr_accessor(*VALID_OPTIONS)
+
+    # @private
+    def self.extended(base_obj)
+      base_obj.initialize_default_options
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Default options
+    def options
+      VALID_OPTIONS.inject({}){ |o, k| o.merge!(k => send(k)) }
+    end
+
+    # Initialize default options
+    def initialize_default_options
+      self.api_endpoint = DEFAULT_API_ENDPOINT
+      self.api_key = nil
+    end
+
+    # Reset configuration options to default values
+    def reset!
+      initialize_default_options
+
+      self
+    end
+  end
+end

data/lib/azimuth/connection.rb

@@ -0,0 +1,28 @@
+require 'faraday_middleware'
+require 'azimuth/response/raise_error'
+
+module Azimuth
+  # Faraday connection methods
+  module Connection
+    private
+
+    def connection
+      options = {
+        ssl: { verify: false },
+        url: self.api_endpoint,
+      }
+
+      connection = Faraday.new(options) do |conn|
+        conn.response(:mashify)
+        conn.response(:json, content_type: /\bjson$/)
+
+        conn.use(Azimuth::Response::RaiseError)
+        conn.use(FaradayMiddleware::FollowRedirects, limit: 3)
+
+        conn.adapter(Faraday.default_adapter)
+      end
+
+      connection
+    end
+  end
+end

data/lib/azimuth/error.rb

@@ -0,0 +1,45 @@
+require 'multi_json'
+
+module Azimuth
+  # Custom error class
+  class Error < StandardError
+    # Returns the Error based on status and response message.
+    #
+    # @param [Hash] response HTTP response
+    # @return [Azimuth::Error]
+    def self.from_response(response)
+      parsed_response_info = ::MultiJson.load(response[:body])['info']
+
+      status_code = parsed_response_info['statuscode']
+
+      return if status_code == 0
+
+      if error_message = parsed_response_info['messages']
+        error_message = error_message.join(' ')
+      end
+
+      case status_code
+      when 400
+        raise Azimuth::ErrorWithInput, error_message
+      when 403
+        raise Azimuth::KeyRelatedError, error_message
+      when 500
+        raise Azimuth::UnknownError, error_message
+      when 600...699
+        raise Azimuth::OtherError, error_message
+      end
+    end
+  end
+
+  # Raised when API returns 400 error code
+  class ErrorWithInput < Error; end
+
+  # Raised when API returns 403 error code
+  class KeyRelatedError < Error; end
+
+  # Raised when API returns 500 error code
+  class UnknownError < Error; end
+
+  # Raised when API returns error code between 600 and 699
+  class OtherError < Error; end
+end