ierail 0.4.1 → 0.5.0

data/lib/ierail.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rest-client'
 require 'nokogiri'
 require 'uri'
@@ -10,19 +12,21 @@ require 'train_movement'
 require 'core_ext'
 
 class IERail
-  
+
   URL = "http://api.irishrail.ie/realtime/realtime.asmx"
-  
+
   class IERailGet < Nokogiri::XML::SAX::Document
-    
+
     attr_reader :result
-    
+
     def initialize(url, array_name, object_name)
-      @ws_url = URI.encode(url)
+      @ws_url = url.gsub(' ', '%20')
       @ws_array_name = array_name.downcase
       @ws_object_name = object_name.downcase
+      @result = nil
+      @current = nil
     end
-      
+
     def response
       unless @result
         parser = Nokogiri::XML::SAX::Parser.new(self)
@@ -31,27 +35,27 @@ class IERail
       @result
     end
 
-    def start_document 
+    def start_document
       @result = []
     end
-    
+
     def characters string
-      string.strip!
-      @result.last[@current] << string unless string.empty?
+      str = string.strip
+      @result.last[@current] << str unless str.empty?
     end
-    
+
     def start_element name, attrs = []
       case name.downcase
-        when @ws_object_name 
+        when @ws_object_name
           @result << Hash.new
         when @ws_array_name
           ;
         else
-          @current = name          
-          @result.last[@current] = ""
+          @current = name
+          @result.last[@current] = String.new("")
       end
     end
-    
+
     def end_element name
       if @current && @result.last[@current].empty?
         @result.last.delete(@current)
@@ -59,7 +63,7 @@ class IERail
       @current = nil
     end
   end
-  
+
   # Get ALL the stations!
   # Returns array of Station objects, and each object responds to
   # {
@@ -72,10 +76,10 @@ class IERail
   #
   def stations
     ier = IERailGet.new("getAllStationsXML?", "arrayofobjstation", "objstation")
-    
+
     ier.response.map { |s| Station.new(s) }
   end
-  
+
   # Get ALL the trains! That are on the go at the moment.
   # Returns array of Train objects, and each object responds to
   #  {
@@ -90,10 +94,10 @@ class IERail
   #
   def trains
     ier = IERailGet.new("getCurrentTrainsXML?", "arrayofobjtrainpositions", "objtrainpositions")
-    
+
     ier.response.map { |t| Train.new(t) }
   end
-  
+
   # 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
   # {
@@ -122,21 +126,21 @@ class IERail
   #
   def station(name)
     ier = IERailGet.new("getStationDataByNameXML?StationDesc=#{name}", "arrayofobjstationdata", "objstationdata")
-    
+
     ier.response.map { |sd| StationData.new(sd) }
   end
-  
-  # Get train information for a particular station, by station name, within the time period in minutes from now. 
+
+  # Get train information for a particular station, by station name, within the time period in minutes from now.
   # This gives data on trains thru that station.
   # Returns array of StationData objects, and each obj looks like the one for IERail#station
   # Will return an empty array if no information.
   #
   def station_times(name, mins)
     ier = IERailGet.new("getStationDataByNameXML_withNumMins?StationDesc=#{name}&NumMins=#{mins}", "arrayofobjstationdata", "objstationdata")
-    
+
     ier.response.map { |sd| StationData.new(sd) }
   end
-  
+
   # Get the movements of a particular train, by train code, on a date.
   #  If no date is supplied assume train has run/is running today.
   #
@@ -153,10 +157,10 @@ class IERail
   #
   def train_movements(code, date=Time.now)
     ier = IERailGet.new("getTrainMovementsXML?TrainId=#{code}&TrainDate=#{date.strftime("%d/%m/%Y")}", "ArrayOfObjTrainMovements", "ObjTrainMovements")
-    
+
     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
   # {
@@ -168,8 +172,11 @@ class IERail
   #
   def find_station(partial)
     ier = IERailGet.new("getStationsFilterXML?StationText=#{partial}", "ArrayOfObjStationFilter", "objStationFilter")
-    Struct.new("Station", :name, :description, :code)
-    
+
+    unless defined?(Struct::Station)
+        Struct.new("Station", :name, :description, :code)
+    end
+
     ier.response.map do |st|
        Struct::Station.new(st['StationDesc_sp'],
                            st['StationDesc'],
@@ -189,7 +196,7 @@ class IERail
       direction = name.to_s.split('_').first.capitalize
 
       ier = IERailGet.new("getStationDataByNameXML?StationDesc=#{args.first}", "arrayofobjstationdata", "objstationdata")
-     
+
       ier.response.select { |sd| sd['Direction'] == direction }.map { |sd| StationData.new(sd) }
     end
   end

data/lib/station.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Station
   attr_reader :description, :code, :id
 

data/lib/station_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class StationData
   attr_reader :server_time, :train_code, :station_name, :station_code,
               :status, :last_location, :due_in, :minutes_late, :minutes_early,

data/lib/train.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Train
   attr_reader :status, :code, :date, :message, :direction
 

data/lib/train_movement.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 class TrainMovement
-  
+
   attr_reader :location_full_name
 
   def initialize hash
     @train_code          = hash['TrainCode']
     @train_date          = Time.parse hash['TrainDate']
-    @location_code       = hash['LocationCode'] 
+    @location_code       = hash['LocationCode']
     @location_full_name  = hash['LocationFullName']
     @location_order      = hash['LocationOrder'].to_i
     @location_type       = hash['LocationType']
@@ -19,7 +21,7 @@ class TrainMovement
     @arrival             = arrival_time.nil? ? @expected_arrival : Time.parse(arrival_time)
     @departure           = departure_time.nil? ? @expected_departure : Time.parse(departure_time)
   end
-  
+
   def location
     {code: @location_code, name: @location_full_name, stop_number: @location_order, type: @location_type}
   end
@@ -27,11 +29,11 @@ class TrainMovement
   def arrival
     {scheduled: @scheduled_arrival, expected: @expected_arrival, actual: @arrival}
   end
-  
+
   def departure
     {scheduled: @scheduled_departure, expected: @expected_departure, actual: @departure}
   end
-  
+
   def train
     {code: @train_code, date: @train_date, origin: @train_origin}
   end

data/test/unit/helper.rb

@@ -1,13 +1,12 @@
 require 'simplecov'
-require 'coveralls'
 require 'tzinfo'
 require 'vcr'
 require 'timecop'
-require 'time'
+require 'date'
 require 'minitest/autorun'
 require 'ierail'
 
-def get_original_time(t)
+def helper_get_original_time(t)
   t = Time.now if t.nil?
   @when = Time.parse(t.to_s)
   if TZInfo::Timezone.get('Europe/Dublin').current_period.dst?
@@ -17,12 +16,17 @@ def get_original_time(t)
   else
     @when -= @when.utc_offset
   end
-  
+
   @when
 end
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
+def helper_get_thirty_mins
+  thirty_mins = Time.now + (60 * 30)
+  " #{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter
+])
+
 SimpleCov.start

data/test/unit/ierail.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 $:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
 
 require_relative 'helper'
 
-class IERailTest < MiniTest::Unit::TestCase
+class IERailTest < Minitest::Test
   def setup
     @ir = IERail.new
 
@@ -14,7 +15,7 @@ class IERailTest < MiniTest::Unit::TestCase
 
   def test_that_the_train_directions_are_correct
     VCR.use_cassette('northbound') do |cassette|
-      time = get_original_time(cassette.originally_recorded_at)
+      time = helper_get_original_time(cassette.originally_recorded_at)
 
       Timecop.freeze(time || Time.now) do
         northbound_train = @ir.northbound_from('Dublin Connolly').sample
@@ -22,7 +23,7 @@ class IERailTest < MiniTest::Unit::TestCase
       end
     end
     VCR.use_cassette('northbound') do |cassette|
-      time = get_original_time(cassette.originally_recorded_at)
+      time = helper_get_original_time(cassette.originally_recorded_at)
 
       Timecop.freeze(time || Time.now) do
         southbound_train = @ir.southbound_from('Dublin Connolly').sample
@@ -33,7 +34,7 @@ class IERailTest < MiniTest::Unit::TestCase
 
   def test_that_an_empty_array_is_returned_when_no_data
     VCR.use_cassette('westbound') do |cassette|
-      time = get_original_time(cassette.originally_recorded_at)
+      time = helper_get_original_time(cassette.originally_recorded_at)
 
       Timecop.freeze(time || Time.now) do
         nonexistant = @ir.westbound_from('Clongriffin')
@@ -44,35 +45,27 @@ class IERailTest < MiniTest::Unit::TestCase
 
   def test_that_the_before_time_constraint_works
     VCR.use_cassette('northbound') do |cassette|
-      time = get_original_time(cassette.originally_recorded_at)
-
+      time = helper_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_arrival <= thirty_mins
+        before_train = @ir.southbound_from('Dublin Connolly').before(helper_get_thirty_mins()).sample
+        assert before_train.expected_arrival.to_i - before_train.server_time.to_i  < (30 * 60)
       end
     end
   end
 
   def test_that_the_after_time_constraint_works
     VCR.use_cassette('southbound') do |cassette|
-      time = get_original_time(cassette.originally_recorded_at)
-
+      time = helper_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_arrival >= thirty_mins
+        after_train = @ir.southbound_from('Dublin Connolly').after(helper_get_thirty_mins()).sample
+        assert after_train.expected_arrival.to_i - after_train.server_time.to_i  >= (30 * 60)
       end
     end
   end
 
   def test_that_the_in_constraint_works
     VCR.use_cassette('southbound_from') do |cassette|
-      time = get_original_time(cassette.originally_recorded_at)
+      time = helper_get_original_time(cassette.originally_recorded_at)
 
       Timecop.freeze(time || Time.now) do
         mins = 30
@@ -92,7 +85,7 @@ class IERailTest < MiniTest::Unit::TestCase
 
   def test_station_times
     VCR.use_cassette('station_times') do |cassette|
-      time = get_original_time(cassette.originally_recorded_at)
+      time = helper_get_original_time(cassette.originally_recorded_at)
 
       Timecop.freeze(time || Time.now) do
         station_data = @ir.station_times('Dublin Connolly',30).sample
@@ -103,7 +96,7 @@ class IERailTest < MiniTest::Unit::TestCase
 
   def test_find_station
     VCR.use_cassette('find_station') do |cassette|
-      time = get_original_time(cassette.originally_recorded_at)
+      time = helper_get_original_time(cassette.originally_recorded_at)
 
       Timecop.freeze(time || Time.now) do
         station = @ir.find_station('Dublin Connolly').sample
@@ -114,7 +107,7 @@ class IERailTest < MiniTest::Unit::TestCase
 
   def test_that_station_times_returns_station_data
     VCR.use_cassette('station_times') do |cassette|
-      time = get_original_time(cassette.originally_recorded_at)
+      time = helper_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
@@ -124,10 +117,10 @@ class IERailTest < MiniTest::Unit::TestCase
   end
 
   def test_that_station_times_equivalent_to_in
-    VCR.use_cassette('station_times') do |cassette|
+    VCR.use_cassette('station_times') do
       trains = @ir.station_times('Dublin Connolly', 30)
 
-      VCR.use_cassette('station') do |cassette|
+      VCR.use_cassette('station') do
         in_half_an_hour = @ir.station('Dublin Connolly').in(30)
 
         assert_equal trains.count, in_half_an_hour.count
@@ -139,7 +132,7 @@ class IERailTest < MiniTest::Unit::TestCase
   end
 
   def test_that_found_station_is_a_struct_with_name_description_code
-    VCR.use_cassette('find_station') do |cassette|
+    VCR.use_cassette('find_station') do
       station = @ir.find_station('Dublin Connolly').sample
       assert_equal station.class, Struct::Station
       refute_nil station.name

data/test/unit/station.rb

@@ -2,7 +2,7 @@ $:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
 
 require_relative 'helper'
 
-class StationTest < MiniTest::Unit::TestCase
+class StationTest < Minitest::Test
   def setup
     ir = IERail.new
 

data/test/unit/station_data.rb

@@ -2,7 +2,7 @@ $:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
 
 require_relative 'helper'
 
-class StationDataTest < MiniTest::Unit::TestCase
+class StationDataTest < Minitest::Test
   def setup
     ir = IERail.new
     
@@ -29,10 +29,6 @@ class StationDataTest < MiniTest::Unit::TestCase
     refute_empty @station_data.code
   end
 
-  def test_that_there_is_a_query_time
-    refute_nil @station_data.query_time
-  end
-
   def test_that_there_is_a_status
     refute_empty @station_data.status
   end

data/test/unit/train.rb

@@ -2,7 +2,7 @@ $:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
 
 require_relative 'helper'
 
-class TrainTest < MiniTest::Unit::TestCase
+class TrainTest < Minitest::Test
   def setup
     ir = IERail.new
 

data/test/unit/train_movement.rb

@@ -2,7 +2,7 @@ $:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
 
 require_relative 'helper'
 
-class TrainMovementTest < MiniTest::Unit::TestCase
+class TrainMovementTest < Minitest::Test
   def setup
     ir = IERail.new