metra_schedule 0.2.2 → 0.3.0

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/lib/metra/cacher.rb

@@ -3,10 +3,11 @@ require 'fileutils'
 module MetraSchedule
   class Cacher
     
-    attr_accessor :cache_dir
+    attr_accessor :cache_dir, :delays
 
     def initialize
       @cache_dir = "#{ENV['HOME']}/.metra_schedule"
+      @delay_file = 'delays'
     end
 
     def self.load_from_cache(line)
@@ -43,6 +44,20 @@ module MetraSchedule
       end
     end
 
+    def delays_exist?
+      return true if File.exists?(File.join(@cache_dir, @delay_file))
+      false
+    end
+
+    def clear_delays
+      begin
+        FileUtils.rm(File.join(@cache_dir, @delay_file))
+        true
+      rescue
+        false
+      end
+    end
+
     def persist_line(line)
       create_cache_dir_if_not_exists
       return false unless line.engines
@@ -56,6 +71,20 @@ module MetraSchedule
         nil
       end
     end
+
+    def persist_delays(delays)
+      create_cache_dir_if_not_exists
+      return false unless delays
+      true if File.open(File.join(@cache_dir, @delay_file), 'w') {|f| Marshal.dump(delays, f)}
+    end
+
+    def retrieve_delays
+      if delays_exist?
+        File.open(File.join(@cache_dir, @delay_file), 'r') {|f| Marshal.load(f)}
+      else
+        nil
+      end
+    end
     
   end
 end

data/lib/metra/delay_parser.rb

@@ -0,0 +1,60 @@
+require 'nokogiri'
+require 'open-uri'
+
+module MetraSchedule
+  class DelayParser
+    attr_reader :html_doc, :url
+    attr_accessor :line
+
+    def initialize(html_doc=nil)
+      time = Time.now.to_i
+      @url = "http://metrarail.com/content/metra/en/home/service_updates/service_updates_alerts/jcr:content/serviceAdvisory.display.html?t=#{time}"
+      @html_doc = @url unless html_doc
+      @html_doc = html_doc if html_doc
+    end
+
+    def scrape
+      parse_nokogiri
+      make_train_delays
+    end
+
+    def parse_nokogiri
+      html_doc = open(@html_doc) if @html_doc.is_a?(String)
+      html_doc = @html_doc if @html_doc.is_a?(File)
+      @html_doc = Nokogiri::HTML(html_doc)
+    end
+
+    def make_train_delays
+      return unless has_delays?
+      all_advisories.inject([]) do |total, node|
+        total << {:train_num => find_train_num(node), :delay => find_delay(node)}
+      end
+    end
+
+    def find_train_num(node)
+      node.text.scan(/#([0-9]+)/).first.first.to_i
+    end
+
+    def find_delay(node)
+      text_array = node.text.delete("\r\n").split("\s")[3..-1]
+      text_array.delete_at(0) if text_array[0] == "-"
+      text_array.join("\s").strip
+    end
+    
+    def has_delays?
+      @html_doc.css('#serviceAdvisory').count > 0
+    end
+
+    private
+
+    def all_advisories
+      nodes = @html_doc.css('#serviceAdvisory dl dd')
+      advisories = nodes.inject([]) do |total, node|
+        id = node.attributes.has_key?("id")
+        total << node unless id
+        total
+      end
+    end
+
+  end
+end

data/lib/metra/extensions/time_extension.rb

@@ -2,7 +2,11 @@ module MetraSchedule
   module Extensions
     module TimeExtension
       def to_today
-        Time.local(Time.now.year, Time.now.month, Time.now.day, self.hour, self.min, self.sec)
+        if self.hour >= 0 and self.hour <= 2 # Midnight to 2AM counts as the same day
+          Time.local(Time.now.year, Time.now.month, Time.now.day+1, self.hour, self.min, self.sec)
+        else
+          Time.local(Time.now.year, Time.now.month, Time.now.day, self.hour, self.min, self.sec)
+        end
       end
     end
   end

data/lib/metra/line.rb

@@ -5,7 +5,7 @@ module MetraSchedule
     include MetraSchedule::TrainData
 
     attr_reader :cacher, :cache_dir 
-    attr_reader :line_key, :name, :url, :dir, :sched, :start, :destination, :time
+    attr_reader :line_key, :name, :url, :dir, :sched, :start, :destination, :time, :del_threshold
     attr_accessor :engines
 
     def initialize(line_name)
@@ -30,6 +30,7 @@ module MetraSchedule
       else
         @engines = cached_engines
       end
+      self
     end
 
     def update_schedule
@@ -155,8 +156,16 @@ module MetraSchedule
       @engines.find {|e| e.train_num == train_num}
     end
 
+    def delay_threshold(minutes)
+      @del_threshold = minutes if minutes
+      self
+    end
+
     def trains
       return [] unless engines
+      if MetraSchedule::Cacher.new.delays_exist?
+        @filters.insert(0, inject_delays)
+      end
       @filters.inject(engines) { |e, fun| fun.call(e) }.sort
     end
 
@@ -172,6 +181,20 @@ module MetraSchedule
       end
     end
 
+    def inject_delays
+      lambda do |engines|
+        delays = MetraSchedule::Cacher.new.retrieve_delays
+        delays.each do |d|
+          if engines.any? {|e| e.train_num == d[:train_num] }
+            train = find_train_by_train_num(d[:train_num])
+            train.delay = d[:delay]
+            train.del_threshold = @del_threshold if @del_threshold
+          end
+        end
+        engines
+      end
+    end
+
     def filter_by_stop
       lambda do |engines|
         if @start and not @destination
@@ -190,7 +213,11 @@ module MetraSchedule
       lambda do |engines|
         return engines unless @time and @start
         engines.find_all do |engine|
-          engine.in_time?(@start, @time)
+          if @del_threshold and engine.delay
+            engine.in_time?(@start, @time - (60 * @del_threshold))
+          else
+            engine.in_time?(@start, @time)
+          end
         end
       end
     end

data/lib/metra/train.rb

@@ -1,7 +1,7 @@
 module MetraSchedule
   class Train
     attr_reader :train_num, :schedule, :bike_limit, :direction, :stops
-    attr_accessor :my_departure, :my_arrival # Injected when the line is filtered
+    attr_accessor :my_departure, :my_arrival, :delay, :del_threshold # Injected when the line is filtered
 
     def initialize(options={})
       unless options.empty?
@@ -20,17 +20,7 @@ module MetraSchedule
 
     def in_time?(station, time)
       stop_time = stops.find {|s| s.station == station}.time
-      if (stop_time.hour == time.hour)
-        if (stop_time.min > time.min)
-          return true
-        else
-          return false
-        end
-      elsif (stop_time.hour > time.hour)
-        return true
-      else
-        return false
-      end
+      stop_time.to_today > time.to_today
     end
 
     def departure_and_arrival(start, destination)
@@ -39,11 +29,16 @@ module MetraSchedule
       {:departure => departure.to_today, :arrival => arrival.to_today}
     end
 
+    def departure_with_delay
+      return @my_departure unless @del_threshold
+      if @my_departure
+        @my_departure + (60 * @del_threshold)
+      end
+    end
+
     def my_travel_time
       return nil unless @my_departure and @my_arrival
-      minutes = (@my_arrival.to_i - @my_departure.to_i) / 60
-      return minutes if minutes > 0
-      return minutes + 1440 if minutes < 0
+      minutes = (@my_arrival.to_today.to_i - @my_departure.to_today.to_i) / 60
     end
 
     def print_my_travel_time

data/lib/metra.rb

@@ -3,6 +3,7 @@ require File.join(File.dirname(__FILE__), 'metra', 'line')
 require File.join(File.dirname(__FILE__), 'metra', 'train')
 require File.join(File.dirname(__FILE__), 'metra', 'stop')
 require File.join(File.dirname(__FILE__), 'metra', 'parser')
+require File.join(File.dirname(__FILE__), 'metra', 'delay_parser')
 require File.join(File.dirname(__FILE__), 'metra', 'cacher')
 require File.join(File.dirname(__FILE__), 'metra', 'extensions', 'time_extension')
 

data/metra_schedule.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{metra_schedule}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Blake Smith"]
-  s.date = %q{2010-01-05}
+  s.date = %q{2010-02-03}
   s.description = %q{metra_schedule provides a ruby object interface to the Chicago metra train schedule}
   s.email = %q{blakesmith0@gmail.com}
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "lib/metra.rb",
      "lib/metra/cacher.rb",
      "lib/metra/classmethods.rb",
+     "lib/metra/delay_parser.rb",
      "lib/metra/extensions/time_extension.rb",
      "lib/metra/line.rb",
      "lib/metra/parser.rb",
@@ -33,6 +34,10 @@ Gem::Specification.new do |s|
      "lib/metra/train_data.rb",
      "metra_schedule.gemspec",
      "test/fixture/UP_NW.html",
+     "test/fixture/service_updates_alerts.html",
+     "test/fixture/service_updates_alerts_multiple_with_non_delay.html",
+     "test/fixture/service_updates_alerts_no_advisories.html",
+     "test/fixture/service_updates_alerts_no_range.html",
      "test/functional/test_all_filters.rb",
      "test/integration/test_line_integration.rb",
      "test/test_helper.rb",
@@ -46,6 +51,7 @@ Gem::Specification.new do |s|
      "test/timecop/lib/timecop/time_stack_item.rb",
      "test/timecop/lib/timecop/timecop.rb",
      "test/unit/test_cacher.rb",
+     "test/unit/test_delay_parser.rb",
      "test/unit/test_line.rb",
      "test/unit/test_metra.rb",
      "test/unit/test_parser.rb",
@@ -71,6 +77,7 @@ Gem::Specification.new do |s|
      "test/unit/test_metra.rb",
      "test/unit/test_stop.rb",
      "test/unit/test_parser.rb",
+     "test/unit/test_delay_parser.rb",
      "test/unit/test_cacher.rb",
      "test/test_helper.rb"
   ]

data/test/fixture/service_updates_alerts.html

@@ -0,0 +1,26 @@
+            	<div id="serviceAdvisory">
+	            	
+	                    
+	                    
+	                        <h2><span class="hidden">Service Advisories</span></h2>
+	                    
+	                
+                    <dl>
+                        
+                            
+                                
+                                    
+
+                                        <dt class="line md-n first">Milwaukee District / North Line</dt>
+                                    
+                                    
+                                    
+                                
+                                <dd class="first"><a href="#serviceAdvisory1">Inbound Train #2156  18 - 20 minutes delayed</a></dd>
+                                <dd id="serviceAdvisory1" class="details">Inbound Train #2156 scheduled to arrive Chicago at 8:59 p.m., is operating approximately 20 minutes behind schedule due to freight train interference.</dd>
+                            
+                        
+                    </dl>
+                </div>
+
+            

data/test/fixture/service_updates_alerts_multiple_with_non_delay.html

@@ -0,0 +1,39 @@
+            
+              <div id="serviceAdvisory">
+                
+                      
+                      
+                          <h2><span class="hidden">Service Advisories</span></h2>
+                      
+                  
+                    <dl>
+                        
+                            
+                                
+                                    
+
+                                        <dt class="line sws first">SouthWest Service</dt>
+                                    
+                                    
+                                    
+                                
+                                <dd class="first"><a href="#serviceAdvisory1">Outbound Train #807 - Stopped North of Ashburn</a></dd>
+                                <dd id="serviceAdvisory1" class="details">Train #807, scheduled to arrive Orland Park 179th at 9:39 a.m., is stopped north of Ashburn due to switch problems. The duration of this delay is unknown. Metra will update this site as information becomes available.</dd>
+                            
+                        
+                            
+                                
+                                    
+
+                                        <dt class="line up-w ">Union Pacific / West Line</dt>
+                                    
+                                    
+                                    
+                                
+                                <dd ><a href="#serviceAdvisory2">Outbound Train #25 - 15 Minute Delay</a></dd>
+                                <dd id="serviceAdvisory2" class="details">Train #25, scheduled to arrive Elburn at 10:08 a.m., is operating 15 minutes behind schedule due to switch problems.</dd>
+                            
+                        
+                    </dl>
+                </div>
+