ruby-irail 0.2.1 → 0.3.0

data/README.md

@@ -40,6 +40,10 @@ train_stations = irail.stations
 origin      = train_stations.first
 destination = train_stations.last
 irail.connections(origin, destination)
+
+#get train trip information (all stops for a train)
+
+irail.vehicle("BE.NMBS.IC2240") # the vehicle ids cans be found when querying for a connection
 ```
 
 ## Contributing

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

@@ -3,6 +3,7 @@ module IRail::API
     API_URL         = "http://api.irail.be"
     STATIONS_URI    = "stations/"
     CONNECTIONS_URI = "connections/"
+    VEHICLE_URI     = "vehicle/"
 
     def stations(options = {})
       station_list_url = build_station_list_url
@@ -16,9 +17,10 @@ module IRail::API
       IRail::NMBS::DocumentParser.parse_connections(xml_connections)
     end
 
-    def get_connections(connections_url, origin_station, destination_station, options = {})
-      options = build_connections_option_hash(origin_station, destination_station, options)
-      IRail::Request.get(connections_url, options)
+    def vehicle(vehicle_id, options = {})
+      vehicle_url = build_vehicle_url
+      xml_vehicle = get_vehicle(vehicle_url, vehicle_id, options)
+      IRail::NMBS::DocumentParser.parse_vehicle(xml_vehicle)
     end
 
     def get_station_list(station_list_url, options = {})
@@ -26,6 +28,16 @@ module IRail::API
       IRail::Request.get(station_list_url, options)
     end
 
+    def get_connections(connections_url, origin_station, destination_station, options = {})
+      options = build_connections_option_hash(origin_station, destination_station, options)
+      IRail::Request.get(connections_url, options)
+    end
+
+    def get_vehicle(vehicle_url, vehicle_id, options = {})
+      options = build_vehicle_option_hash(vehicle_id, options)
+      IRail::Request.get(vehicle_url, options)
+    end
+
     private
     def build_connections_option_hash(origin_station, destination_station, options = {})
       {
@@ -36,6 +48,14 @@ module IRail::API
       }
     end
 
+    def build_vehicle_option_hash(vehicle_id, options = {})
+      {
+        :query => options.merge({
+          :id => vehicle_id
+        })
+      }
+    end
+
     def build_station_list_url
       [API_URL, STATIONS_URI].join('/')
     end
@@ -43,5 +63,9 @@ module IRail::API
     def build_connections_url
       [API_URL, CONNECTIONS_URI].join('/')
     end
+
+    def build_vehicle_url
+      [API_URL, VEHICLE_URI].join('/')
+    end
   end
 end

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

@@ -9,12 +9,14 @@ module IRail::NMBS
 
     xml_name "via"
 
-    xml_accessor :id,        :from => "@id", :as => Integer
+    xml_accessor :id,        :from => "@id",    :as => Integer
+    xml_accessor :delay,     :from => "@delay", :as => Integer
     xml_accessor :station,   :as   => Station
     xml_accessor :vehicle,   :as   => Vehicle
     xml_accessor :arrival,   :as   => Step, :from => "arrival"
     xml_accessor :departure, :as   => Step, :from => "departure"
     xml_accessor :direction, :as   => Station
     xml_reader   :wait_time, :from => "timeBetween", :as => Integer
+    xml_accessor :unix_time, :from => "time",        :as => UnixTime
   end
 end

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

@@ -0,0 +1,12 @@
+require "roxml"
+require_relative "./vehicle.rb"
+require_relative "./vehicle_trip.rb"
+
+module IRail::NMBS
+  class VehicleInformation
+    include ROXML
+
+    xml_accessor :vehicle, :as   => Vehicle
+    xml_accessor :trip,    :from => "stops", :as => VehicleTrip
+  end
+end

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

@@ -0,0 +1,13 @@
+require "roxml"
+require_relative "./stopover.rb"
+
+module IRail::NMBS
+  class VehicleTrip
+    include ROXML
+
+    xml_name 'stops'
+
+    xml_accessor :stop_count, :from => "@number", :as => Integer
+    xml_accessor :stops,      :from => "stop",    :as => [Stopover]
+  end
+end

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

@@ -2,6 +2,7 @@ module IRail::NMBS
   class DocumentParser
     STATION_XPATH    = "//station"
     CONNECTION_XPATH = "//connection"
+    VEHICLE_XPATH    = "//vehicleinformation"
 
     def self.parse_stations(xml_string)
       xml_stations(xml_string).inject([]) do |stations, xml_station|
@@ -15,6 +16,16 @@ module IRail::NMBS
       end
     end
 
+    def self.parse_vehicle(xml_string)
+      vehicle = xml_vehicle(xml_string)
+      IRail::NMBS::VehicleInformation.from_xml(vehicle.to_s)
+    end
+
+    def self.xml_vehicle(xml_string)
+      xml_payload = Nokogiri::XML(xml_string)
+      xml_payload.xpath(VEHICLE_XPATH)
+    end
+
     def self.xml_stations(xml_string)
       xml_payload = Nokogiri::XML(xml_string)
       xml_payload.xpath(STATION_XPATH)

data/lib/version.rb

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

data/spec/packages/nmbs/api_spec.rb

@@ -32,6 +32,34 @@ describe IRail::API::NMBS do
     end
   end
 
+  describe :vehicle do
+    let(:vehicle_id)  { mock("Vehicle id") }
+    let(:vehicle_url) { mock("Vehicle url") }
+    let(:xml_vehicle) { mock("Xml vehicle") }
+    let(:vehicle)     { mock("vehicle") }
+    let(:options)     { mock("Options") }
+
+    before :each do
+      irail.stub(:build_vehicle_url => vehicle_url)
+      irail.stub(:get_vehicle => xml_vehicle)
+      IRail::NMBS::DocumentParser.stub(:parse_vehicle => vehicle)
+    end
+
+    it "builds the vehicle url" do
+      irail.should_receive(:build_vehicle_url)
+      irail.vehicle(vehicle_id)
+    end
+
+    it "gets the vehicle" do
+      irail.should_receive(:get_vehicle).with(vehicle_url, vehicle_id, options)
+      irail.vehicle(vehicle_id, options)
+    end
+
+    it "returns the parsed vehicle" do
+      irail.vehicle(vehicle_id, options).should eql vehicle
+    end
+  end
+
   describe :stations do
     let(:station_list_url) { mock("Url") }
     let(:xml_station_list) { mock("Xml station list") }

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

@@ -7,6 +7,10 @@ describe IRail::NMBS::Stopover do
     stopover.should respond_to(:id)
   end
 
+  it "has a delay" do
+    stopover.should respond_to(:delay)
+  end
+
   it "has a station" do
     stopover.should respond_to(:station)
   end
@@ -30,4 +34,8 @@ describe IRail::NMBS::Stopover do
   it "has a wait time in seconds" do
     stopover.should respond_to(:wait_time)
   end
+
+  it "has a unix time" do
+    stopover.should respond_to(:unix_time)
+  end
 end

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

@@ -0,0 +1,13 @@
+require_relative '../../../../lib/ruby-irail/packages/nmbs/models/vehicle_information.rb'
+
+describe IRail::NMBS::VehicleInformation do
+  let(:vehicle_information) { IRail::NMBS::VehicleInformation.new }
+
+  it "has a vehicle" do
+    vehicle_information.should respond_to(:vehicle)
+  end
+
+  it "has a trip" do
+    vehicle_information.should respond_to(:trip)
+  end
+end

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

@@ -0,0 +1,13 @@
+require_relative '../../../../lib/ruby-irail/packages/nmbs/models/vehicle_trip.rb'
+
+describe IRail::NMBS::VehicleTrip do
+  let(:vehicle_trip) { IRail::NMBS::VehicleTrip.new }
+
+  it "has a count of the number of stops" do
+    vehicle_trip.should respond_to(:stop_count)
+  end
+
+  it "has many stops" do
+    vehicle_trip.should respond_to(:stops)
+  end
+end

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

@@ -77,4 +77,36 @@ describe IRail::NMBS::DocumentParser do
       IRail::NMBS::DocumentParser.parse_connections(xml_string).size.should eql connections.size
     end
   end
+
+  describe :'self.parse_vehicle' do
+    let(:xml_string)       { mock("Xml string") }
+    let(:xml_payload)      { mock("Xml payload") }
+    let(:vehicle)          { mock("Vehicle") }
+    let(:vehicle_instance) { mock("Vehicle instance") }
+
+    before :each do
+      Nokogiri.stub(:XML => xml_payload)
+      xml_payload.stub(:xpath => vehicle)
+      IRail::NMBS::VehicleInformation.stub(:from_xml => vehicle_instance)
+    end
+
+    it "gets the xml payload from the string passed as parameter" do
+      Nokogiri.should_receive(:XML).with(xml_string)
+      IRail::NMBS::DocumentParser.parse_vehicle(xml_string)
+    end
+
+    it "extracts the vehicle from the xml payload" do
+      xml_payload.should_receive(:xpath).with(IRail::NMBS::DocumentParser::VEHICLE_XPATH)
+      IRail::NMBS::DocumentParser.parse_vehicle(xml_string)
+    end
+
+    it "creates a new vehicle for the parsed vehicle attributes" do
+      IRail::NMBS::VehicleInformation.should_receive(:from_xml).with(vehicle.to_s)
+      IRail::NMBS::DocumentParser.parse_vehicle(xml_string)
+    end
+
+    it "returns a vehicule instance" do
+      IRail::NMBS::DocumentParser.parse_vehicle(xml_string).should eql vehicle_instance
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-irail
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70214013650340 !ruby/object:Gem::Requirement
+  requirement: &70168325071420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70214013650340
+  version_requirements: *70168325071420
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70214013649860 !ruby/object:Gem::Requirement
+  requirement: &70168325071000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70214013649860
+  version_requirements: *70168325071000
 - !ruby/object:Gem::Dependency
   name: roxml
-  requirement: &70214013649380 !ruby/object:Gem::Requirement
+  requirement: &70168325070580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70214013649380
+  version_requirements: *70168325070580
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70214013648800 !ruby/object:Gem::Requirement
+  requirement: &70168325070140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70214013648800
+  version_requirements: *70168325070140
 description: IRail makes Belgian railway schedule easily available for anyone. This
   is a Ruby wrapper for their API.
 email:
@@ -86,6 +86,8 @@ files:
 - lib/ruby-irail/packages/nmbs/models/trip.rb
 - lib/ruby-irail/packages/nmbs/models/unix_time.rb
 - lib/ruby-irail/packages/nmbs/models/vehicle.rb
+- lib/ruby-irail/packages/nmbs/models/vehicle_information.rb
+- lib/ruby-irail/packages/nmbs/models/vehicle_trip.rb
 - lib/ruby-irail/packages/nmbs/parser/document_parser.rb
 - lib/version.rb
 - ruby-irail.gemspec
@@ -102,7 +104,9 @@ files:
 - spec/packages/nmbs/models/stopover_spec.rb
 - spec/packages/nmbs/models/trip_spec.rb
 - spec/packages/nmbs/models/unix_time_spec.rb
+- spec/packages/nmbs/models/vehicle_information_spec.rb
 - spec/packages/nmbs/models/vehicle_spec.rb
+- spec/packages/nmbs/models/vehicle_trip_spec.rb
 - spec/packages/nmbs/parser/document_parser_spec.rb
 homepage: https://github.com/mlainez/ruby-irail
 licenses: []
@@ -142,5 +146,7 @@ test_files:
 - spec/packages/nmbs/models/stopover_spec.rb
 - spec/packages/nmbs/models/trip_spec.rb
 - spec/packages/nmbs/models/unix_time_spec.rb
+- spec/packages/nmbs/models/vehicle_information_spec.rb
 - spec/packages/nmbs/models/vehicle_spec.rb
+- spec/packages/nmbs/models/vehicle_trip_spec.rb
 - spec/packages/nmbs/parser/document_parser_spec.rb