osrm 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 169960f4f55e9adb038d4d74352338acf90947b6
-  data.tar.gz: 713c1b28e080c8c48e1f3d3327ae80f2ecf15dc3
+  metadata.gz: 92463b2268cde98a25fd17ee40da3cf7776b419d
+  data.tar.gz: 7137bacdd9c3138599a072a7f0a9739a81b3c09f
 SHA512:
-  metadata.gz: ec89dcde3038a0ad936478b4fe8315494a25bcf4740eecbdaf7b71b8f1c822435385284d761491457b89810ceb00ca177756ea479eb94fb805dfdcd7f6e61238
-  data.tar.gz: caa178c62c8ac16d7182da470afa56e58168c698289293a466fa236ff23115561877f9f6d48418322fa5d7226c43e3871efdc6cae96e06edb56884a3f440a300
+  metadata.gz: 5531d84abc60df3286e5a6df00adbe4f761b8af9b271473703977ddb8d08fcde15c0c28caa4ee47a12cbc4e9ba407ba4acfbd0254a47e61bbbea508b37d69f0d
+  data.tar.gz: 5942655353720c6484a1a8474e0b46e85c82c095c2f658285bc5e283357d363690dd03811b4572bf3628e95be4c4d9aeb1b76bb6fa2fe05c82464d2fc9e68be7

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### OSRM Gem 0.4.2 (2017 Feb 23) ###
+
+* Support Mapbox server
+* Support routing profiles
+
 ### OSRM Gem 0.4.1 (2016 Sep 17) ###
 
 * Add overview option

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Freayd
+Copyright (c) 2014-2017 Freayd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,7 @@
 ## OSRM Gem
 
 OSRM Gem is a Ruby API that allows you to request [Open Source Routing Machine](http://project-osrm.org/) servers.
-You can [run your own server](https://github.com/Project-OSRM/osrm-backend/wiki) or use the [demo server](https://github.com/Project-OSRM/osrm-backend/wiki/Api-usage-policy).
+You can [run your own server](https://github.com/Project-OSRM/osrm-backend/wiki), use the [OSRM demo server](https://github.com/Project-OSRM/osrm-backend/wiki/Demo-server) or the [Mapbox server](https://www.mapbox.com/developers/).
 
 ## Usage
 
@@ -18,6 +18,11 @@ You can [run your own server](https://github.com/Project-OSRM/osrm-backend/wiki)
           server:     'example.com',      # Must be specified
           port:       8080,               # Default: 80 or 443 if SSL
           use_ssl:    true,               # Default: false
+          ## OSRM demo server connection
+          # server:     :demo,
+          ## Mapbox server connection
+          # server:     :mapbox,
+          # api_key:    'access-token',
 
           # Connection (advanced)
           timeout:        10,                               # Default: 3
@@ -40,8 +45,9 @@ You can [run your own server](https://github.com/Project-OSRM/osrm-backend/wiki)
 3. Request
 
         OSRM.routes('50.202712,8.582738', '50.20232,8.574447')
-        OSRM.route('50.202712,8.582738', '50.20232,8.574447')
+        OSRM.route('50.202712,8.582738', '50.20232,8.574447', '50.2099431,8.5710665')
+        OSRM.route_by_cycling('45.734818,7.3219649', '45.868829,7.1533417')
 
 ## License
 
-OSRM Gem is released under [MIT License](http://opensource.org/licenses/MIT).
+OSRM Gem is released under [MIT License](https://opensource.org/licenses/MIT).

data/lib/osrm.rb

@@ -12,11 +12,27 @@ module OSRM
     Configuration.instance
   end
 
-  def self.routes(*locations, overview: nil)
-    Query.new(*locations).execute(alternatives: true, overview: overview)
+  def self.routes(*locations, overview: nil, profile: nil)
+    Query.new(*locations)
+         .execute(alternatives: true, overview: overview, profile: profile)
   end
 
-  def self.route(*locations, overview: nil)
-    Query.new(*locations).execute(alternatives: false, overview: overview).first
+  def self.route(*locations, overview: nil, profile: nil)
+    Query.new(*locations)
+         .execute(alternatives: false, overview: overview, profile: profile)
+         .first
+  end
+
+  def self.method_missing(method, *arguments, **keyword_arguments)
+    if /^(?<delegate>routes?)_by_(?<profile>[a-z]+)$/ =~ method
+      keyword_arguments[:profile] = profile
+      method(delegate).call(*arguments, **keyword_arguments)
+    else
+      super
+    end
+  end
+
+  def self.respond_to_missing?(method, *)
+    /^routes?_by_[a-z]+$/.match(method) || super
   end
 end

data/lib/osrm/configuration.rb

@@ -9,6 +9,7 @@ module OSRM
       server:  nil,
       port:    nil,
       use_ssl: false,
+      api_key: nil,
 
       timeout:        3,
       user_agent:     "OSRMRubyGem/#{OSRM::VERSION}",
@@ -21,7 +22,8 @@ module OSRM
       overview:  :simplified
     }.freeze
 
-    DEMO_SERVER = 'router.project-osrm.org'.freeze
+    DEMO_SERVER   = 'router.project-osrm.org'.freeze
+    MAPBOX_SERVER = 'api.mapbox.com'.freeze
 
     def initialize
       @data = {}
@@ -38,13 +40,25 @@ module OSRM
 
     def server=(server)
       @data[:server] =
-        server == :demo ? DEMO_SERVER.dup : server
+        case server
+        when :demo, DEMO_SERVER
+          DEMO_SERVER.dup
+        when :mapbox, MAPBOX_SERVER
+          self.use_ssl = true
+          MAPBOX_SERVER.dup
+        else
+          server
+        end
     end
 
     def use_demo_server?
       @data[:server] == DEMO_SERVER
     end
 
+    def use_mapbox_server?
+      @data[:server] == MAPBOX_SERVER
+    end
+
     def port=(port)
       @data[:port] = port&.to_i
     end
@@ -78,15 +92,17 @@ module OSRM
       ensure_cache_version
     end
 
-    # Raise an exception if major and minor versions of the cache and library are different
+    # Raise an exception if the cache isn't compatible with the current library version
     def ensure_cache_version
       return unless cache
 
       cache_version = cache[cache_key('version')]
+      minimum_version = '0.4.0'
       if cache_version &&
-         Gem::Version.new(cache_version).bump != Gem::Version.new(OSRM::VERSION).bump
+         Gem::Version.new(cache_version) < Gem::Version.new(minimum_version)
         @data[:cache] = nil
-        raise "OSRM API error: Incompatible cache version #{cache_version}, expected #{OSRM::VERSION}"
+        raise "OSRM API error: Incompatible cache version #{cache_version}, " +
+              "expected #{minimum_version} or higher"
       end
     end
 

data/lib/osrm/query.rb

@@ -11,8 +11,8 @@ module OSRM
       @locations = locations.compact.reject(&:empty?)
     end
 
-    def execute(alternatives: nil, overview: nil)
-      build_uri(alternatives: alternatives, overview: overview)
+    def execute(alternatives: nil, overview: nil, profile: nil)
+      build_uri(alternatives: alternatives, overview: overview, profile: profile)
       fetch_json_data[:routes].map { |route| Route.new(route) }
     end
 
@@ -22,7 +22,7 @@ module OSRM
       raw_data = cache || fetch_raw_data
 
       json = JSON.parse(raw_data, symbolize_names: true)
-      raise "OSRM API error: #{json[:message]} (#{json[:code]})" unless json[:code] == 'Ok'
+      raise "OSRM API error: #{json[:message]}#{' ('+json[:code]+')' if json[:code]}" unless json[:code] == 'Ok'
 
       cache(raw_data)
       json
@@ -76,22 +76,36 @@ module OSRM
     def ensure_valid_response(response)
       return if %w(200 400).include?(response.code)
 
+      begin
+        return if response.body.start_with?('{') && JSON.parse(response.body)
+      rescue JSON::ParserError
+        nil
+      end
+
       if configuration.use_demo_server? &&
-         response['location'] &&
-         response['location']['forbidden.html']
+         response['location']&.include?('forbidden.html')
         raise 'OSRM API error: API usage policy has been violated, see https://github.com/Project-OSRM/osrm-backend/wiki/Api-usage-policy'
-      else
-        raise 'OSRM API error: Invalid response' \
-              " #{response.code} #{response.message}"
       end
+
+      ensure_ready_server if response.code == '404'
+      raise 'OSRM API error: Invalid response' + \
+            " #{response.code} #{response.message}"
     end
 
-    def build_uri(alternatives: nil, overview: nil)
+    def ensure_ready_server
+      root_uri = @uri.class.build(host: @uri.host, port: @uri.port)
+      root_response = Net::HTTP.get(root_uri)
+      raise "OSRM API error: #{root_response}" if root_response.match(/NOT READY/i)
+    end
+
+    def build_uri(alternatives: nil, overview: nil, profile: nil)
       raise "OSRM API error: Server isn't configured" unless configuration.server
 
-      service = 'route'
-      version = 'v1'
-      profile = 'driving'
+      use_mapbox = configuration.use_mapbox_server?
+      service = use_mapbox ? 'directions' : 'route'
+      version = use_mapbox ? 'v5' : 'v1'
+      profile ||= 'driving'
+      profile.prepend('mapbox/') if use_mapbox
       format  = 'json'
 
       alternatives = alternatives.nil? ? false : (alternatives == true)
@@ -107,6 +121,8 @@ module OSRM
         ['overview', overview.to_s]
       ]
 
+      params << ['access_token', configuration.api_key] if use_mapbox
+
       uri_class = configuration.use_ssl? ? URI::HTTPS : URI::HTTP
       @uri = uri_class.build(
         host: configuration.server,

data/lib/osrm/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osrm
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Freayd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-17 00:00:00.000000000 Z
+date: 2017-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -48,22 +48,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.2.2
+        version: 10.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.2.2
+        version: 10.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: encoded_polyline
   requirement: !ruby/object:Gem::Requirement
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: OSRM API for Ruby