osrm_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 238aeb1689da90fbecf6c1af2deba2058d5e1745
+  data.tar.gz: bbb3387c67f31b68b7771f1c5acea7c71d7ded9c
+SHA512:
+  metadata.gz: 6744e8a869f4bdf3108d6c03cf59a3f6d6dbbf0d5711d4dfafc30f2e861ef86065ae74fbd4fb2294c5a026668c731f2dd016e8a35ba26a8428c60951173d6182
+  data.tar.gz: 10afa72994fbb1c4afd0ae2231af01ca46f530ee9b4c647d1e2f7a365bbf6ceb37814a818f74bdf7cc242f22b46c86f5bfcae5cc20ee0449825e536893133fed

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in osrm_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 IgorPetuh
+
+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.

data/README.md

@@ -0,0 +1,44 @@
+# OsrmApi
+
+This Gem provides interaction with [OSRM Server API](https://github.com/Project-OSRM/osrm-backend/wiki/Server-api)
+ 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'osrm_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install osrm_api
+
+## Usage
+
+```ruby
+require 'osrm_api'
+
+# Initialize the client.
+client = OSRM::Client.new(host: 'example.com', port: 5000)
+
+# Perform the request
+distance = client.distance('40.723279,-73.937766', '40.90,-73.10', '40.82279,-73.937766')
+route = client.route('40.723279,-73.937766', '40.90,-73.10', '40.823279,-73.937766')
+locate = client.locate('53.911808, 27.595035')
+nearest = client.nearest('53.911808, 27.595035')
+```
+### Response
+
+## Contributing
+
+1. Fork it ( https://github.com/ikantam/osrm-api/fork )
+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/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/script.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby
+require 'osrm_api'
+options = { }
+client = OSRM::Client.new(options)
+lc = client.route('40.725160,-73.998794', '42.725160,-73.998794')

data/lib/osrm_api/client.rb

@@ -0,0 +1,69 @@
+require 'net/https'
+require 'json'
+
+require 'osrm_api/request/route_request'
+require 'osrm_api/response/route_object'
+
+require 'osrm_api/request/locate_request'
+require 'osrm_api/response/locate_object'
+
+require 'osrm_api/request/distance_request'
+require 'osrm_api/response/distance_object'
+
+require 'osrm_api/request/nearest_request'
+require 'osrm_api/response/nearest_object'
+
+module OSRM
+  # :nodoc
+  class Client
+    DEFAULT_OPTIONS = {
+      host: 'localhost',
+      port: 5000
+    }.freeze
+
+    # @return [OSRM::Client]
+    def initialize(options = {})
+      @options = DEFAULT_OPTIONS.merge(options)
+    end
+
+    # @return [Response::LocateObject]
+    def locate(location)
+      request = Request::LocateRequest.new(location)
+      yield if block_given?
+      Response::LocateObject.new execute request
+    end
+
+    # @return [Response::RouteObject]
+    def route(*locations)
+      request = Request::RouteRequest.new(*locations)
+      yield if block_given?
+      Response::RouteObject.new execute request
+    end
+
+    # @return [Response::NearestObject]
+    def nearest(location)
+      request = Request::NearestRequest.new(location)
+      yield if block_given?
+      Response::NearestObject.new execute request
+    end
+
+    # Return casting <Response::DistanceObject>
+    # @param [Array] locations
+    # @return [Response::DistanceObject]
+    def distance(*locations)
+      request = Request::DistanceRequest.new(*locations)
+      yield if block_given?
+      Response::DistanceObject.new execute request
+    end
+
+    private
+
+    # Method performs given request and returns body response
+    # @param [OSRM::Request::BaseRequest] request
+    def execute(request)
+      uri = request.build_uri @options[:host], @options[:port]
+      res = Net::HTTP.get_response uri
+      JSON.parse(res.body)
+    end
+  end
+end

data/lib/osrm_api/request/base_request.rb

@@ -0,0 +1,43 @@
+require 'uri/https'
+module OSRM
+  module Request
+    # :nodoc
+    class BaseRequest
+      LOC_PARAM = :loc
+
+      # Contains service path
+      # @return [Symbol]
+      def service
+        fail 'Specify the PATH to the Service'
+      end
+
+      # Contains default parameters for specially API request
+      # @return [Hash]
+      def default_params
+        @default_params ||= {}
+      end
+
+      # @return [Array]
+      def params
+        @params ||= []
+      end
+
+      def add_param(key, value)
+        params << [key, value]
+      end
+
+      # @param [String] host
+      # @param [Fixnum] port
+      # @return [URI]
+      def build_uri(host, port)
+        URI::HTTP.build(
+            host: host,
+            port: port.to_i,
+            path: "/#{service}",
+            query: URI.encode_www_form(params +
+                       default_params.map { |key, item| [key, item] })
+        )
+      end
+    end
+  end
+end

data/lib/osrm_api/request/distance_request.rb

@@ -0,0 +1,16 @@
+require 'osrm_api/request/base_request'
+module OSRM
+  module Request
+    # :nodoc
+    class DistanceRequest < BaseRequest
+      def initialize(*locations)
+        locations = locations.compact.reject(&:empty?)
+        locations.each { |item| add_param LOC_PARAM, item.split.join }
+      end
+
+      def service
+        :table
+      end
+    end
+  end
+end

data/lib/osrm_api/request/locate_request.rb

@@ -0,0 +1,16 @@
+require 'osrm_api/request/base_request'
+
+module OSRM
+  module Request
+    # :nodoc
+    class LocateRequest < BaseRequest
+      def initialize(location)
+        add_param LOC_PARAM, location.split.join
+      end
+
+      def service
+        :locate
+      end
+    end
+  end
+end

data/lib/osrm_api/request/nearest_request.rb

@@ -0,0 +1,16 @@
+require 'osrm_api/request/base_request'
+
+module OSRM
+  module Request
+    # :nodoc
+    class NearestRequest < BaseRequest
+      def initialize(location)
+        add_param LOC_PARAM, location.split.join
+      end
+
+      def service
+        :nearest
+      end
+    end
+  end
+end

data/lib/osrm_api/request/route_request.rb

@@ -0,0 +1,28 @@
+require 'osrm_api/request/base_request'
+module OSRM
+  module Request
+    # :nodoc
+    class RouteRequest < BaseRequest
+      OUTPUT_PARAM = :output
+      ALT_PARAM = :alt
+      Z_PARAM = :z
+      GEO_PARAM = :geometry
+
+      def service
+        :viaroute
+      end
+
+      def default_params
+        @default_params ||= {
+          OUTPUT_PARAM => :json,
+          ALT_PARAM => :false
+        }
+      end
+
+      def initialize(*locations)
+        locations = locations.compact.reject(&:empty?)
+        locations.each { |item|  add_param LOC_PARAM, item.split.join }
+      end
+    end
+  end
+end

data/lib/osrm_api/response/base_object.rb

@@ -0,0 +1,19 @@
+module OSRM
+  module Response
+    # :nodoc
+    class BaseObject
+      attr_accessor :origin_response
+
+      def initialize(json)
+        @origin_response = json.freeze
+        cast
+      end
+
+      private
+
+      def cast
+        fail 'Method should be implemented'
+      end
+    end
+  end
+end

data/lib/osrm_api/response/distance_object.rb

@@ -0,0 +1,16 @@
+require 'osrm_api/response/base_object'
+
+module OSRM
+  module Response
+    # :nodoc
+    class DistanceObject < BaseObject
+      attr_reader :distance_table
+
+      private
+
+      def cast
+        @distance_table = @origin_response['distance_table']
+      end
+    end
+  end
+end

data/lib/osrm_api/response/locate_object.rb

@@ -0,0 +1,18 @@
+require 'osrm_api/response/base_object'
+
+module OSRM
+  module Response
+    # :nodoc
+    class LocateObject < BaseObject
+      attr_reader :lat, :lon
+
+      private
+
+      def cast
+        return unless @origin_response['status'] == 0
+        @lat, @lon = @origin_response['mapped_coordinate']
+        yield if block_given?
+      end
+    end
+  end
+end

data/lib/osrm_api/response/nearest_object.rb

@@ -0,0 +1,16 @@
+require 'osrm_api/response/locate_object'
+
+module OSRM
+  module Response
+    # :nodoc
+    class NearestObject < LocateObject
+      attr_reader :name
+
+      private
+
+      def cast
+        super { @name = @origin_response['name'] }
+      end
+    end
+  end
+end

data/lib/osrm_api/response/route_object.rb

@@ -0,0 +1,20 @@
+require 'osrm_api/response/base_object'
+
+module OSRM
+  module Response
+    # :nodoc
+    class RouteObject < BaseObject
+      attr_reader :geometry, :summary, :instructions, :name
+
+      private
+
+      def cast
+        return unless @origin_response['status'] == 0
+        @geometry = @origin_response['route_geometry']
+        @summary = @origin_response['route_summary']
+        @name = @origin_response['route_name']
+        @instructions = @origin_response['route_instructions']
+      end
+    end
+  end
+end

data/lib/osrm_api/version.rb

@@ -0,0 +1,4 @@
+# :nodoc
+module OSRM
+  VERSION = '1.0.0'
+end

data/lib/osrm_api.rb

@@ -0,0 +1,6 @@
+require 'osrm_api/version'
+require 'osrm_api/client'
+
+# :nodoc
+module OSRM
+end

data/osrm_api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'osrm_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'osrm_api'
+  spec.version       = OSRM::VERSION
+  spec.authors       = ['IgorPetuh']
+  spec.email         = ['i.petuh@icloud.com']
+  spec.summary       = 'OSRM API'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/ikantam/osrm-api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/spec/fixtures/distance.json

@@ -0,0 +1,12 @@
+{
+  "distance_table": [
+    [
+      0,
+      40017
+    ],
+    [
+      40063,
+      0
+    ]
+  ]
+}

data/spec/fixtures/invalid_route.json

@@ -0,0 +1,53 @@
+{
+  "hint_data": {
+    "locations": [
+      "wQ0NACgfGAAAAAAABQAAAAAAAAA5AAAAAAAAAOCbCAAAAAAATrJyAoeHt_sDABEA",
+      "hjYYAIg2GADefQEAAAAAALMAAAAAAAAAZAgAAFMNDAAAAAAA-bJqAiTnl_sAABEA"
+    ],
+    "checksum": 361082431
+  },
+  "status_message": "Found route between points",
+  "route_summary": {
+    "end_point": "Fishermem's Way",
+    "start_point": "",
+    "total_time": 9572,
+    "total_distance": 193078
+  },
+  "found_alternative": true,
+  "alternative_summaries": [
+    {
+      "end_point": "Fishermem's Way",
+      "start_point": "",
+      "total_time": 10015,
+      "total_distance": 206532
+    }
+  ],
+  "via_points": [
+    [
+      41.071182,
+      -71.858299
+    ],
+    [
+      40.547066,
+      -73.930977
+    ]
+  ],
+  "via_indices": [
+    0,
+    2173
+  ],
+  "alternative_indices": [
+    0,
+    2407
+  ],
+  "alternative_names": [
+    [
+      "",
+      ""
+    ]
+  ],
+  "route_name": [
+    "",
+    ""
+  ]
+}

data/spec/fixtures/nearest.json

@@ -0,0 +1,8 @@
+{
+  "name": "Anthony Street",
+  "mapped_coordinate": [
+    40.72319,
+    -73.937729
+  ],
+  "status": 0
+}

data/spec/fixtures/route.json

@@ -0,0 +1,54 @@
+{
+  "hint_data": {
+    "locations": [
+      "wQ0NACgfGAAAAAAABQAAAAAAAAA5AAAAAAAAAOCbCAAAAAAATrJyAoeHt_sDABEA",
+      "hjYYAIg2GADefQEAAAAAALMAAAAAAAAAZAgAAFMNDAAAAAAA-bJqAiTnl_sAABEA"
+    ],
+    "checksum": 361082431
+  },
+  "status_message": "Found route between points",
+  "route_summary": {
+    "end_point": "Fishermem's Way",
+    "start_point": "",
+    "total_time": 9572,
+    "total_distance": 193078
+  },
+  "found_alternative": true,
+  "alternative_summaries": [
+    {
+      "end_point": "Fishermem's Way",
+      "start_point": "",
+      "total_time": 10015,
+      "total_distance": 206532
+    }
+  ],
+  "via_points": [
+    [
+      41.071182,
+      -71.858299
+    ],
+    [
+      40.547066,
+      -73.930977
+    ]
+  ],
+  "status": 0,
+  "via_indices": [
+    0,
+    2173
+  ],
+  "alternative_indices": [
+    0,
+    2407
+  ],
+  "alternative_names": [
+    [
+      "",
+      ""
+    ]
+  ],
+  "route_name": [
+    "",
+    ""
+  ]
+}

data/spec/osrm_api/client_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'rspec'
+require 'osrm_api'
+
+describe OSRM::Client do
+  subject(:factory) { described_class }
+
+  describe '#Instantiate object' do
+    WebMock.disable!
+    it '#with invalid params' do
+      obj = factory.new(host: 'bla-bla-bla')
+      expect { obj.route('12.12,-12.1', '123.1,-34.1') }
+        .to raise_error(SocketError)
+    end
+
+    it '#with correct' do
+      WebMock.enable!
+      TEST_HOST = 'example.com'
+      QUERY_STRING  = 'locate?loc=12.12,-12.12'
+      stub_request(:any, 'http://' + TEST_HOST + ':5000/' + QUERY_STRING)
+        .to_return(body: JSON.generate(status: 0, mapped_coordinate: [1, 2]))
+      obj = factory.new(host: TEST_HOST)
+      expect(obj.locate('12.12, -12.12')).to_not eq(nil)
+    end
+  end
+end

data/spec/osrm_api/request/route_request_spec.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+require 'spec_helper'
+
+describe OSRM::Request::RouteRequest do
+  subject(:factory) { described_class }
+  HOST = 'ex.com'
+  PORT = 5000
+
+  it 'should contain service' do
+    obj = factory.new('')
+    expect(obj.service.length).not_to eq(0)
+  end
+
+  it 'should build correct query' do
+    obj = factory.new('12.12,-12.12', '13.13,-13.13')
+    uri = obj.build_uri(HOST, PORT)
+    expect(URI.decode(uri.query).include?('loc=12.12,-12.12&loc=13.13,-13.13')).to eq(true)
+  end
+
+  it 'should can edit default params' do
+    obj = factory.new('12.12,-12.12', '-13.13,13.12')
+    obj.default_params[:z] = 'z'
+    uri = obj.build_uri(HOST, PORT)
+    expect(URI.decode(uri.query).include?('z=z')).to eq(true)
+  end
+end

data/spec/osrm_api/response/distance_object_spec.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require 'spec_helper'
+
+describe OSRM::Response::DistanceObject do
+  subject(:factory) { described_class }
+  describe '#Instantiate' do
+    it 'should contain distance array' do
+      json = JSON.parse(fixture('distance.json').read)
+      obj = factory.new json
+      expect(obj.distance_table).to eq(json['distance_table'])
+    end
+  end
+end

data/spec/osrm_api/response/nearest_object_spec.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+
+describe OSRM::Response::NearestObject do
+  subject(:factory) { described_class }
+  describe '#Instantiate' do
+    it '#with valid params' do
+      json = JSON.parse(fixture('nearest.json'))
+      obj = factory.new json
+      expect(obj.name).to eq(json['name'])
+    end
+  end
+end

data/spec/osrm_api/response/route_object_spec.rb

@@ -0,0 +1,18 @@
+require 'rspec'
+require 'spec_helper'
+
+describe OSRM::Response::RouteObject do
+  subject(:factory) { described_class }
+
+  describe '#Instantiate' do
+    it '#with valid params' do
+      obj = factory.new JSON.parse(fixture('route.json').read)
+      expect(obj.summary.class).to eq(Hash)
+    end
+
+    it '#with invalid params' do
+      obj = factory.new JSON.parse(fixture('invalid_route.json').read)
+      expect(obj.summary.class).to eq(NilClass)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+$LOAD_PATH.uniq!
+
+require 'rspec'
+require 'webmock/rspec'
+require 'json'
+require 'osrm_api'
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(File.join(fixture_path, '/', file))
+end
+
+RSpec.configure do |config|
+  config.color = true
+  config.run_all_when_everything_filtered = true
+  config.raise_errors_for_deprecations!
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: osrm_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- IgorPetuh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ''
+email:
+- i.petuh@icloud.com
+executables:
+- script.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/script.rb
+- lib/osrm_api.rb
+- lib/osrm_api/client.rb
+- lib/osrm_api/request/base_request.rb
+- lib/osrm_api/request/distance_request.rb
+- lib/osrm_api/request/locate_request.rb
+- lib/osrm_api/request/nearest_request.rb
+- lib/osrm_api/request/route_request.rb
+- lib/osrm_api/response/base_object.rb
+- lib/osrm_api/response/distance_object.rb
+- lib/osrm_api/response/locate_object.rb
+- lib/osrm_api/response/nearest_object.rb
+- lib/osrm_api/response/route_object.rb
+- lib/osrm_api/version.rb
+- osrm_api.gemspec
+- spec/fixtures/distance.json
+- spec/fixtures/invalid_route.json
+- spec/fixtures/nearest.json
+- spec/fixtures/route.json
+- spec/osrm_api/client_spec.rb
+- spec/osrm_api/request/route_request_spec.rb
+- spec/osrm_api/response/distance_object_spec.rb
+- spec/osrm_api/response/nearest_object_spec.rb
+- spec/osrm_api/response/route_object_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ikantam/osrm-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: OSRM API
+test_files:
+- spec/fixtures/distance.json
+- spec/fixtures/invalid_route.json
+- spec/fixtures/nearest.json
+- spec/fixtures/route.json
+- spec/osrm_api/client_spec.rb
+- spec/osrm_api/request/route_request_spec.rb
+- spec/osrm_api/response/distance_object_spec.rb
+- spec/osrm_api/response/nearest_object_spec.rb
+- spec/osrm_api/response/route_object_spec.rb
+- spec/spec_helper.rb
+has_rdoc: