ierail 0.3 → 0.3.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2ZmNzc1ZDRiZGIwMjkzZDc2Mjc1N2Y4MDM1MDhjNGZjMTRiNGFmZA==
+  data.tar.gz: !binary |-
+    Y2I0NWVhZDU0M2E3YTAwMWNjOTc2YmJlYzNhMDVmMjc4YzM3MTZlOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjkwOWVmNTE2YzQ3NTEzZTQ0ZDhlNTliYzdmYWM1M2MyYjFjNDZjNTM2MDQy
+    OWRlYzFkZGMxZWY3NTRmYTU0ZWNmYTc3OGExNGZiNzIxNTY2YjBiYjk4ZDBj
+    NDJjMDg1NjM4N2IwODBlNjcwNDE5YjM2OTAzYmI0Y2EyMDM5ZTU=
+  data.tar.gz: !binary |-
+    ZTg1OTI0NTdiMmU1MGEzMzk5NmI0YjM3NTlhMDMzNjlhYzIwM2M2ZTFmMWMz
+    ZTE3MTA1YWJiZjAxNTRmNDhhZGU5MGQ0MWRmNjUzOWUxMDBlOWI0YjczOGMx
+    ZjcxYmZhMzFmZGY1ZDdlYWZhZGJmNTYxYjgxZTRhOTg2MTdjNTQ=

data/.coveralls.yml

@@ -0,0 +1 @@
+service: travis_ci

data/.gitignore

@@ -0,0 +1 @@
+coverage

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'coveralls', require: false
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    ierail (0.3)
+      json (~> 1.7.7)
+      nokogiri (~> 1.5.0)
+      rest-client (~> 1.6.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colorize (0.5.8)
+    coveralls (0.6.6)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    json (1.7.7)
+    mime-types (1.23)
+    multi_json (1.7.3)
+    nokogiri (1.5.9)
+    rake (10.0.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  ierail!
+  rake

data/LICENSE.txt

@@ -0,0 +1,15 @@
+Oisin Hurley
+2012
+
+In the original BSD license, both occurrences of the phrase "COPYRIGHT HOLDERS AND CONTRIBUTORS" in the disclaimer read "REGENTS AND CONTRIBUTORS".
+
+Here is the license template:
+
+Copyright (c) 2012, Oisin Hurley
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  

data/README.md

@@ -0,0 +1,68 @@
+[![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)
+
+## Irish Rail API Ruby Wrapper
+
+I wrote most of this on the train, as is appropriate. 
+
+It's a trivial wrapper for the Irish Rail real time (whut?) train times system, in Ruby. It uses the HTTP GET API that was thankfully supplied along with the more *interesting* SOAP API, so a tiddly simple set up with [RestClient](https://github.com/archiloque/rest-client) and [Nokogiri](http://nokogiri.org/) (two of my favourite things ever) to pull and process the XML data into Hashes for great value.
+
+## Usage
+
+### Grab the IERail gem
+
+
+`$ gem install ierail`
+
+<pre><code>require 'ierail'
+
+ir = IERail.new
+</code></pre>
+
+### Find all Southbound trains serving Clongriffin station
+
+<pre><code>trains = ir.southbound_from('clongriffin')</code></pre>
+
+### Find all trains serving Clongriffin in the next 30 minutes
+
+<pre><code>trains = ir.station_times('clongriffin', 30)
+
+trains.each { |t| puts t.inspect }
+</code></pre>
+
+### Find all Northbound trains serving Clongriffin before / after a certain time
+
+<pre><code>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>
+
+### Find out information for a specific train
+
+<pre><code>trains = ir.station('clongriffin', 60)
+
+trains.first.last_location # "Arrived Harmonstown"
+
+trains.first.origin # {:name=>"Greystones", :time=>"07:30"}
+
+trains.first.destination # {:name=>"Malahide", :time=>"08:49"}
+
+trains.first.arrival # {:scheduled=>"08:40", :expected=>"08:41"}
+
+trains.first.departure # {:scheduled=>"08:41", :expected=>"08:41"}
+
+trains.first.duein # "2"
+
+trains.first.late? # 0 || 1
+</code></pre>
+
+Check the **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.

data/Rakefile

@@ -0,0 +1,9 @@
+task :default => :test
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test" 
+  t.test_files = FileList['test/unit/*.rb']
+  t.verbose = true
+end

data/ierail.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = 'ierail'
+  s.version     = '0.3.2'
+  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.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'
+end

data/lib/core_ext.rb

@@ -0,0 +1,21 @@
+class Array
+  #Filters elements, collecting those
+  #whose times are before _time_
+  def before time
+    select {|t| Time.parse(t.expdepart) <= Time.parse(time) }
+  end
+
+  #Filters elements, collecting those
+  #whose times are after _time_
+  def after time
+    select {|t| Time.parse(t.expdepart) >= Time.parse(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
+    future_time = Time.now + (time * 60)
+    before "#{future_time.hour}:#{future_time.min}"
+  end
+end

data/lib/ierail.rb

@@ -1,9 +1,12 @@
 require 'rest-client'
 require 'nokogiri'
+require 'uri'
+require 'time'
 
 require 'train'
 require 'station'
 require 'station_data'
+require 'core_ext'
 
 class IERail
   
@@ -14,7 +17,7 @@ class IERail
     attr_reader :result
     
     def initialize(url, array_name, object_name)
-      @ws_url = url
+      @ws_url = URI.encode(url)
       @ws_array_name = array_name.downcase
       @ws_object_name = object_name.downcase
     end

data/lib/station_data.rb

@@ -1,7 +1,7 @@
 class StationData
   attr_reader :servertime, :traincode, :station_name, :station_code,
               :status, :last_location, :duein, :late, 
-              :train_type, :direction, :query_time, :train_date
+              :train_type, :direction, :query_time, :train_date, :expdepart
 
   def initialize hash
     @servertime       = hash['Servertime']

data/main.rb

@@ -0,0 +1,31 @@
+$: << File.expand_path(File.join(File.dirname(__FILE__), "lib"))
+
+require 'ierail'
+
+ir = IERail.new
+
+# List all the stations in the system
+#
+# puts ir.stations.sample.name
+
+# List all of the trains that are buzzing around at the moment
+# and what they are up to
+#
+# puts ir.trains.sample.direction
+
+# What's the story out in Glenageary station?
+#
+# puts ir.station("Glenageary").sample.arrival[:expected]
+
+# Trains due in and out of Glenageary in the next 30 minutes
+#
+# puts ir.station_times("Glenageary", 30).sample.late?
+
+# Find stations that match the string partial
+#
+stations = ir.find_station("gl")
+
+candidates = []
+stations.each { |ks| candidates << ks.name }
+
+puts candidates.inspect

data/test/unit/helper.rb

@@ -0,0 +1,8 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start

data/test/unit/ierail.rb

@@ -0,0 +1,53 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
+
+require_relative 'helper'
+
+require 'minitest/autorun'
+require 'ierail'
+
+class IERailTest < MiniTest::Unit::TestCase
+  def setup
+    @ir = IERail.new
+  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'
+  end
+
+  def test_that_an_empty_array_is_returned_when_no_data
+    nonexistant = @ir.westbound_from('Clongriffin')
+    assert_empty nonexistant
+  end
+
+  def test_that_the_before_time_constraint_works
+    #Thirty minutes from now
+    thirty_mins = Time.now + 60*30
+    time = "#{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
+    before_train = @ir.southbound_from('Malahide').before(time).sample
+    assert Time.parse(before_train.expdepart) <= thirty_mins
+  end
+
+  def test_that_the_after_time_constraint_works
+    #Thirty minutes from now
+    thirty_mins = Time.now + 60*30
+    time = "#{thirty_mins.hour}:#{thirty_mins.min}" # "HH:MM"
+    after_train = @ir.southbound_from('Malahide').after(time).sample
+    assert Time.parse(after_train.expdepart) >= thirty_mins
+  end
+
+  def test_that_the_in_constraint_works
+    mins = 30
+    thirty_mins = Time.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
+    }
+  end
+end

data/test/unit/station.rb

@@ -0,0 +1,43 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
+
+require_relative 'helper'
+
+require 'minitest/autorun'
+require 'ierail'
+
+class StationTest < MiniTest::Unit::TestCase
+  def setup
+    ir = IERail.new
+    @station = ir.stations.sample #Use a random station
+  end
+
+  def test_that_a_station_has_a_description
+    refute_empty @station.description
+  end
+
+  def test_that_a_station_responds_to_name_alias
+    assert_respond_to @station, :name
+    assert_equal @station.name, @station.description
+  end
+
+  def test_that_a_station_has_a_location
+    refute_empty @station.location
+  end
+
+  def test_that_a_stations_locations_is_an_array
+    assert_equal @station.location.class, Array
+  end
+
+  def test_that_a_stations_location_contains_two_values
+    assert_equal @station.location.size, 2
+  end
+
+  def test_that_a_station_has_a_code
+    refute_empty @station.code
+  end
+
+  def test_that_a_stations_has_an_id
+    refute_empty @station.id
+  end
+end
+

data/test/unit/station_data.rb

@@ -0,0 +1,82 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
+
+require_relative 'helper'
+
+require 'minitest/autorun'
+require 'ierail'
+
+class StationDataTest < MiniTest::Unit::TestCase
+  def setup
+    ir = IERail.new
+    @station_data = ir.station('Glenageary').sample
+  end
+
+  def test_that_there_is_a_traincode
+    refute_empty @station_data.traincode
+  end
+
+  def test_that_there_is_a_station_name_and_code
+    refute_empty @station_data.name
+    refute_empty @station_data.code
+  end
+
+  def test_that_there_is_a_status
+    refute_empty @station_data.status
+  end
+
+  def test_that_there_is_a_due_value
+   refute_empty @station_data.due_in
+  end
+
+  def test_that_there_is_a_late_value
+    refute_empty @station_data.late
+  end
+
+  def test_that_there_is_a_query_time
+    refute_empty @station_data.query_time
+  end
+
+  def test_that_there_is_a_train_date
+    refute_empty @station_data.train_date
+  end
+
+  def test_that_origin_method_returns_a_hash
+    assert_equal @station_data.origin.class, Hash
+  end  
+  
+  def test_that_there_is_an_origin_name_and_time
+    refute_empty @station_data.origin[:name]
+    refute_empty @station_data.origin[:time]
+  end
+
+  def test_that_destination_method_returns_a_hash
+    assert_equal @station_data.destination.class, Hash
+  end
+
+  def test_that_there_is_a_destination_name_and_time
+    refute_empty @station_data.destination[:name]
+    refute_empty @station_data.destination[:time]
+  end
+
+  def test_that_arrival_method_returns_a_hash
+    assert_equal @station_data.arrival.class, Hash
+  end
+
+  def test_that_there_is_an_arrival_sched_and_exp
+    refute_empty @station_data.arrival[:scheduled]
+    refute_empty @station_data.arrival[:expected]
+  end
+
+  def test_that_departure_method_returns_a_hash
+    assert_equal @station_data.departure.class, Hash
+  end
+
+  def test_that_there_is_a_departure_sched_and_exp
+    refute_empty @station_data.departure[:scheduled]
+    refute_empty @station_data.departure[:expected]
+  end
+
+  def test_that_it_responds_to_late?
+    assert_respond_to @station_data, :late? 
+  end
+end 

data/test/unit/train.rb

@@ -0,0 +1,46 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..','..', 'lib'))
+
+require_relative 'helper'
+
+require 'minitest/autorun'
+require 'ierail'
+
+class TrainTest < MiniTest::Unit::TestCase
+  def setup
+    ir = IERail.new
+    @train = ir.trains.sample #Use a random train
+  end
+
+  def test_that_a_train_has_status
+    refute_empty @train.status
+  end
+
+  def test_that_a_train_has_a_location
+    refute_empty @train.location
+  end
+
+  def test_that_a_trains_location_is_an_array
+    assert_equal @train.location.class, Array
+  end
+
+  def test_that_the_location_array_contains_only_two_values
+    assert_equal @train.location.size, 2
+  end
+
+  def test_that_a_train_has_a_code
+    refute_empty @train.code
+  end
+
+  def test_that_a_train_has_a_date
+    refute_empty @train.date
+  end
+
+  def test_that_a_train_has_a_message
+    refute_empty @train.message
+  end
+
+  def test_that_a_train_has_a_direction
+    refute_empty @train.direction
+  end
+
+end

metadata

@@ -1,60 +1,106 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ierail
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: "0.3"
+version: !ruby/object:Gem::Version
+  version: 0.3.2
 platform: ruby
-authors: 
+authors:
 - Oisin Hurley
 - Gary Rafferty
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-09 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
+date: 2013-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !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.5.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !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.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !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.7.7
 description: Irish Rail Train Schedule and Status API
 email: oi.sin@nis.io
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ierail.gemspec
+- lib/core_ext.rb
 - lib/ierail.rb
 - lib/station.rb
 - lib/station_data.rb
 - lib/train.rb
-has_rdoc: true
+- main.rb
+- test/unit/helper.rb
+- test/unit/ierail.rb
+- test/unit/station.rb
+- test/unit/station_data.rb
+- test/unit/train.rb
 homepage: http://rubygems.org/gems/ierail
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+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: 1.6.2
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Irish Rail Train Schedule and Status API
 test_files: []
-
+has_rdoc: