ruby-irail 0.3.0 → 0.4.0

data/lib/ruby-irail/packages/nmbs/api.rb

@@ -4,6 +4,7 @@ module IRail::API
     STATIONS_URI    = "stations/"
     CONNECTIONS_URI = "connections/"
     VEHICLE_URI     = "vehicle/"
+    LIVEBOARD_URI   = "liveboard/"
 
     def stations(options = {})
       station_list_url = build_station_list_url
@@ -23,6 +24,18 @@ module IRail::API
       IRail::NMBS::DocumentParser.parse_vehicle(xml_vehicle)
     end
 
+    def departures(station_id, options = {})
+      liveboard_url  = build_liveboard_url
+      xml_departures = get_departures(liveboard_url, station_id, options)
+      IRail::NMBS::DocumentParser.parse_liveboard(xml_departures)
+    end
+
+    def arrivals(station_id, options = {})
+      liveboard_url = build_liveboard_url
+      xml_arrivals  = get_arrivals(liveboard_url, station_id, options)
+      IRail::NMBS::DocumentParser.parse_liveboard(xml_arrivals)
+    end
+
     def get_station_list(station_list_url, options = {})
       options = { :query => options } if options.any?
       IRail::Request.get(station_list_url, options)
@@ -38,6 +51,16 @@ module IRail::API
       IRail::Request.get(vehicle_url, options)
     end
 
+    def get_departures(liveboard_url, station_id, options = {})
+      options = build_departures_option_hash(station_id, options)
+      IRail::Request.get(liveboard_url, options)
+    end
+
+    def get_arrivals(liveboard_url, station_id, options = {})
+      options = build_arrivals_option_hash(station_id, options)
+      IRail::Request.get(liveboard_url, options)
+    end
+
     private
     def build_connections_option_hash(origin_station, destination_station, options = {})
       {
@@ -56,6 +79,24 @@ module IRail::API
       }
     end
 
+    def build_departures_option_hash(station_id, options = {})
+      {
+        :query => options.merge({
+          :id     => station_id,
+          :arrdep => "DEP"
+        })
+      }
+    end
+
+    def build_arrivals_option_hash(station_id, options = {})
+      {
+        :query => options.merge({
+          :id     => station_id,
+          :arrdep => "ARR"
+        })
+      }
+    end
+
     def build_station_list_url
       [API_URL, STATIONS_URI].join('/')
     end
@@ -67,5 +108,9 @@ module IRail::API
     def build_vehicle_url
       [API_URL, VEHICLE_URI].join('/')
     end
+
+    def build_liveboard_url
+      [API_URL, LIVEBOARD_URI].join('/')
+    end
   end
 end

data/lib/ruby-irail/packages/nmbs/models/liveboard.rb

@@ -0,0 +1,13 @@
+require "roxml"
+
+module IRail::NMBS
+  class Liveboard
+    include ROXML
+
+    xml_name 'liveboard'
+
+    xml_accessor :station,         :as   => Station
+    xml_accessor :departures,      :from => "departures/departure", :as => [Step]
+    xml_accessor :arrivals,        :from => "arrivals/arrival",     :as => [Step]
+  end
+end

data/lib/ruby-irail/packages/nmbs/parser/document_parser.rb

@@ -21,6 +21,10 @@ module IRail::NMBS
       IRail::NMBS::VehicleInformation.from_xml(vehicle.to_s)
     end
 
+    def self.parse_liveboard(xml_string)
+      IRail::NMBS::Liveboard.from_xml(xml_string)
+    end
+
     def self.xml_vehicle(xml_string)
       xml_payload = Nokogiri::XML(xml_string)
       xml_payload.xpath(VEHICLE_XPATH)

data/lib/version.rb

@@ -1,3 +1,3 @@
 module IRail
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/packages/nmbs/api_spec.rb

@@ -87,6 +87,62 @@ describe IRail::API::NMBS do
     end
   end
 
+  describe :departures do
+    let(:liveboard_url)  { mock("Url") }
+    let(:station_id)     { mock("Station id") }
+    let(:options)        { mock("Options") }
+    let(:liveboard)      { mock("Liveboard") }
+    let(:xml_departures) { mock("Xml departures") }
+
+    before :each do
+      irail.stub(:build_liveboard_url => liveboard_url)
+      irail.stub(:get_departures => xml_departures)
+      IRail::NMBS::DocumentParser.stub(:parse_liveboard => liveboard)
+    end
+
+    it "builds the liveboard url" do
+      irail.should_receive(:build_liveboard_url)
+      irail.departures(station_id, options)
+    end
+
+    it "gets the departures xml" do
+      irail.should_receive(:get_departures).with(liveboard_url, station_id, options)
+      irail.departures(station_id, options)
+    end
+
+    it "returns the liveboard" do
+      irail.departures(station_id, options).should eql liveboard
+    end
+  end
+
+  describe :arrivals do
+    let(:liveboard_url)  { mock("Url") }
+    let(:station_id)     { mock("Station id") }
+    let(:options)        { mock("Options") }
+    let(:liveboard)      { mock("Liveboard") }
+    let(:xml_arrivals)   { mock("Xml arrivals") }
+
+    before :each do
+      irail.stub(:build_liveboard_url => liveboard_url)
+      irail.stub(:get_arrivals => xml_arrivals)
+      IRail::NMBS::DocumentParser.stub(:parse_liveboard => liveboard)
+    end
+
+    it "builds the liveboard url" do
+      irail.should_receive(:build_liveboard_url)
+      irail.arrivals(station_id, options)
+    end
+
+    it "gets the arrivals xml" do
+      irail.should_receive(:get_arrivals).with(liveboard_url, station_id, options)
+      irail.arrivals(station_id, options)
+    end
+
+    it "returns the parsed departures" do
+      irail.arrivals(station_id, options).should eql liveboard
+    end
+  end
+
   describe :get_connections do
     let(:origin_station)      { mock("Origin station") }
     let(:destination_station) { mock("Destination station") }
@@ -115,6 +171,60 @@ describe IRail::API::NMBS do
     end
   end
 
+  describe :get_departures do
+    let(:station_id)    { mock("Station id") }
+    let(:options)       { mock("Options") }
+    let(:liveboard_url) { mock("Liveboard url") }
+    let(:options_hash)  { mock("Options hash") }
+    let(:response)      { mock("Response") }
+
+    before :each do
+      irail.stub(:build_departures_option_hash => options_hash)
+      IRail::Request.stub(:get => response)
+    end
+
+    it "builds the options hash" do
+      irail.should_receive(:build_departures_option_hash).with(station_id, options)
+      irail.get_departures(liveboard_url, station_id, options)
+    end
+
+    it "calls the connections url through a get request" do
+      IRail::Request.should_receive(:get).with(liveboard_url, options_hash)
+      irail.get_departures(liveboard_url, station_id, options)
+    end
+
+    it "returns the response" do
+      irail.get_departures(liveboard_url, station_id, options).should eql response
+    end
+  end
+
+  describe :get_arrivals do
+    let(:station_id)    { mock("Station id") }
+    let(:options)       { mock("Options") }
+    let(:liveboard_url) { mock("Liveboard url") }
+    let(:options_hash)  { mock("Options hash") }
+    let(:response)      { mock("Response") }
+
+    before :each do
+      irail.stub(:build_arrivals_option_hash => options_hash)
+      IRail::Request.stub(:get => response)
+    end
+
+    it "builds the options hash" do
+      irail.should_receive(:build_arrivals_option_hash).with(station_id, options)
+      irail.get_arrivals(liveboard_url, station_id, options)
+    end
+
+    it "calls the connections url through a get request" do
+      IRail::Request.should_receive(:get).with(liveboard_url, options_hash)
+      irail.get_arrivals(liveboard_url, station_id, options)
+    end
+
+    it "returns the response" do
+      irail.get_arrivals(liveboard_url, station_id, options).should eql response
+    end
+  end
+
   describe :get_station_list do
     let(:url)      { mock("Url") }
     let(:response) { mock("Response") }

data/spec/packages/nmbs/models/liveboard_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../../../../lib/ruby-irail/packages/nmbs/models/liveboard.rb'
+
+describe IRail::NMBS::Liveboard do
+  let(:liveboard) { IRail::NMBS::Liveboard.new }
+
+  it "has a station" do
+    liveboard.should respond_to(:station)
+  end
+
+  it "has many departures" do
+    liveboard.should respond_to(:departures)
+  end
+
+  it "has many arrivals" do
+    liveboard.should respond_to(:arrivals)
+  end
+end

data/spec/packages/nmbs/parser/document_parser_spec.rb

@@ -12,6 +12,9 @@ describe IRail::NMBS::DocumentParser do
   class IRail::NMBS::Connection
   end
 
+  class IRail::NMBS::Liveboard
+  end
+
   describe :'self.parse_stations' do
     let(:xml_string)  { mock("Xml string") }
     let(:xml_payload) { mock("Xml payload") }
@@ -109,4 +112,23 @@ describe IRail::NMBS::DocumentParser do
       IRail::NMBS::DocumentParser.parse_vehicle(xml_string).should eql vehicle_instance
     end
   end
+
+  describe :'self.parse_liveboard' do
+    let(:xml_string)         { mock("Xml string") }
+    let(:liveboard)          { mock("Loveboard") }
+    let(:liveboard_instance) { mock("Liveboard instance") }
+
+    before :each do
+      IRail::NMBS::Liveboard.stub(:from_xml => liveboard_instance)
+    end
+
+    it "creates a liveboard from the xml payload" do
+      IRail::NMBS::Liveboard.should_receive(:from_xml).with(xml_string)
+      IRail::NMBS::DocumentParser.parse_liveboard(xml_string)
+    end
+
+    it "returns a liveboard instance" do
+      IRail::NMBS::DocumentParser.parse_liveboard(xml_string).should eql liveboard_instance
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-irail
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000Z
+date: 2012-07-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70168325071420 !ruby/object:Gem::Requirement
+  requirement: &70221051588820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70168325071420
+  version_requirements: *70221051588820
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70168325071000 !ruby/object:Gem::Requirement
+  requirement: &70221051588400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70168325071000
+  version_requirements: *70221051588400
 - !ruby/object:Gem::Dependency
   name: roxml
-  requirement: &70168325070580 !ruby/object:Gem::Requirement
+  requirement: &70221051587980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70168325070580
+  version_requirements: *70221051587980
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70168325070140 !ruby/object:Gem::Requirement
+  requirement: &70221051587560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70168325070140
+  version_requirements: *70221051587560
 description: IRail makes Belgian railway schedule easily available for anyone. This
   is a Ruby wrapper for their API.
 email:
@@ -79,6 +79,7 @@ files:
 - lib/ruby-irail/packages/mivbstib/parser/station_parser.rb
 - lib/ruby-irail/packages/nmbs/api.rb
 - lib/ruby-irail/packages/nmbs/models/connection.rb
+- lib/ruby-irail/packages/nmbs/models/liveboard.rb
 - lib/ruby-irail/packages/nmbs/models/platform.rb
 - lib/ruby-irail/packages/nmbs/models/station.rb
 - lib/ruby-irail/packages/nmbs/models/step.rb
@@ -98,6 +99,7 @@ files:
 - spec/packages/mivbstib/parser/station_parser_spec.rb
 - spec/packages/nmbs/api_spec.rb
 - spec/packages/nmbs/models/connection_spec.rb
+- spec/packages/nmbs/models/liveboard_spec.rb
 - spec/packages/nmbs/models/platform_spec.rb
 - spec/packages/nmbs/models/station_spec.rb
 - spec/packages/nmbs/models/step_spec.rb
@@ -140,6 +142,7 @@ test_files:
 - spec/packages/mivbstib/parser/station_parser_spec.rb
 - spec/packages/nmbs/api_spec.rb
 - spec/packages/nmbs/models/connection_spec.rb
+- spec/packages/nmbs/models/liveboard_spec.rb
 - spec/packages/nmbs/models/platform_spec.rb
 - spec/packages/nmbs/models/station_spec.rb
 - spec/packages/nmbs/models/step_spec.rb