osrm 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdc794797d20732a0c4a33a912e073b0cbd2aa8d
-  data.tar.gz: 88fb01a32646ad10133991a3b40b3f8183778e4a
+  metadata.gz: 99fe81d0e8e9ed18d963a3416b26b481e603a17e
+  data.tar.gz: 5cae22daace097f00fdb33e97de4000b0cb64700
 SHA512:
-  metadata.gz: c9514f44e128a83d87405a0e313accb15b5d050152bd4d956abfadbdb8d3da511c19391d6fa32e0ce3730ab7192615c8315696d1a788d9cfbd8211a2d6792270
-  data.tar.gz: 64f26b84663d32a9cca57413471f46ec448d173ea4ba9e30aafcd65a48a936f637c5f0e3724b8c3068882f00f8606935c716c2d54d85488e37776c7d48532b65
+  metadata.gz: fa42df2a83ced80bb0fd164a8963e88637ab858eeb238fca61921e01a5c1b984efe44e1b1485cfb32cdf89caa16e72209e7cc9ef69a1b9cd8656806178ab093a
+  data.tar.gz: 40959aa1aed650b0dee8c7e6c65bf28889dcc9efdce0f8ed27034144265986b0a4d5ded79b19c554a4eb2277de3c11cb3e7e610398183ace7633c082f05cbe1b

data/README.md

@@ -9,6 +9,22 @@ You can [run your own server](https://github.com/Project-OSRM/osrm-backend/wiki)
 
         gem install osrm
 
+2. Configure
+
+        require 'osrm'
+        OSRM.configure(
+          server:     'example.com',
+          port:       8080,          # Default: 80 or 443 if SSL
+          use_ssl:    true,          # Default: false
+          timeout:    10,            # Default: 3
+          user_agent: 'MyScript/1.1' # Default: OSRMRubyGem/{version}
+        )
+
+3. Request
+
+        OSRM.routes('50.202712,8.582738', '50.20232,8.574447')
+        OSRM.route('50.202712,8.582738', '50.20232,8.574447')
+
 ## License
 
 OSRM Gem is released under [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.html).

data/lib/osrm.rb

@@ -1 +1,23 @@
+require 'osrm/configuration'
+require 'osrm/query'
+require 'osrm/route'
 require 'osrm/version'
+
+module OSRM
+  def self.configure(options)
+    Configuration.instance.merge!(options)
+  end
+
+  def self.configuration
+    Configuration.instance
+  end
+
+  def self.routes(*locations)
+    OSRM::Query.new(*locations).execute
+  end
+
+  def self.route(*locations)
+    # OPTIMIZE: Send a different request with alt=false
+    routes(*locations).first
+  end
+end

data/lib/osrm/configuration.rb

@@ -0,0 +1,65 @@
+require 'singleton'
+require 'osrm/version'
+
+module OSRM
+  class Configuration
+    include Singleton
+
+    DEFAULTS = {
+      server:     nil,
+      port:       nil,
+      use_ssl:    false,
+      timeout:    3,
+      user_agent: "OSRMRubyGem/#{OSRM::VERSION}"
+    }.freeze
+
+    DEMO_SERVER = 'router.project-osrm.org'.freeze
+
+    def initialize
+      @data = DEFAULTS.dup
+    end
+
+    def merge!(options)
+      options.each do |option, value|
+        public_send(:"#{option}=", value) if DEFAULTS.key?(option.to_sym)
+      end
+
+      self
+    end
+
+    def server=(server)
+      @data[:server] =
+        server == :demo ? Configuration::DEMO_SERVER.dup : server
+    end
+
+    def port=(port)
+      @data[:port] = port && port.to_i
+    end
+
+    def use_ssl=(use_ssl)
+      @data[:use_ssl] = use_ssl ? true : false
+    end
+
+    def timeout=(timeout)
+      @data[:timeout] = timeout && timeout.to_i
+    end
+
+    def use_demo_server?
+      @data[:server] == DEMO_SERVER
+    end
+
+    # Dynamically add missing accessors
+    DEFAULTS.each do |option, default_value|
+      reader = case default_value
+               when TrueClass, FalseClass then :"#{option}?"
+               else option
+               end
+      writer = :"#{option}="
+
+      define_method(reader) { @data[option] }
+      unless method_defined?(writer)
+        define_method(writer) { |value| @data[option] = value }
+      end
+    end
+  end
+end

data/lib/osrm/query.rb

@@ -0,0 +1,133 @@
+require 'json'
+require 'net/http'
+require 'timeout'
+require 'uri'
+
+module OSRM
+  class Query
+    attr_accessor :locations
+
+    def initialize(*locations)
+      @locations = locations.compact.reject(&:empty?)
+    end
+
+    # OPTIMIZE: Don't execute if 0 or 1 location(s)
+    def execute
+      json = fetch_json_data
+      routes = []
+      return routes if json.nil?
+
+      # Main route
+      routes << Route.new(
+        geometry: json['route_geometry'],
+        summary:  json['route_summary']
+      )
+
+      # Alternative routes
+      if json['found_alternative']
+        json['alternative_geometries'].each_index do |index|
+          routes << Route.new(
+            geometry: json['alternative_geometries'][index],
+            summary:  json['alternative_summaries'][index]
+          )
+        end
+      end
+
+      routes
+    end
+
+    private
+
+    def fetch_json_data
+      raw_data = fetch_raw_data
+      JSON.parse(raw_data) if raw_data
+    rescue JSON::ParserError
+      warn 'OSRM API error: Invalid JSON'
+    end
+
+    def fetch_raw_data
+      response = api_request
+      response.body if valid_response?(response)
+    rescue SocketError
+      warn 'OSRM API error: Unable to establish connection'
+    rescue SystemCallError => err
+      # NOTE: Identify error class by string in case the class
+      #   is not implemented on the current platform
+      case err.class.to_s
+      when 'Errno::EHOSTDOWN'
+        warn 'OSRM API error: Host is down'
+      when 'Errno::ECONNREFUSED'
+        warn 'OSRM API error: Connection refused'
+      else
+        raise
+      end
+    rescue TimeoutError
+      warn 'OSRM API error: Timeout expired'
+    end
+
+    # TODO: Be sure that the HTTP query is ALWAYS closed
+    #   properly, even if an error happen (timeout or whatever)
+    def api_request
+      build_uri
+      timeout(configuration.timeout) do
+        Net::HTTP.start(uri.host, uri.port,
+                        use_ssl: configuration.use_ssl?) do |http|
+          response = http.get(
+            uri.request_uri,
+            'User-Agent' => configuration.user_agent
+          )
+
+          if response.class.body_permitted?
+            charset = response.type_params['charset']
+            response.body.force_encoding(charset) if charset
+          end
+
+          response
+        end
+      end
+    end
+
+    def valid_response?(response)
+      return true if response.is_a?(Net::HTTPOK)
+
+      if configuration.use_demo_server? &&
+         response['location'] &&
+         response['location']['forbidden.html']
+        warn 'OSRM API error: API usage policy has been violated, see https://github.com/Project-OSRM/osrm-backend/wiki/Api-usage-policy'
+      else
+        warn 'OSRM API error: Invalid response' \
+             " #{response.code} #{response.message}"
+      end
+
+      false
+    end
+
+    def build_uri
+      fail "OSRM API error: Server isn't configured" unless configuration.server
+
+      service  = 'viaroute'
+      params = [
+        *@locations.map { |l| ['loc', l] },
+        %w(output json),
+        %w(instructions false),
+        %w(alt true)
+      ]
+
+      uri_class = configuration.use_ssl? ? URI::HTTPS : URI::HTTP
+      @uri = uri_class.build(
+        host: configuration.server,
+        port: configuration.port,
+        path: "/#{service}",
+        query: URI.encode_www_form(params)
+      )
+    end
+
+    def uri
+      @uri || build_uri
+    end
+
+    def configuration
+      OSRM.configuration
+    end
+  end
+end

data/lib/osrm/route.rb

@@ -0,0 +1,30 @@
+require 'encoded_polyline'
+
+module OSRM
+  class Route
+    attr_accessor :geometry, :summary
+
+    def initialize(geometry: nil, summary: nil)
+      @geometry = decode_geometry(geometry)
+      @summary = summary
+    end
+
+    private
+
+    def decode_geometry(geometry)
+      return [] if geometry.nil? || geometry.empty?
+
+      EncodedPolyline.decode_points(geometry, 6).map do |point|
+        point.map { |coordinate| fix_float_precision(coordinate) }
+      end
+    end
+
+    # HACK: Should fix encoded_polyline gem instead
+    def fix_float_precision(float)
+      decimals = float.to_f.to_s[/\d+\z/]
+      fixed_decimals = decimals.sub(/(\d)\1{5,}\d{,2}\z/, '')
+
+      decimals == fixed_decimals ? float : float.round(fixed_decimals.size)
+    end
+  end
+end

data/lib/osrm/version.rb

@@ -1,3 +1,3 @@
 module OSRM
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osrm
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Freayd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.0
 - !ruby/object:Gem::Dependency
   name: encoded_polyline
   requirement: !ruby/object:Gem::Requirement
@@ -53,10 +79,13 @@ files:
 - LICENSE
 - README.md
 - lib/osrm.rb
+- lib/osrm/configuration.rb
+- lib/osrm/query.rb
+- lib/osrm/route.rb
 - lib/osrm/version.rb
 homepage: https://github.com/freayd/osrm
 licenses:
-- GPL-3
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []