mapbox-sdk 1.0.0 → 2.3.1

data/lib/mapbox/geocoder.rb

@@ -1,20 +1,57 @@
 require 'rest-client'
 require 'json'
+require 'uri'
 
 module Mapbox
   class Geocoder
     include Mapbox::APIOperations::Request
-    def self.geocode_forward(query, proximity=nil, dataset='mapbox.places')
+    extend Mapbox::HashUtils
+
+    def self.assemble_params(options={})
+      proximity = options[:proximity]
+      bbox = options[:bbox]
+      types = options[:types]
+      params = ''
+      opts = options.select { |key, value| key != :proximity && key != :bbox && key != :types}
+      if opts.length > 0
+        params += "#{params.length > 0 ? '&' : '?'}#{URI.encode_www_form(opts)}"
+      end
+
+      if proximity then
+        lon = proximity[:longitude].round(3)
+        lat = proximity[:latitude].round(3)
+        params += "#{params.length > 0 ? '&' : '?'}proximity=#{lon}%2C#{lat}"
+      end
+
+      if bbox then
+        params += "#{params.length > 0 ? '&' : '?'}bbox=#{bbox.join('%2C')}"
+      end
+
+      if types then
+        params += "#{params.length > 0 ? '&' : '?'}types=#{types.join('%2C')}"
+      end
+
+      return params
+    end
+
+    def self.geocode_forward(query, options={}, dataset='mapbox.places')
+      params = self.assemble_params(options)
+
       return request(
         :get,
-        "/v4/geocode/#{dataset}/#{URI.escape(query)}.json",
+        "/geocoding/v5/#{dataset}/#{URI.escape(query)}.json#{params}",
         nil)
     end
 
-    def self.geocode_reverse(location, dataset='mapbox.places')
+    def self.geocode_reverse(location, options={}, dataset='mapbox.places')
+      location[:longitude] = location[:longitude].round(5)
+      location[:latitude] = location[:latitude].round(5)
+
+      params = self.assemble_params(options)
+
       return request(
         :get,
-        "/v4/geocode/#{dataset}/#{location["longitude"]},#{location["latitude"]}.json",
+        "/geocoding/v5/#{dataset}/#{xy_from_hash(location).join(',')}.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/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/lib/mapbox/tilequery.rb

@@ -0,0 +1,15 @@
+module Mapbox
+  class Tilequery
+    include Mapbox::APIOperations::Request
+    extend Mapbox::HashUtils
+
+    def self.tilequery(mapid, location, radius, limit)
+      lon = location['longitude'].round(5)
+      lat = location['latitude'].round(5)
+      return request(
+        :get,
+        "/v4/#{mapid}/tilequery/#{lon},#{lat}.json?radius=#{radius}&limit=#{limit}",
+        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 = '1.0.0'
+  s.version = '2.3.1'
   s.summary = 'Ruby bindings for the Mapbox API'
   s.description = ''
   s.authors = ['Tom MacWright']
@@ -10,8 +10,7 @@ spec = Gem::Specification.new do |s|
   s.homepage = 'https://mapbox.com/developers'
   s.license = 'MIT'
 
-  s.add_dependency('rest-client', '~> 1.4')
-  s.add_dependency('json', '~> 1.8.1')
+  s.add_dependency('rest-client', '~> 2.1.0')
 
   s.add_development_dependency('mocha', '~> 0.13.2')
   s.add_development_dependency('shoulda', '~> 3.4.0')

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

@@ -9,14 +9,16 @@ module Mapbox
       Mapbox.access_token = ENV["MapboxAccessToken"]
       result = Mapbox::Directions.directions([
         {
-          "longitude" => -100,
-          "latitude" => 38
+          :longitude => -100,
+          :latitude => 38
         },
         {
-          "longitude" => -90,
-          "latitude" => 38
+          :longitude => -90,
+          :latitude => 38
         }
-      ])
+      ], "cycling", {
+        geometries: "geojson"
+      })
       assert result
     end
   end

data/test/geocoding_test.rb

@@ -11,13 +11,60 @@ module Mapbox
       assert result
     end
 
-  should "#geocode_reverse" do
+    should "#geocode_forward (rounded proximity to 3 decimal places)" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Geocoder.geocode_forward("Chester, NJ", {:proximity => {:longitude => 0.1234567, :latitude => -10.987654}})
+      assert result
+      assert Mapbox.request_opts[:url].include? '?proximity=0.123%2C-10.988&'
+    end
+
+    should "#geocode_forward (include bbox param)" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Geocoder.geocode_forward("Washington", {:bbox => [-78.3284,38.6039,-78.0428,38.7841]})
+      assert result
+      assert Mapbox.request_opts[:url].include? '?bbox=-78.3284%2C38.6039%2C-78.0428%2C38.7841';
+    end
+
+    should "#geocode_forward (include extra param)" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Geocoder.geocode_forward("Washington", {:bbox => [-78.3284,38.6039,-78.0428,38.7841], :foo_key => "foo_val", :bar_key => "bar_val"})
+      assert result
+      assert Mapbox.request_opts[:url].include? '?foo_key=foo_val&bar_key=bar_val';
+    end
+
+    should "#geocode_forward (include country param)" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Geocoder.geocode_forward("Washington", {:country => "ca"})
+      assert result
+      assert Mapbox.request_opts[:url].include? '?country=ca';
+    end
+
+    should "#geocode_forward (include types param)" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Geocoder.geocode_forward("Washington", {:types => ['poi.landmark', 'address'], :foo_key => "foo_val", :bar_key => "bar_val"})
+      assert result
+      assert Mapbox.request_opts[:url].include? '?foo_key=foo_val&bar_key=bar_val&types=poi.landmark%2Caddress';
+    end
+
+    should "#geocode_reverse" do
       Mapbox.access_token = ENV["MapboxAccessToken"]
       result = Mapbox::Geocoder.geocode_reverse({
-        "latitude" => 38,
-        "longitude" => -100
+        :latitude => 38,
+        :longitude => -100
       })
       assert result
     end
+
+    should "#geocode_reverse (rounded coordinates to 5 decimal places)" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Geocoder.geocode_reverse({
+        :latitude => 1.23456789,
+        :longitude => -99.8765432
+      })
+      for coord in result.first['query'] do
+        assert coord.to_s.split('.')[-1].length <= 5
+      end
+    end
+
   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/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/mapbox_test.rb

@@ -15,4 +15,27 @@ module Mapbox
       Mapbox.access_token = "foo"
     end
   end
+
+  class HashUtilTest < Test::Unit::TestCase
+    include Mapbox::HashUtils
+
+    should "return array of long,lat from hash with string keys" do
+      assert_equal xy_from_hash({'longitude' => -122, 'latitude' => 45}),
+                   [-122, 45]
+    end
+
+    should "return array of long,lat from hash with symbol keys" do
+      assert_equal xy_from_hash({:longitude => -122, :latitude => 45}),
+                   [-122, 45]
+    end
+
+    should "return array of long,lat from hash with mixed keys" do
+      assert_equal xy_from_hash({:longitude => -122, 'latitude' => 45}),
+                   [-122, 45]
+    end
+
+    should "raise arguemnt error if not given a hash" do
+      assert_raise { xy_from_hash(Object.new) }
+    end
+  end
 end