mbta_wrapper 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+ - 1.9.3
+script: rspec spec

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mbta_wrapper.gemspec
 gemspec
+gem 'rspec'

data/README.md

@@ -1,6 +1,8 @@
 # MbtaWrapper
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/sicentendu/mbta_wrapper.png?branch=master)](https://travis-ci.org/sicentendu/mbta_wrapper)
+
+Ruby MBTA API wrapper, nothing is really built yet but maybe it will be soon
 
 ## Installation
 
@@ -18,7 +20,19 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem provides super easy access to the MBTA's API.
+
+    MbtaWrapper::Subway
+    MbtaWrapper::CommuterRail
+    MbtaWrapper::Bus
+    
+To view the current number of red line trains running:
+
+    MbtaWrapper::SubwayLine.new('red').active_trains
+
+To create an array of current trains on the red line:
+  
+    MbtaWrapper::SubwayLine.new('red').current_trains
 
 ## Contributing
 

data/lib/mbta_wrapper/bus_line.rb

@@ -0,0 +1,5 @@
+module MbtaWrapper
+  class BusLine
+
+  end
+end

data/lib/mbta_wrapper/commuterrail_line.rb

@@ -0,0 +1,5 @@
+module MbtaWrapper
+  class CommuterRailLine
+
+  end
+end

data/lib/mbta_wrapper/subway.rb

@@ -1,45 +1,34 @@
 module MbtaWrapper
   class Subway
-    def initialize(line)
-      @line = line
+    def initialize(train_number, destination, stops, position)
+      @train_number = train_number
+      @destination = destination
+      @stops = stops
+      @position = position
     end
 
-    def get_and_parse_json
-      resp = Net::HTTP.get_response(URI.parse("http://developer.mbta.com/lib/rthr/#{@line}.json"))
-      data = JSON.parse(resp.body)
-      ready = data['TripList']
+    def train_number
+      @train_number
     end
 
-    # Number of current active trains
-    def active_trains
-      data = get_and_parse_json
-      data['Trips'].length
+    def destination
+      @destination
     end
 
-    # Time until next train at station
-    def time_until(station)
-      data = get_and_parse_json
-      time = 0
-      data['Trips'].each do |trip|
-      end
+    def stops
+      @stops
     end
 
-    # 
-    def upcoming(number = 10)
-      data = get_and_parse_json
-      data['Trips'].each do |trip|
-        first_prediction = trip['Predictions'].first
-        stop = first_prediction['Stop']
-        time = (sec = first_prediction['Seconds'].to_i) < 60 ? sec : (sec / 60).round
-        if sec < 60
-          puts "A #{@line} line train will arrive at #{stop} in #{time} seconds"
-        else
-          puts "A #{@line} line train will arrive at #{stop} in #{time} minutes"
-        end
-      end
+    def position
+      @position
     end
 
-    def next_stops
+    def next_stop
+      stops.first
+    end
+
+    def time_to_stop_at(station)
+      stops.select {|stop| stop['Stop'] == station}.first['Seconds']
     end
   end
 end

data/lib/mbta_wrapper/subway_line.rb

@@ -0,0 +1,69 @@
+module MbtaWrapper
+  class SubwayLine
+    def initialize(line)
+      @line = line
+      @default_json_url = "http://developer.mbta.com/lib/rthr/" + @line.to_s.downcase + ".json"
+    end
+
+    def current_trains
+      data = parse_json
+      current_trains = []
+      data['Trips'].each do |train|
+        if !train['Position'].nil?
+          train_number = train['Position']['Train'] ||= nil
+          position = {'Latitude' => train['Position']['Lat'], 'Longitude' => train['Position']['Long']}
+        end
+        destination = train['Destination']
+        stops = []
+        train['Predictions'].each do |stop|
+          stops << {'Stop' => stop['Stop'], 'Seconds' => stop['Seconds']}
+        end
+        current_trains << MbtaWrapper::Subway.new(train_number, destination, stops, position)
+      end
+      current_trains
+    end
+    
+
+    def get_json(url = @default_json_url)
+      Net::HTTP.get_response(URI.parse(url)).body
+    end
+
+    def parse_json(url = @default_json_url)
+      resp = get_json(url)
+      data = JSON.parse(resp)
+      ready = data['TripList']
+    end
+
+    # Number of current active trains
+    def active_trains
+      data = parse_json
+      data['Trips'].length
+    end
+
+    # Time until next train at station
+    def time_until(station)
+      data = parse_json
+      time = 0
+      data['Trips'].each do |trip|
+      end
+    end
+
+    # 
+    def upcoming(number = 10)
+      data = parse_json
+      data['Trips'].each do |trip|
+        first_prediction = trip['Predictions'].first
+        stop = first_prediction['Stop']
+        time = (sec = first_prediction['Seconds'].to_i) < 60 ? sec : (sec / 60).round
+        if sec < 60
+          puts "A #{@line} line train will arrive at #{stop} in #{time} seconds"
+        else
+          puts "A #{@line} line train will arrive at #{stop} in #{time} minutes"
+        end
+      end
+    end
+
+    def next_stops
+    end
+  end
+end

data/lib/mbta_wrapper/version.rb

@@ -1,3 +1,3 @@
 module MbtaWrapper
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/mbta_wrapper.rb

@@ -1,11 +1,14 @@
 require "mbta_wrapper/version"
+require "mbta_wrapper/subway_line"
 require "mbta_wrapper/bus"
 require "mbta_wrapper/commuterrail"
 require "mbta_wrapper/subway"
+require "mbta_wrapper/bus_line"
+require "mbta_wrapper/commuterrail_line"
 require 'json'
 require 'net/http'
 require 'rexml/document'
 
-module MBTAWrapper
-  # Your code goes here...
+module MbtaWrapper
+  
 end

data/spec/bus_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/mbta_wrapper_spec.rb

@@ -0,0 +1 @@
+require 'spec_helper'

data/spec/sample_data/red.json

@@ -0,0 +1,60 @@
+{ "TripList": {"CurrentTime": 1360520290,"Line": "Red", "Trips": [{"TripID": "R98308BF6", "Destination": "Ashmont", "Predictions": [
+{"StopID": "70061", "Stop": "Alewife", "Seconds": 985},
+{"StopID": "70063", "Stop": "Davis", "Seconds": 1069},
+{"StopID": "70065", "Stop": "Porter Square", "Seconds": 1192}]},
+{"TripID": "R98308C5D", "Destination": "Alewife", "Position": {"Timestamp": 1360518799, "Train": "1510", "Lat": 42.20749, "Long": -71.00173,"Heading": 190}, "Predictions": [
+{"StopID": "70104", "Stop": "Quincy Adams", "Seconds": 237},
+{"StopID": "70102", "Stop": "Quincy Center", "Seconds": 416},
+{"StopID": "70100", "Stop": "Wollaston", "Seconds": 689},
+{"StopID": "70098", "Stop": "North Quincy", "Seconds": 1195}]},
+{"TripID": "R98308C74", "Destination": "Alewife", "Position": {"Timestamp": 1360519343, "Train": "1639", "Lat": 42.20749, "Long": -71.00156,"Heading": 190}, "Predictions": [
+{"StopID": "70105", "Stop": "Braintree", "Seconds": 710},
+{"StopID": "70104", "Stop": "Quincy Adams", "Seconds": 985},
+{"StopID": "70102", "Stop": "Quincy Center", "Seconds": 1159}]},
+{"TripID": "R98308C2A", "Destination": "Alewife", "Position": {"Timestamp": 1360519774, "Train": "1813", "Lat": 42.28458, "Long": -71.06377,"Heading": 330}, "Predictions": [
+{"StopID": "70094", "Stop": "Ashmont", "Seconds": -10},
+{"StopID": "70092", "Stop": "Shawmut", "Seconds": 64},
+{"StopID": "70090", "Stop": "Fields Corner", "Seconds": 133},
+{"StopID": "70088", "Stop": "Savin Hill", "Seconds": 295},
+{"StopID": "70086", "Stop": "JFK/UMass", "Seconds": 424}]},
+{"TripID": "R98308C9F", "Destination": "Braintree", "Position": {"Timestamp": 1360520257, "Train": "1623", "Lat": 42.38826, "Long": -71.11895,"Heading": 180}, "Predictions": [
+{"StopID": "70067", "Stop": "Harvard Square", "Seconds": 117},
+{"StopID": "70069", "Stop": "Central Square", "Seconds": 310},
+{"StopID": "70071", "Stop": "Kendall/MIT", "Seconds": 432},
+{"StopID": "70073", "Stop": "Charles/MGH", "Seconds": 571},
+{"StopID": "70075", "Stop": "Park Street", "Seconds": 679},
+{"StopID": "70077", "Stop": "Downtown Crossing", "Seconds": 744},
+{"StopID": "70079", "Stop": "South Station", "Seconds": 788},
+{"StopID": "70081", "Stop": "Broadway", "Seconds": 904},
+{"StopID": "70083", "Stop": "Andrew", "Seconds": 1028}]},
+{"TripID": "R98308BF5", "Destination": "Alewife", "Position": {"Timestamp": 1360520075, "Train": "1846", "Lat": 42.36598, "Long": -71.10479,"Heading": 310}, "Predictions": [
+{"StopID": "70066", "Stop": "Porter Square", "Seconds": 370},
+{"StopID": "70064", "Stop": "Davis", "Seconds": 549},
+{"StopID": "70061", "Stop": "Alewife", "Seconds": 746}]},
+{"TripID": "R98308BDC", "Destination": "Ashmont", "Note": "Delayed", "Position": {"Timestamp": 1360519520, "Train": "1840", "Lat": 42.39621, "Long": -71.14054,"Heading": 265}, "Predictions": [
+{"StopID": "70063", "Stop": "Davis", "Seconds": 46},
+{"StopID": "70065", "Stop": "Porter Square", "Seconds": 169},
+{"StopID": "70067", "Stop": "Harvard Square", "Seconds": 319},
+{"StopID": "70069", "Stop": "Central Square", "Seconds": 512},
+{"StopID": "70071", "Stop": "Kendall/MIT", "Seconds": 634}]},
+{"TripID": "R98308CE1", "Destination": "Braintree", "Position": {"Timestamp": 1360519936, "Train": "1705", "Lat": 42.3185, "Long": -71.05212,"Heading": 170}, "Predictions": [
+{"StopID": "70097", "Stop": "North Quincy", "Seconds": 168},
+{"StopID": "70099", "Stop": "Wollaston", "Seconds": 277},
+{"StopID": "70101", "Stop": "Quincy Center", "Seconds": 581},
+{"StopID": "70103", "Stop": "Quincy Adams", "Seconds": 770},
+{"StopID": "70105", "Stop": "Braintree", "Seconds": 1052}]},
+{"TripID": "R98308CE2", "Destination": "Alewife", "Position": {"Timestamp": 1360520260, "Train": "1520", "Lat": 42.27582, "Long": -71.03012,"Heading": 315}, "Predictions": [
+{"StopID": "70096", "Stop": "JFK/UMass", "Seconds": 595},
+{"StopID": "70084", "Stop": "Andrew", "Seconds": 809},
+{"StopID": "70082", "Stop": "Broadway", "Seconds": 933},
+{"StopID": "70080", "Stop": "South Station", "Seconds": 1083},
+{"StopID": "70078", "Stop": "Downtown Crossing", "Seconds": 1154}]},
+{"TripID": "R98308C0F", "Destination": "Ashmont", "Position": {"Timestamp": 1360520261, "Train": "1883", "Lat": 42.35524, "Long": -71.06018,"Heading": 135}, "Predictions": [
+{"StopID": "70079", "Stop": "South Station", "Seconds": 15},
+{"StopID": "70081", "Stop": "Broadway", "Seconds": 131},
+{"StopID": "70083", "Stop": "Andrew", "Seconds": 255},
+{"StopID": "70085", "Stop": "JFK/UMass", "Seconds": 408},
+{"StopID": "70087", "Stop": "Savin Hill", "Seconds": 546},
+{"StopID": "70089", "Stop": "Fields Corner", "Seconds": 714},
+{"StopID": "70091", "Stop": "Shawmut", "Seconds": 831},
+{"StopID": "70093", "Stop": "Ashmont", "Seconds": 981}]}]}}

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'mbta_wrapper'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/subway_line_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe MbtaWrapper::SubwayLine do
+  it 'should return correct number of current trains' do
+    red_line = create_red_line
+    red_line.active_trains.should == 10
+  end
+
+  it 'should create an array of Subways' do
+    red_line = create_red_line
+    red_line.current_trains.first.class.should == MbtaWrapper::Subway
+  end
+
+  def create_red_line
+    red_line = MbtaWrapper::SubwayLine.new('red')
+    red_line.stub!(:get_json).and_return(File.read('spec/sample_data/red.json'))
+    red_line
+  end
+end

data/spec/subway_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe MbtaWrapper::Subway do
+  it 'should have working accessors' do
+    t = create_red_line_train
+    t.destination.should == 'Alewife'
+    t.train_number.should == '1510'
+    t.stops.class.should == Array
+  end
+
+  it 'should give the correct next stop' do
+    t = create_red_line_train
+    t.next_stop.should == {'Stop' => 'Quincy Adams', 'Seconds' => 237}
+  end
+
+  it 'should give the correct time to specified stop' do
+    t = create_red_line_train
+    t.time_to_stop_at('Quincy Adams').should == 237
+  end
+
+  def create_red_line_train
+    red_line = MbtaWrapper::SubwayLine.new('red')
+    red_line.stub!(:get_json).and_return(File.read('spec/sample_data/red.json'))
+    red_line.current_trains[1]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mbta_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -19,16 +19,27 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/mbta_wrapper.rb
 - lib/mbta_wrapper/bus.rb
+- lib/mbta_wrapper/bus_line.rb
 - lib/mbta_wrapper/commuterrail.rb
+- lib/mbta_wrapper/commuterrail_line.rb
 - lib/mbta_wrapper/subway.rb
+- lib/mbta_wrapper/subway_line.rb
 - lib/mbta_wrapper/version.rb
 - mbta_wrapper.gemspec
+- spec/bus_spec.rb
+- spec/mbta_wrapper_spec.rb
+- spec/sample_data/red.json
+- spec/spec_helper.rb
+- spec/subway_line_spec.rb
+- spec/subway_spec.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -53,4 +64,10 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Simple MBTA Ruby wrapper
-test_files: []
+test_files:
+- spec/bus_spec.rb
+- spec/mbta_wrapper_spec.rb
+- spec/sample_data/red.json
+- spec/spec_helper.rb
+- spec/subway_line_spec.rb
+- spec/subway_spec.rb