Added new helper with more info

Add helper to mocha tests
magnatronus · Apr 17, 2019 · a6d1b15 · a6d1b15
1 parent 87e3365
commit a6d1b15
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 7 deletions.
diff --git a/LDBWSOperationInfo.js b/LDBWSOperationInfo.js
@@ -0,0 +1,54 @@
+'use strict';
+/**
+ * LDBWSOperationInfo.js
+ * This is a helper that defines information for specific LDBWS Operation Requests. 
+ */
+
+const OperationInfo = {
+   "GetDepartureBoard": { 
+       "key": "GetStationBoardResult",
+       "type": "board"
+   },
+   "GetDepBoardWithDetails": {
+       "key": "GetStationBoardResult",
+       "type": "board"
+   },
+   "GetArrivalBoard": {
+       "key": "GetStationBoardResult",
+       "type": "board"
+    },
+   "GetArrBoardWithDetails": {
+       "key": "GetStationBoardResult",
+       "type": "board"
+    },
+   "GetArrivalDepartureBoard": {
+       "key": "GetStationBoardResult",
+       "type": "board"
+    },
+   "GetArrDepBoardWithDetails": {
+       "key": "GetStationBoardResult",
+       "type": "board"
+    },
+   "GetNextDepartures": {
+       "key": "DeparturesBoard",
+       "type": "departure"
+    },
+   "GetNextDeparturesWithDetails": {
+       "key": "DeparturesBoard",
+       "type": "departure"
+    },
+   "GetFastestDepartures": {
+       "key": "DeparturesBoard",
+       "type": "departure"
+    },
+   "GetFastestDeparturesWithDetails":{
+       "key": "DeparturesBoard",
+       "type": "departure"
+    },
+   "GetServiceDetails": {
+       "key": "GetServiceDetailsResult",
+       "type": "service"
+    },
+ }
+
+ module.exports = OperationInfo;
diff --git a/LDBWSReturn.js b/LDBWSReturn.js
@@ -2,6 +2,7 @@
 /**
  * LDBWSReturn.js
  * This is a helper that defines the return key for the LDBWS Operation Requests. 
+ * @deprecated LDBWSOperationInfo supercedes this 
  */
 
 const ReturnKey = {

diff --git a/package.json b/package.json
@@ -1,11 +1,14 @@
 {
   "name": "ldbws-json",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "engines": {
     "node": ">=7.6"
   },
   "description": "JSON Interface for the National Rail Enquiries Darwin OpenLDBWS SOAP service. Requires a valid token to access services.",
-  "author": "Steve Rogers <srogers.uk@gmail.com>",
+  "author": {
+    "name": "SpiralArm Consulting ltd",
+    "email": "srogers.uk@gmail.com"
+  },
   "license": "MIT",
   "homepage": "https://github.com/magnatronus/ldbws-json",
   "repository": {

diff --git a/readme.MD b/readme.MD
@@ -43,15 +43,15 @@ Then, for example, to get the Departure Board  Information for London Victoria (
 const openLDBWS     = require('ldbws-json');
 const operation     = require('ldbws-json/LDBWSOperation');
 const requestData   = require('ldbws-json/LDBWSRequestData');
-const resultKeys    = require('ldbws-json/LDBWSReturn');
+const operationInfo = require('ldbws-json/LDBWSOperationInfo');
 
 // Put a valid Token here
 const token = "{PUT_YOUR_ASSIGNED_TOKEN_HERE}";
 
 // Select the operation method we will call and use the helper to extract the result
 // use of resultkeys is optional and provided for convienience only
 const method = operation.GET_DEPARTURE_BOARD;
-const key = resultKeys[method];
+const key = operationInfo[method].key;
 
 // populate the required data structure here we use the CRS code for London Victoria
 const options = Object.assign({}, requestData.Board);

diff --git a/test/departuresoap.js b/test/departuresoap.js
@@ -13,7 +13,6 @@ describe('SOAP Departures Test', function() {
     options.filterList = ['EDB', 'LET'];
     const envelope = `<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"><Header><AccessToken xmlns="http://thalesgroup.com/RTTI/2013-11-28/Token/types"><TokenValue>${token}</TokenValue></AccessToken></Header><Body><GetNextDeparturesRequest xmlns="http://thalesgroup.com/RTTI/2017-02-02/ldb/"><crs>KGX</crs><filterList><crs>EDB</crs><crs>LET</crs></filterList><timeOffset>0</timeOffset><timeWindow>0</timeWindow></GetNextDeparturesRequest></Body></Envelope>`;
     const soapCall = new LDBWSSoap(token, method, options).generateCall();
-    console.log(soapCall);
     it('should equal the hardcoded envelope', function() {
       assert.equal(soapCall, envelope);
     });

diff --git a/test/jsonboard.js b/test/jsonboard.js
@@ -6,7 +6,7 @@ describe('JSON Board Test', function() {
   describe('#Departure Board JSON for Kings Cross', function() {
     it('should have London Kings Cross as locationName', async function() {
         const method = require('../LDBWSOperation').GET_DEPARTURE_BOARD;
-        const resultKey = require('../LDBWSReturn')[method];
+        const resultKey = require('../LDBWSOperationInfo')[method].key;
         const options = Object.assign({}, require('../LDBWSRequestData').Board);
         options.crs = "KGX";
 

diff --git a/test/jsondeparture.js b/test/jsondeparture.js
@@ -6,7 +6,7 @@ describe('JSON Departure Test', function() {
   describe('#Next Departures JSON for Kings Cross', function() {
     it('should have London Kings Cross as locationName', async function() {
         const method = require('../LDBWSOperation').GET_NEXT_DEPARTURES;
-        const resultKey = require('../LDBWSReturn')[method];
+        const resultKey = require('../LDBWSOperationInfo')[method].key;
         const options = Object.assign({}, require('../LDBWSRequestData').Departure);
         options.crs = "KGX";
         options.filterList = ['EDB', 'LET'];