mbta_wrapper 0.0.2 → 0.0.200

data/README.md

@@ -2,7 +2,7 @@
 
 [![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
+Ruby MBTA API wrapper gem, not much is really built yet but maybe it will be soon. If you think of any features you want, let me know.
 
 ## Installation
 
@@ -22,20 +22,29 @@ Or install it yourself as:
 
 This gem provides super easy access to the MBTA's API.
 
-    MbtaWrapper::Subway
-    MbtaWrapper::CommuterRail
-    MbtaWrapper::Bus
+    MbtaWrapper::Subway # Built
+    MbtaWrapper::CommuterRail # Not Built
+    MbtaWrapper::Bus # Not Built
+
+    MbtaWrapper::SubwayLine # Built
+    MbtaWrapper::CommuterRailLine # Not Built
+    MbtaWrapper::BusLine # Not Built
     
 To view the current number of red line trains running:
 
-    MbtaWrapper::SubwayLine.new('red').active_trains
+    MbtaWrapper.red_line.active_trains
 
 To create an array of current trains on the red line:
   
-    MbtaWrapper::SubwayLine.new('red').current_trains
+    MbtaWrapper.red_line.current_trains
 
 ## Contributing
 
+TODO:
+Implement CommuterRail and Bus (lines), create tests, think of more ways to supply data
+
+If you'd like to help:
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/lib/mbta_wrapper.rb

@@ -10,5 +10,17 @@ require 'net/http'
 require 'rexml/document'
 
 module MbtaWrapper
+
+  def self.orange_line
+    MbtaWrapper::SubwayLine.new('orange')
+  end
+
+  def self.blue_line
+    MbtaWrapper::SubwayLine.new('blue')
+  end
+
+  def self.red_line
+    MbtaWrapper::SubwayLine.new('red')
+  end
   
 end

data/lib/mbta_wrapper/bus.rb

@@ -1,21 +1,5 @@
 module MbtaWrapper
   class Bus
-    def initialize(line)
-      @line = line
-    end
-
-    def self.get_xml(command)
-      resp = Net::HTTP.get_response(URI.parse("http://webservices.nextbus.com/service/publicXMLFeed?command=#{command}&a=mbta")).body
-      data = REXML::Document.new(resp)
-    end
-
-    def self.all_lines
-      line_names = []
-      routes = Bus.get_xml('routeList')[2]
-      routes.each do |title|
-        line_names << title.text
-      end
-      line_names
-    end
+    
   end
 end

data/lib/mbta_wrapper/bus_line.rb

@@ -1,5 +1,37 @@
 module MbtaWrapper
   class BusLine
+    def initialize(line)
+      @line = line
+    end
 
+    def line
+      @line
+    end
+
+    def self.get_xml_no_route(command)
+      resp = Net::HTTP.get_response(URI.parse("http://webservices.nextbus.com/service/publicXMLFeed?command=#{command}&a=mbta")).body
+      data = REXML::Document.new(resp)
+    end
+
+    def self.get_xml(command, route)
+      resp = Net::HTTP.get_response(URI.parse("http://webservices.nextbus.com/service/publicXMLFeed?command=#{command}&a=mbta&r=#{route}")).body
+      data = REXML::Document.new(resp)
+    end
+
+
+    def self.all_lines
+      line_names = []
+      routes = MbtaWrapper::BusLine.get_xml_no_route('routeList')
+      routes.elements.each('*/route') do |title|
+        line_names << title.attributes['title']
+      end
+      line_names
+    end
+
+    ##
+    # Display inbound or outbound route for Bus
+    def route_config(bus_line, direction)
+      stops = MbtaWrapper::BusLine.get_xml('routeConfig', bus_line.to_i)
+    end
   end
 end

data/lib/mbta_wrapper/subway.rb

@@ -1,4 +1,13 @@
 module MbtaWrapper
+  ##
+  # This class represents an individual T (subway train)
+  #
+  # Train number is the ID number given by the MBTA \n
+  # Destination is the end destination of the train \n
+  # Stops is an array of hashes containing the stop name and seconds until it will be reached \n
+  # Position is the last updated latitude and longitude coordinates of the train \n
+  #
+  # Subway should be generated from SubwayLine, it will constantly need to be regenerated to reflect current train status
   class Subway
     def initialize(train_number, destination, stops, position)
       @train_number = train_number
@@ -23,12 +32,16 @@ module MbtaWrapper
       @position
     end
 
+    ##
+    # Returns the next stop the train will make
     def next_stop
       stops.first
     end
 
+    ##
+    # Returns the time in seconds it will take the train to reach the given station
     def time_to_stop_at(station)
-      stops.select {|stop| stop['Stop'] == station}.first['Seconds']
+      stops.select {|stop| stop['Stop'] == station}.first['Seconds'] ||= nil
     end
   end
 end

data/lib/mbta_wrapper/subway_line.rb

@@ -1,10 +1,26 @@
 module MbtaWrapper
+  ##
+  # This class represents a colored T (subway) line
+  #
+  # It is initialized with the given color
   class SubwayLine
     def initialize(line)
       @line = line
       @default_json_url = "http://developer.mbta.com/lib/rthr/" + @line.to_s.downcase + ".json"
     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
+
+    ##
+    # Returns an array of MbtaWrapper::Subway, representing the current trains running
     def current_trains
       data = parse_json
       current_trains = []
@@ -22,25 +38,16 @@ module MbtaWrapper
       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
+    ## 
+    # Returns the number of current active trains
     def active_trains
       data = parse_json
       data['Trips'].length
     end
 
-    # Time until next train at station
+    ##
+    # Incomplete
     def time_until(station)
       data = parse_json
       time = 0
@@ -48,7 +55,8 @@ module MbtaWrapper
       end
     end
 
-    # 
+    ##
+    # Incomplete
     def upcoming(number = 10)
       data = parse_json
       data['Trips'].each do |trip|
@@ -63,6 +71,8 @@ module MbtaWrapper
       end
     end
 
+    ##
+    # Incomplete
     def next_stops
     end
   end

data/lib/mbta_wrapper/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mbta_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.200
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies: []
 description: Simple MBTA Ruby wrapper
 email: