mbta-rt 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f083321e45d765cb822b1b088fd89e3e0a8afd59
+  data.tar.gz: 22c35f18765697e7e79c660e46c97da407dd5611
+SHA512:
+  metadata.gz: ac640cd12ba2cd7ee4291794ecbdafcfef86d979938cd321c490b400ede831c7605322ca12d28605cfcab61ee6c210bdc06c54bfe3df53b47e0aa4084057ad51
+  data.tar.gz: 25cd133dcedaacdcf008216cfd21364b3e8798cbd1a61f04f5aec059130ab5240504bd11048db93943fde7412d9349a5775763534e0f0149c2f48e1cfdbf08f6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 phereford
+
+MIT License
+
+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,74 @@
+# Mbta
+The mbta released a realtime api about a year ago. I have some
+interest in building a hyperlocal app around public transportation
+and have this created this api wrapper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mbta-rt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mbta
+
+## Usage
+This is very much a WIP. The API is stable and won't be changing much.
+
+In a configuration file add the following:
+```
+require 'mbta'
+Mbta.api_key = '<INSERT API_KEY>'
+Mbta.format = 'json' # acceptable inputs are json, jsonp, and xml.
+```
+
+Once you are properly setup, then it is just a matter of knowing
+what data you want to get after.
+```
+Mbta::RoutesRequest.all #=> returns a jsonified string of all requests
+```
+
+I have built a wrapper around each of the endpoints for their v2
+realtime api. Here is what the footprint looks like for each request:
+```
+Mbta::RoutesRequest.all
+Mbta::RoutesReqest.by_stop(stop_id)
+
+Mbta::PredictionsRequest.by_stop(stop_id, options_hash)
+Mbta::PredictionsRequest.by_route(route_id, options_hash)
+Mbta::PredictionsRequest.by_trip(trip_id, options_hash)
+
+Mbta::ScheduleRequest.by_stop(stop_id, options_hash)
+Mbta::ScheduleRequest.by_route(route_id, options_hash)
+Mbta::ScheduleRequest.by_trip(trip_id, options_hash)
+
+Mbta::StopsRequest.by_route(route_id)
+Mbta::StopsRequest.by_location(lat, long)
+
+Mbta::VehiclesRequest.by_route(route_id, options_hash)
+Mbta::VehiclesRequest.by_trip(tripe_id, options_hash)
+```
+
+I will need to write up some documentation about what each
+options_hash can take, but peeking at the documentation of
+their [endpoint](http://realtime.mbta.com/Portal/Content/Documents/MBTA-realtime_APIDocumentation_v2_0_1_2014-09-08.pdf) may help guide you.
+
+## Left ToDo
+1) Encapsulate errors from the various endpoints into real Error objects
+2) Instead of just returning raw json, consider returning Ruby objects. Maybe a boolean staging return json or ruby objects.
+3) Build out ruby models with attrs for the various pieces of the json response.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mbta/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh 'irb -rubygems -I lib -r mbta.rb'
+end

data/lib/mbta.rb

@@ -0,0 +1,15 @@
+require 'mbta/version'
+require 'mbta/config'
+require 'mbta/connection'
+require 'mbta/request'
+require 'mbta/routes_request'
+require 'mbta/stops_request'
+require 'mbta/schedule_request'
+require 'mbta/vehicles_request'
+require 'mbta/predictions_request'
+
+module Mbta
+  class << self
+    attr_accessor :api_key, :format
+  end
+end

data/lib/mbta/config.rb

@@ -0,0 +1,5 @@
+module Mbta
+  module Config
+    BASE_URL = 'http://realtime.mbta.com/developer/api/v2/'
+  end
+end

data/lib/mbta/connection.rb

@@ -0,0 +1,17 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Mbta
+  class Connection
+    def self.connection
+      @connection = begin
+        Faraday.new(:url => Mbta::Config::BASE_URL, :params => { :api_key => Mbta.api_key, :format => Mbta.format }) do |c|
+          c.request :url_encoded
+          c.request :json
+          c.response :json
+          c.adapter Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/mbta/predictions_request.rb

@@ -0,0 +1,12 @@
+module Mbta
+  class PredictionsRequest < Request
+    class << self
+      [:stop, :route, :trip].each do |mode|
+        define_method("by_#{mode}") do |mode_id, options: {}|
+          hash = {mode => mode_id}.merge!(options)
+          get("predictionsby#{mode}", hash)
+        end
+      end
+    end
+  end
+end

data/lib/mbta/request.rb

@@ -0,0 +1,16 @@
+module Mbta
+  class Request < Connection
+    def self.get(path, options={})
+      request(:get, path, options)
+    end
+
+    private
+    def self.request(request_type, path, options)
+      response = connection.send(request_type, path) do |request|
+        options.each{ |k,v| request.params[k.to_s] = v }
+      end
+
+      response.body.to_json
+    end
+  end
+end

data/lib/mbta/routes_request.rb

@@ -0,0 +1,11 @@
+module Mbta
+  class RoutesRequest < Request
+    def self.all
+      get('routes')
+    end
+
+    def self.by_stop(stop_id)
+      get('routesbystop', { stop: stop_id })
+    end
+  end
+end

data/lib/mbta/schedule_request.rb

@@ -0,0 +1,12 @@
+module Mbta
+  class ScheduleRequest < Request
+    class << self
+      [:stop, :route, :trip].each do |mode|
+        define_method("by_#{mode}") do |mode_id, options: {}|
+          hash = {mode => mode_id}.merge!(options)
+          get("scheduleby#{mode}", hash)
+        end
+      end
+    end
+  end
+end

data/lib/mbta/stops_request.rb

@@ -0,0 +1,13 @@
+module Mbta
+  class StopsRequest < Request
+    class << self
+      def by_route(route_id)
+        get('stopsbyroute', { route: route_id })
+      end
+
+      def by_location(lat, long)
+        get('stopsbylocation', { lat: lat, lon: long })
+      end
+    end
+  end
+end

data/lib/mbta/vehicles_request.rb

@@ -0,0 +1,12 @@
+module Mbta
+  class VehiclesRequest < Request
+    class << self
+      [:route, :trip].each do |mode|
+        define_method("by_#{mode}") do |mode_id, options: {}|
+          hash = { mode => mode_id }.merge!(options)
+          get("vehiclesby#{mode}", hash)
+        end
+      end
+    end
+  end
+end

data/lib/mbta/version.rb

@@ -0,0 +1,3 @@
+module Mbta
+  VERSION = '1.0.0'
+end

data/mbta.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mbta/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mbta-rt'
+  spec.version       = Mbta::VERSION
+  spec.authors       = ['phereford']
+  spec.email         = ['phereford@gmail.com']
+  spec.summary       = %q{Ruby API Wrapper around MBTA realtime v2 api.}
+  spec.homepage      = 'http://www.github.com/phereford/mbta'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.9.1'
+  spec.add_dependency 'faraday_middleware', '~> 0.9.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'minitest', '~> 5.7.0'
+  spec.add_development_dependency 'minitest-vcr', '~> 1.3.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.1.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'vcr', '~> 2.9.3'
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
+end

data/test/cassettes/Mbta_PredictionsRequest/returns_json_from_the_by_route_method.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://realtime.mbta.com/developer/api/v2/predictionsbyroute?api_key=wX9NwuHnZU2ToO7GmGR9uw&format=json&route=52
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 404
+      message: 'No data for '
+    headers:
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Content-Length:
+      - '50'
+      Content-Type:
+      - application/json
+      Expires:
+      - '-1'
+      Server:
+      - Microsoft-IIS/7.5
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Sun, 05 Jul 2015 21:44:35 GMT
+    body:
+      encoding: UTF-8
+      string: '{ "error": { "message": "No data for  route 52" }}'
+    http_version: 
+  recorded_at: Sun, 05 Jul 2015 21:44:36 GMT
+recorded_with: VCR 2.9.3

data/test/cassettes/Mbta_StopsRequest/_by_location/returns_an_error_message_json_when_missing_a_lat.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://realtime.mbta.com/developer/api/v2/stopsbylocation?api_key=wX9NwuHnZU2ToO7GmGR9uw&format=json&lat=&lon=-71.191223
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 400
+      message: Invalid request parameter
+    headers:
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Content-Length:
+      - '66'
+      Content-Type:
+      - application/json
+      Expires:
+      - '-1'
+      Server:
+      - Microsoft-IIS/7.5
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Sun, 05 Jul 2015 21:56:36 GMT
+    body:
+      encoding: UTF-8
+      string: '{ "error": { "message": "Missing required query parameter: lat" }}'
+    http_version: 
+  recorded_at: Sun, 05 Jul 2015 21:56:36 GMT
+recorded_with: VCR 2.9.3

data/test/cassettes/Mbta_StopsRequest/_by_location/returns_an_error_message_json_when_missing_a_long.yml

@@ -0,0 +1,44 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://realtime.mbta.com/developer/api/v2/stopsbylocation?api_key=wX9NwuHnZU2ToO7GmGR9uw&format=json&lat=40&lon=
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 400
+      message: Invalid request parameter
+    headers:
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Content-Length:
+      - '66'
+      Content-Type:
+      - application/json
+      Expires:
+      - '-1'
+      Server:
+      - Microsoft-IIS/7.5
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Sun, 05 Jul 2015 21:58:46 GMT
+    body:
+      encoding: UTF-8
+      string: '{ "error": { "message": "Missing required query parameter: lon" }}'
+    http_version: 
+  recorded_at: Sun, 05 Jul 2015 21:58:47 GMT
+recorded_with: VCR 2.9.3

data/test/cassettes/Mbta_StopsRequest/_by_location/returns_valid_json_when_passed_a_lat_and_long.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://realtime.mbta.com/developer/api/v2/stopsbylocation?api_key=wX9NwuHnZU2ToO7GmGR9uw&format=json&lat=42.363114&lon=-71.191223
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Pragma:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Expires:
+      - '-1'
+      Server:
+      - Microsoft-IIS/7.5
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Sun, 05 Jul 2015 21:56:35 GMT
+      Content-Length:
+      - '2699'
+    body:
+      encoding: UTF-8
+      string: '{"stop":[{"stop_id":"8181","stop_name":"Watertown St @ Fifth St","parent_station":"","parent_station_name":"","stop_lat":"42.363114","stop_lon":"-71.191223","distance":"0"},{"stop_id":"8176","stop_name":"Watertown
+        St @ Fifth Ave","parent_station":"","parent_station_name":"","stop_lat":"42.362933","stop_lon":"-71.191427","distance":"0.0162406731396914"},{"stop_id":"8175","stop_name":"Watertown
+        St @ Morse St","parent_station":"","parent_station_name":"","stop_lat":"42.362644","stop_lon":"-71.19201","distance":"0.0515512116253376"},{"stop_id":"8182","stop_name":"Watertown
+        St opp Morse St","parent_station":"","parent_station_name":"","stop_lat":"42.362688","stop_lon":"-71.192143","distance":"0.0555802248418331"},{"stop_id":"8180","stop_name":"Watertown
+        St opp Aldrich Rd","parent_station":"","parent_station_name":"","stop_lat":"42.364094","stop_lon":"-71.189091","distance":"0.127980828285217"},{"stop_id":"8174","stop_name":"Watertown
+        St @ Pond St","parent_station":"","parent_station_name":"","stop_lat":"42.361881","stop_lon":"-71.194156","distance":"0.172004327178001"},{"stop_id":"8183","stop_name":"Watertown
+        St opp Pond St","parent_station":"","parent_station_name":"","stop_lat":"42.36191","stop_lon":"-71.194485","distance":"0.186133340001106"},{"stop_id":"8177","stop_name":"Watertown
+        St opp California St","parent_station":"","parent_station_name":"","stop_lat":"42.364349","stop_lon":"-71.187436","distance":"0.211104184389114"},{"stop_id":"8173","stop_name":"Watertown
+        St @ Washburn St","parent_station":"","parent_station_name":"","stop_lat":"42.361668","stop_lon":"-71.195503","distance":"0.240127876400948"},{"stop_id":"8284","stop_name":"Watertown
+        St @ Galen St","parent_station":"","parent_station_name":"","stop_lat":"42.364331","stop_lon":"-71.186377","distance":"0.261084020137787"},{"stop_id":"8179","stop_name":"Watertown
+        St @ Galen St","parent_station":"","parent_station_name":"","stop_lat":"42.364483","stop_lon":"-71.186401","distance":"0.263572841882706"},{"stop_id":"900","stop_name":"Watertown
+        Yard","parent_station":"","parent_station_name":"","stop_lat":"42.364307","stop_lon":"-71.185703","distance":"0.29365000128746"},{"stop_id":"8185","stop_name":"Watertown
+        St opp Pearl St","parent_station":"","parent_station_name":"","stop_lat":"42.361534","stop_lon":"-71.19681","distance":"0.305113464593887"},{"stop_id":"8172","stop_name":"Watertown
+        St @ Pearl St","parent_station":"","parent_station_name":"","stop_lat":"42.361395","stop_lon":"-71.197011","distance":"0.31836062669754"},{"stop_id":"8178","stop_name":"Watertown
+        Sq Terminal","parent_station":"","parent_station_name":"","stop_lat":"42.365436","stop_lon":"-71.185502","distance":"0.333127826452255"}]}'
+    http_version: 
+  recorded_at: Sun, 05 Jul 2015 21:56:36 GMT
+recorded_with: VCR 2.9.3