mapbox-sdk 1.0.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5ada80d6e1cbf4bce52c8963bdcd9eb0d6c7ad93
-  data.tar.gz: 4c58511165153eca7a4bb787ae979f75ebf277d7
+SHA256:
+  metadata.gz: 2de67f3d74dc108741f0f24be98c0d0c9ef1e0f339f1f93a0ded434a346327e7
+  data.tar.gz: a1c6335da15b1741f67f59d56860f7185aed3e21ee64ffb356b4dc03b3e71925
 SHA512:
-  metadata.gz: 0f8ddaff0bb1a510dba43c5b7b4a5ff9b13d230b390a9d734df095279cffbefa61d86ef04c220e53973241419dc9daafdd4fd7d47bf1bfa23b016e22ea7783d1
-  data.tar.gz: 6c92af8cd540921a908634beba3cbb784e4bb2205d71889a758ee31992359f3c21e099b56b0434f814d84b20bc4ae5bc56994cf557c5dcc082a194652f94500a
+  metadata.gz: 652a2d627953d128b3dd777885356646e40cb023584113e80ac88b53ccc14001d70837f7c04902fe6a8484fd1d064845a42e842762d321dd0e21ce64534a9b82
+  data.tar.gz: 80deb42871d24df8de2f632a86b5d815a9ec0ec69824096e23d86bc32213dd82603a05be7cbe292bd0180f61c467549201b4784ce4eef6a522d1583d2540dcf1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+ - 2.5.1
+install:
+ - bundle install
+script: 
+ - bundle exec ruby -Itest test/all_tests.rb
+after_success:
+  - coveralls

data/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+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.3.1] - 2020-11-07
+### Added
+
+### Changed
+- Update to restclient 2.1.0
+
+### Removed
+
+## [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
+- New README/docs folder and organization
+
+### Changed
+- Update to restclient 2.0
+- Parameters to requests for directions
+
+### Removed
+
+## [2.1.0] - 2018-06-07
+### Added
+- Added CHANGELOG.md
+- Added Tilequery endpoint
+
+### Changed
+- Updated documentation links in README
+
+### Removed

data/Gemfile

@@ -3,7 +3,11 @@ gemspec
 
 if Gem::Version.new(RUBY_VERSION.dup) < Gem::Version.new('1.9.3')
   gem 'i18n', '< 0.7'
-  gem 'rest-client', '~> 1.6.8'
-  gem 'activesupport', '~> 3.2'
+  gem 'rest-client', '~> 2.1.0'
+  gem "activesupport", ">= 4.1.11"
   gem 'rake', '10.1.0'
 end
+
+group :development, :test do
+  gem "coveralls", :require => false
+end

data/README.md

@@ -1,38 +1,40 @@
+[![Coverage Status](https://coveralls.io/repos/github/mapbox/mapbox-sdk-rb/badge.svg?branch=master)](https://coveralls.io/github/mapbox/mapbox-sdk-rb?branch=master)
+
 # mapbox-sdk-ruby
 
 The `mapbox-sdk` gem. A ruby interface to [Mapbox APIs](https://www.mapbox.com/developers/api/).
 
+## Installation
+
+```
+gem install mapbox-sdk
+```
+
 ## Services
 
-* [Geocoding](https://www.mapbox.com/developers/api/geocoding/)
+* [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/developers/api/directions/)
+* [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
 
-## Example
-
-```rb
-require "mapbox-sdk"
-Mapbox.access_token = "YOUR_ACCESS_TOKEN"
-
-# Reverse geocoding
-placenames = Mapbox::Geocoder.geocode_reverse({
-  "latitude" => 38,
-  "longitude" => -100
-})
-
-# Forward geocoding
-places = Mapbox::Geocoder.geocode_forward("Chester, NJ")
-
-# Directions
-drivingDirections = Mapbox::Directions.directions([{
-  "longitude" => -100,
-  "latitude" => 38
-}, {
-  "longitude" => -90,
-  "latitude" => 38
-}])
+## Testing
+
+You'll need to [create an access token](https://account.mapbox.com/access-tokens/create) in order to run tests.
+
+Then you can run the entire test suite with the following command:
+
+```
+MapboxAccessToken=<YOUR_ACCESS_TOKEN> bundle exec ruby -Itest test/all_tests.rb
 ```
 
 Heavily influenced by Stripe's Ruby client, and includes its MIT license.

data/docs/directions.md

@@ -0,0 +1,31 @@
+# Directions
+
+```rb
+require "mapbox-sdk"
+Mapbox.access_token = "YOUR_ACCESS_TOKEN"
+
+# Driving directions with required profile parameter.
+drivingDirections = Mapbox::Directions.directions([{
+  "longitude" => -100,
+  "latitude" => 38
+}, {
+  "longitude" => -90,
+  "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/navigation/#retrieve-directions]).
+
+# For instance, to use the `geometries` and `voice_instructions` parameter:
+drivingDirections = Mapbox::Directions.directions([{
+  "longitude" => -100,
+  "latitude" => 38
+}, {
+  "longitude" => -90,
+  "latitude" => 38
+  }], "driving", {
+    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/navigation/#directions).
+```

data/docs/geocoding.md

@@ -0,0 +1,15 @@
+# Geocoding
+
+```rb
+require "mapbox-sdk"
+Mapbox.access_token = "YOUR_ACCESS_TOKEN"
+
+# Reverse geocoding
+placenames = Mapbox::Geocoder.geocode_reverse({
+  "latitude": 38,
+  "longitude": -100
+})
+
+# Forward geocoding with optional proximity parameter
+places = Mapbox::Geocoder.geocode_forward("Chester, NJ", {:proximity => {:longitude => -74.6968, :latitude => 40.7843}})
+```

data/docs/isochrone.md

@@ -0,0 +1,11 @@
+# Isochrone
+
+```rb
+require "mapbox-sdk"
+Mapbox.access_token = "YOUR_ACCESS_TOKEN"
+
+isochrone = Mapbox::Isochrone.isochrone("walking", "-118.22258,33.99038", {contours_minutes: [5,10,15]})
+
+# You must include the contours_minutes parameter, as well as a profile (walking, driving, cycling) and the center point coordinate.
+# Optional parameters are contours_colors, polygons, denoise, and generalize. See more on the API documentation page.
+```

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/docs/tilequery.md

@@ -0,0 +1,12 @@
+# Tilequery
+
+```rb
+require "mapbox-sdk"
+Mapbox.access_token = "YOUR_ACCESS_TOKEN"
+
+tilequery = Mapbox::Tilequery.tilequery(mapid, {location}, radius, limit)
+
+# Example: tilequery = Mapbox::Tilequery.tilequery("mapbox.mapbox-streets-v7", {"longitude" => -100, "latitude" => 38}, 0, 1)
+# `Radius` refers to the approximate distance in meters to query for features. Defaults to  0 if left blank. Has no upper bound. Required for queries against point and line data. 
+# `Limit` refers to the number of features between  1 - 50 to return. Defaults to  5 if left blank.
+```

data/lib/mapbox-sdk.rb

@@ -0,0 +1 @@
+require 'mapbox'

data/lib/mapbox.rb

@@ -3,15 +3,15 @@ require 'json'
 require 'mapbox/api_operations'
 require 'mapbox/authentication_error'
 
-# services
-require 'mapbox/geocoder'
-require 'mapbox/directions'
-
 module Mapbox
   @api_base = 'https://api.mapbox.com'
+  @request_opts = {}
+
+  LATITUDE_KEY = 'latitude'.freeze
+  LONGITUDE_KEY = 'longitude'.freeze
 
   class << self
-    attr_accessor :access_token, :api_base
+    attr_accessor :access_token, :api_base, :request_opts
   end
 
   def self.request(method, url, api_key, params={}, headers={}, api_base_url=nil)
@@ -37,10 +37,10 @@ module Mapbox
       payload = nil
     end
 
-    request_opts = {:verify_ssl => OpenSSL::SSL::VERIFY_PEER,
+    @request_opts = {:verify_ssl => OpenSSL::SSL::VERIFY_PEER,
                       :ssl_ca_file => @ssl_bundle_path}
 
-    request_opts.update(
+    @request_opts.update(
       :method => method,
       :open_timeout => 30,
       :payload => payload,
@@ -48,7 +48,7 @@ module Mapbox
       :timeout => 80)
 
     begin
-      response = execute_request(request_opts)
+      response = execute_request(@request_opts)
     rescue SocketError => e
       handle_restclient_error(e, api_base_url)
     rescue NoMethodError => e
@@ -168,4 +168,20 @@ module Mapbox
 
     raise StandardError.new(message + "\n\n(Network error: #{e.message})")
   end
+
+  module HashUtils
+    def xy_from_hash h = {}
+      [ h.fetch(:longitude){ h[LONGITUDE_KEY] },
+        h.fetch(:latitude){ h[LATITUDE_KEY] } ]
+    end
+  end
 end
+
+# services
+require 'mapbox/geocoder'
+require 'mapbox/directions'
+require 'mapbox/tilequery'
+require 'mapbox/isochrone'
+require 'mapbox/matrix'
+require 'mapbox/map_matching'
+require 'mapbox/optimization'

data/lib/mapbox/directions.rb

@@ -1,17 +1,59 @@
-require 'rest-client'
-require 'json'
-
 module Mapbox
   class Directions
     include Mapbox::APIOperations::Request
-    def self.directions(waypoints, profile='mapbox.driving')
-      formatted_waypoints = waypoints.map { |point|
-        "#{point['longitude']},#{point['latitude']}"
-      }.join(';')
+    extend Mapbox::HashUtils
+
+    def self.assemble_params(options={})
+      alternatives = options[:alternatives]
+      annotations = options[:annotations]
+      approaches = options[:approaches]
+      banner_instructions = options[:banner_instructions]
+      bearings = options[:bearings]
+      continue_straight = options[:continue_straight]
+      exclude = options[:exclude]
+      geometries = options[:geometries]
+      language = options[:language]
+      overview = options[:overview]
+      radiuses = options[:radiuses]
+      roundabout_exits = options[:roundabout_exits]
+      steps = options[:steps]
+      voice_instructions = options[:voice_instructions]
+      voice_units = options[:voice_units]
+      waypoint_names = options[:waypoint_names]
+      
+      params = ''
+      opts = options.select { |key, value| key != :approaches && key != :bearings && key != :radiuses && key != :waypoint_names  }
+      if opts.length > 0
+        params += "#{params.length > 0 ? '&' : '?'}#{URI.encode_www_form(opts)}"
+      end
+
+      if approaches  then
+        params += "#{params.length > 0 ? '&' : '?'}approaches=#{approaches.join(';')}"
+      end
+
+      if bearings then
+        params += "#{params.length > 0 ? '&' : '?'}bearings=#{bearings.map {|p| bearings.join ','}.join ';'}"
+      end
+
+      if radiuses then
+        params += "#{params.length > 0 ? '&' : '?'}radiuses=#{radiuses.join ';'}"
+      end
+
+      if waypoint_names then
+        params += "#{params.length > 0 ? '&' : '?'}waypoint_names=#{waypoint_names.join ';'}"
+      end
+
+      return params
+    end
+
+    def self.directions(waypoints, profile, options={})
+      formatted_waypoints = waypoints.map {|p| xy_from_hash(p).join ','}.join ';'
+      params = self.assemble_params(options)
+      
       return request(
-        :get,
-        "/v4/directions/#{profile}/#{formatted_waypoints}.json",
-        nil)
+          :get,
+          "/directions/v5/mapbox/#{profile}/#{formatted_waypoints}.json#{params}",
+          nil)
     end
   end
-end
+end