osrm 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c953314975877ae27e5bdd08fbeee9bfa05d81f
-  data.tar.gz: a94b634022234fe7dcf6526fb0d79416e22749b3
+  metadata.gz: 169960f4f55e9adb038d4d74352338acf90947b6
+  data.tar.gz: 713c1b28e080c8c48e1f3d3327ae80f2ecf15dc3
 SHA512:
-  metadata.gz: 5122640743216979410cad71c32a0a91867564f8745425e61055eb4eb57e2383cf2ea47161f6880406bcaea21e5d8841199a0de3ac876dba4971586400373eae
-  data.tar.gz: f971c84db9359ca98ec542f191e6e8362c004f7c2ba711ef572e6eb574023e66f5642c6b0a7e31b3d42416e54425fcd9ae83969851c6b4d779ee79c40ca7137f
+  metadata.gz: ec89dcde3038a0ad936478b4fe8315494a25bcf4740eecbdaf7b71b8f1c822435385284d761491457b89810ceb00ca177756ea479eb94fb805dfdcd7f6e61238
+  data.tar.gz: caa178c62c8ac16d7182da470afa56e58168c698289293a466fa236ff23115561877f9f6d48418322fa5d7226c43e3871efdc6cae96e06edb56884a3f440a300

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Changelog
 
+### OSRM Gem 0.4.1 (2016 Sep 17) ###
+
+* Add overview option
+
 ### OSRM Gem 0.4.0 (2016 Sep 17) ###
 
 * Upgrade to server API 5

data/README.md

@@ -29,7 +29,11 @@ You can [run your own server](https://github.com/Project-OSRM/osrm-backend/wiki)
           # The cache can be any object providing [] and []= methods.
           # The cache key must contain the {url} pattern.
           cache:      {},                 # Default: nil (no cache)
-          cache_key:  'my-script:{url}'   # Default: 'osrm:{url}'
+          cache_key:  'my-script:{url}',  # Default: 'osrm:{url}'
+
+          # Requests
+          # Specify the precision of the overview geometries returned
+          overview: :full                 # Possible values: false, :simplified (default), :full
 
         )
 

data/lib/osrm.rb

@@ -12,11 +12,11 @@ module OSRM
     Configuration.instance
   end
 
-  def self.routes(*locations)
-    Query.new(*locations).execute
+  def self.routes(*locations, overview: nil)
+    Query.new(*locations).execute(alternatives: true, overview: overview)
   end
 
-  def self.route(*locations)
-    routes(*locations).first
+  def self.route(*locations, overview: nil)
+    Query.new(*locations).execute(alternatives: false, overview: overview).first
   end
 end

data/lib/osrm/configuration.rb

@@ -16,7 +16,9 @@ module OSRM
       after_request:  nil,
 
       cache:     nil,
-      cache_key: 'osrm:{url}'
+      cache_key: 'osrm:{url}',
+
+      overview:  :simplified
     }.freeze
 
     DEMO_SERVER = 'router.project-osrm.org'.freeze
@@ -105,6 +107,17 @@ module OSRM
       ensure_cache_version
     end
 
+    def overview=(overview)
+      ensure_valid_overview(overview)
+      @data[:overview] = overview
+    end
+
+    def ensure_valid_overview(overview)
+      unless [false, :simplified, :full].include?(overview)
+        raise "OSRM API error: Invalid overview type #{overview.inspect}"
+      end
+    end
+
     # Dynamically add missing accessors
     DEFAULTS.each do |option, default_value|
       reader = case default_value

data/lib/osrm/query.rb

@@ -11,8 +11,8 @@ module OSRM
       @locations = locations.compact.reject(&:empty?)
     end
 
-    def execute
-      build_uri
+    def execute(alternatives: nil, overview: nil)
+      build_uri(alternatives: alternatives, overview: overview)
       fetch_json_data[:routes].map { |route| Route.new(route) }
     end
 
@@ -86,7 +86,7 @@ module OSRM
       end
     end
 
-    def build_uri
+    def build_uri(alternatives: nil, overview: nil)
       raise "OSRM API error: Server isn't configured" unless configuration.server
 
       service = 'route'
@@ -94,9 +94,17 @@ module OSRM
       profile = 'driving'
       format  = 'json'
 
+      alternatives = alternatives.nil? ? false : (alternatives == true)
+      if overview.nil?
+        overview = configuration.overview
+      else
+        configuration.ensure_valid_overview(overview)
+      end
+
       params = [
-        %w(alternatives true),
-        %w(geometries polyline)
+        ['alternatives', alternatives.to_s],
+        ['geometries', 'polyline'],
+        ['overview', overview.to_s]
       ]
 
       uri_class = configuration.use_ssl? ? URI::HTTPS : URI::HTTP

data/lib/osrm/route.rb

@@ -6,14 +6,15 @@ module OSRM
 
     def initialize(json = {})
       @geometry = decode_geometry(json[:geometry])
-      @distance = json[:distance] || 0
-      @duration = json[:duration] || 0
+      @distance = json[:distance].to_f
+      @duration = json[:duration].to_f
     end
 
     private
 
     def decode_geometry(geometry)
-      return [] if geometry.nil? || geometry.empty?
+      return nil if geometry.nil?
+      return [] if geometry.empty?
 
       EncodedPolyline.decode_points(geometry, 5).map do |point|
         point.map { |coordinate| fix_float_precision(coordinate) }

data/lib/osrm/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osrm
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Freayd