azimuth 1.0.0

data/spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/with_no_optionnal_options/does_not_return_destination_informations.yml

@@ -0,0 +1,87 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://www.mapquestapi.com/directions/v2/routematrix?key=<API_KEY>
+    body:
+      encoding: UTF-8
+      string: "{\"locations\":[\"48.843079, 2.314442\",\"48.869061, 2.383329\",\"49.000000,
+        2.300000\"],\"options\":{}}"
+    headers:
+      User-Agent:
+      - Faraday v0.8.9
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Apache-Coyote/1.1
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - OPTIONS,GET,POST
+      Set-Cookie:
+      - JSESSIONID=3534BF65D920222EB7019EB2BDF42D5D; Path=/directions/; HttpOnly
+      Expires:
+      - Mon, 20 Dec 1998 01:00:00 GMT
+      Last-Modified:
+      - Mon, 13 Jan 2014 18:40:55 GMT
+      Cache-Control:
+      - no-cache, must-revalidate
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json;charset=UTF-8
+      Content-Length:
+      - '1592'
+      Date:
+      - Mon, 13 Jan 2014 18:40:55 GMT
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJhbGxUb0FsbCI6ZmFsc2UsImRpc3RhbmNlIjpbMCw0LjkwOSwxNy45Njhd
+        LCJ0aW1lIjpbMCwxMDE5LDIxMjldLCJsb2NhdGlvbnMiOlt7ImxhdExuZyI6
+        eyJsbmciOjIuMzE0NDQyLCJsYXQiOjQ4Ljg0MzA3OX0sImFkbWluQXJlYTQi
+        OiJQYXJpcyIsImFkbWluQXJlYTVUeXBlIjoiQ2l0eSIsImFkbWluQXJlYTRU
+        eXBlIjoiQ291bnR5IiwiYWRtaW5BcmVhNSI6IlBhcmlzIiwic3RyZWV0Ijoi
+        NSBSdWUgRGFsb3UiLCJhZG1pbkFyZWExIjoiRlIiLCJhZG1pbkFyZWEzIjoi
+        SWxlLWRlLUZyYW5jZSIsInR5cGUiOiJzIiwiZGlzcGxheUxhdExuZyI6eyJs
+        bmciOjIuMzE0NDQyLCJsYXQiOjQ4Ljg0MzA3OX0sImxpbmtJZCI6MCwicG9z
+        dGFsQ29kZSI6Ijc1MDA3Iiwic2lkZU9mU3RyZWV0IjoiTiIsImRyYWdQb2lu
+        dCI6ZmFsc2UsImFkbWluQXJlYTFUeXBlIjoiQ291bnRyeSIsImdlb2NvZGVR
+        dWFsaXR5IjoiQUREUkVTUyIsImdlb2NvZGVRdWFsaXR5Q29kZSI6IkwxQUFB
+        IiwiYWRtaW5BcmVhM1R5cGUiOiJTdGF0ZSJ9LHsibGF0TG5nIjp7ImxuZyI6
+        Mi4zODMzMjksImxhdCI6NDguODY5MDYxfSwiYWRtaW5BcmVhNCI6IlBhcmlz
+        IiwiYWRtaW5BcmVhNVR5cGUiOiJDaXR5IiwiYWRtaW5BcmVhNFR5cGUiOiJD
+        b3VudHkiLCJhZG1pbkFyZWE1IjoiUGFyaXMiLCJzdHJlZXQiOiIxOCBSdWUg
+        ZHUgUHJlc3NvaXIiLCJhZG1pbkFyZWExIjoiRlIiLCJhZG1pbkFyZWEzIjoi
+        SWxlLWRlLUZyYW5jZSIsInR5cGUiOiJzIiwiZGlzcGxheUxhdExuZyI6eyJs
+        bmciOjIuMzgzMzI5LCJsYXQiOjQ4Ljg2OTA2MX0sImxpbmtJZCI6MCwicG9z
+        dGFsQ29kZSI6Ijc1MDExIiwic2lkZU9mU3RyZWV0IjoiTiIsImRyYWdQb2lu
+        dCI6ZmFsc2UsImFkbWluQXJlYTFUeXBlIjoiQ291bnRyeSIsImdlb2NvZGVR
+        dWFsaXR5IjoiQUREUkVTUyIsImdlb2NvZGVRdWFsaXR5Q29kZSI6IkwxQUFB
+        IiwiYWRtaW5BcmVhM1R5cGUiOiJTdGF0ZSJ9LHsibGF0TG5nIjp7ImxuZyI6
+        Mi4zLCJsYXQiOjQ5fSwiYWRtaW5BcmVhNCI6IlNhcmNlbGxlcyIsImFkbWlu
+        QXJlYTVUeXBlIjoiQ2l0eSIsImFkbWluQXJlYTRUeXBlIjoiQ291bnR5Iiwi
+        YWRtaW5BcmVhNSI6IkFuZGlsbHkiLCJzdHJlZXQiOiJSdWUgZGVzIFByw6lz
+        IiwiYWRtaW5BcmVhMSI6IkZSIiwiYWRtaW5BcmVhMyI6IklsZS1kZS1GcmFu
+        Y2UiLCJ0eXBlIjoicyIsImRpc3BsYXlMYXRMbmciOnsibG5nIjoyLjMsImxh
+        dCI6NDl9LCJsaW5rSWQiOjAsInBvc3RhbENvZGUiOiI5NTU4MCIsInNpZGVP
+        ZlN0cmVldCI6Ik4iLCJkcmFnUG9pbnQiOmZhbHNlLCJhZG1pbkFyZWExVHlw
+        ZSI6IkNvdW50cnkiLCJnZW9jb2RlUXVhbGl0eSI6IkFERFJFU1MiLCJnZW9j
+        b2RlUXVhbGl0eUNvZGUiOiJMMUFBQSIsImFkbWluQXJlYTNUeXBlIjoiU3Rh
+        dGUifV0sIm1hbnlUb09uZSI6ZmFsc2UsImluZm8iOnsiY29weXJpZ2h0Ijp7
+        InRleHQiOiLCqSAyMDEzIE1hcFF1ZXN0LCBJbmMuIiwiaW1hZ2VVcmwiOiJo
+        dHRwOi8vYXBpLm1xY2RuLmNvbS9yZXMvbXFsb2dvLmdpZiIsImltYWdlQWx0
+        VGV4dCI6IsKpIDIwMTMgTWFwUXVlc3QsIEluYy4ifSwic3RhdHVzY29kZSI6
+        MCwibWVzc2FnZXMiOltdfX0=
+    http_version: 
+  recorded_at: Mon, 13 Jan 2014 18:40:56 GMT
+recorded_with: VCR 2.8.0

data/spec/lib/azimuth/client/route_matrix_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Azimuth::Client::RouteMatrix do
+  describe '.route_matrix', :vcr do
+    it_behaves_like 'a route matrix request'
+
+    let(:locations) do
+      ['48.843079, 2.314442', '48.869061, 2.383329', '49.000000, 2.300000']
+    end
+
+    context 'with no optionnal options' do
+      let(:route_matrix_result) { client.route_matrix(locations) }
+
+      it 'does not return destination informations' do
+        expect(route_matrix_result.size).to eql 2
+      end
+    end
+
+    context 'with many to one options' do
+      let(:route_matrix_result) do
+        client.route_matrix(locations, manyToOne: true)
+      end
+
+      it 'does not return destination informations' do
+        expect(route_matrix_result.size).to eql 2
+      end
+    end
+
+    context 'with all to all options' do
+      let(:route_matrix_result) do
+        client.route_matrix(locations, allToAll: true)
+      end
+
+      it 'it returns destination informations' do
+        expect(route_matrix_result.size).to eql 3
+      end
+    end
+  end
+end

data/spec/lib/azimuth/client_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Azimuth::Client do
+  describe 'module configuration' do
+    before do
+      Azimuth.reset!
+
+      Azimuth.configure do |config|
+        Azimuth::Configuration::VALID_OPTIONS.each do |key|
+          config.send("#{key}=", "Some #{key}")
+        end
+      end
+    end
+
+    after { Azimuth.reset! }
+
+    it "inherits the module configuration" do
+      client = Azimuth::Client.new
+
+      Azimuth::Configuration::VALID_OPTIONS.each do |key|
+        expect(client.instance_variable_get(:"@#{key}")).to eq "Some #{key}"
+      end
+    end
+  end
+
+  context 'with class level configuration' do
+    describe 'api_endpoint' do
+      it 'sets api_endpoint' do
+        client = Azimuth::Client.new
+
+        expect(client.api_endpoint).
+          to eql 'http://www.mapquestapi.com/directions/v2/'
+      end
+
+      it 'overrides module configuration' do
+        client = Azimuth::Client.new(api_endpoint: 'http://fuubar.com')
+
+        expect(client.api_endpoint).to eql 'http://fuubar.com'
+      end
+    end
+
+    describe 'api_key' do
+      it 'sets api_key'  do
+        client = Azimuth::Client.new
+
+        expect(client.api_key).to be_nil
+      end
+
+      it 'overrides module configuration' do
+        client = Azimuth::Client.new(api_key: 'randomkey')
+
+        expect(client.api_key).to eql 'randomkey'
+      end
+    end
+  end
+end

data/spec/lib/azimuth/request_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Azimuth::Request do
+  it_behaves_like 'an error', 400, Azimuth::ErrorWithInput
+  it_behaves_like 'an error', 403, Azimuth::KeyRelatedError
+  it_behaves_like 'an error', 500, Azimuth::UnknownError
+
+  Array(600...699).each do |status_code|
+    it_behaves_like 'an error', status_code, Azimuth::OtherError
+  end
+end

data/spec/lib/azimuth_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Azimuth do
+  describe '.respond_to?' do
+    context 'with an existing Azimuth method' do
+      it 'responds to method' do
+        expect(Azimuth.respond_to?(:new, true)).to be_true
+      end
+    end
+
+    context 'with an existing Azimuth::Client method' do
+      it 'responds to method' do
+        expect(Azimuth.respond_to?(:post, true)).to be_true
+      end
+
+      it 'delegates to Azimuth::Client' do
+        Azimuth::Client.stub_chain(:new, :post).and_return(true)
+
+        expect(Azimuth::Client).to receive(:new).ordered
+        expect(Azimuth::Client).to receive(:new).ordered
+
+        Azimuth.post('fuubar', test: {} )
+      end
+    end
+  end
+
+  describe '.new' do
+    it 'returns a Azimuth::Client' do
+      expect(Azimuth.new).to be_a Azimuth::Client
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter 'spec'
+  add_filter 'lib/azimuth/response'
+end
+
+require 'rspec'
+require 'vcr'
+require 'json'
+require 'webmock/rspec'
+require 'azimuth'
+require 'uri'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+WebMock.disable_net_connect!(allow: 'coveralls.io')
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.filter_sensitive_data('<API_KEY>') do
+    URI.escape(test_api_key)
+  end
+  c.configure_rspec_metadata!
+end
+
+RSpec.configure do |c|
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+end
+
+def stub_post(url)
+  stub_request(:post, map_quest_direction_url(url))
+end
+
+def map_quest_direction_url(url)
+  "http://www.mapquestapi.com/directions/v2/#{url}?key=#{test_api_key}"
+end
+
+def test_api_key
+  ENV.fetch('MAP_QUEST_API_KEY', 'test_api_key')
+end
+
+def client
+  Azimuth.new(api_key: test_api_key)
+end

data/spec/support/shared_examples/error.rb

@@ -0,0 +1,15 @@
+shared_examples 'an error' do |status_code, exception|
+  it "raising #{exception.name} when http status code is #{status_code}" do
+    VCR.turn_off!
+
+    endpoint = 'bigboombadaboum'
+
+    stub_post(endpoint).to_return(
+      body: { info: { statuscode: status_code, messages: ['error'] } }.to_json,
+    )
+
+    expect { client.post(endpoint) }.to raise_error(exception, 'error')
+
+    VCR.turn_on!
+  end
+end

data/spec/support/shared_examples/route_matrix_request.rb

@@ -0,0 +1,26 @@
+shared_examples 'a route matrix request' do
+  let(:locations) do
+    ['48.843079, 2.314442', '48.869061, 2.383329', '49.000000, 2.300000']
+  end
+
+  let(:route_matrix_result) { client.route_matrix(locations) }
+
+  it 'returns locations distances to destination' do
+    route_matrix_result.each do |location|
+      expect(location.distance).not_to be_nil
+    end
+  end
+
+  it 'returns locations driving times to destination' do
+    route_matrix_result.each do |location|
+      expect(location.time).not_to be_nil
+    end
+  end
+
+  it 'returns locations coordinates' do
+    route_matrix_result.each do |location|
+      expect(location.latitude).not_to be_nil
+      expect(location.longitude).not_to be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: azimuth
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aylic Petit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.5
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Simple Ruby wrapper for the MapQuest Direction API.
+email:
+- sush@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- Rakefile
+- azimuth.gemspec
+- lib/azimuth.rb
+- lib/azimuth/client.rb
+- lib/azimuth/client/route_matrix.rb
+- lib/azimuth/configuration.rb
+- lib/azimuth/connection.rb
+- lib/azimuth/error.rb
+- lib/azimuth/request.rb
+- lib/azimuth/response/raise_error.rb
+- lib/azimuth/version.rb
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/behaves_like_a_route_matrix_request/returns_locations_coordinates.yml
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/behaves_like_a_route_matrix_request/returns_locations_distances_to_destination.yml
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/behaves_like_a_route_matrix_request/returns_locations_driving_times_to_destination.yml
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/with_all_to_all_options/it_returns_destination_informations.yml
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/with_many_to_one_options/does_not_return_destination_informations.yml
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/with_no_optionnal_options/does_not_return_destination_informations.yml
+- spec/lib/azimuth/client/route_matrix_spec.rb
+- spec/lib/azimuth/client_spec.rb
+- spec/lib/azimuth/request_spec.rb
+- spec/lib/azimuth_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/error.rb
+- spec/support/shared_examples/route_matrix_request.rb
+homepage: https://github.com/sush/azimuth
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: MapQuest Direction API Ruby wrapper
+test_files:
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/behaves_like_a_route_matrix_request/returns_locations_coordinates.yml
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/behaves_like_a_route_matrix_request/returns_locations_distances_to_destination.yml
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/behaves_like_a_route_matrix_request/returns_locations_driving_times_to_destination.yml
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/with_all_to_all_options/it_returns_destination_informations.yml
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/with_many_to_one_options/does_not_return_destination_informations.yml
+- spec/cassettes/Azimuth_Client_RouteMatrix/_route_matrix/with_no_optionnal_options/does_not_return_destination_informations.yml
+- spec/lib/azimuth/client/route_matrix_spec.rb
+- spec/lib/azimuth/client_spec.rb
+- spec/lib/azimuth/request_spec.rb
+- spec/lib/azimuth_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples/error.rb
+- spec/support/shared_examples/route_matrix_request.rb
+has_rdoc: