tube 0.2.0

data/README.txt

@@ -0,0 +1,36 @@
+= Tube/Status
+
+A simple MIT licensed Ruby library to access the status of the London Underground network as displayed on the Transport for London {Live travel news}[http://www.tfl.gov.uk/tfl/livetravelnews/realtime/tube/default.html] page.
+
+== Installation
+
+    $ gem install tube --source http://gemcutter.org
+
+== Examples
+    require 'tube/status'
+    
+    status = Tube::Status.new
+    
+    broken_lines = status.lines.select {|line| line.problem?}
+    broken_lines.collect {|line| line.name}
+    #=> ["Circle", "District", "Jubilee", "Metropolitan", "Northern"]
+    
+    status.lines.detect {|line| line.id == :circle}.message
+    #=> "Saturday 7 and Sunday 8 March, suspended."
+    
+    closed_stations = status.station_groups["Closed stations"]
+    closed_stations.collect {|station| station.name}
+    #=> ["Blackfriars", "Hatton Cross"]
+    
+    stations = status.station_groups.values.flatten
+    stations.detect {|station| station.name =~ "hatton"}.message
+    #=> "Saturday 7 and Sunday 8 March, closed."
+    
+    status.updated.strftime("%I:%M%p")
+    #=> "04:56PM"
+    
+    status.reload
+    status.updated.strftime("%I:%M%p")
+    #=> "05:00PM"
+
+See the {documentation}[http://sourcetagsandcodes.com/codes/tube_status/doc/] for more details.

data/lib/tube/line.rb

@@ -0,0 +1,24 @@
+module Tube # :nodoc:
+  
+  # Models the data gathered on a tube line from the tfl.gov.uk "Live travel
+  # news" page.
+  # 
+  class Line
+    attr_reader :id
+    attr_accessor :name, :status, :problem, :message
+    alias problem? problem
+    
+    # :call-seq: Line.new(id, name, status, problem, message=nil)
+    # 
+    # Create a new Line.
+    # 
+    def initialize( id, name, status, problem, message=nil )
+      @id = id
+      @name = name
+      @status = status
+      @problem = problem
+      @message = message
+    end
+    
+  end
+end

data/lib/tube/station.rb

@@ -0,0 +1,20 @@
+module Tube # :nodoc:
+  
+  # Models the data gathered on a tube station from the tfl.gov.uk "Live travel
+  # news" page.
+  # 
+  class Station
+    attr_reader :name
+    attr_accessor :message
+    
+    # :call-seq: Station.new(name, message)
+    # 
+    # Create a new Station.
+    # 
+    def initialize( name, message )
+      @name = name
+      @message = message
+    end
+    
+  end
+end

data/lib/tube/status.rb

@@ -0,0 +1,84 @@
+require 'open-uri'
+
+require "#{File.dirname( __FILE__ )}/status_parser"
+require "#{File.dirname( __FILE__ )}/line"
+require "#{File.dirname( __FILE__ )}/station"
+
+module Tube # :nodoc:
+  
+  # Models the status of the London Underground network as displayed on
+  # http://www.tfl.gov.uk/tfl/livetravelnews/realtime/tube/default.html.
+  # 
+  # It is a very thin abstraction over the tfl website, as a result the access
+  # to data on stations is somewhat different to lines due to the differing
+  # presentation.
+  # However it is very dynamic, for example should the East London line return
+  # it will show up in the lines array automatically.
+  # 
+  # ==Example Usage
+  #  require 'tube/status'
+  #  
+  #  status = Tube::Status.new
+  #  
+  #  broken_lines = status.lines.select {|line| line.problem?}
+  #  broken_lines.collect {|line| line.name}
+  #  #=> ["Circle", "District", "Jubilee", "Metropolitan", "Northern"]
+  #  
+  #  status.lines.detect {|line| line.id == :circle}.message
+  #  #=> "Saturday 7 and Sunday 8 March, suspended."
+  #  
+  #  closed_stations = status.station_groups["Closed stations"]
+  #  closed_stations.collect {|station| station.name}
+  #  #=> ["Blackfriars", "Hatton Cross"]
+  #  
+  #  stations = status.station_groups.values.flatten
+  #  stations.detect {|station| station.name =~ "hatton"}.message
+  #  #=> "Saturday 7 and Sunday 8 March, closed."
+  #  
+  #  status.updated.strftime("%I:%M%p")
+  #  #=> "04:56PM"
+  #  
+  #  status.reload
+  #  status.updated.strftime("%I:%M%p")
+  #  #=> "05:00PM"
+  # 
+  class Status
+    attr_reader :updated, :lines, :station_groups
+    
+    # :call-seq: Status.new -> status
+    # 
+    # Request and parse the status of the London Underground network from the
+    # tfl.gov.uk "Live travel news" page.
+    # 
+    def initialize( url=
+        "http://www.tfl.gov.uk/tfl/livetravelnews/realtime/tube/default.html" )
+      results = Tube::StatusParser.parse( open( url ) )
+      @updated = results[:updated]
+      
+      @lines = results[:lines].map do |line|
+        id = line[:html_class].to_sym
+        name = line[:name]
+        status = line[:status][:headline]
+        problem = line[:status][:problem]
+        message = line[:status][:message]
+        
+        Line.new( id, name, status, problem, message )
+      end
+      
+      @station_groups = results[:station_groups].inject( {} ) do |memo, group|
+        stations = group[:stations].map do |station|
+          Station.new( station[:name], station[:message] )
+        end
+        
+        memo[group[:name]] = stations
+        memo
+      end
+      
+      self
+    end
+    
+    alias reload initialize
+    public :reload
+    
+  end
+end

data/lib/tube/status_parser.rb

@@ -0,0 +1,135 @@
+require 'time'
+require 'date'
+require 'rubygems'
+require 'hpricot'
+
+module Tube # :nodoc:
+  module StatusParser # :nodoc:
+    extend self
+    
+    def parse( html_doc )
+      service_board = Hpricot( html_doc ).at( "#service-board" )
+      
+      updated_element = service_board.previous_sibling.children.first
+      updated = parse_updated( updated_element )
+      
+      lines = service_board.search( "dl#lines dt" ).map do |line_element|
+        parse_line( line_element )
+      end
+      
+      station_group_elements = service_board.search( "dl#stations dt" )
+      station_groups = station_group_elements.map do |station_group_element|
+        parse_station_group( station_group_element )
+      end
+      
+      {:updated => updated, :lines => lines, :station_groups => station_groups}
+    end
+    
+    def parse_updated( updated_element )
+      time_text = updated_element.inner_text.match( /(\d?\d:\d\d(a|p)m)/ )[0]
+      time_zone = if is_bst? then "+0100" else "+0000" end
+      
+      Time.parse( "#{time_text} #{time_zone}" )
+    end
+    
+    def parse_line( line_element )
+      name = line_element.inner_text.strip
+      html_class = line_element.attributes["class"]
+      status = parse_status( line_element.next_sibling )
+      
+      {:name => name, :html_class => html_class, :status => status}
+    end
+    
+    def parse_status( status_element )
+      header = status_element.at( "h3" )
+      
+      if header
+        headline = header.inner_text.strip
+        message = parse_status_message( status_element.search( "div.message p" ) )
+      else
+        headline = status_element.inner_text.strip
+      end
+      problem = status_element.attributes["class"] == "problem"
+      
+      {:headline => headline, :problem => problem, :message => message}
+    end
+    
+    def parse_station_group( station_group_element )
+      name = station_group_element.inner_text.strip
+      stations = []
+      
+      station_element = station_group_element
+      while station_element = station_element.next_sibling
+        if station_element.to_html =~ /^<dd/
+          stations.push( parse_station( station_element ) )
+        elsif station_element.to_html =~ /^<dt/
+          break
+        end
+      end
+      
+      {:name => name, :stations => stations}
+    end
+    
+    def parse_station( station_element )
+      name = station_element.at( "h3" ).inner_text.strip
+      message = parse_status_message( station_element.search("div.message p") )
+      
+      {:name => name, :message => message}
+    end
+    
+    def parse_status_message( messages )
+      text_messages = messages.map do |message|
+        if message.children
+          message.children.select {|child| child.text?}.join( " " )
+        end
+      end.compact
+      text_messages.reject! {|m| m.empty?}
+      
+      text_messages.map {|m| m.gsub( /\s+/, " " ).strip}.join( "\n" )
+    end
+    
+    private
+    
+    # :call-seq: is_bst? -> bool
+    # 
+    # Is British Summer Time currently in effect.
+    # 
+    def is_bst?
+      bst_start = last_sunday_of_month( "march" )
+      bst_end = last_sunday_of_month( "october" )
+      
+      one_hour = 3600
+      bst_start = Time.gm( bst_start.year, bst_start.month ) + one_hour
+      bst_end = Time.gm( bst_end.year, bst_end.month ) + one_hour
+      
+      (bst_start..bst_end).include?( Time.now.getgm )
+    end
+    
+    # :call-seq: last_sunday_of_month(month_name) -> date
+    # 
+    def last_sunday_of_month( month )
+      start_of_next_month = Date.parse( next_month_name( month ) )
+      
+      week_day = start_of_next_month.wday
+      
+      distance_from_sunday = if week_day == 0 then 7 else week_day end
+      start_of_next_month - distance_from_sunday
+    end
+    
+    # :call-seq: next_month_name(month_name) -> string
+    # 
+    def next_month_name( month )
+      index = Date::MONTHNAMES.index( month.capitalize )
+      index ||= ABBR_MONTHNAMES.index( month.capitalize )
+      
+      index += 1
+      
+      if index >= 12
+        index = 1
+      end
+      
+      Date::MONTHNAMES[index]
+    end
+    
+  end
+end

data/test/dummy.html

@@ -0,0 +1,71 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+    <title>Service update now &#124; Transport for London</title>
+    <!-- Transport for London website template version 1.7 -->
+    
+    <meta http-equiv="content-type" content="text/html;charset=utf-8" />
+</head>
+<body class="template-6">
+    <!-- <lm>Sun, 15 Nov 2009 12:12:20 GMT</lm> -->
+    
+    <div id="container" class="live-travel-news">
+        <div id="main-content">
+            <h1>Live travel news</h1>
+            
+            <h2>Service update at 12:12pm <a href="later.html" id="works_later" class="alert" name="works_later">View engineering works planned for <strong>later today</strong></a></h2>
+            <div id="service-board">
+                <dl id="lines">
+                    <dt class="central">Central</dt>
+                    <dd>Good service</dd>
+                    <dt class="district">District</dt>
+                    <dd class="problem">
+                        <h3>Part closure</h3>
+                        <div class="message">
+                            <p>Rail replacement bus</p>
+                            <p>Service A: details...</p>
+                            <p><a href="/transform">See how we are transforming the Tube</a></p>
+                        </div>
+                    </dd>
+                    <dt class="waterlooandcity">Waterloo &amp; City</dt>
+                    <dd class="problem">
+                        <h3>Planned closure</h3>
+                        <div class="message">
+                            <p>Closed Sunday.</p>
+                            <p><a href="/transform">See how we are transforming the Tube</a></p>
+                        </div>
+                    </dd>
+                </dl>
+                <dl id="stations">
+                    <dt>Closed stations</dt>
+                    <dd>
+                        <h3>Bank</h3>
+                        <div class="message">
+                            <p>Closed due to excessive noise.</p>
+                            <p><a href="/transform">See how we are transforming the Tube</a></p>
+                        </div>
+                    </dd>
+                    <dd>
+                        <h3>Holborn</h3>
+                        <div class="message">
+                            <p>Closed due to fire investigation.</p>
+                            <p>Go to Chancery Lane or Tottenham Court Road instead.</p>
+                            <p><a href="/transform">See how we are transforming the Tube</a></p>
+                        </div>
+                    </dd>
+                    
+                    <dt>Station maintenance</dt>
+                    <dd>
+                        <h3>Elephant &amp; Castle</h3>
+                        <div class="message">
+                            <p>Reduced lift service.</p>
+                            <p><a href="/transform">See how we are transforming the Tube</a></p>
+                        </div>
+                    </dd>
+                </dl>
+            </div>
+        </div>
+    </div>
+</body>
+</html>

data/test/status_parser_test.rb

@@ -0,0 +1,140 @@
+require "test/unit"
+
+require "#{File.dirname( __FILE__ )}/../lib/tube/status"
+
+class TestStatusParser < Test::Unit::TestCase
+  def test_parse_updated
+    document = Hpricot("<h2>Service update at 6:26pm</h2>")
+    element = document.at("h2")
+    result = Tube::StatusParser.parse_updated(element)
+    
+    assert_equal(Time.parse("6:26pm"), result)
+  end
+  
+  def test_parse_updated_with_anchor_in_element
+    document = Hpricot(%Q{<h2>Service update at 12:12pm <a href="/later.html">View engineering works planned for later today</a></h2>})
+    element = document.at("h2")
+    result = Tube::StatusParser.parse_updated(element)
+    
+    assert_equal(Time.parse("12:12pm"), result)
+  end
+  
+  def test_parse_line
+    document = Hpricot(%Q{<dt class="central">Central</dt> <dd>Good service</dd>})
+    element = document.at("dt")
+    result = Tube::StatusParser.parse_line(element)
+    
+    assert_equal("Central", result[:name])
+    assert_equal("central", result[:html_class])
+    assert_equal("Good service", result[:status][:headline])
+  end
+  
+  def test_parse_line_with_complex_name
+    document = Hpricot(%Q{<dt class="waterlooandcity">Waterloo &amp; City</dt> <dd></dd>})
+    element = document.at("dt")
+    result = Tube::StatusParser.parse_line(element)
+    
+    assert_equal("Waterloo & City", result[:name])
+    assert_equal("waterlooandcity", result[:html_class])
+  end
+  
+  def test_parse_status
+    document = Hpricot("<dd>Good service</dd>")
+    element = document.at("dd")
+    result = Tube::StatusParser.parse_status(element)
+    
+    assert_equal("Good service", result[:headline])
+  end
+  
+  def test_parse_status_with_problem
+    document = Hpricot(%Q{<dd class="problem">Part suspended</dd>})
+    element = document.at("dd")
+    result = Tube::StatusParser.parse_status(element)
+    
+    assert_equal(true, result[:problem])
+  end
+  
+  def test_parse_status_with_header
+    document = Hpricot(%Q{<dd><h3>Part suspended</h3></dd>})
+    element = document.at("dd")
+    result = Tube::StatusParser.parse_status(element)
+    
+    assert_equal("Part suspended", result[:headline])
+  end
+  
+  def test_parse_status_with_message
+    document = Hpricot(%Q{<dd class="problem"><h3>Part closure</h3><div class="message"><p>engineering works, etc...</p></div></dd>})
+    element = document.at("dd")
+    result = Tube::StatusParser.parse_status(element)
+    
+    assert_equal("Part closure", result[:headline])
+    assert_equal(true, result[:problem])
+    assert_equal("engineering works, etc...", result[:message])
+  end
+  
+  def test_parse_status_message
+    document = Hpricot(%Q{<div><p>engineering works, etc...</p></div>})
+    elements = document.search("div p")
+    result = Tube::StatusParser.parse_status_message(elements)
+    
+    assert_equal("engineering works, etc...", result)
+  end
+  
+  def test_parse_status_message_with_multi_paragraph_message
+    document = Hpricot(%Q{<div><p>Rail replacement bus</p><p>Service A: details...</p></div>})
+    elements = document.search("div p")
+    result = Tube::StatusParser.parse_status_message(elements)
+    
+    assert_equal("Rail replacement bus\nService A: details...", result)
+  end
+  
+  def test_parse_status_message_removes_anchor_from_message
+    document = Hpricot(%Q{<div><p>Closed Sunday.</p><p><a href="/transform">See how we are transforming the Tube</a></p></div>})
+    elements = document.search("div p")
+    result = Tube::StatusParser.parse_status_message(elements)
+    
+    assert_equal("Closed Sunday.", result)
+  end
+  
+  def test_parse_station_group
+    document = Hpricot(%Q{<dt>Closed stations</dt>
+    <dd><h3>Bank</h3><div class="message"><p>Closed due to excessive noise.</p></div></dd>
+    <dd><h3>Holborn</h3><div class="message"><p>Closed due to fire investigation.</p></div></dd>})
+    element = document.at("dt")
+    result = Tube::StatusParser.parse_station_group(element)
+    
+    assert_equal("Closed stations", result[:name])
+    assert_equal("Bank", result[:stations].first[:name])
+    assert_equal("Holborn", result[:stations].last[:name])
+  end
+  
+  def test_parse_station
+    document = Hpricot(%Q{<dd><h3>Bank</h3><div class="message"><p>Closed due to excessive noise.</p></div></dd>})
+    element = document.at("dd")
+    result = Tube::StatusParser.parse_station(element)
+    
+    assert_equal("Bank", result[:name])
+    # This seriously happend once.
+    assert_equal("Closed due to excessive noise.", result[:message])
+  end
+  
+  def test_parse
+    # the file used here is an approximation of the most important bits of the
+    # Live travel news at http://www.tfl.gov.uk/tfl/livetravelnews/realtime/tube/default.html
+    document = open("#{File.dirname( __FILE__ )}/dummy.html")
+    result = Tube::StatusParser.parse(document)
+    
+    assert(result)
+    assert_equal(Time.parse("12:12pm"), result[:updated])
+    assert_equal(3, result[:lines].length)
+    assert_equal("Central", result[:lines].first[:name])
+    assert_equal("Closed Sunday.", result[:lines].last[:status][:message])
+    assert_equal(2, result[:station_groups].length)
+    assert_equal(2, result[:station_groups].first[:stations].length)
+    assert_equal(1, result[:station_groups].last[:stations].length)
+    assert_equal("Closed stations", result[:station_groups].first[:name])
+    assert_equal("Elephant & Castle", result[:station_groups].last[:stations].first[:name])
+    
+    assert_equal({:updated=>Time.parse("12:12pm"), :station_groups=>[{:stations=>[{:message=>"Closed due to excessive noise.", :name=>"Bank"}, {:message=>"Closed due to fire investigation.\nGo to Chancery Lane or Tottenham Court Road instead.", :name=>"Holborn"}], :name=>"Closed stations"}, {:stations=>[{:message=>"Reduced lift service.", :name=>"Elephant & Castle"}], :name=>"Station maintenance"}], :lines=>[{:status=>{:problem=>false, :message=>nil, :headline=>"Good service"}, :html_class=>"central", :name=>"Central"}, {:status=>{:problem=>true, :message=>"Rail replacement bus\nService A: details...", :headline=>"Part closure"}, :html_class=>"district", :name=>"District"}, {:status=>{:problem=>true, :message=>"Closed Sunday.", :headline=>"Planned closure"}, :html_class=>"waterlooandcity", :name=>"Waterloo & City"}]}, result)
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: tube
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Matthew Sadler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-15 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hpricot
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+    version: 
+description: A simple Ruby library to access the status of the London Underground network.
+email: mat@sourcetagsandcodes.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/tube/line.rb
+- lib/tube/station.rb
+- lib/tube/status.rb
+- lib/tube/status_parser.rb
+- test/dummy.html
+- test/status_parser_test.rb
+- README.txt
+has_rdoc: true
+homepage: http://github.com/matsadler/tube
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Access the status of the London Underground network.
+test_files: 
+- test/status_parser_test.rb