mapbox-sdk 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ada80d6e1cbf4bce52c8963bdcd9eb0d6c7ad93
-  data.tar.gz: 4c58511165153eca7a4bb787ae979f75ebf277d7
+  metadata.gz: c0484d85c89aade2922c0a0d43b3d3d61c74db5f
+  data.tar.gz: 0a9304ae7755bbb5121bc237f61b915cdd35596c
 SHA512:
-  metadata.gz: 0f8ddaff0bb1a510dba43c5b7b4a5ff9b13d230b390a9d734df095279cffbefa61d86ef04c220e53973241419dc9daafdd4fd7d47bf1bfa23b016e22ea7783d1
-  data.tar.gz: 6c92af8cd540921a908634beba3cbb784e4bb2205d71889a758ee31992359f3c21e099b56b0434f814d84b20bc4ae5bc56994cf557c5dcc082a194652f94500a
+  metadata.gz: 2664c0e47fc458b1933b3476d7902edbb965613b5326f308b77e07be56f16e5ba2c3193b0abd4ec365e6538e7c7e2db3e7860320a8110f7c23bcfe5c9dad93a4
+  data.tar.gz: 68f8963b09a9f1b00c76778a79751467ff1d1c636c5454ef6aa934a3124f0daed07e54c6b540f8a151edbcbe0600324936f7a74088e3a9fd3a2d74590aa29995

data/README.md

@@ -2,6 +2,12 @@
 
 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/)
@@ -22,8 +28,8 @@ placenames = Mapbox::Geocoder.geocode_reverse({
   "longitude" => -100
 })
 
-# Forward geocoding
-places = Mapbox::Geocoder.geocode_forward("Chester, NJ")
+# Forward geocoding with optional proximity parameter
+places = Mapbox::Geocoder.geocode_forward("Chester, NJ", {:proximity => {:longitude => -74.6968, :latitude => 40.7843}})
 
 # Directions
 drivingDirections = Mapbox::Directions.directions([{

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,15 @@ 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'

data/lib/mapbox/directions.rb

@@ -4,10 +4,9 @@ require 'json'
 module Mapbox
   class Directions
     include Mapbox::APIOperations::Request
+    extend Mapbox::HashUtils
     def self.directions(waypoints, profile='mapbox.driving')
-      formatted_waypoints = waypoints.map { |point|
-        "#{point['longitude']},#{point['latitude']}"
-      }.join(';')
+      formatted_waypoints = waypoints.map {|p| xy_from_hash(p).join ','}.join ';'
       return request(
         :get,
         "/v4/directions/#{profile}/#{formatted_waypoints}.json",

data/lib/mapbox/geocoder.rb

@@ -1,20 +1,43 @@
 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.geocode_forward(query, options={}, dataset='mapbox.places')
+      proximity = options[:proximity]
+      bbox = options[:bbox]
+      params = ''
+      opts = options.select { |key, value| key != :proximity && key != :bbox}
+      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
       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')
+      location[:longitude] = location[:longitude].round(5)
+      location[:latitude] = location[:latitude].round(5)
+
       return request(
         :get,
-        "/v4/geocode/#{dataset}/#{location["longitude"]},#{location["latitude"]}.json",
+        "/geocoding/v5/#{dataset}/#{xy_from_hash(location).join(',')}.json",
         nil)
     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.0.0'
   s.summary = 'Ruby bindings for the Mapbox API'
   s.description = ''
   s.authors = ['Tom MacWright']

data/test/directions_test.rb

@@ -9,12 +9,12 @@ 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
         }
       ])
       assert result

data/test/geocoding_test.rb

@@ -11,13 +11,53 @@ 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_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/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

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: mapbox-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Tom MacWright
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
   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
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.13.2
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: ''
@@ -106,6 +106,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/mapbox-sdk.rb
 - lib/mapbox.rb
 - lib/mapbox/api_operations.rb
 - lib/mapbox/authentication_error.rb
@@ -125,17 +126,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Mapbox API