mapbox-sdk 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 206fa6c2df10182a6dec5a95110961dd3688eb42181af8d3ff8d9264410cb69c
-  data.tar.gz: 8e9771a4339e26319e665d665f7f1abdfc3c5a45daca881846e9f4a9f698fe6c
+  metadata.gz: e37005101fa7cc0a72f5711254531e13574ddd14d470a8e115b278e62c4297f3
+  data.tar.gz: ff3a2679ed83dc2df5f1fba7474d59cf0489adaa6b303f0f45072a579f2714d4
 SHA512:
-  metadata.gz: 9708d334fe1a76f02886d8a8da17d862f192a2c1a6705ee90588145c3a7e9d56a4f068d8a5193bf811fd489fc3a7543e07415e516c9adbb2e024dc7bb3361b0b
-  data.tar.gz: 8789e29b94f27a624d3d8eb89c809cdb710a8262b72abb5017a125662d2299fc2d08fc2df7cc0d30e35ae6343cd2b6a0e877f08f655d16ba63a61a7f4b2c5f41
+  metadata.gz: 5e0d69f2d9f8920ef0ab08505156e1498dd579df3cedfc706444065d9d1ead993dab7abf9ab5451c5c22e0c0078e1a701f2f3eb5cb3a7dd29ee01ffb264f25d6
+  data.tar.gz: 1b7b0370797210b16210060bbc92c52a9fa14add842fc2d4b7adb57e66aa0f951143012508084cde4ecc6d6c5e6fa91d53b2f8735c0a24b9a05849de9eb179e8

data/CHANGELOG.md

@@ -4,7 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [2.1.0] - 2018-12-14
+## [2.3.0] - 2019-01-16
+### Added
+- Matrix endpoint, docs, and tests
+- Map Matching endpoint, docs, and tests
+- Optimization endpoint, docs, and tests
+
+### Changed
+
+### Removed
+
+## [2.2.0] - 2018-12-14
 ### Added
 - Selection of directions profiles
 - Isochrone endpoint

data/README.md

@@ -12,14 +12,20 @@ gem install mapbox-sdk
 
 ## Services
 
-* [Geocoding](https://www.mapbox.com/api-documentation/#geocoding) [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/master/docs/geocoding.md)]
+* [Geocoding](https://docs.mapbox.com/api/search/) [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/master/docs/geocoding.md)]
   * Forward (place names ⇢  longitude, latitude)
   * Reverse (longitude, latitude ⇢ place names)
-* [Directions](https://www.mapbox.com/api-documentation/#directions): [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/master/docs/directions.md)]
-  * Profiles for driving, walking, and cycling
-* [Tilequery](https://www.mapbox.com/api-documentation/#tilequery): [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/master/docs/tilequery.md)]
-* [Isochrone](https://www.mapbox.com/api-documentation/#isochrone): [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/masterdocs/isochrone.md)]
+* [Directions](https://docs.mapbox.com/api/navigation/#directions): [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/master/docs/directions.md)]
+  * Profiles for driving, driving-traffic, walking, and cycling
+* [Tilequery](https://docs.mapbox.com/api/maps/#tilequery): [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/master/docs/tilequery.md)]
+* [Isochrone](https://docs.mapbox.com/api/navigation/#isochrone): [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/master/docs/isochrone.md)]
   * Profiles for driving, walking, and cycling
+* [Matrix](https://docs.mapbox.com/api/navigation/#matrix): [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/master/docs/matrix.md)]
+  * Profiles for driving, driving-traffic, walking, and cycling
+* [Map Matching](https://docs.mapbox.com/api/navigation/#map-matching): [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/master/docs/mapmatching.md)]
+  * Profiles for driving, driving-traffic, walking, and cycling
+* [Optimization](https://docs.mapbox.com/api/navigation/#optimization): [[docs](https://github.com/mapbox/mapbox-sdk-rb/blob/master/docs/optimization.md)]
+* Profiles for driving, driving-traffic, walking, and cycling
 
 ## Testing
 

data/docs/directions.md

@@ -13,7 +13,7 @@ drivingDirections = Mapbox::Directions.directions([{
   "latitude" => 38
   }], "driving")
 
-# To provide query parameters to the Directions API, such as `geometries`, `language` or `steps`, add those in a Hash as third parameter (find the full list of parameters (here)[https://www.mapbox.com/api-documentation/#retrieve-directions]).
+# To provide query parameters to the Directions API, such as `geometries`, `language` or `steps`, add those in a Hash as third parameter (find the full list of parameters (here)[https://www.mapbox.com/api-documentation/navigation/#retrieve-directions]).
 
 # For instance, to use the `geometries` and `voice_instructions` parameter:
 drivingDirections = Mapbox::Directions.directions([{
@@ -26,6 +26,6 @@ drivingDirections = Mapbox::Directions.directions([{
     geometries: "geojson",
     voice_instructions: true
   })
-  
-# In the above example, you can substitute `driving` for `driving-traffic`, `cycling` or `walking`. For more, [check out the documentation](https://www.mapbox.com/api-documentation/#directions).
-```
+
+# In the above example, you can substitute `driving` for `driving-traffic`, `cycling` or `walking`. For more, [check out the documentation](https://www.mapbox.com/api-documentation/navigation/#directions).
+```

data/docs/mapmatching.md

@@ -0,0 +1,43 @@
+# Map Matching
+
+```rb
+require "mapbox-sdk"
+Mapbox.access_token = "YOUR_ACCESS_TOKEN"
+
+# Snap fuzzy, inaccurate GPS or phone traces to the road and path network with required profile parameter.
+matching = Mapbox::MapMatching.map_matching([{
+  "longitude" => -117.17282,
+  "latitude" => 32.71204
+}, {
+  "longitude" => -117.17288,
+  "latitude" => 32.71225
+}, {
+  "longitude" => -117.17293,
+  "latitude" => 32.71244
+  },{
+  "longitude" => -117.17292,
+  "latitude" => 32.71256
+  }], "driving")
+
+# To provide query parameters to the Matrix API, such as `annotations`, `approaches` or `sources`, add those in a Hash as third parameter (find the full list of parameters (here)[https://www.mapbox.com/api-documentation/navigation/#matrix]).
+
+# For instance, to use the `geometries` and `voice_instructions` parameter:
+matching = Mapbox::MapMatching.map_matching([{
+  "longitude" => -117.17282,
+  "latitude" => 32.71204
+}, {
+  "longitude" => -117.17288,
+  "latitude" => 32.71225
+}, {
+  "longitude" => -117.17293,
+  "latitude" => 32.71244
+  },{
+  "longitude" => -117.17292,
+  "latitude" => 32.71256
+  }], "driving", {
+    annotations: ["duration", "distance", "speed"],
+    approaches: ["curb","curb","curb","curb"]
+  })
+
+# In the above example, you can substitute `driving` for `driving-traffic`, `cycling` or `walking`. For more, [check out the documentation](https://docs.mapbox.com/api/navigation/#map-matching).
+```

data/docs/matrix.md

@@ -0,0 +1,38 @@
+# Matrix
+
+```rb
+require "mapbox-sdk"
+Mapbox.access_token = "YOUR_ACCESS_TOKEN"
+
+# Return travel times between many points, passing in the required profile parameter.
+matrix = Mapbox::Matrix.matrix([{
+  "longitude" => -122.42,
+  "latitude" => 37.78
+}, {
+  "longitude" => -122.45,
+  "latitude" => 37.91
+}, {
+ "longitude" => -122.48,
+  "latitude" => 37.73
+  }], "walking")
+
+# To provide query parameters to the Matrix API, such as `annotations`, `approaches` or `sources`, add those in a Hash as third parameter (find the full list of parameters (here)[https://www.mapbox.com/api-documentation/navigation/#matrix]).
+
+# For instance, to use the `annotations`, `approaches`, and `destinations` parameters:
+matrix = Mapbox::Matrix.matrix([{
+  "longitude" => -122.42,
+  "latitude" => 37.78
+}, {
+  "longitude" => -122.45,
+  "latitude" => 37.91
+}, {
+ "longitude" => -122.48,
+  "latitude" => 37.73
+  }], "cycling", {
+    annotations: ["duration", "distance"],
+    approaches: ["curb","","curb"],
+    destinations: [0,1]
+  })
+
+# In the above example, you can substitute `driving` for `driving-traffic`, `cycling` or `walking`. For more, [check out the documentation](https://www.mapbox.com/api-documentation/navigation/#matrix).
+```

data/docs/optimization.md

@@ -0,0 +1,52 @@
+# Optimization
+
+```rb
+require "mapbox-sdk"
+Mapbox.access_token = "YOUR_ACCESS_TOKEN"
+
+# Returns a duration-optimized route between coordinates with required profile parameter.
+optimization = Mapbox::Optimization.optimization([{
+  "longitude" => -122.42,
+  "latitude" => 37.78
+}, {
+  "longitude" => -122.45,
+  "latitude" => 37.91
+}, {
+ "longitude" => -122.48,
+  "latitude" => 37.73
+  }], "walking")
+
+# To provide query parameters to the Matrix API, such as `annotations`, `approaches` or `sources`, add those in a Hash as third parameter (find the full list of parameters (here)[https://www.mapbox.com/api-documentation/navigation/#matrix]).
+
+# For instance, to use the `annotations`, `approaches`, and `overview` parameters:
+optimization = Mapbox::Optimization.optimization([{
+  "longitude" => -122.42,
+  "latitude" => 37.78
+}, {
+  "longitude" => -122.45,
+  "latitude" => 37.91
+}, {
+ "longitude" => -122.48,
+  "latitude" => 37.73
+  }], "cycling", {
+    annotations: ["duration", "distance"],
+    approaches: ["curb","curb","curb"],
+    overview: "false"
+  })
+
+# The bearings param works a bit differently. Here's an example, leaving the second bearing blank with an additional `;` character (you must include the same number of bearings as waypoints, per the docs):
+optimization = Mapbox::Optimization.optimization([{
+  "longitude" => -122.42,
+  "latitude" => 37.78
+}, {
+  "longitude" => -122.45,
+  "latitude" => 37.91
+}, {
+ "longitude" => -122.48,
+  "latitude" => 37.73
+  }], "driving", {
+    bearings: "45,90;;90,1"
+  })
+
+# In the above example, you can substitute `driving` for `driving-traffic`, `cycling` or `walking`. For more, [check out the documentation](https://docs.mapbox.com/api/navigation/#optimization).
+```

data/lib/mapbox.rb

@@ -181,4 +181,7 @@ end
 require 'mapbox/geocoder'
 require 'mapbox/directions'
 require 'mapbox/tilequery'
-require 'mapbox/isochrone'
+require 'mapbox/isochrone'
+require 'mapbox/matrix'
+require 'mapbox/map_matching'
+require 'mapbox/optimization'

data/lib/mapbox/map_matching.rb

@@ -0,0 +1,57 @@
+module Mapbox
+  class MapMatching
+    include Mapbox::APIOperations::Request
+    extend Mapbox::HashUtils
+
+    def self.assemble_params(options={})
+      annotations = options[:annotations]
+      approaches = options[:approaches]
+      radiuses = options[:radiuses]
+      timestamps = options[:timestamps]
+      waypoint_names = options[:waypoint_names]
+      waypoints = options[:waypoints]
+      
+      params = ''
+      opts = options.select { |key, value| key != :annotations && key != :approaches && key != :radiuses && key != :timestamps && key != :waypoint_names && key != :waypoints  }
+      if opts.length > 0
+        params += "#{params.length > 0 ? '&' : '?'}#{URI.encode_www_form(opts)}"
+      end
+
+      if annotations  then
+        params += "#{params.length > 0 ? '&' : '?'}annotations=#{annotations.join(',')}"
+      end
+
+      if approaches  then
+        params += "#{params.length > 0 ? '&' : '?'}approaches=#{approaches.join(';')}"
+      end
+
+      if radiuses then
+        params += "#{params.length > 0 ? '&' : '?'}radiuses=#{radiuses.join ';'}"
+      end
+
+      if timestamps then
+        params += "#{params.length > 0 ? '&' : '?'}timestamps=#{timestamps.join ';'}"
+      end
+
+      if waypoint_names then
+        params += "#{params.length > 0 ? '&' : '?'}waypoint_names=#{waypoint_names.join ';'}"
+      end
+
+      if waypoints then
+        params += "#{params.length > 0 ? '&' : '?'}waypoints=#{waypoints.join ';'}"
+      end
+
+      return params
+    end
+
+    def self.map_matching(waypoints, profile, options={})
+      formatted_waypoints = waypoints.map {|p| xy_from_hash(p).join ','}.join ';'
+      params = self.assemble_params(options)
+      
+      return request(
+          :get,
+          "/matching/v5/mapbox/#{profile}/#{formatted_waypoints}.json#{params}",
+          nil)
+    end
+  end
+end

data/lib/mapbox/matrix.rb

@@ -0,0 +1,32 @@
+module Mapbox
+  class Matrix
+    include Mapbox::APIOperations::Request
+    extend Mapbox::HashUtils
+
+    def self.assemble_params(options={})
+      opts = options.dup
+
+      self.joinArrayParam(opts, :destinations)
+      self.joinArrayParam(opts, :annotations, ',')
+      self.joinArrayParam(opts, :approaches)
+      self.joinArrayParam(opts, :sources)
+
+      return "?#{URI.encode_www_form(opts)}"
+    end
+
+    def self.joinArrayParam(opts, name, joinSymbol = ';')
+      if opts[name].kind_of?(Array)
+        opts[name] = opts[name].join(joinSymbol)
+      end
+    end
+
+    def self.matrix(waypoints, profile, options={})
+      formatted_waypoints = waypoints.map {|p| xy_from_hash(p).join ','}.join ';'
+      params = self.assemble_params(options)
+      return request(
+          :get,
+          "/directions-matrix/v1/mapbox/#{profile}/#{formatted_waypoints}.json#{params}",
+          nil)
+    end
+  end
+end

data/lib/mapbox/optimization.rb

@@ -0,0 +1,47 @@
+module Mapbox
+  class Optimization
+    include Mapbox::APIOperations::Request
+    extend Mapbox::HashUtils
+
+    def self.assemble_params(options={})
+      annotations = options[:annotations]
+      approaches = options[:approaches]
+      distributions = options[:distributions]
+      radiuses = options[:radiuses]
+      
+      params = ''
+      opts = options.select { |key, value| key != :annotations && key != :approaches && key != :distributions && key != :radiuses }
+      if opts.length > 0
+        params += "#{params.length > 0 ? '&' : '?'}#{URI.encode_www_form(opts)}"
+      end
+
+      if annotations  then
+        params += "#{params.length > 0 ? '&' : '?'}annotations=#{annotations.join(',')}"
+      end
+
+      if approaches  then
+        params += "#{params.length > 0 ? '&' : '?'}approaches=#{approaches.join(';')}"
+      end
+
+      if distributions  then
+        params += "#{params.length > 0 ? '&' : '?'}distributions=#{distributions.join(';')}"
+      end
+
+      if radiuses then
+        params += "#{params.length > 0 ? '&' : '?'}radiuses=#{radiuses.join(';')}"
+      end
+
+      return params
+    end
+
+    def self.optimization(waypoints, profile, options={})
+      formatted_waypoints = waypoints.map {|p| xy_from_hash(p).join ','}.join ';'
+      params = self.assemble_params(options)
+      
+      return request(
+          :get,
+          "/optimized-trips/v1/mapbox/#{profile}/#{formatted_waypoints}.json#{params}",
+          nil)
+    end
+  end
+end

data/mapbox-sdk.gemspec

@@ -2,7 +2,7 @@ $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
 spec = Gem::Specification.new do |s|
   s.name = 'mapbox-sdk'
-  s.version = '2.2.0'
+  s.version = '2.3.0'
   s.summary = 'Ruby bindings for the Mapbox API'
   s.description = ''
   s.authors = ['Tom MacWright']

data/test/map_matching_test.rb

@@ -0,0 +1,46 @@
+require 'mapbox'
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+
+module Mapbox
+  class MapMatchingTest < Test::Unit::TestCase
+    should "#map match with just coordinates and profile" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::MapMatching.map_matching([{
+        "longitude" => -117.17282,
+        "latitude" => 32.71204
+      }, {
+        "longitude" => -117.17288,
+        "latitude" => 32.71225
+      }, {
+        "longitude" => -117.17293,
+        "latitude" => 32.71244
+        },{
+        "longitude" => -117.17292,
+        "latitude" => 32.71256
+        }], "driving")
+      assert result
+    end
+    should "#map match with optional params" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::MapMatching.map_matching([{
+        "longitude" => -117.17282,
+        "latitude" => 32.71204
+      }, {
+        "longitude" => -117.17288,
+        "latitude" => 32.71225
+      }, {
+       "longitude" => -117.17293,
+        "latitude" => 32.71244
+      }, {
+       "longitude" => -117.17292,
+        "latitude" => 32.71256
+        }], "driving", {
+          annotations: ["duration", "distance", "speed"],
+          approaches: ["curb","curb","curb","curb"]
+        })
+      assert result
+    end
+  end
+end

data/test/matrix_test.rb

@@ -0,0 +1,40 @@
+require 'mapbox'
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+
+module Mapbox
+  class MatrixTest < Test::Unit::TestCase
+    should "#matrix with just coordinates and profile" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Matrix.matrix([{
+        "longitude" => -122.42,
+        "latitude" => 37.78
+      }, {
+        "longitude" => -122.45,
+        "latitude" => 37.91
+      }, {
+       "longitude" => -122.48,
+        "latitude" => 37.73
+        }], "driving")
+      assert result
+    end
+    should "#matrix with optional params" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Matrix.matrix([{
+        "longitude" => -122.42,
+        "latitude" => 37.78
+      }, {
+        "longitude" => -122.45,
+        "latitude" => 37.91
+      }, {
+       "longitude" => -122.48,
+        "latitude" => 37.73
+        }], "cycling", {
+          annotations: ["duration", "distance"],
+          approaches: ["curb","curb","curb"]
+        })
+      assert result
+    end
+  end
+end

data/test/optimization_test.rb

@@ -0,0 +1,56 @@
+require 'mapbox'
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+
+module Mapbox
+  class MatrixTest < Test::Unit::TestCase
+    should "#optimization with just coordinates and profile" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Optimization.optimization([{
+        "longitude" => -122.42,
+        "latitude" => 37.78
+      }, {
+        "longitude" => -122.45,
+        "latitude" => 37.91
+      }, {
+       "longitude" => -122.48,
+        "latitude" => 37.73
+        }], "walking")
+      assert result
+    end
+    should "#optimization with optional params" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Optimization.optimization([{
+        "longitude" => -122.42,
+        "latitude" => 37.78
+      }, {
+        "longitude" => -122.45,
+        "latitude" => 37.91
+      }, {
+       "longitude" => -122.48,
+        "latitude" => 37.73
+        }], "cycling", {
+          annotations: ["duration", "distance"],
+          approaches: ["curb","curb","curb"]
+        })
+      assert result
+    end
+    should "#optimization with an empty bearing" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Optimization.optimization([{
+        "longitude" => -122.42,
+        "latitude" => 37.78
+      }, {
+        "longitude" => -122.45,
+        "latitude" => 37.91
+      }, {
+       "longitude" => -122.48,
+        "latitude" => 37.73
+        }], "driving", {
+          bearings: "45,90;;90,1"
+        })
+      assert result
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mapbox-sdk
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Tom MacWright
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-14 00:00:00.000000000 Z
+date: 2019-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -97,6 +97,9 @@ files:
 - docs/directions.md
 - docs/geocoding.md
 - docs/isochrone.md
+- docs/mapmatching.md
+- docs/matrix.md
+- docs/optimization.md
 - docs/tilequery.md
 - lib/mapbox-sdk.rb
 - lib/mapbox.rb
@@ -105,13 +108,19 @@ files:
 - lib/mapbox/directions.rb
 - lib/mapbox/geocoder.rb
 - lib/mapbox/isochrone.rb
+- lib/mapbox/map_matching.rb
+- lib/mapbox/matrix.rb
+- lib/mapbox/optimization.rb
 - lib/mapbox/tilequery.rb
 - mapbox-sdk.gemspec
 - test/all_tests.rb
 - test/directions_test.rb
 - test/geocoding_test.rb
 - test/isochrone_test.rb
+- test/map_matching_test.rb
 - test/mapbox_test.rb
+- test/matrix_test.rb
+- test/optimization_test.rb
 - test/tilequery_test.rb
 homepage: https://mapbox.com/developers
 licenses:
@@ -132,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Mapbox API
@@ -142,5 +150,8 @@ test_files:
 - test/directions_test.rb
 - test/geocoding_test.rb
 - test/isochrone_test.rb
+- test/map_matching_test.rb
 - test/mapbox_test.rb
+- test/matrix_test.rb
+- test/optimization_test.rb
 - test/tilequery_test.rb