ierail 0.2

data/lib/ierail.rb

@@ -0,0 +1,165 @@
+require 'rest-client'
+require 'nokogiri'
+
+require 'train'
+require 'station'
+require 'station_data'
+
+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 = url
+      @ws_array_name = array_name.downcase
+      @ws_object_name = object_name.downcase
+    end
+      
+    def response
+      unless @result
+        parser = Nokogiri::XML::SAX::Parser.new(self)
+        parser.parse(RestClient.get(URL + "/" + @ws_url))
+      end
+      @result
+    end
+
+    def start_document 
+      @result = []
+    end
+    
+    def characters string
+      string.strip!
+      @result.last[@current] << string unless string.empty?
+    end
+    
+    def start_element name, attrs = []
+      case name.downcase
+        when @ws_object_name 
+          @result << Hash.new
+        when @ws_array_name
+          ;
+        else
+          @current = name          
+          @result.last[@current] = ""
+      end
+    end
+    
+    def end_element name
+      if @current && @result.last[@current].empty?
+        @result.last.delete(@current)
+      end
+      @current = nil
+    end
+  end
+  
+  # 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"
+  #  }
+  # Returns empty array if no data, but that would be odd.
+  #
+  def stations
+    ier = IERailGet.new("getAllStationsXML?", "arrayofobjstation", "objstation")
+    retval = []
+    ier.response.each do |s|
+      retval << Station.new(s)
+    end
+    retval
+  end
+  
+  # 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"
+  #  }
+  # Returns empty array if no data
+  #
+  def trains
+    ier = IERailGet.new("getCurrentTrainsXML?", "arrayofobjtrainpositions", "objtrainpositions")
+    retval = []
+    ier.response.each do |t|
+      retval << Train.new(t)
+    end
+    retval
+  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
+  # {
+  #   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 empty array if no data.
+  #
+  def station(name)
+    ier = IERailGet.new("getStationDataByNameXML?StationDesc=#{name}", "arrayofobjstationdata", "objstationdata")
+    retval = []
+    ier.response.each do |sd|
+      retval << StationData.new(sd)
+    end
+    retval
+  end
+  
+  # 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")
+    retval = []
+    ier.response.each do |sd|
+      retval << StationData.new(sd)
+    end
+    retval
+  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"
+  #  }
+  # or an empty array if no matches.
+  #
+  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'])
+    end
+    retval
+  end
+end

data/lib/station.rb

@@ -0,0 +1,17 @@
+class Station
+  attr_reader :description, :code, :id
+
+  def initialize hash
+    @description = hash['StationDesc']
+    @latitude    = hash['StationLatitude']
+    @longitude   = hash['StationLongitude']
+    @code        = hash['StationCode']
+    @id          = hash['StationId']
+  end
+
+  def location
+    [@longitude,@latitude]
+  end
+
+  alias :name :description
+end

data/lib/station_data.rb

@@ -0,0 +1,52 @@
+class StationData
+  attr_reader :servertime, :traincode, :station_name, :station_code,
+              :status, :last_location, :duein, :late, 
+              :train_type, :direction, :query_time, :train_date
+
+  def initialize hash
+    @servertime       = hash['Servertime']
+    @traincode        = hash['Traincode']
+    @station_name     = hash['Stationfullname']
+    @station_code     = hash['Stationcode']
+    @query_time       = hash['Querytime']
+    @train_date       = hash['Traindate']
+    @origin           = hash['Origin']
+    @destination      = hash['Destination']
+    @origin_time      = hash['Origintime']
+    @destination_time = hash['Destinationtime']
+    @status           = hash['Status']
+    @last_location    = hash['Lastlocation']
+    @duein            = hash['Duein']
+    @late             = hash['Late']
+    @exparrival       = hash['Exparrival']
+    @expdepart        = hash['Expdepart']
+    @scharrival       = hash['Scharrival']
+    @schdepart        = hash['Schdepart']
+    @direction        = hash['Direction']
+    @train_type       = hash['Traintype']
+  end
+
+  def origin
+    {name: @origin, time: @origin_time}
+  end
+
+  def destination
+    {name: @destination, time: @destination_time}
+  end
+
+  def arrival
+    {scheduled: @scharrival, expected: @exparrival}
+  end
+
+  def departure
+    {scheduled: @schdepart, expected: @expdepart}
+  end
+
+  def late?
+    @late.to_i > 0
+  end
+
+  alias :name :station_name
+  alias :code :station_code
+  alias :due_in :duein
+end

data/lib/train.rb

@@ -0,0 +1,17 @@
+class Train
+  attr_reader :status, :code, :date, :message, :direction
+
+  def initialize hash
+    @status    = hash['TrainStatus']
+    @longitude = hash['TrainLongitude']
+    @latitude  = hash['TrainLatitude']
+    @code      = hash['TrainCode']
+    @date      = hash['TrainDate']
+    @message   = hash['PublicMessage']
+    @direction = hash['Direction']
+  end
+
+  def location
+    [@longitude,@latitude]
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: ierail
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.2"
+platform: ruby
+authors: 
+- Oisin Hurley
+- Gary Rafferty
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-09 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Irish Rail Train Schedule and Status API
+email: oi.sin@nis.io
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ierail.rb
+- lib/station.rb
+- lib/station_data.rb
+- lib/train.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/ierail
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Irish Rail Train Schedule and Status API
+test_files: []
+