mapbox-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ada80d6e1cbf4bce52c8963bdcd9eb0d6c7ad93
+  data.tar.gz: 4c58511165153eca7a4bb787ae979f75ebf277d7
+SHA512:
+  metadata.gz: 0f8ddaff0bb1a510dba43c5b7b4a5ff9b13d230b390a9d734df095279cffbefa61d86ef04c220e53973241419dc9daafdd4fd7d47bf1bfa23b016e22ea7783d1
+  data.tar.gz: 6c92af8cd540921a908634beba3cbb784e4bb2205d71889a758ee31992359f3c21e099b56b0434f814d84b20bc4ae5bc56994cf557c5dcc082a194652f94500a

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+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 'rake', '10.1.0'
+end

data/Gemfile.lock

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

data/LICENSE

@@ -0,0 +1,37 @@
+Copyright (c) 2015, Mapbox
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+---
+
+The MIT License
+
+Copyright (c) 2011- Stripe, Inc. (https://stripe.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# mapbox-sdk-ruby
+
+The `mapbox-sdk` gem. A ruby interface to [Mapbox APIs](https://www.mapbox.com/developers/api/).
+
+## Services
+
+* [Geocoding](https://www.mapbox.com/developers/api/geocoding/)
+  * Forward (place names ⇢  longitude, latitude)
+  * Reverse (longitude, latitude ⇢ place names)
+* [Directions](https://www.mapbox.com/developers/api/directions/)
+  * Profiles for driving, 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
+}])
+```
+
+Heavily influenced by Stripe's Ruby client, and includes its MIT license.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/**/*_test.rb'
+end

data/lib/mapbox.rb

@@ -0,0 +1,171 @@
+require 'rest-client'
+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'
+
+  class << self
+    attr_accessor :access_token, :api_base
+  end
+
+  def self.request(method, url, api_key, params={}, headers={}, api_base_url=nil)
+    api_base_url = api_base_url || @api_base
+    params = params || {}
+
+    unless access_token ||= @access_token
+      raise AuthenticationError.new('No API key provided. ' \
+        'Set your API key using "Mapbox.access_token = <access_token>". ' \
+        'You can generate API keys from the Mapbox web interface. ' \
+        'See https://mapbox.com/developers for details, or email help@mapbox.com ' \
+        'if you have any questions.')
+    end
+
+    url = api_base_url + url
+
+    params['access_token'] = access_token
+
+    case method.to_s.downcase.to_sym
+    when :get, :head, :delete
+      # Make params into GET parameters
+      url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any?
+      payload = nil
+    end
+
+    request_opts = {:verify_ssl => OpenSSL::SSL::VERIFY_PEER,
+                      :ssl_ca_file => @ssl_bundle_path}
+
+    request_opts.update(
+      :method => method,
+      :open_timeout => 30,
+      :payload => payload,
+      :url => url,
+      :timeout => 80)
+
+    begin
+      response = execute_request(request_opts)
+    rescue SocketError => e
+      handle_restclient_error(e, api_base_url)
+    rescue NoMethodError => e
+      # Work around RestClient bug
+      if e.message =~ /\WRequestFailed\W/
+        e = StandardError.new('Unexpected HTTP response code')
+        handle_restclient_error(e, api_base_url)
+      else
+        raise
+      end
+    rescue RestClient::ExceptionWithResponse => e
+      if e.response
+        handle_api_error(e, e.response)
+      else
+        handle_restclient_error(e, api_base_url)
+      end
+    rescue RestClient::Exception, Errno::ECONNREFUSED => e
+      handle_restclient_error(e, api_base_url)
+    end
+
+    [parse(response), api_key]
+  end
+
+  def self.uri_encode(params)
+    params.
+      map { |k,v| "#{k}=#{url_encode(v)}" }.join('&')
+  end
+
+  def self.url_encode(key)
+    URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+  end
+
+  def self.execute_request(opts)
+    RestClient::Request.execute(opts)
+  end
+
+  def self.parse(response)
+    begin
+      # Would use :symbolize_names => true, but apparently there is
+      # some library out there that makes symbolize_names not work.
+      response = JSON.parse(response.body)
+    rescue JSON::ParserError
+      raise general_api_error(response.code, response.body)
+    end
+
+    response
+  end
+
+  def self.general_api_error(rcode, rbody)
+    StandardError.new("Invalid response object from API: #{rbody.inspect} " +
+                 "(HTTP response code was #{rcode})")
+  end
+
+  def self.handle_api_error(rcode, rbody)
+    begin
+      error_obj = JSON.parse(rbody)
+      error = error_obj[:error] or raise StandardError.new # escape from parsing
+
+    rescue JSON::ParserError, StandardError
+      raise general_api_error(rcode, rbody)
+    end
+
+    case rcode
+    when 400, 404
+      raise invalid_request_error error, rcode, rbody, error_obj
+    when 401
+      raise authentication_error error, rcode, rbody, error_obj
+    else
+      raise api_error error, rcode, rbody, error_obj
+    end
+
+  end
+
+  def self.invalid_request_error(error, rcode, rbody, error_obj)
+    StandardError.new(error[:message], error[:param], rcode,
+      rbody, error_obj)
+  end
+
+  def self.authentication_error(error, rcode, rbody, error_obj)
+    AuthenticationError.new(error[:message], rcode, rbody, error_obj)
+  end
+
+  def self.api_error(error, rcode, rbody, error_obj)
+    StandardError.new(error[:message], rcode, rbody, error_obj)
+  end
+
+  def self.handle_restclient_error(e, api_base_url=nil)
+    api_base_url = @api_base unless api_base_url
+    connection_message = "Please check your internet connection and try again. " \
+        "If this problem persists, you should check Mapbox's service status at " \
+        "https://status.mapbox.com/, or let us know at help@mapbox.com."
+
+    case e
+    when RestClient::RequestTimeout
+      message = "Could not connect to Mapbox (#{api_base_url}). #{connection_message}"
+
+    when RestClient::ServerBrokeConnection
+      message = "The connection to the server (#{api_base_url}) broke before the " \
+        "request completed. #{connection_message}"
+
+    when RestClient::SSLCertificateNotVerified
+      message = "Could not verify Mapbox's SSL certificate. " \
+        "Please make sure that your network is not intercepting certificates. " \
+        "(Try going to https://api.mapbox.com/ in your browser.) " \
+        "If this problem persists, let us know at help@mapbox.com."
+
+    when SocketError
+      message = "Unexpected error communicating when trying to connect to Mapbox. " \
+        "You may be seeing this message because your DNS is not working. " \
+        "To check, try running 'host mapbox.com' from the command line."
+
+    else
+      message = "Unexpected error communicating with Mapbox. " \
+        "If this problem persists, let us know at help@mapbox.com."
+
+    end
+
+    raise StandardError.new(message + "\n\n(Network error: #{e.message})")
+  end
+end

data/lib/mapbox/api_operations.rb

@@ -0,0 +1,39 @@
+module Mapbox
+  module APIOperations
+    module Request
+      module ClassMethods
+        OPTS_KEYS_TO_PERSIST = Set[:access_token, :api_base]
+
+        def request(method, url, params={}, opts={})
+          headers = opts.clone
+          access_token = headers.delete(:access_token)
+          api_base = headers.delete(:api_base)
+          # Assume all remaining opts must be headers
+
+          response, opts[:api_key] = Mapbox.request(method, url, access_token, params, headers, api_base)
+
+          # Hash#select returns an array before 1.9
+          opts_to_persist = {}
+          opts.each do |k, v|
+            if OPTS_KEYS_TO_PERSIST.include?(k)
+              opts_to_persist[k] = v
+            end
+          end
+
+          [response, opts_to_persist]
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      protected
+
+      def request(method, url, params={}, opts={})
+        opts = @opts.merge(opts)
+        self.class.request(method, url, params, opts)
+      end
+    end
+  end
+end

data/lib/mapbox/authentication_error.rb

@@ -0,0 +1,7 @@
+module Mapbox
+  class MapboxError < StandardError
+  end
+
+  class AuthenticationError < MapboxError
+  end
+end

data/lib/mapbox/directions.rb

@@ -0,0 +1,17 @@
+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(';')
+      return request(
+        :get,
+        "/v4/directions/#{profile}/#{formatted_waypoints}.json",
+        nil)
+    end
+  end
+end

data/lib/mapbox/geocoder.rb

@@ -0,0 +1,21 @@
+require 'rest-client'
+require 'json'
+
+module Mapbox
+  class Geocoder
+    include Mapbox::APIOperations::Request
+    def self.geocode_forward(query, proximity=nil, dataset='mapbox.places')
+      return request(
+        :get,
+        "/v4/geocode/#{dataset}/#{URI.escape(query)}.json",
+        nil)
+    end
+
+    def self.geocode_reverse(location, dataset='mapbox.places')
+      return request(
+        :get,
+        "/v4/geocode/#{dataset}/#{location["longitude"]},#{location["latitude"]}.json",
+        nil)
+    end
+  end
+end

data/mapbox-sdk.gemspec

@@ -0,0 +1,25 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+spec = Gem::Specification.new do |s|
+  s.name = 'mapbox-sdk'
+  s.version = '1.0.0'
+  s.summary = 'Ruby bindings for the Mapbox API'
+  s.description = ''
+  s.authors = ['Tom MacWright']
+  s.email = ['tom@mapbox.org']
+  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_development_dependency('mocha', '~> 0.13.2')
+  s.add_development_dependency('shoulda', '~> 3.4.0')
+  s.add_development_dependency('test-unit')
+  s.add_development_dependency('rake')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/test/directions_test.rb

@@ -0,0 +1,23 @@
+require 'mapbox'
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+
+module Mapbox
+  class DirectionsTest < Test::Unit::TestCase
+    should "#directions" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Directions.directions([
+        {
+          "longitude" => -100,
+          "latitude" => 38
+        },
+        {
+          "longitude" => -90,
+          "latitude" => 38
+        }
+      ])
+      assert result
+    end
+  end
+end

data/test/geocoding_test.rb

@@ -0,0 +1,23 @@
+require 'mapbox'
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+
+module Mapbox
+  class GeocodingTest < Test::Unit::TestCase
+    should "#geocode_forward" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Geocoder.geocode_forward("Chester, NJ")
+      assert result
+    end
+
+  should "#geocode_reverse" do
+      Mapbox.access_token = ENV["MapboxAccessToken"]
+      result = Mapbox::Geocoder.geocode_reverse({
+        "latitude" => 38,
+        "longitude" => -100
+      })
+      assert result
+    end
+  end
+end

data/test/mapbox_test.rb

@@ -0,0 +1,18 @@
+require 'mapbox'
+require 'test/unit'
+require 'mocha/setup'
+require 'shoulda'
+
+module Mapbox
+  class ModuleTest < Test::Unit::TestCase
+    should "throw if access_token is not defined" do
+      assert_raise {
+        Mapbox.request()
+      }
+    end
+
+    should "allow access token to be set" do
+      Mapbox.access_token = "foo"
+    end
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: mapbox-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tom MacWright
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-23 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: ''
+email:
+- tom@mapbox.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/mapbox.rb
+- lib/mapbox/api_operations.rb
+- lib/mapbox/authentication_error.rb
+- lib/mapbox/directions.rb
+- lib/mapbox/geocoder.rb
+- mapbox-sdk.gemspec
+- test/directions_test.rb
+- test/geocoding_test.rb
+- test/mapbox_test.rb
+homepage: https://mapbox.com/developers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Mapbox API
+test_files:
+- test/directions_test.rb
+- test/geocoding_test.rb
+- test/mapbox_test.rb