mtb_project_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee7bef301acbc81fa8a345e2f6cdfe7780138276
+  data.tar.gz: e2366f0e91e29c5187a1733de4d8a82db33b3ce2
+SHA512:
+  metadata.gz: 5cba9682504991acc308a01a5048b5d08fd21980dc0c5ec6bfe5123e56088bb1e82b6a56aa1ba4ee752de939bea2a91c1c5c9799a42505fe8dca40bdf62ecd9b
+  data.tar.gz: 0023302dd1747d65f7cf022c7ec013c4e3ddf2aae21c5b8261b54acb71678a22974d781bc109d3f19aa8c43bf13f1432fd55083b2541a530a6a83acdef2f25d2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mtb_project_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    mtb_project_api (0.1.0)
+      faraday
+      oj
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (10.0.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.7)
+    multipart-post (2.0.0)
+    oj (3.6.5)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  mtb_project_api!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,105 @@
+# MTB Project Api Wrapper Gem
+
+A simple wrapper gem to access the [public endpoints provided by the  MTB Project API](https://www.mtbproject.com/data).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mtb_project_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mtb_project_api
+
+## Usage
+
+To initialize a `MtbProjectApi::Client`, you'll need your MTB Project login **email** and **private key** which you can find [in the right column here](https://www.mtbproject.com/data).
+
+```
+require 'mtb_project_api'
+
+mtb_project_client = MtbProjectApi::Client.new(email, mtb_project_key)
+```
+Here are the following calls you can make:
+
+**.get_local_trails**
+```
+# Returns trails for a given query.
+#
+# Required Arguments:
+# lat - Latitude for a given area
+# lon - Longitude for a given area
+#
+# Optional Arguments:
+# maxDistance - Max distance, in miles, from lat, lon. Default: 30. Max: 200.
+# maxResults - Max number of trails to return. Default: 10. Max: 500.
+# sort - Values can be 'quality', 'distance'. Default: quality.
+# minLength - Min trail length, in miles. Default: 0 (no minimum).
+# minStars - Min star rating, 0-4. Default: 0.
+
+params = {
+  lat: 40.0274,
+  lon: -105.2519,
+  maxDistance: 10
+}
+
+mtb_project_client.get_local_trails(params)
+```
+
+**.get_trails_by_id**
+```
+# Returns trails for given trail IDs.
+#
+# Required Arguments:
+# ids - one or array of trail IDs
+
+params = {
+  ids: [343243, 5653463, 423426]
+}
+
+mtb_project_client.get_trails_by_id(params)
+```
+
+**.get_conditions**
+```
+# Returns conditions for given trail IDs.
+#
+# Required Arguments:
+# ids - one or array of trail IDs
+
+params = {
+  ids: [343243, 5653463, 423426]
+}
+
+mtb_project_client.get_conditions(params)
+```
+
+**.get_to_dos**
+```
+# Returns up to 200 of the user's to-do trail IDs.
+#
+# Optional Arguments:
+# startPos - The starting index of the list to return. Defaults to 0.
+
+params = {
+  startPos: 3
+}
+mtb_project_client.get_to_dos(params)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tarnelope/mtb_project_api.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mtb_project_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mtb_project_api.rb

@@ -0,0 +1,5 @@
+require "mtb_project_api/version"
+require "mtb_project_api/client"
+
+module MtbProjectApi
+end

data/lib/mtb_project_api/client.rb

@@ -0,0 +1,102 @@
+require 'faraday'
+require 'oj'
+
+module MtbProjectApi
+  class Client
+    API_ENDPOINT = 'https://www.mtbproject.com/data/'.freeze
+
+    def initialize(email, private_key)
+      @email = email
+      @private_key = private_key
+    end
+
+    # Returns trails for a given query.
+    #
+    # Required Arguments:
+    # lat - Latitude for a given area
+    # lon - Longitude for a given area
+    #
+    # Optional Arguments:
+    # maxDistance - Max distance, in miles, from lat, lon. Default: 30. Max: 200.
+    # maxResults - Max number of trails to return. Default: 10. Max: 500.
+    # sort - Values can be 'quality', 'distance'. Default: quality.
+    # minLength - Min trail length, in miles. Default: 0 (no minimum).
+    # minStars - Min star rating, 0-4. Default: 0.
+    def get_local_trails(params = {})
+      allowed_keys = [:lat, :lon, :maxDistance, :maxResults, :sort, :minLength, :minStars]
+      request_params = params.select { |k| allowed_keys.include?(k) }.merge(key: @private_key)
+
+      request(
+        http_method: :get,
+        endpoint: "get-trails",
+        params: request_params
+      )
+    end
+
+    # Returns trails for given trail IDs.
+    #
+    # Required Arguments:
+    # ids - one or array of trail IDs
+    def get_trails_by_id(params = {})
+      request_by_ids("get-trails-by-id", params)
+    end
+
+    # Returns conditions for given trail IDs.
+    #
+    # Required Arguments:
+    # ids - one or array of trail IDs
+    def get_conditions(params = {})
+      request_by_ids("get-conditions", params)
+    end
+
+    # Returns up to 200 of the user's to-do trail IDs.
+    #
+    # Optional Arguments:
+    # startPos - The starting index of the list to return. Defaults to 0.
+    def get_to_dos(params = {})
+      request_params = params.merge({
+        email: @email,
+        key: @private_key
+      })
+
+      request(
+          http_method: :get,
+          endpoint: "get-to-dos",
+          params: request_params
+        )
+    end
+
+    private
+
+    def client
+      @_client ||= Faraday.new(API_ENDPOINT) do |client|
+        client.request :url_encoded
+        client.adapter Faraday.default_adapter
+      end
+    end
+
+    def request(http_method:, endpoint:, params: {})
+      response = client.public_send(http_method, endpoint, params)
+      Oj.load(response.body)
+    end
+
+    def request_by_ids(endpoint, params)
+      request_params = request_by_ids_params(params)
+
+      request(
+        http_method: :get,
+        endpoint: endpoint,
+        params: request_params
+      )
+    end
+
+    def request_by_ids_params(params)
+      ids = Array(params[:ids]).join(',')
+
+      {
+        ids: ids,
+        key: @private_key
+      }
+    end
+  end
+end

data/lib/mtb_project_api/version.rb

@@ -0,0 +1,3 @@
+module MtbProjectApi
+  VERSION = "1.0.0"
+end

data/mtb_project_api.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mtb_project_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mtb_project_api"
+  spec.version       = MtbProjectApi::VERSION
+  spec.authors       = ["Teresa Tarn"]
+  spec.email         = ["teresa.tarn@kapost.com"]
+  spec.license       = "MIT"
+  spec.summary       = "Easily access MTB Project's provided endpoints."
+  spec.description   = "A wrapper gem for the public MTB Project API"
+  spec.homepage      = "https://www.github.com/tarnelope/mtb_project_api"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.15"
+  spec.add_dependency "oj", "~> 3.6"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.4"
+  spec.add_development_dependency "byebug", "~> 10.0"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: mtb_project_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Teresa Tarn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A wrapper gem for the public MTB Project API
+email:
+- teresa.tarn@kapost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mtb_project_api.rb
+- lib/mtb_project_api/client.rb
+- lib/mtb_project_api/version.rb
+- mtb_project_api.gemspec
+homepage: https://www.github.com/tarnelope/mtb_project_api
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Easily access MTB Project's provided endpoints.
+test_files: []