mapbox-sdk 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0484d85c89aade2922c0a0d43b3d3d61c74db5f
-  data.tar.gz: 0a9304ae7755bbb5121bc237f61b915cdd35596c
+SHA256:
+  metadata.gz: 4292d0f1ca115de9e53c9289a9fb375904e2b49faf028b6a90a523ea35d5c0fb
+  data.tar.gz: 9dabda32d362ed87adc887589f73cd5fc8025c2cd69bc3f46647423e684623f9
 SHA512:
-  metadata.gz: 2664c0e47fc458b1933b3476d7902edbb965613b5326f308b77e07be56f16e5ba2c3193b0abd4ec365e6538e7c7e2db3e7860320a8110f7c23bcfe5c9dad93a4
-  data.tar.gz: 68f8963b09a9f1b00c76778a79751467ff1d1c636c5454ef6aa934a3124f0daed07e54c6b540f8a151edbcbe0600324936f7a74088e3a9fd3a2d74590aa29995
+  metadata.gz: 994336458245a81e414248411bded1b62c03a80cf268bbc1f428d3fefef31b49e60355944dc2c397317cae809cbfde8e39f7dce9aa275c941e49ce92232f9f65
+  data.tar.gz: 040654e4765ff2fc308eef710669fffa48ad0b7b1d15c908150a0a5c29879be9fad18b340c6fc600bfc1b6806cf1eee0f3bf6292d0a378f4ce3637530020e37f

data/.circleci/config.yml

@@ -0,0 +1,40 @@
+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

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# 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.1.0] - 2018-06-07
+### Added
+- Added CHANGELOG.md
+- Added Tilequery endpoint
+
+### Changed
+- Updated documentation links in README
+
+### Removed

data/Gemfile

@@ -3,7 +3,7 @@ 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 'rest-client', '~> 2.0.1'
   gem 'activesupport', '~> 3.2'
   gem 'rake', '10.1.0'
 end

data/README.md

@@ -10,11 +10,12 @@ gem install mapbox-sdk
 
 ## Services
 
-* [Geocoding](https://www.mapbox.com/developers/api/geocoding/)
+* [Geocoding](https://www.mapbox.com/api-documentation/#geocoding)
   * Forward (place names ⇢  longitude, latitude)
   * Reverse (longitude, latitude ⇢ place names)
-* [Directions](https://www.mapbox.com/developers/api/directions/)
+* [Directions](https://www.mapbox.com/api-documentation/#directions)
   * Profiles for driving, walking, and cycling
+* [Tilequery](https://www.mapbox.com/api-documentation/#tilequery)
 
 ## Example
 
@@ -31,14 +32,23 @@ placenames = Mapbox::Geocoder.geocode_reverse({
 # Forward geocoding with optional proximity parameter
 places = Mapbox::Geocoder.geocode_forward("Chester, NJ", {:proximity => {:longitude => -74.6968, :latitude => 40.7843}})
 
-# Directions
+# 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.
 ```
 
 Heavily influenced by Stripe's Ruby client, and includes its MIT license.

data/lib/mapbox.rb

@@ -180,3 +180,4 @@ end
 # services
 require 'mapbox/geocoder'
 require 'mapbox/directions'
+require 'mapbox/tilequery'

data/lib/mapbox/directions.rb

@@ -1,16 +1,13 @@
-require 'rest-client'
-require 'json'
-
 module Mapbox
   class Directions
     include Mapbox::APIOperations::Request
     extend Mapbox::HashUtils
-    def self.directions(waypoints, profile='mapbox.driving')
+    def self.directions(waypoints, profile)
       formatted_waypoints = waypoints.map {|p| xy_from_hash(p).join ','}.join ';'
       return request(
-        :get,
-        "/v4/directions/#{profile}/#{formatted_waypoints}.json",
-        nil)
+          :get,
+          "/directions/v5/mapbox/#{profile}/#{formatted_waypoints}.json",
+          nil)
     end
   end
-end
+end

data/lib/mapbox/geocoder.rb

@@ -7,11 +7,12 @@ module Mapbox
     include Mapbox::APIOperations::Request
     extend Mapbox::HashUtils
 
-    def self.geocode_forward(query, options={}, dataset='mapbox.places')
+    def self.assemble_params(options={})
       proximity = options[:proximity]
       bbox = options[:bbox]
+      types = options[:types]
       params = ''
-      opts = options.select { |key, value| key != :proximity && key != :bbox}
+      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
@@ -25,19 +26,32 @@ module Mapbox
       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,
         "/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,
-        "/geocoding/v5/#{dataset}/#{xy_from_hash(location).join(',')}.json",
+        "/geocoding/v5/#{dataset}/#{xy_from_hash(location).join(',')}.json#{params}",
         nil)
     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 = '2.0.0'
+  s.version = '2.1.0'
   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.0.1')
 
   s.add_development_dependency('mocha', '~> 0.13.2')
   s.add_development_dependency('shoulda', '~> 3.4.0')

data/test/directions_test.rb

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

data/test/geocoding_test.rb

@@ -39,6 +39,13 @@ module Mapbox
       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({

data/test/tilequery_test.rb

@@ -0,0 +1,15 @@
+require 'mapbox'
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+
+module Mapbox
+  class TilequeryTest < Test::Unit::TestCase
+    should "#tilequery" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Tilequery.tilequery(
+        "mapbox.mapbox-streets-v7", {"longitude" => -122.42901, "latitude" => 37.80633}, 5, 10)
+      assert result
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mapbox-sdk
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Tom MacWright
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2018-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -101,8 +87,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".gitignore"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -112,10 +100,12 @@ files:
 - lib/mapbox/authentication_error.rb
 - lib/mapbox/directions.rb
 - lib/mapbox/geocoder.rb
+- lib/mapbox/tilequery.rb
 - mapbox-sdk.gemspec
 - test/directions_test.rb
 - test/geocoding_test.rb
 - test/mapbox_test.rb
+- test/tilequery_test.rb
 homepage: https://mapbox.com/developers
 licenses:
 - MIT
@@ -136,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Mapbox API
@@ -144,3 +134,4 @@ test_files:
 - test/directions_test.rb
 - test/geocoding_test.rb
 - test/mapbox_test.rb
+- test/tilequery_test.rb

data/Gemfile.lock

@@ -1,64 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mapbox (1.0.0)
-      json (~> 1.8.1)
-      rest-client (~> 1.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (4.2.3)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    bourne (1.5.0)
-      mocha (>= 0.13.2, < 0.15)
-    domain_name (0.5.24)
-      unf (>= 0.0.5, < 1.0.0)
-    http-cookie (1.0.2)
-      domain_name (~> 0.5)
-    i18n (0.7.0)
-    json (1.8.3)
-    metaclass (0.0.4)
-    mime-types (2.6.1)
-    minitest (5.7.0)
-    mocha (0.13.3)
-      metaclass (~> 0.0.1)
-    netrc (0.10.3)
-    power_assert (0.2.4)
-    rake (10.4.2)
-    rest-client (1.8.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 3.0)
-      netrc (~> 0.7)
-    shoulda (3.4.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (~> 1.0, >= 1.4.1)
-    shoulda-context (1.2.1)
-    shoulda-matchers (1.5.6)
-      activesupport (>= 3.0.0)
-      bourne (~> 1.3)
-    test-unit (3.1.2)
-      power_assert
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  mapbox!
-  mocha (~> 0.13.2)
-  rake
-  shoulda (~> 3.4.0)
-  test-unit
-
-BUNDLED WITH
-   1.10.6