ierail 0.3.4 → 0.3.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    M2I4ZmZhZmU5MDM4N2Y0YzQyYTIxZDFjMTFmOWYxZDEyMzkyNmQ2Yg==
-  data.tar.gz: !binary |-
-    OGZhZTJjMDA5NzQ4NjhhOWVjZGM3NTc3YjgyOTFiZTdhOGVlNGI0ZQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZjQ1NjY0NmVmY2QxMmE2MjcwZmE0ZjIxYjAzMmM4ZTA3NTY1MDI5MGQ4ODlj
-    MDljZGFkZTcwMTkyMzgzNDVlNjkxYTQ0YTZhMTE3NzQwMTQ4NjViNWE4MWFk
-    NTQxMDQzMmI1ZDQyYjMwM2M3NDQzNjZhNWJmZDRlMDRjM2ZlY2E=
-  data.tar.gz: !binary |-
-    ZDIzZjI2MTA3Y2M1ZThkYzNhOWVkNWQ2YTFjY2VmMjcwNmJlZmJlOTc0M2Zi
-    NzQwYzY3ZTA2NWFlZWUyZDE5NjY4MmI0ZDAwMmU1ZGQ5MDQ2NmFlNDBiNDVl
-    ZGRmNTgwNmVmNDE5MDE0NWEwNGYwNDMxYTFiOWIyODUyZDhmOWE=
+SHA1:
+  metadata.gz: 8624329e17244b7bebb63b152459c3bf590a3458
+  data.tar.gz: 8614aa0c660b016fb50b2f537215268e0a49684f
+SHA512:
+  metadata.gz: fbec8afce43b9f6da40921a3dacb4c851e10376810a095a25a3cd3f106dff6afcdedcc01cf01f6768476aa7b408af4965ccca818673bac424946ee5027413d7d
+  data.tar.gz: 92f1ff53061f37dd7805b887670dbc6c9dff4da32f0c55223aac514efd332e81d1e3e33babee693fed9a04e1e6169d0b45f3f1fe431995babe7fd9845a377cb0

data/.gitignore

@@ -1 +1,2 @@
 coverage
+.DS_Store

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
+  - 2.1.0
+  - 2.0.0
   - 1.9.3
-  - 1.9.2
-  - jruby-19mode
-  - rbx-19mode
+  - jruby

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    ierail (0.3.3)
-      json (~> 1.7.7)
-      nokogiri (~> 1.5.0)
-      rest-client (~> 1.6.7)
-      tzinfo (~> 0.3.37)
+    ierail (0.3.5)
+      json (~> 1.7, >= 1.7.7)
+      nokogiri (~> 1.5, >= 1.5.0)
+      rest-client (~> 1.6, >= 1.6.7)
+      tzinfo (~> 0.3, >= 0.3.37)
 
 GEM
   remote: https://rubygems.org/
@@ -17,10 +17,10 @@ GEM
       rest-client
       simplecov (>= 0.7)
       thor
-    json (1.7.7)
+    json (1.8.1)
     mime-types (1.23)
     multi_json (1.7.3)
-    nokogiri (1.5.9)
+    nokogiri (1.5.11)
     rake (10.0.4)
     rest-client (1.6.7)
       mime-types (>= 1.16)
@@ -29,9 +29,10 @@ GEM
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
     thor (0.18.1)
-    tzinfo (0.3.37)
+    tzinfo (0.3.39)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES

data/README.md

@@ -1,5 +1,6 @@
 [![Build Status](https://travis-ci.org/oisin/ierail.png?branch=master)](https://travis-ci.org/oisin/ierail)
 [![Coverage Status](https://coveralls.io/repos/oisin/ierail/badge.png?branch=master)](https://coveralls.io/r/oisin/ierail)
+[![Gem Version](https://badge.fury.io/rb/ierail.png)](http://badge.fury.io/rb/ierail)
 
 ## Irish Rail API Ruby Wrapper
 
@@ -12,57 +13,70 @@ It's a trivial wrapper for the Irish Rail real time (whut?) train times system,
 ### Grab the IERail gem
 
 
-`$ gem install ierail`
+```bash
+$ gem install ierail
+```
 
-<pre><code>require 'ierail'
+```ruby
+require 'ierail'
 
 ir = IERail.new
-</code></pre>
+```
 
 ### Find all Southbound trains serving Clongriffin station
 
-<pre><code>trains = ir.southbound_from('clongriffin')</code></pre>
+```ruby
+trains = ir.southbound_from('clongriffin')
+```
 
 ### Find all trains serving Clongriffin in the next 30 minutes
 
-<pre><code>trains = ir.station_times('clongriffin', 30)
+```ruby
+trains = ir.station_times('clongriffin', 30)
 
-trains.each { |t| puts t.inspect }
-</code></pre>
+trains.each { |t| p t.inspect }
+```
 
 ### Find all Northbound trains serving Clongriffin before / after a certain time
 
-<pre><code>trains = ir.northbound_from('clongriffin').after('HH:MM')
+```ruby
+trains = ir.northbound_from('clongriffin').after('HH:MM')
 trains = ir.northbound_from('clongriffin').before('HH:MM')
-</code></pre>
+```
 
 NB: "HH:MM" must be soon, as the API, by default, returns upcoming
 arrivals
 
 ### Find all Southbound trains from Malahide in the next N minutes
 
-<pre><code>trains = ir.southbound_from('malahide').in(N)
-</code></pre>
+```ruby
+trains = ir.southbound_from('malahide').in(N)
+```
 
 ### Find out information for a specific train
 
-<pre><code>trains = ir.station('clongriffin', 60)
+```ruby
+trains = ir.station('clongriffin', 60)
 
 trains.first.last_location # "Arrived Harmonstown"
 
-trains.first.origin # {:name=>"Greystones", :time=>"07:30"}
+trains.first.origin # {:name=>"Greystones", :time=>2013-05-13 22:10:00 +0100}
 
-trains.first.destination # {:name=>"Malahide", :time=>"08:49"}
+trains.first.destination # {:name=>"Malahide", :time=>2013-05-13 22:10:00 +0100}
 
-trains.first.arrival # {:scheduled=>"08:40", :expected=>"08:41"}
+trains.first.arrival # {:scheduled=>2013-05-13 22:09:00 +0100, :expected=>2013-05-13 22:10:00 +0100}
 
-trains.first.departure # {:scheduled=>"08:41", :expected=>"08:41"}
+trains.first.departure # {:scheduled=>2013-05-13 22:09:00 +0100, :expected=>2013-05-13 22:10:00 +0100}
 
 trains.first.duein # "2"
 
 trains.first.late? # 0 || 1
-</code></pre>
+```
 
-Check the **main.rb** for additional usage.
+Check the [main.rb](main.rb) for additional usage.
+
+Pull requests welcome, because there's damn all in it at the moment. Please accompany the pull request with an appropriate test, and if you can, an example here in the README.
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/oisin/ierail/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
-Pull requests welcome, because there's damn all in it at the moment. Please accompany the pull request with an appropriate test.

data/ierail.gemspec

@@ -2,16 +2,16 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'ierail'
-  s.version     = '0.3.4'
+  s.version     = '0.3.5'
   s.date        = Date.today.to_s
   s.summary     = "Irish Rail Train Schedule and Status API"
   s.description = "Irish Rail Train Schedule and Status API"
-  s.authors     = ["Oisin Hurley", "Gary Rafferty"]
+  s.authors     = ["Oisin Hurley", "Gary Rafferty", "Michael Dever"]
   s.email       = 'oi.sin@nis.io'
   s.files       = `git ls-files`.split("\n")
   s.homepage    = 'http://rubygems.org/gems/ierail'
-  s.add_dependency 'nokogiri', '~> 1.5.0'
-  s.add_dependency 'rest-client', '~> 1.6.7'
-  s.add_dependency 'json', '~> 1.7.7'
-  s.add_dependency 'tzinfo', '~> 0.3.37'
+  s.add_runtime_dependency 'json', '~> 1.7', '>= 1.7.7'
+  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'
 end

data/lib/ierail.rb

@@ -6,6 +6,7 @@ require 'time'
 require 'train'
 require 'station'
 require 'station_data'
+require 'train_movement'
 require 'core_ext'
 
 class IERail
@@ -71,11 +72,8 @@ class IERail
   #
   def stations
     ier = IERailGet.new("getAllStationsXML?", "arrayofobjstation", "objstation")
-    retval = []
-    ier.response.each do |s|
-      retval << Station.new(s)
-    end
-    retval
+    
+    ier.response.map { |s| Station.new(s) }
   end
   
   # Get ALL the trains! That are on the go at the moment.
@@ -92,11 +90,8 @@ class IERail
   #
   def trains
     ier = IERailGet.new("getCurrentTrainsXML?", "arrayofobjtrainpositions", "objtrainpositions")
-    retval = []
-    ier.response.each do |t|
-      retval << Train.new(t)
-    end
-    retval
+    
+    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
@@ -124,11 +119,8 @@ class IERail
   #
   def station(name)
     ier = IERailGet.new("getStationDataByNameXML?StationDesc=#{name}", "arrayofobjstationdata", "objstationdata")
-    retval = []
-    ier.response.each do |sd|
-      retval << StationData.new(sd)
-    end
-    retval
+    
+    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. 
@@ -138,9 +130,28 @@ class IERail
   #
   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.
+  #
+  # This gives all the stations that the train has or will be stopped at.
+  # 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#station => "Glenageary"
+  # }
+  #
+  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 |sd|
-      retval << StationData.new(sd)
+    ier.response.each do |tm|
+      retval << TrainMovement.new(tm)
     end
     retval
   end
@@ -157,13 +168,12 @@ class IERail
   def find_station(partial)
     ier = IERailGet.new("getStationsFilterXML?StationText=#{partial}", "ArrayOfObjStationFilter", "objStationFilter")
     Struct.new("Station", :name, :description, :code)
-    retval = []
-    ier.response.each do |st|
-       retval << Struct::Station.new(st['StationDesc_sp'],
-                                     st['StationDesc'],
-                                     st['StationCode'])
+    
+    ier.response.map do |st|
+       Struct::Station.new(st['StationDesc_sp'],
+                           st['StationDesc'],
+                           st['StationCode'])
     end
-    retval
   end
 
   # Get direction-specific train information for a particular station, by station name. 
@@ -197,11 +207,8 @@ class IERail
       direction = name.to_s.split('_').first.capitalize
 
       ier = IERailGet.new("getStationDataByNameXML?StationDesc=#{args.first}", "arrayofobjstationdata", "objstationdata")
-      retval = []
-      ier.response.each do |sd|
-        retval << StationData.new(sd) if sd['Direction'] == direction
-      end
-      retval
+     
+      ier.response.select { |sd| sd['Direction'] == direction }.map { |sd| StationData.new(sd) }
     end
   end
 end

data/lib/station_data.rb

@@ -18,12 +18,21 @@ class StationData
     @last_location    = hash['Lastlocation']
     @duein            = hash['Duein']
     @late             = hash['Late']
-    @exparrival       = Time.parse hash['Exparrival']
-    @expdepart        = Time.parse hash['Expdepart']
-    @scharrival       = Time.parse hash['Scharrival']
-    @schdepart        = Time.parse hash['Schdepart']
+    
+    # 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']
+    
+    
   end
 
   def origin

data/lib/train_movement.rb

@@ -0,0 +1,40 @@
+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_full_name  = hash['LocationFullName']
+    @location_order      = hash['LocationOrder'].to_i
+    @location_type       = hash['LocationType']
+    @train_origin        = hash['TrainOrigin']
+    @scheduled_arrival   = Time.parse hash['ScheduledArrival']
+    @scheduled_departure = Time.parse hash['ScheduledDeparture']
+    @expected_arrival    = Time.parse hash['ExpectedArrival']
+    @expected_departure  = Time.parse hash['ExpectedDeparture']
+    arrival_time         = hash['Arrival']
+    departure_time       = hash['Departure']
+    @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
+
+  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
+
+  alias :station :location_full_name
+end

data/test/unit/ierail.rb

@@ -37,7 +37,7 @@ class IERailTest < MiniTest::Unit::TestCase
     #Thirty minutes from now
     thirty_mins = @now + (60 * 30)
     time = "#{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
-    before_train = @ir.southbound_from('Malahide').before(time).sample
+    before_train = @ir.southbound_from('Dublin Connolly').before(time).sample
     assert before_train.expdepart <= thirty_mins
   end
 
@@ -45,7 +45,7 @@ class IERailTest < MiniTest::Unit::TestCase
     #Thirty minutes from now
     thirty_mins = @now + (60 * 30)
     time = "#{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
-    after_train = @ir.southbound_from('Malahide').after(time).sample
+    after_train = @ir.southbound_from('Dublin Connolly').after(time).sample
     assert after_train.expdepart >= thirty_mins
   end
 

data/test/unit/train_movement.rb

@@ -0,0 +1,50 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
+
+require_relative 'helper'
+
+require 'minitest/autorun'
+require 'ierail'
+
+class TrainMovementTest < MiniTest::Unit::TestCase
+  def setup
+    ir = IERail.new
+        
+    train_code = ir.trains.sample.code #Use a random train code
+    @train_movement = ir.train_movements(train_code).sample #Use a random movement from the random train
+  end
+    
+  def test_that_location_method_returns_a_hash
+    assert_equal @train_movement.location.class, Hash
+  end
+  
+  def test_that_there_is_a_location_code_and_name_and_stop_number_and_type
+    refute_empty @train_movement.location[:code]
+    refute_empty @train_movement.location[:name]
+    refute_nil @train_movement.location[:stop_number]
+    refute_empty @train_movement.location[:type]
+  end
+  
+  def test_that_arrival_method_returns_a_hash
+    assert_equal @train_movement.arrival.class, Hash
+  end
+
+  def test_that_there_is_an_arrival_sched_and_exp_and_actual
+    refute_nil @train_movement.arrival[:scheduled]
+    refute_nil @train_movement.arrival[:expected]
+    refute_nil @train_movement.arrival[:actual]
+  end
+  
+  def test_that_departure_method_returns_a_hash
+    assert_equal @train_movement.departure.class, Hash
+  end
+
+  def test_that_there_is_a_departure_sched_and_exp_and_actual
+    refute_nil @train_movement.departure[:scheduled]
+    refute_nil @train_movement.departure[:expected]
+    refute_nil @train_movement.departure[:actual]
+  end
+  
+  def test_that_it_responds_to_station
+    assert_respond_to @train_movement, :station
+  end
+end 

metadata

@@ -1,70 +1,95 @@
 --- !ruby/object:Gem::Specification
 name: ierail
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Oisin Hurley
 - Gary Rafferty
+- Michael Dever
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2014-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.7
 - !ruby/object:Gem::Dependency
-  name: json
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.37
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.37
 description: Irish Rail Train Schedule and Status API
@@ -73,9 +98,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -87,12 +112,14 @@ files:
 - lib/station.rb
 - lib/station_data.rb
 - lib/train.rb
+- lib/train_movement.rb
 - main.rb
 - test/unit/helper.rb
 - test/unit/ierail.rb
 - test/unit/station.rb
 - test/unit/station_data.rb
 - test/unit/train.rb
+- test/unit/train_movement.rb
 homepage: http://rubygems.org/gems/ierail
 licenses: []
 metadata: {}
@@ -102,17 +129,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Irish Rail Train Schedule and Status API