mapbox-sdk 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4292d0f1ca115de9e53c9289a9fb375904e2b49faf028b6a90a523ea35d5c0fb
-  data.tar.gz: 9dabda32d362ed87adc887589f73cd5fc8025c2cd69bc3f46647423e684623f9
+  metadata.gz: 206fa6c2df10182a6dec5a95110961dd3688eb42181af8d3ff8d9264410cb69c
+  data.tar.gz: 8e9771a4339e26319e665d665f7f1abdfc3c5a45daca881846e9f4a9f698fe6c
 SHA512:
-  metadata.gz: 994336458245a81e414248411bded1b62c03a80cf268bbc1f428d3fefef31b49e60355944dc2c397317cae809cbfde8e39f7dce9aa275c941e49ce92232f9f65
-  data.tar.gz: 040654e4765ff2fc308eef710669fffa48ad0b7b1d15c908150a0a5c29879be9fad18b340c6fc600bfc1b6806cf1eee0f3bf6292d0a378f4ce3637530020e37f
+  metadata.gz: 9708d334fe1a76f02886d8a8da17d862f192a2c1a6705ee90588145c3a7e9d56a4f068d8a5193bf811fd489fc3a7543e07415e516c9adbb2e024dc7bb3361b0b
+  data.tar.gz: 8789e29b94f27a624d3d8eb89c809cdb710a8262b72abb5017a125662d2299fc2d08fc2df7cc0d30e35ae6343cd2b6a0e877f08f655d16ba63a61a7f4b2c5f41

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

@@ -4,6 +4,18 @@ 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
+### 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

data/Gemfile

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

data/README.md

@@ -1,3 +1,5 @@
+[![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/).
@@ -10,45 +12,17 @@ gem install mapbox-sdk
 
 ## Services
 
-* [Geocoding](https://www.mapbox.com/api-documentation/#geocoding)
+* [Geocoding](https://www.mapbox.com/api-documentation/#geocoding) [[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)
+* [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)
-
-## Example
-
-```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}})
-
-# Driving directions with required profile parameter
-drivingDirections = Mapbox::Directions.directions([{
-  "longitude" => -100,
-  "latitude" => 38
-}, {
-  "longitude" => -90,
-  "latitude" => 38
-  }], "driving")
-  
-# 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).
-
-# Tilequery
-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.
-```
+* [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)]
+  * Profiles for driving, walking, and cycling
+
+## Testing
+
+Run `bundle exec ruby -Itest test/all_tests.rb` or individual tests as needed.
 
 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/#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/#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/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.rb

@@ -181,3 +181,4 @@ end
 require 'mapbox/geocoder'
 require 'mapbox/directions'
 require 'mapbox/tilequery'
+require 'mapbox/isochrone'

data/lib/mapbox/directions.rb

@@ -2,11 +2,57 @@ module Mapbox
   class Directions
     include Mapbox::APIOperations::Request
     extend Mapbox::HashUtils
-    def self.directions(waypoints, profile)
+
+    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,
-          "/directions/v5/mapbox/#{profile}/#{formatted_waypoints}.json",
+          "/directions/v5/mapbox/#{profile}/#{formatted_waypoints}.json#{params}",
           nil)
     end
   end

data/lib/mapbox/isochrone.rb

@@ -0,0 +1,35 @@
+module Mapbox
+  class Isochrone
+    include Mapbox::APIOperations::Request
+
+    def self.assemble_params(options={})
+      contours_minutes = options[:contours_minutes]
+      contours_colors = options[:contours_colors]
+      
+      params = ''
+      opts = options.select { |key, value| key != :contours_minutes && key != :contours_colors }
+      if opts.length > 0
+        params += "#{params.length > 0 ? '&' : '?'}#{URI.encode_www_form(opts)}"
+      end
+
+      if contours_minutes  then
+        params += "#{params.length > 0 ? '&' : '?'}contours_minutes=#{contours_minutes.join(',')}"
+      end
+
+      if contours_colors then
+        params += "#{params.length > 0 ? '&' : '?'}contours_colors=#{contours_colors.join(',')}"
+      end
+
+      return params
+    end
+
+    def self.isochrone(profile, coordinates, options={})
+      params = self.assemble_params(options)
+      
+      return request(
+          :get,
+          "/isochrone/v1/mapbox/#{profile}/#{coordinates}#{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.1.0'
+  s.version = '2.2.0'
   s.summary = 'Ruby bindings for the Mapbox API'
   s.description = ''
   s.authors = ['Tom MacWright']

data/test/all_tests.rb

@@ -0,0 +1,4 @@
+require 'coveralls'
+Coveralls.wear!
+
+Dir[File.dirname(File.absolute_path(__FILE__)) + '/**/*_test.rb'].each {|file| require file }

data/test/directions_test.rb

@@ -16,7 +16,9 @@ module Mapbox
           :longitude => -90,
           :latitude => 38
         }
-      ], "cycling")
+      ], "cycling", {
+        geometries: "geojson"
+      })
       assert result
     end
   end

data/test/isochrone_test.rb

@@ -0,0 +1,15 @@
+require 'mapbox'
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+
+module Mapbox
+  class IsochroneTest < Test::Unit::TestCase
+    should "#isochrone" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Isochrone.isochrone(
+        "walking", "-118.22258,33.99038", {contours_minutes: [5,10,15]})
+      assert result
+    end
+  end
+end

data/test/tilequery_test.rb

@@ -12,4 +12,4 @@ module Mapbox
       assert result
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mapbox-sdk
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Tom MacWright
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2018-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -87,23 +87,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- docs/directions.md
+- docs/geocoding.md
+- docs/isochrone.md
+- docs/tilequery.md
 - lib/mapbox-sdk.rb
 - lib/mapbox.rb
 - lib/mapbox/api_operations.rb
 - lib/mapbox/authentication_error.rb
 - lib/mapbox/directions.rb
 - lib/mapbox/geocoder.rb
+- lib/mapbox/isochrone.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/mapbox_test.rb
 - test/tilequery_test.rb
 homepage: https://mapbox.com/developers
@@ -126,12 +133,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Mapbox API
 test_files:
+- test/all_tests.rb
 - test/directions_test.rb
 - test/geocoding_test.rb
+- test/isochrone_test.rb
 - test/mapbox_test.rb
 - test/tilequery_test.rb

data/.circleci/config.yml

@@ -1,40 +0,0 @@
-version: 2
-jobs:
-  build:
-    working_directory: ~/mapbox/mapbox-sdk-rb
-    parallelism: 1
-    shell: /bin/bash --login
-    environment:
-      CIRCLE_ARTIFACTS: /tmp/circleci-artifacts
-      CIRCLE_TEST_REPORTS: /tmp/circleci-test-results
-    docker:
-    - image: circleci/build-image:ubuntu-14.04-XXL-upstart-1189-5614f37
-      command: /sbin/init
-    steps:
-    - checkout
-    - run: mkdir -p $CIRCLE_ARTIFACTS $CIRCLE_TEST_REPORTS
-    - restore_cache:
-        keys:
-        - v1-dep-{{ .Branch }}-
-        - v1-dep-master-
-        - v1-dep-
-    - run: echo -e "export RAILS_ENV=test\nexport RACK_ENV=test" >> $BASH_ENV
-    - run: 'bundle check --path=vendor/bundle || bundle install --path=vendor/bundle
-        --jobs=4 --retry=3 '
-    - save_cache:
-        key: v1-dep-{{ .Branch }}-{{ epoch }}
-        paths:
-        - vendor/bundle
-        - ~/virtualenvs
-        - ~/.bundle
-    - run:
-        command: bundle exec rake test
-        environment:
-          RAILS_ENV: test
-          RACK_ENV: test
-    - store_test_results:
-        path: /tmp/circleci-test-results
-    - store_artifacts:
-        path: /tmp/circleci-artifacts
-    - store_artifacts:
-        path: /tmp/circleci-test-results