osrm 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8597e75fad0414f8f8aa2b9ebce485b0f9ccd712
-  data.tar.gz: 698e2fc52de22d09adfe7a06e57ba8f889a286f2
+  metadata.gz: 6c953314975877ae27e5bdd08fbeee9bfa05d81f
+  data.tar.gz: a94b634022234fe7dcf6526fb0d79416e22749b3
 SHA512:
-  metadata.gz: dfc6876e927a578f05261f6519f9025040045ac49cbe2e785b81fed5f459b90c9f2425dc1954c358e883c9eff91db6b21f87eb5a8dae30ef77439d1378e15e74
-  data.tar.gz: bf665ae1f754cd6486c9da9cb479b969fe5e277629759430e2979e367362ad8aa06f6d5887f80ab8c0220144fca0d1c0580d660bbbf4b0612a699a4c0651dae6
+  metadata.gz: 5122640743216979410cad71c32a0a91867564f8745425e61055eb4eb57e2383cf2ea47161f6880406bcaea21e5d8841199a0de3ac876dba4971586400373eae
+  data.tar.gz: f971c84db9359ca98ec542f191e6e8362c004f7c2ba711ef572e6eb574023e66f5642c6b0a7e31b3d42416e54425fcd9ae83969851c6b4d779ee79c40ca7137f

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+## Changelog
+
+### OSRM Gem 0.4.0 (2016 Sep 17) ###
+
+* Upgrade to server API 5
+* Route object lost its summary attribute in favor of distance and duration
+* Raise errors instead of printing warnings
+
+### OSRM Gem 0.3.0 (2014 Dec 21) ###
+
+* Add before & after request callbacks
+
+### OSRM Gem 0.2.0 (2014 Dec 20) ###
+
+* Add caching support
+* Switch to MIT License
+
+### OSRM Gem 0.1.0 (2014 Dec 19) ###
+
+Initial release:
+
+* Add configuration options (server, port, use_ssl, timeout, user_agent)
+* Implement route requesting
+
+### OSRM Gem 0.0.0 (2014 Dec 12) ###
+
+First (and empty) release:
+
+* Provide version number
+* GPL v3 License

data/lib/osrm.rb

@@ -13,12 +13,10 @@ module OSRM
   end
 
   def self.routes(*locations)
-    OSRM::Query.new(*locations).execute
+    Query.new(*locations).execute
   end
 
   def self.route(*locations)
-    # OPTIMIZE: Send a different request with alt=false
-    #   ...or not -> reusing the cache
     routes(*locations).first
   end
 end

data/lib/osrm/configuration.rb

@@ -36,7 +36,7 @@ module OSRM
 
     def server=(server)
       @data[:server] =
-        server == :demo ? Configuration::DEMO_SERVER.dup : server
+        server == :demo ? DEMO_SERVER.dup : server
     end
 
     def use_demo_server?
@@ -44,7 +44,7 @@ module OSRM
     end
 
     def port=(port)
-      @data[:port] = port && port.to_i
+      @data[:port] = port&.to_i
     end
 
     def use_ssl=(use_ssl)
@@ -52,12 +52,12 @@ module OSRM
     end
 
     def timeout=(timeout)
-      @data[:timeout] = timeout && timeout.to_i
+      @data[:timeout] = timeout&.to_i
     end
 
     def before_request=(before_request)
       if before_request && !before_request.is_a?(Proc)
-        fail "OSRM API error: Invalid before request #{before_request.inspect}"
+        raise "OSRM API error: Invalid before request #{before_request.inspect}"
       end
 
       @data[:before_request] = before_request
@@ -65,18 +65,44 @@ module OSRM
 
     def after_request=(after_request)
       if after_request && !after_request.is_a?(Proc)
-        fail "OSRM API error: Invalid after request #{after_request.inspect}"
+        raise "OSRM API error: Invalid after request #{after_request.inspect}"
       end
 
       @data[:after_request] = after_request
     end
 
+    def cache=(cache)
+      @data[:cache] = cache
+      ensure_cache_version
+    end
+
+    # Raise an exception if major and minor versions of the cache and library are different
+    def ensure_cache_version
+      return unless cache
+
+      cache_version = cache[cache_key('version')]
+      if cache_version &&
+         Gem::Version.new(cache_version).bump != Gem::Version.new(OSRM::VERSION).bump
+        @data[:cache] = nil
+        raise "OSRM API error: Incompatible cache version #{cache_version}, expected #{OSRM::VERSION}"
+      end
+    end
+
+    def cache_key(url = nil)
+      if url
+        @data[:cache_key]&.gsub('{url}', url)
+      else
+        @data[:cache_key]
+      end
+    end
+
     def cache_key=(cache_key)
       unless cache_key.include?('{url}')
-        fail "OSRM API error: Invalid cache key #{cache_key.inspect}"
+        raise "OSRM API error: Invalid cache key #{cache_key.inspect}"
       end
 
       @data[:cache_key] = cache_key
+      ensure_cache_version
     end
 
     # Dynamically add missing accessors
@@ -87,7 +113,9 @@ module OSRM
                end
       writer = :"#{option}="
 
-      define_method(reader) { @data[option] }
+      unless method_defined?(reader)
+        define_method(reader) { @data[option] }
+      end
       unless method_defined?(writer)
         define_method(writer) { |value| @data[option] = value }
       end

data/lib/osrm/query.rb

@@ -11,81 +11,55 @@ module OSRM
       @locations = locations.compact.reject(&:empty?)
     end
 
-    # OPTIMIZE: Implement a custom locations= method
-    #   -> Remove consecutive duplicate locations (http://stackoverflow.com/a/8105422)
-
-    # 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
+      build_uri
+      fetch_json_data[:routes].map { |route| Route.new(route) }
     end
 
     private
 
     def fetch_json_data
-      build_uri
       raw_data = cache || fetch_raw_data
 
-      json = JSON.parse(raw_data) if raw_data
+      json = JSON.parse(raw_data, symbolize_names: true)
+      raise "OSRM API error: #{json[:message]} (#{json[:code]})" unless json[:code] == 'Ok'
 
       cache(raw_data)
       json
-    rescue JSON::ParserError
-      warn 'OSRM API error: Invalid JSON'
+    rescue JSON::ParserError => error
+      raise "OSRM API error: Invalid JSON: (#{error})"
     end
 
     def fetch_raw_data
       configuration.before_request.call if configuration.before_request
       response = api_request
       configuration.after_request.call if configuration.after_request
-      # TODO: Be sure that after request is ALWAYS called???
-      #   (even if api_request failed)
 
-      response.body if valid_response?(response)
+      ensure_valid_response(response)
+      response.body
     rescue SocketError
-      warn 'OSRM API error: Unable to establish connection'
-    rescue SystemCallError => err
+      raise 'OSRM API error: Unable to establish connection'
+    rescue SystemCallError => error
       # NOTE: Identify error class by string in case the class
       #   is not implemented on the current platform
-      case err.class.to_s
+      case error.class.to_s
       when 'Errno::EHOSTDOWN'
-        warn 'OSRM API error: Host is down'
+        raise 'OSRM API error: Host is down'
       when 'Errno::ECONNREFUSED'
-        warn 'OSRM API error: Connection refused'
+        raise 'OSRM API error: Connection refused'
       else
         raise
       end
-    rescue TimeoutError
-      warn 'OSRM API error: Timeout expired'
+    rescue Timeout::Error
+      raise '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
-      timeout(configuration.timeout) do
-        Net::HTTP.start(uri.host, uri.port,
+      Timeout.timeout(configuration.timeout) do
+        Net::HTTP.start(@uri.host, @uri.port,
                         use_ssl: configuration.use_ssl?) do |http|
           response = http.get(
-            uri.request_uri,
+            @uri.request_uri,
             'User-Agent' => configuration.user_agent
           )
 
@@ -99,60 +73,57 @@ module OSRM
       end
     end
 
-    def valid_response?(response)
-      return true if response.is_a?(Net::HTTPOK)
+    def ensure_valid_response(response)
+      return if %w(200 400).include?(response.code)
 
       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'
+        raise '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}"
+        raise '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
+      raise "OSRM API error: Server isn't configured" unless configuration.server
+
+      service = 'route'
+      version = 'v1'
+      profile = 'driving'
+      format  = 'json'
 
-      service  = 'viaroute'
       params = [
-        *@locations.map { |l| ['loc', l] },
-        %w(output json),
-        %w(instructions false),
-        %w(alt true)
+        %w(alternatives true),
+        %w(geometries polyline)
       ]
 
       uri_class = configuration.use_ssl? ? URI::HTTPS : URI::HTTP
       @uri = uri_class.build(
         host: configuration.server,
         port: configuration.port,
-        path: "/#{service}",
+        path: "/#{service}/#{version}/#{profile}/#{lonlat_locations.join(';')}.#{format}",
         query: URI.encode_www_form(params)
       )
     end
 
-    def uri
-      @uri || build_uri
+    # Reverse from ['latitude,longitude'] to ['longitude,latitude']
+    def lonlat_locations
+      locations.map { |location| location.split(',').reverse.join(',') }
     end
 
     def cache(value = nil)
-      return nil unless OSRM.configuration.cache
+      return nil unless configuration.cache
 
       if value
-        OSRM.configuration.cache[cache_key('version')] ||= OSRM::VERSION
-        OSRM.configuration.cache[cache_key(uri.to_s)] = value
+        configuration.cache[configuration.cache_key('version')] ||= OSRM::VERSION
+        configuration.cache[configuration.cache_key(@uri.to_s)] = value
       else
-        OSRM.configuration.cache[cache_key(uri.to_s)]
+        configuration.cache[configuration.cache_key(@uri.to_s)]
       end
     end
 
-    def cache_key(url)
-      OSRM.configuration.cache_key.gsub('{url}', url)
-    end
-
     def configuration
       OSRM.configuration
     end

data/lib/osrm/route.rb

@@ -2,12 +2,12 @@ require 'encoded_polyline'
 
 module OSRM
   class Route
-    # TODO: Rename from geometry to points???
-    attr_accessor :geometry, :summary
+    attr_accessor :geometry, :distance, :duration
 
-    def initialize(geometry: nil, summary: nil)
-      @geometry = decode_geometry(geometry)
-      @summary = summary
+    def initialize(json = {})
+      @geometry = decode_geometry(json[:geometry])
+      @distance = json[:distance] || 0
+      @duration = json[:duration] || 0
     end
 
     private
@@ -15,7 +15,7 @@ module OSRM
     def decode_geometry(geometry)
       return [] if geometry.nil? || geometry.empty?
 
-      EncodedPolyline.decode_points(geometry, 6).map do |point|
+      EncodedPolyline.decode_points(geometry, 5).map do |point|
         point.map { |coordinate| fix_float_precision(coordinate) }
       end
     end

data/lib/osrm/version.rb

@@ -1,3 +1,3 @@
 module OSRM
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osrm
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Freayd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-21 00:00:00.000000000 Z
+date: 2016-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,20 +50,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.0
+        version: 11.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.0
+        version: 11.2.2
 - !ruby/object:Gem::Dependency
   name: encoded_polyline
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +90,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/osrm.rb
@@ -109,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -117,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: OSRM API for Ruby