ierail 0.3.5 → 0.4.0

data/ierail.gemspec

@@ -2,7 +2,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'ierail'
-  s.version     = '0.3.5'
+  s.version     = '0.4.0'
   s.date        = Date.today.to_s
   s.summary     = "Irish Rail Train Schedule and Status API"
   s.description = "Irish Rail Train Schedule and Status API"
@@ -10,8 +10,11 @@ Gem::Specification.new do |s|
   s.email       = 'oi.sin@nis.io'
   s.files       = `git ls-files`.split("\n")
   s.homepage    = 'http://rubygems.org/gems/ierail'
-  s.add_runtime_dependency 'json', '~> 1.7', '>= 1.7.7'
+  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.1'
   s.add_runtime_dependency 'rest-client', '~> 1.6', '>= 1.6.7'
-  s.add_runtime_dependency 'nokogiri', '~> 1.5', '>= 1.5.0'
-  s.add_runtime_dependency 'tzinfo', '~> 0.3', '>= 0.3.37'
+  s.add_runtime_dependency 'nokogiri', '~> 1.6', '>= 1.6.1'
+  s.add_runtime_dependency 'tzinfo', '~> 1.1', '>= 1.1.0'
+  s.add_development_dependency 'vcr', '~> 2.9', '>= 2.9.0'
+  s.add_development_dependency 'webmock', '~> 1.17', '>= 1.17.4'
+  s.add_development_dependency 'timecop', '~> 0.6', '>= 0.6.2'
 end

data/lib/core_ext.rb

@@ -2,21 +2,21 @@ class Array
   #Filters elements, collecting those
   #whose times are before _time_
   def before time
-    select {|t| t.expdepart <= Time.parse(time) }
+    query_time = Time.parse(time)
+    select {|t| t.arrival[:expected] <= query_time }
   end
 
   #Filters elements, collecting those
   #whose times are after _time_
   def after time
-    select {|t| t.expdepart >= Time.parse(time) }
+    query_time = Time.parse(time)
+    select {|t| t.arrival[:expected] >= query_time }
   end
 
   # The 'in' is just sugar really, saving the 
   # programmer from doing a trivial computation 
   # over and over again in their code.
   def in time
-    select { |t|
-      ((t.expdepart - t.query_time ) / 60) < time
-    }
+    select { |t| t.due_in <= time }
   end
 end

data/lib/ierail.rb

@@ -63,10 +63,10 @@ class IERail
   # Get ALL the stations!
   # Returns array of Station objects, and each object responds to
   # {
-  #    obj#name =>"Belfast Central", 
-  #    obj#location =>["-5.91744", "54.6123"] 
-  #    obj#code =>"BFSTC", 
-  #    obj#id =>"228"
+  #    obj#name => "Belfast Central",
+  #    obj#location => [-5.91744, 54.6123]
+  #    obj#code => "BFSTC",
+  #    obj#id => 228
   #  }
   # Returns empty array if no data, but that would be odd.
   #
@@ -79,12 +79,12 @@ class IERail
   # Get ALL the trains! That are on the go at the moment.
   # Returns array of Train objects, and each object responds to
   #  {
-  #    obj#status =>"R", 
-  #    obj#location =>["-6.23929, ""53.3509"] 
-  #    obj#code =>"D303", 
-  #    obj#date =>"20 Jan 2012", 
-  #    obj#message =>"D303\\n09:30 - Docklands to M3 Parkway (1 mins late)\\nDeparted Docklands next stop Broombridge", 
-  #    obj#direction =>"Northbound"
+  #    obj#status => "R",
+  #    obj#location => [-6.23929, 53.3509]
+  #    obj#code =>  "D303",
+  #    obj#date => 20 Jan 2012,
+  #    obj#message => "D303\\n09:30 - Docklands to M3 Parkway (1 mins late)\\nDeparted Docklands next stop Broombridge",
+  #    obj#direction => "Northbound"
   #  }
   # Returns empty array if no data
   #
@@ -97,23 +97,26 @@ class IERail
   # Get train information for a particular station, by station name. This gives data on trains thru that station
   # Returns array of StationData objects, and each object responds to
   # {
-  #   obj#servertime =>"2012-01-20T10:03:33.777", 
-  #   obj#traincode =>"E909", 
-  #   obj#name / obj#station_name =>"Glenageary", 
-  #   obj#code / obj#station_code =>"GLGRY", 
-  #   obj#query_time =>"10:03:33", 
-  #   obj#train_date =>"20 Jan 2012", 
-  #   obj#origin => {:name => "Bray", :time => "09:55"} 
-  #   obj#destination => {:name => "Howth", :time => "11:03"} 
-  #   obj#status =>"En Route", 
-  #   obj#last_location =>"Arrived Killiney", 
-  #   obj#duein / obj#due_in =>"6", 
-  #   obj#late =>"0", 
-  #   obj#late? => 0 / 1
-  #   obj#arrival => {:scheduled => "10:09", :expected => "10:09"}
-  #   obj#departure => {:scheduled => "10:09", :expected => "10:09"}
+  #   obj#server_time => 2012-01-20T10:03:33.777,
+  #   obj#train_code => "E909",
+  #   obj#name / obj#station_name => "Glenageary",
+  #   obj#code / obj#station_code => "GLGRY",
+  #   obj#query_time => 10:03:33,
+  #   obj#train_date => 20 Jan 2012,
+  #   obj#origin => {:name => "Bray", :time => 09:55}
+  #   obj#destination => {:name => "Howth", :time => 11:03}
+  #   obj#status => "En Route",
+  #   obj#last_location => "Arrived Killiney",
+  #   obj#due_in => 6,
+  #   obj#minutes_early => 0,
+  #   obj#minutes_late => 0,
+  #   obj#on_time? => true / false,
+  #   obj#early? => true / false,
+  #   obj#late? => true / false,
+  #   obj#arrival => {:scheduled => 10:09, :expected => 10:09}
+  #   obj#departure => {:scheduled => 10:09, :expected => 10:09}
   #   obj#direction => "Northbound",
-  #   obj#train_type => "DART", 
+  #   obj#train_type => "DART",
   # }
   # Returns empty array if no data.
   #
@@ -141,27 +144,25 @@ class IERail
   # Returns an array of TrainMovement objects, and each object responds to
   # {
   #    obj#location => {code: "GLGRY", name: "Glenageary", stop_number: 1 (Stop number on route), type: "O" (Origin) \ "S" (Stop) \ "D" (Destination)}
-  #    obj#train => {:code => "E909", :date => "20 Jan 2012", :origin => "Glenageary"}
-  #    obj#arrival => {:scheduled => "10:09", :expected => "10:09", :actual => "10.09"}
-  #    obj#departure => {:scheduled => "10:09", :expected => "10:09", :actual => "10.09"}
+  #    obj#train => {:code => "E909", :date => 20 Jan 2012, :origin => "Glenageary"}
+  #    obj#arrival => {:scheduled => 10:09, :expected => 10:09, :actual => 10.09}
+  #    obj#departure => {:scheduled => 10:09, :expected => 10:09, :actual => 10.09}
   #    obj#station => "Glenageary"
   # }
+  # Returns empty array if no data.
   #
   def train_movements(code, date=Time.now)
     ier = IERailGet.new("getTrainMovementsXML?TrainId=#{code}&TrainDate=#{date.strftime("%d/%m/%Y")}", "ArrayOfObjTrainMovements", "ObjTrainMovements")
-    retval = []
-    ier.response.each do |tm|
-      retval << TrainMovement.new(tm)
-    end
-    retval
+    
+    ier.response.map{ |tm| TrainMovement.new(tm) }
   end
   
   # Find station codes and descriptions using a partial string to match the station name
   # Returns an array of Structs that each respond to
   # {
-  #    struct#name =>"Sandycove", 
-  #    struct#description =>"Glasthule (Sandycove )", 
-  #    struct#code =>"SCOVE"
+  #    struct#name => "Sandycove",
+  #    struct#description => "Glasthule (Sandycove)",
+  #    struct#code => "SCOVE"
   #  }
   # or an empty array if no matches.
   #
@@ -176,28 +177,9 @@ class IERail
     end
   end
 
-  # Get direction-specific train information for a particular station, by station name. 
+  # Get direction-specific train information for a particular station, by station name.
   # This gives data on trains through that station
-  # Returns array of StationData objects, and each object responds to
-  # {
-  #   obj#servertime =>"2012-01-20T10:03:33.777", 
-  #   obj#traincode =>"E909", 
-  #   obj#name / obj#station_name =>"Glenageary", 
-  #   obj#code / obj#station_code =>"GLGRY", 
-  #   obj#query_time =>"10:03:33", 
-  #   obj#train_date =>"20 Jan 2012", 
-  #   obj#origin => {:name => "Bray", :time => "09:55"} 
-  #   obj#destination => {:name => "Howth", :time => "11:03"} 
-  #   obj#status =>"En Route", 
-  #   obj#last_location =>"Arrived Killiney", 
-  #   obj#duein / obj#due_in =>"6", 
-  #   obj#late =>"0", 
-  #   obj#late? => 0 / 1
-  #   obj#arrival => {:scheduled => "10:09", :expected => "10:09"}
-  #   obj#departure => {:scheduled => "10:09", :expected => "10:09"}
-  #   obj#direction => "Northbound",
-  #   obj#train_type => "DART", 
-  # }
+  # Returns array of StationData objects, and each obj looks like the one for IERail#station
   # Returns empty array if no data.
   #
 

data/lib/station.rb

@@ -3,10 +3,10 @@ class Station
 
   def initialize hash
     @description = hash['StationDesc']
-    @latitude    = hash['StationLatitude']
-    @longitude   = hash['StationLongitude']
+    @latitude    = hash['StationLatitude'].to_f
+    @longitude   = hash['StationLongitude'].to_f
     @code        = hash['StationCode']
-    @id          = hash['StationId']
+    @id          = hash['StationId'].to_i
   end
 
   def location

data/lib/station_data.rb

@@ -1,38 +1,44 @@
 class StationData
-  attr_reader :servertime, :traincode, :station_name, :station_code,
-              :status, :last_location, :duein, :late, 
-              :train_type, :direction, :query_time, :train_date, :expdepart
+  attr_reader :server_time, :train_code, :station_name, :station_code,
+              :status, :last_location, :due_in, :minutes_late, :minutes_early,
+              :train_type, :direction, :query_time, :train_date, :expected_departure,
+              :expected_arrival, :scheduled_arrival, :scheduled_departure
 
   def initialize hash
-    @servertime       = hash['Servertime']
-    @traincode        = hash['Traincode']
-    @station_name     = hash['Stationfullname']
-    @station_code     = hash['Stationcode']
-    @query_time       = Time.parse(hash['Querytime'])
-    @train_date       = hash['Traindate']
-    @origin           = hash['Origin']
-    @destination      = hash['Destination']
-    @origin_time      = Time.parse hash['Origintime']
-    @destination_time = Time.parse hash['Destinationtime']
-    @status           = hash['Status']
-    @last_location    = hash['Lastlocation']
-    @duein            = hash['Duein']
-    @late             = hash['Late']
-    
+    @server_time                = Time.parse hash['Servertime']
+    @train_code                 = hash['Traincode']
+    @station_name               = hash['Stationfullname']
+    @station_code               = hash['Stationcode']
+    @query_time                 = Time.parse hash['Querytime']
+    @train_date                 = Date.parse hash['Traindate']
+    @origin                     = hash['Origin']
+    @destination                = hash['Destination']
+    @origin_time                = Time.parse hash['Origintime']
+    @destination_time           = Time.parse hash['Destinationtime']
+    @status                     = hash['Status']
+    @last_location              = hash['Lastlocation']
+    @due_in                     = hash['Duein'].to_i
+
+    # Though IE give a late value, this really represents difference from scheduled arrival
+    # and therefore represents the number of minutes that the train is off-schedule where
+    # <0: early, 0: on time and >0: late
+
+    off_schedule_minutes        = hash['Late'].to_i
+    @minutes_late               = off_schedule_minutes > 0 ? off_schedule_minutes : 0
+    @minutes_early              = off_schedule_minutes < 0 ? -off_schedule_minutes : 0
+
     # If train origin is station_name, then arrival times will be 00:00, so are adjusted to suit expected origin time.
     # Likewise if destination is station_name, departure times should suit expected destination time.
     # See: http://api.irishrail.ie/realtime/ Point 8
-    is_departure_station   = @station_name.eql?(@origin)
-    is_terminating_station = @station_name.eql?(@destination)
-    
-    @exparrival       = is_departure_station ? @origin_time : Time.parse(hash['Exparrival'])
-    @expdepart        = is_terminating_station ? @destination_time : Time.parse(hash['Expdepart'])
-    @scharrival       = is_departure_station ? @origin_time + @late.to_i : Time.parse(hash['Scharrival'])
-    @schdepart        = is_terminating_station ? @destination_time + @late.to_i : Time.parse(hash['Schdepart'])
-    @direction        = hash['Direction']
-    @train_type       = hash['Traintype']
-    
-    
+    is_departure_station        = @station_name.eql?(@origin)
+    is_terminating_station      = @station_name.eql?(@destination)
+
+    @expected_arrival           = is_departure_station ? @origin_time : Time.parse(hash['Exparrival'])
+    @expected_departure         = is_terminating_station ? @destination_time : Time.parse(hash['Expdepart'])
+    @scheduled_arrival          = is_departure_station ? @origin_time + off_schedule_minutes : Time.parse(hash['Scharrival'])
+    @scheduled_departure        = is_terminating_station ? @destination_time + off_schedule_minutes : Time.parse(hash['Schdepart'])
+    @direction                  = hash['Direction']
+    @train_type                 = hash['Traintype']
   end
 
   def origin
@@ -44,18 +50,25 @@ class StationData
   end
 
   def arrival
-    {scheduled: @scharrival, expected: @exparrival}
+    {scheduled: @scheduled_arrival, expected: @expected_arrival}
   end
 
   def departure
-    {scheduled: @schdepart, expected: @expdepart}
+    {scheduled: @scheduled_departure, expected: @expected_departure}
   end
 
   def late?
-    @late.to_i > 0
+    @minutes_late > 0
+  end
+
+  def early?
+    @minutes_early > 0
+  end
+
+  def on_time?
+    !late? && !early?
   end
 
   alias :name :station_name
   alias :code :station_code
-  alias :due_in :duein
 end

data/lib/train.rb

@@ -3,10 +3,10 @@ class Train
 
   def initialize hash
     @status    = hash['TrainStatus']
-    @longitude = hash['TrainLongitude']
-    @latitude  = hash['TrainLatitude']
+    @longitude = hash['TrainLongitude'].to_f
+    @latitude  = hash['TrainLatitude'].to_f
     @code      = hash['TrainCode']
-    @date      = hash['TrainDate']
+    @date      = Date.parse hash['TrainDate']
     @message   = hash['PublicMessage']
     @direction = hash['Direction']
   end

data/test/unit/helper.rb

@@ -1,5 +1,24 @@
 require 'simplecov'
 require 'coveralls'
+require 'tzinfo'
+require 'vcr'
+require 'timecop'
+require 'time'
+require 'minitest/autorun'
+require 'ierail'
+
+def get_original_time(t)
+  @when = Time.parse(t.to_s)
+  if TZInfo::Timezone.get('Europe/Dublin').current_period.dst?
+    unless @when.zone == 'IST'
+      @when -= @when.utc_offset - 3600
+    end
+  else
+    @when -= @when.utc_offset
+  end
+  
+  @when
+end
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,

data/test/unit/ierail.rb

@@ -2,63 +2,150 @@ $:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
 
 require_relative 'helper'
 
-require 'minitest/autorun'
-require 'ierail'
-require 'tzinfo'
-
 class IERailTest < MiniTest::Unit::TestCase
   def setup
     @ir = IERail.new
 
-    @now = Time.now
-
-    if TZInfo::Timezone.get('Europe/Dublin').current_period.dst?
-      unless @now.zone == 'IST'
-        @now -= @now.utc_offset - 3600
-      end
-    else
-      @now -= @now.utc_offset
+    VCR.configure do |c|
+      c.cassette_library_dir = 'fixtures/vcr_cassettes'
+      c.hook_into :webmock
     end
   end
 
   def test_that_the_train_directions_are_correct
-    northbound_train = @ir.northbound_from('Howth Junction').sample
-    southbound_train = @ir.southbound_from('Clongriffin').sample
-    assert_equal northbound_train.direction, 'Northbound'
-    assert_equal southbound_train.direction, 'Southbound'
+    VCR.use_cassette('northbound') do |cassette|
+      time = get_original_time(cassette.originally_recorded_at)
+
+      Timecop.freeze(time || Time.now) do
+        northbound_train = @ir.northbound_from('Dublin Connolly').sample
+        assert_equal northbound_train.direction, 'Northbound'
+      end
+    end
+    VCR.use_cassette('northbound') do |cassette|
+      time = get_original_time(cassette.originally_recorded_at)
+
+      Timecop.freeze(time || Time.now) do
+        southbound_train = @ir.southbound_from('Dublin Connolly').sample
+        assert_equal southbound_train.direction, 'Southbound'
+      end
+    end
   end
 
   def test_that_an_empty_array_is_returned_when_no_data
-    nonexistant = @ir.westbound_from('Clongriffin')
-    assert_empty nonexistant
+    VCR.use_cassette('westbound') do |cassette|
+      time = get_original_time(cassette.originally_recorded_at)
+
+      Timecop.freeze(time || Time.now) do
+        nonexistant = @ir.westbound_from('Clongriffin')
+        assert_empty nonexistant
+      end
+    end
   end
 
   def test_that_the_before_time_constraint_works
-    #Thirty minutes from now
-    thirty_mins = @now + (60 * 30)
-    time = "#{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
-    before_train = @ir.southbound_from('Dublin Connolly').before(time).sample
-    assert before_train.expdepart <= thirty_mins
+    VCR.use_cassette('northbound') do |cassette|
+      time = get_original_time(cassette.originally_recorded_at)
+
+      Timecop.freeze(time || Time.now) do
+        #Thirty minutes from now
+        thirty_mins = Time.now + (60 * 30)
+        time = "#{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
+        before_train = @ir.southbound_from('Dublin Connolly').before(time).sample
+        assert before_train.expected_departure <= thirty_mins
+      end
+    end
   end
 
   def test_that_the_after_time_constraint_works
-    #Thirty minutes from now
-    thirty_mins = @now + (60 * 30)
-    time = "#{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
-    after_train = @ir.southbound_from('Dublin Connolly').after(time).sample
-    assert after_train.expdepart >= thirty_mins
+    VCR.use_cassette('southbound') do |cassette|
+      time = get_original_time(cassette.originally_recorded_at)
+
+      Timecop.freeze(time || Time.now) do
+        #Thirty minutes from now
+        thirty_mins = Time.now + (60 * 30)
+        time = "#{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
+        after_train = @ir.southbound_from('Dublin Connolly').after(time).sample
+        assert after_train.expected_departure >= thirty_mins
+      end
+    end
   end
 
   def test_that_the_in_constraint_works
-    mins = 30
-    thirty_mins = @now + (60 * mins)
-    time = "#{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
-    before_train = @ir.southbound_from('Malahide').before(time)
-
-    in_half_an_hour = @ir.southbound_from('Malahide').in(mins)
-    assert_equal before_train.count, in_half_an_hour.count
-    before_train.each_with_index { |b,i|
-      assert_equal b.traincode, in_half_an_hour[i].traincode
-    }
+    VCR.use_cassette('southbound_from') do |cassette|
+      time = get_original_time(cassette.originally_recorded_at)
+
+      Timecop.freeze(time || Time.now) do
+        mins = 30
+        thirty_mins = Time.now + (60 * mins)
+        time = "#{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
+        southbounds = @ir.southbound_from('Dublin Connolly')
+
+        before_train = southbounds.before(time)
+
+        in_half_an_hour = southbounds.in(mins)
+        assert_equal before_train.count, in_half_an_hour.count
+        before_train.each_with_index { |b,i|
+          assert_equal b.train_code, in_half_an_hour[i].train_code
+        }
+      end
+    end
+  end
+
+  def test_station_times
+    VCR.use_cassette('station_times') do |cassette|
+      time = get_original_time(cassette.originally_recorded_at)
+
+      Timecop.freeze(time || Time.now) do
+        station_data = @ir.station_times('Dublin Connolly',30).sample
+        assert_instance_of StationData, station_data
+      end
+    end
+  end
+
+  def test_find_station
+    VCR.use_cassette('find_station') do |cassette|
+      time = get_original_time(cassette.originally_recorded_at)
+
+      Timecop.freeze(time || Time.now) do
+        station = @ir.find_station('Dublin Connolly').sample
+        assert_instance_of Struct::Station, station
+      end
+    end
+  end
+
+  def test_that_station_times_returns_station_data
+    VCR.use_cassette('station_times') do |cassette|
+      time = get_original_time(cassette.originally_recorded_at)
+
+      Timecop.freeze(time || Time.now) do
+        train = @ir.station_times('Dublin Connolly', 30).sample #random train in next 30 mins
+        assert_equal train.class, StationData #StationData has already been tested
+      end
+    end
+  end
+
+  def test_that_station_times_equivalent_to_in
+    VCR.use_cassette('station_times') do |cassette|
+      trains = @ir.station_times('Dublin Connolly', 30)
+
+      VCR.use_cassette('station') do |cassette|
+        in_half_an_hour = @ir.station('Dublin Connolly').in(30)
+
+        assert_equal trains.count, in_half_an_hour.count
+        trains_codes = trains.map {|t| t.train_code}
+        half_hour_train_codes = in_half_an_hour.map {|t| t.train_code}
+        assert_equal trains_codes, half_hour_train_codes
+      end
+    end
+  end
+
+  def test_that_found_station_is_a_struct_with_name_description_code
+    VCR.use_cassette('find_station') do |cassette|
+      station = @ir.find_station('Dublin Connolly').sample
+      assert_equal station.class, Struct::Station
+      refute_nil station.name
+      refute_nil station.description
+      refute_nil station.code
+    end
   end
 end