network_rail 0.0.1.alpha

data/spec/fixtures/train_movements.json

@@ -0,0 +1,412 @@
+[
+   {
+      "header":{
+         "msg_type":"0003",
+         "source_dev_id":"",
+         "user_id":"",
+         "original_data_source":"SMART",
+         "msg_queue_timestamp":"1364295570000",
+         "source_system_id":"TRUST"
+      },
+      "body":{
+         "event_type":"ARRIVAL",
+         "gbtt_timestamp":"",
+         "original_loc_stanox":"",
+         "planned_timestamp":"1364295630000",
+         "timetable_variation":"0",
+         "original_loc_timestamp":"",
+         "current_train_id":"",
+         "delay_monitoring_point":"true",
+         "next_report_run_time":"1",
+         "reporting_stanox":"87171",
+         "actual_timestamp":"1364295600000",
+         "correction_ind":"false",
+         "event_source":"AUTOMATIC",
+         "train_file_address":null,
+         "platform":"",
+         "division_code":"84",
+         "train_terminated":"false",
+         "train_id":"821L30ME26",
+         "offroute_ind":"false",
+         "variation_status":"ON TIME",
+         "train_service_code":"24623104",
+         "toc_id":"84",
+         "loc_stanox":"87171",
+         "auto_expected":"true",
+         "direction_ind":"",
+         "route":"0",
+         "planned_event_type":"ARRIVAL",
+         "next_report_stanox":"87169",
+         "line_ind":""
+      }
+   },
+   {
+      "header":{
+         "msg_type":"0003",
+         "source_dev_id":"",
+         "user_id":"",
+         "original_data_source":"SMART",
+         "msg_queue_timestamp":"1364295571000",
+         "source_system_id":"TRUST"
+      },
+      "body":{
+         "event_type":"DEPARTURE",
+         "gbtt_timestamp":"1364295540000",
+         "original_loc_stanox":"",
+         "planned_timestamp":"1364295540000",
+         "timetable_variation":"0",
+         "original_loc_timestamp":"",
+         "current_train_id":"",
+         "delay_monitoring_point":"true",
+         "next_report_run_time":"14",
+         "reporting_stanox":"86921",
+         "actual_timestamp":"1364295540000",
+         "correction_ind":"false",
+         "event_source":"AUTOMATIC",
+         "train_file_address":null,
+         "platform":" 2",
+         "division_code":"84",
+         "train_terminated":"false",
+         "train_id":"861W12MG26",
+         "offroute_ind":"false",
+         "variation_status":"ON TIME",
+         "train_service_code":"24620104",
+         "toc_id":"84",
+         "loc_stanox":"86921",
+         "auto_expected":"true",
+         "direction_ind":"UP",
+         "route":"2",
+         "planned_event_type":"DEPARTURE",
+         "next_report_stanox":"86901",
+         "line_ind":""
+      }
+   },
+   {
+      "header":{
+         "msg_type":"0003",
+         "source_dev_id":"",
+         "user_id":"",
+         "original_data_source":"SMART",
+         "msg_queue_timestamp":"1364295572000",
+         "source_system_id":"TRUST"
+      },
+      "body":{
+         "event_type":"ARRIVAL",
+         "gbtt_timestamp":"1364295660000",
+         "original_loc_stanox":"",
+         "planned_timestamp":"1364295690000",
+         "timetable_variation":"2",
+         "original_loc_timestamp":"",
+         "current_train_id":"",
+         "delay_monitoring_point":"true",
+         "next_report_run_time":"6",
+         "reporting_stanox":"87214",
+         "actual_timestamp":"1364295540000",
+         "correction_ind":"false",
+         "event_source":"AUTOMATIC",
+         "train_file_address":null,
+         "platform":"",
+         "division_code":"84",
+         "train_terminated":"false",
+         "train_id":"875Y29MH26",
+         "offroute_ind":"false",
+         "variation_status":"EARLY",
+         "train_service_code":"24676004",
+         "toc_id":"84",
+         "loc_stanox":"87214",
+         "auto_expected":"true",
+         "direction_ind":"DOWN",
+         "route":"0",
+         "planned_event_type":"ARRIVAL",
+         "next_report_stanox":"87215",
+         "line_ind":""
+      }
+   },
+   {
+      "header":{
+         "msg_type":"0003",
+         "source_dev_id":"",
+         "user_id":"",
+         "original_data_source":"SMART",
+         "msg_queue_timestamp":"1364295574000",
+         "source_system_id":"TRUST"
+      },
+      "body":{
+         "event_type":"DEPARTURE",
+         "gbtt_timestamp":"1364295000000",
+         "original_loc_stanox":"",
+         "planned_timestamp":"1364295030000",
+         "timetable_variation":"9",
+         "original_loc_timestamp":"",
+         "current_train_id":"",
+         "delay_monitoring_point":"true",
+         "next_report_run_time":"4",
+         "reporting_stanox":"86341",
+         "actual_timestamp":"1364295540000",
+         "correction_ind":"false",
+         "event_source":"AUTOMATIC",
+         "train_file_address":null,
+         "platform":" 2",
+         "division_code":"84",
+         "train_terminated":"false",
+         "train_id":"871P23MF26",
+         "offroute_ind":"false",
+         "variation_status":"LATE",
+         "train_service_code":"24621104",
+         "toc_id":"84",
+         "loc_stanox":"86341",
+         "auto_expected":"true",
+         "direction_ind":"DOWN",
+         "route":"1",
+         "planned_event_type":"DEPARTURE",
+         "next_report_stanox":"86334",
+         "line_ind":""
+      }
+   },
+   {
+      "header":{
+         "msg_type":"0003",
+         "source_dev_id":"",
+         "user_id":"",
+         "original_data_source":"SMART",
+         "msg_queue_timestamp":"1364295574000",
+         "source_system_id":"TRUST"
+      },
+      "body":{
+         "event_type":"DEPARTURE",
+         "gbtt_timestamp":"1364295540000",
+         "original_loc_stanox":"",
+         "planned_timestamp":"1364295540000",
+         "timetable_variation":"0",
+         "original_loc_timestamp":"",
+         "current_train_id":"",
+         "delay_monitoring_point":"true",
+         "next_report_run_time":"3",
+         "reporting_stanox":"86311",
+         "actual_timestamp":"1364295540000",
+         "correction_ind":"false",
+         "event_source":"AUTOMATIC",
+         "train_file_address":null,
+         "platform":" 3",
+         "division_code":"84",
+         "train_terminated":"false",
+         "train_id":"861T38MH26",
+         "offroute_ind":"false",
+         "variation_status":"ON TIME",
+         "train_service_code":"24631204",
+         "toc_id":"84",
+         "loc_stanox":"86311",
+         "auto_expected":"true",
+         "direction_ind":"UP",
+         "route":"2",
+         "planned_event_type":"DEPARTURE",
+         "next_report_stanox":"86313",
+         "line_ind":"M"
+      }
+   },
+   {
+      "header":{
+         "msg_type":"0003",
+         "source_dev_id":"",
+         "user_id":"",
+         "original_data_source":"SMART",
+         "msg_queue_timestamp":"1364295575000",
+         "source_system_id":"TRUST"
+      },
+      "body":{
+         "event_type":"ARRIVAL",
+         "gbtt_timestamp":"1364295660000",
+         "original_loc_stanox":"",
+         "planned_timestamp":"1364295660000",
+         "timetable_variation":"1",
+         "original_loc_timestamp":"",
+         "current_train_id":"",
+         "delay_monitoring_point":"true",
+         "next_report_run_time":"2",
+         "reporting_stanox":"87135",
+         "actual_timestamp":"1364295600000",
+         "correction_ind":"false",
+         "event_source":"AUTOMATIC",
+         "train_file_address":null,
+         "platform":" 2",
+         "division_code":"84",
+         "train_terminated":"false",
+         "train_id":"742C94MF26",
+         "offroute_ind":"false",
+         "variation_status":"EARLY",
+         "train_service_code":"24672104",
+         "toc_id":"84",
+         "loc_stanox":"87135",
+         "auto_expected":"true",
+         "direction_ind":"UP",
+         "route":"0",
+         "planned_event_type":"ARRIVAL",
+         "next_report_stanox":"87149",
+         "line_ind":""
+      }
+   },
+   {
+      "header":{
+         "msg_type":"0003",
+         "source_dev_id":"",
+         "user_id":"",
+         "original_data_source":"SMART",
+         "msg_queue_timestamp":"1364295577000",
+         "source_system_id":"TRUST"
+      },
+      "body":{
+         "event_type":"ARRIVAL",
+         "gbtt_timestamp":"1364295540000",
+         "original_loc_stanox":"",
+         "planned_timestamp":"1364295510000",
+         "timetable_variation":"2",
+         "original_loc_timestamp":"",
+         "current_train_id":"",
+         "delay_monitoring_point":"true",
+         "next_report_run_time":"1",
+         "reporting_stanox":"87121",
+         "actual_timestamp":"1364295600000",
+         "correction_ind":"false",
+         "event_source":"AUTOMATIC",
+         "train_file_address":null,
+         "platform":" 2",
+         "division_code":"84",
+         "train_terminated":"false",
+         "train_id":"872U25MG26",
+         "offroute_ind":"false",
+         "variation_status":"LATE",
+         "train_service_code":"24671105",
+         "toc_id":"84",
+         "loc_stanox":"87121",
+         "auto_expected":"true",
+         "direction_ind":"DOWN",
+         "route":"0",
+         "planned_event_type":"ARRIVAL",
+         "next_report_stanox":"87117",
+         "line_ind":""
+      }
+   },
+   {
+      "header":{
+         "msg_type":"0003",
+         "source_dev_id":"",
+         "user_id":"",
+         "original_data_source":"SMART",
+         "msg_queue_timestamp":"1364295579000",
+         "source_system_id":"TRUST"
+      },
+      "body":{
+         "event_type":"ARRIVAL",
+         "gbtt_timestamp":"1364295780000",
+         "original_loc_stanox":"",
+         "planned_timestamp":"1364295750000",
+         "timetable_variation":"2",
+         "original_loc_timestamp":"",
+         "current_train_id":"",
+         "delay_monitoring_point":"true",
+         "next_report_run_time":"3",
+         "reporting_stanox":"86042",
+         "actual_timestamp":"1364295600000",
+         "correction_ind":"false",
+         "event_source":"AUTOMATIC",
+         "train_file_address":null,
+         "platform":"",
+         "division_code":"84",
+         "train_terminated":"false",
+         "train_id":"872L25MG26",
+         "offroute_ind":"false",
+         "variation_status":"EARLY",
+         "train_service_code":"24629204",
+         "toc_id":"84",
+         "loc_stanox":"86042",
+         "auto_expected":"true",
+         "direction_ind":"DOWN",
+         "route":"0",
+         "planned_event_type":"ARRIVAL",
+         "next_report_stanox":"86045",
+         "line_ind":"S"
+      }
+   },
+   {
+      "header":{
+         "msg_type":"0003",
+         "source_dev_id":"",
+         "user_id":"",
+         "original_data_source":"SMART",
+         "msg_queue_timestamp":"1364295579000",
+         "source_system_id":"TRUST"
+      },
+      "body":{
+         "event_type":"DEPARTURE",
+         "gbtt_timestamp":"",
+         "original_loc_stanox":"",
+         "planned_timestamp":"1364295600000",
+         "timetable_variation":"1",
+         "original_loc_timestamp":"",
+         "current_train_id":"",
+         "delay_monitoring_point":"false",
+         "next_report_run_time":"1",
+         "reporting_stanox":"00000",
+         "actual_timestamp":"1364295540000",
+         "correction_ind":"false",
+         "event_source":"AUTOMATIC",
+         "train_file_address":null,
+         "platform":"",
+         "division_code":"84",
+         "train_terminated":"false",
+         "train_id":"871T21ME26",
+         "offroute_ind":"false",
+         "variation_status":"EARLY",
+         "train_service_code":"24629204",
+         "toc_id":"84",
+         "loc_stanox":"86302",
+         "auto_expected":"true",
+         "direction_ind":"DOWN",
+         "route":"1",
+         "planned_event_type":"DEPARTURE",
+         "next_report_stanox":"86333",
+         "line_ind":""
+      }
+   },
+   {
+      "header":{
+         "msg_type":"0003",
+         "source_dev_id":"",
+         "user_id":"",
+         "original_data_source":"SMART",
+         "msg_queue_timestamp":"1364295580000",
+         "source_system_id":"TRUST"
+      },
+      "body":{
+         "event_type":"DEPARTURE",
+         "gbtt_timestamp":"",
+         "original_loc_stanox":"",
+         "planned_timestamp":"",
+         "timetable_variation":"0",
+         "original_loc_timestamp":"",
+         "current_train_id":"",
+         "delay_monitoring_point":"false",
+         "next_report_run_time":"",
+         "reporting_stanox":"",
+         "actual_timestamp":"1364295540000",
+         "correction_ind":"false",
+         "event_source":"AUTOMATIC",
+         "train_file_address":null,
+         "platform":"",
+         "division_code":"84",
+         "train_terminated":"false",
+         "train_id":"872B27MH26",
+         "offroute_ind":"true",
+         "variation_status":"OFF ROUTE",
+         "train_service_code":"24620204",
+         "toc_id":"84",
+         "loc_stanox":"86005",
+         "auto_expected":"",
+         "direction_ind":"",
+         "route":"",
+         "planned_event_type":"DEPARTURE",
+         "next_report_stanox":"",
+         "line_ind":""
+      }
+   }
+]

data/spec/network_rail/client_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe NetworkRail::Client do
+  before do
+    @stomp_client = stub("Stomp::Client",
+      open?: true,
+      protocol: Stomp::SPL_11,
+      connection_frame: stub(command: true),
+      subscribe: stub(true)
+    )
+  end
+
+  describe "#new" do
+    context "without login credentials" do
+      it "raises an exception" do
+        lambda {
+          client = described_class.new
+        }.should raise_exception(NetworkRail::Exception::NoLoginCredentials)
+      end
+    end
+
+    context "with login credentials" do
+      before(:all) do        
+        NetworkRail.configure do |config|
+          config.user_name = 'test'
+          config.password = 'test'
+        end
+      end
+      
+      it "passes the login credentials in the request" do
+        Stomp::Client.should_receive(:new).once do |options|
+          options[:hosts][0][:login].should == 'test'
+          options[:hosts][0][:passcode].should == 'test'
+        end.and_return(@stomp_client)
+        client = described_class.new
+      end
+      
+      context "after connection attempt" do
+        before(:each) do
+          Stomp::Client.stub(:new).and_return(@stomp_client)
+        end
+        
+        context "when there is a connection error" do
+          it "raises an exception" do
+            @stomp_client.stub(:open?).and_return(false)
+            lambda {
+              client = described_class.new
+            }.should raise_exception(NetworkRail::Exception::ConnectionError)
+          end
+        end
+
+        context "when there is an authentication error" do
+          it "raises an exception" do
+            @stomp_client.stub(:connection_frame).and_return(stub(command: Stomp::CMD_ERROR, body: "java.lang.SecurityException: User name [test] or password is invalid. (RuntimeError)"))
+            lambda {
+              client = described_class.new
+            }.should raise_exception(NetworkRail::Exception::AuthenticationError)
+          end
+        end
+
+        context "when there is an unexpected error" do
+          it "raises an exception" do
+            @stomp_client.stub(:connection_frame).and_return(stub(command: Stomp::CMD_ERROR, body: ''))
+            lambda {
+              client = described_class.new
+            }.should raise_exception(NetworkRail::Exception::ConnectionError)
+          end
+        end
+        
+        context "when the connection is established" do
+          it "returns an instance of #{described_class.to_s}" do
+            client = described_class.new
+            client.should be_kind_of described_class
+          end
+        end
+      end
+    end
+  end
+  
+  describe "#train_movements" do
+    before do
+      NetworkRail.configure do |config|
+        config.user_name = 'test'
+        config.password = 'test'
+      end
+      Stomp::Client.stub(:new).and_return(@stomp_client)
+      
+      @client = described_class.new
+    end
+    
+    context "with no block" do
+      it "raises an exception" do
+        lambda { @client.train_movements }.should raise_exception(NetworkRail::Exception::BlockRequired)
+      end
+    end
+    
+    context "with no train operator parameter" do
+      it "defaults to all train operators and subscribes to the train movements feed" do
+        @stomp_client.should_receive(:subscribe).once.with("/topic/TRAIN_MVT_ALL_TOC")
+        @client.train_movements {|i| }
+      end
+    end
+    
+    context "with train operator parameter" do
+      it "maps the operator parameter to the Network Rail business code and subscribes to the train movements feed" do
+        @stomp_client.should_receive(:subscribe).once.with("/topic/TRAIN_MVT_HY_TOC")
+        @client.train_movements(operator: :south_west_trains) {|i| }
+      end
+    end
+    
+    describe "parsing responses" do
+      before do
+        @stomp_client.stub(:subscribe).and_yield(fixture('train_movements.json'))
+      end
+      
+      it "calls NetworkRail::Message::TrainMovement#factory for each message received" do
+        NetworkRail::Message::TrainMovement.should_receive(:factory).exactly(10).times
+        @client.train_movements {|i| }
+      end
+      
+      it "yields an instance of NetworkRail::Message::TrainMovement for each message received" do
+        expect {|b| @client.train_movements(&b) }.to yield_successive_args(
+          NetworkRail::Message::TrainMovement::Arrival,
+          NetworkRail::Message::TrainMovement::Departure,
+          NetworkRail::Message::TrainMovement::Arrival,
+          NetworkRail::Message::TrainMovement::Departure,
+          NetworkRail::Message::TrainMovement::Departure,
+          NetworkRail::Message::TrainMovement::Arrival,
+          NetworkRail::Message::TrainMovement::Arrival,
+          NetworkRail::Message::TrainMovement::Arrival,
+          NetworkRail::Message::TrainMovement::Departure,
+          NetworkRail::Message::TrainMovement::Departure
+        )
+      end
+    end
+  end
+end

data/spec/network_rail/message/train_movement/base_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe NetworkRail::Message::TrainMovement::Base do
+  describe "#factory" do
+    it "returns an instance of the class" do
+      described_class.should_receive(:new).once.with('test')
+      described_class.factory('test')
+    end
+  end
+  
+  describe "#initialize" do
+    before do
+      @messages = JSON.parse fixture('train_movements.json')
+    end
+    
+    it "assigns the original parsed JSON message to #original_message" do
+      object = described_class.new @messages.first
+      object.original_message.should == @messages.first
+    end
+  end
+end

data/spec/network_rail/message/train_movement/movement_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe NetworkRail::Message::TrainMovement::Movement do
+  before do
+    @messages = JSON.parse fixture('train_movements.json')
+  end
+  
+  describe "#factory" do
+    it "calls the factory method on a different subclass depending on the message type" do
+      @messages.each do |message|
+        target_class = case message['body']['event_type']
+          when "ARRIVAL" then NetworkRail::Message::TrainMovement::Arrival
+          when "DEPARTURE" then NetworkRail::Message::TrainMovement::Departure
+        end
+        
+        target_class.should_receive :new
+        described_class.factory(message)
+      end
+    end
+  end
+  
+  describe "#initialize" do
+    it "converts actual_timestamp to Time and assigns to #time" do
+      object = described_class.new @messages.first
+      object.time.should be_a Time
+      object.time.year.should == 2013
+    end
+
+    it "converts planned_timestamp to Time and assigns to #planned_time" do
+      object = described_class.new @messages.first
+      object.planned_time.should be_a Time
+      object.planned_time.year.should == 2013
+    end
+
+    it "converts toc_id to a symbol representing the train operator and assings to #operator" do
+      object = described_class.new @messages.first
+      object.operator.should == :south_west_trains
+    end
+  end
+  
+  describe "#on_time?" do
+    context "when within the late threshold" do
+      it "returns true" do
+        object = described_class.new @messages.first
+        object.time = Time.now
+        object.planned_time = Time.now - 1.minute
+        object.on_time?.should == true
+      end
+    end
+
+    context "when outside the late threshold" do
+      it "returns false" do
+        object = described_class.new @messages.first
+        object.time = Time.now
+        object.planned_time = Time.now - 1.hour
+        object.on_time?.should == false
+      end
+    end
+  end
+  
+  describe "#delay" do
+    it "returns the difference in seconds between #time and #planned_time" do
+      object = described_class.new @messages.first
+      object.time = Time.now
+      object.planned_time = Time.now - 1.hour
+      object.delay.should == 3600
+    end
+  end
+end

data/spec/network_rail/message/train_movement_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe NetworkRail::Message::TrainMovement do
+  describe "#factory" do
+    before do
+      @messages = JSON.parse fixture('train_movements.json')
+    end
+    
+    it "calls the factory method on a different subclass of NetworkRail::Message::TrainMovement::Base depending on the message type" do
+      @messages.each do |message|
+        target_class = case message['header']['msg_type']
+          when "0001" then NetworkRail::Message::TrainMovement::Activation
+          when "0002" then NetworkRail::Message::TrainMovement::Cancellation
+          when "0003" then NetworkRail::Message::TrainMovement::Movement
+          when "0005" then NetworkRail::Message::TrainMovement::Reinstatement
+          when "0006" then NetworkRail::Message::TrainMovement::ChangeOfOrigin
+          when "0007" then NetworkRail::Message::TrainMovement::ChangeOfIdentity
+        end
+        
+        target_class.should_receive(:factory).once
+        described_class.factory(message)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'network_rail'
+require 'active_support/all'
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.read(fixture_path + '/' + file)
+end