Merge pull request #3 from axelniklasson/development

Development
axelniklasson · Aug 26, 2017 · 2690289 · 2690289
2 parents 6c06135 + ef8452a
commit 2690289
Show file tree

Hide file tree

Showing 12 changed files with 107 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ Below are the implemented endpoints.
 - [x] /neareststation.asp
 - [x] /stationresults.asp
 - [x] /trafficmeans.asp
-- [ ] /journeypath.asp
+- [x] /journeypath.asp
 
 Documentation for this package can be found in the Wiki.
 

diff --git a/lib/endpoints/journeypath.js b/lib/endpoints/journeypath.js
@@ -3,5 +3,41 @@ var xmlParser = require('xml2js');
 var config = require('../config');
 
 module.exports = {
-    // TODO implement this endpoint wrapper
+    /*
+    * Returns coordinates for journeypath on a map.
+    *
+    * @param cf string :  JourneyKey retrieved in response from resultspage method
+    * param id string : SequenceNo of journey retrieved in response from resultspage method
+    * @param cb function : callback function
+    *
+    * @returns SOMETHING COOL
+    */
+    getJourneyPath: function(opts, cb) {
+        if (opts.journeyKey && opts.sequenceNo) {
+            var reqString = config.baseURL + '/journeypath.asp?cf=' + encodeURIComponent(opts.journeyKey) + '&id=' + encodeURIComponent(opts.sequenceNo);
+
+            request(reqString, function (error, response, body) {
+                if (!error && response.statusCode == 200) {
+                    if (config.returnXML) {
+                        /* istanbul ignore next */
+                        return cb(body, null);
+                    } else {
+                        xmlParser.parseString(body, function (err, result) {
+                            if (!err && result) {
+                                return cb(result['soap:Envelope']['soap:Body'][0]['GetJourneyPathResponse'][0]['GetJourneyPathResult'], null);
+                            } else {
+                                /* istanbul ignore next */
+                                return cb(null, error);
+                            }
+                        });
+                    }
+                } else {
+                    /* istanbul ignore next */
+                    return cb(null, error);
+                }
+            });
+        } else {
+            return cb(null, 'Parameters journeyKey and sequenceNo must be specified.');
+        }
+    }
 }
diff --git a/lib/endpoints/neareststation.js b/lib/endpoints/neareststation.js
@@ -26,18 +26,21 @@ module.exports = {
             request(reqString, function (error, response, body) {
                 if (!error && response.statusCode == 200) {
                     if (config.returnXML) {
+                        /* istanbul ignore next */
                         return cb(body, null);
                     } else {
                         xmlParser.parseString(body, function (err, result) {
                             if (!err && result) {
                                 return cb(result['soap:Envelope']['soap:Body'][0]['GetNearestStopAreaResponse'][0]['GetNearestStopAreaResult'][0]['NearestStopAreas'][0]['NearestStopArea'], null);
                             } else {
+                                /* istanbul ignore next */
                                 return cb(null, err);
                             }
                         });
                     }
 
                 } else {
+                    /* istanbul ignore next */
                     return cb(null, error);
                 }
             });
@@ -46,4 +49,3 @@ module.exports = {
         }
     }
 }
-
diff --git a/lib/endpoints/querypage.js b/lib/endpoints/querypage.js
@@ -14,13 +14,14 @@ module.exports = {
     * @returns an array of from- and to-stops
     */
     findStartAndStop: function(opts, cb) {
-        if (opts.from && opts.to && typeof cb === 'function') {
+        if (opts.from && opts.to) {
             var reqString = config.baseURL + '/querypage.asp?inpPointfr=' + encodeURIComponent(opts.from)
             + '&inpPointTo=' + encodeURIComponent(opts.to);
 
             request(reqString, function (error, response, body) {
                 if (!error && response.statusCode == 200) {
                     if (config.returnXML) {
+                        /* istanbul ignore next */
                         return cb(body, null)
                     } else {
                         xmlParser.parseString(body, function (err, result) {
@@ -30,12 +31,14 @@ module.exports = {
                                 resultObj.to = result['soap:Envelope']['soap:Body'][0]['GetStartEndPointResponse'][0]['GetStartEndPointResult'][0]['EndPoints'][0]['Point'];
                                 return cb(resultObj, null);
                             } else {
+                                /* istanbul ignore next */
                                 return cb(null, error);
                             }
                         });
                     }
 
                 } else {
+                    /* istanbul ignore next */
                     return cb(null, error);
                 }
             });

diff --git a/lib/endpoints/querystation.js b/lib/endpoints/querystation.js
@@ -12,23 +12,26 @@ module.exports = {
     * @returns an array of stops
     */
     findStop: function(opts, cb) {
-        if (opts.name && typeof cb === 'function') {
+        if (opts.name) {
             var reqString = config.baseURL + '/querystation.asp?inpPointfr=' + encodeURIComponent(opts.name);
 
             request(reqString, function (error, response, body) {
                 if (!error && response.statusCode == 200) {
                     if (config.returnXML) {
+                        /* istanbul ignore next */
                         return cb(body, null);
                     } else {
                         xmlParser.parseString(body, function (err, result) {
                             if (!err && result) {
                                 return cb(result['soap:Envelope']['soap:Body'][0]['GetStartEndPointResponse'][0]['GetStartEndPointResult'][0]['StartPoints'][0]['Point'], null);
                             } else {
+                                /* istanbul ignore next */
                                 return cb(null, error);
                             }
                         });
                     }
                 } else {
+                    /* istanbul ignore next */
                     return cb(null, error);
                 }
             });

diff --git a/lib/endpoints/resultspage.js b/lib/endpoints/resultspage.js
@@ -6,6 +6,7 @@ module.exports = {
     /*
     * Finds all journeys between two points.
     *
+    * @param next string : next/previous set of journeys
     * @param selPointFr obj : object containing info of departure point name|id|type
     * @param selPointTo obj : object containing info of arrival point name|id|type
     * @param limit int : number of journeys (optional)
@@ -14,10 +15,10 @@ module.exports = {
     * @param transportMode int : sum of trafficmeans IDs (optional)
     * @param cb function : callback function
     *
-    * @returns an array of journyes
+    * @returns an array of journies
     */
     getJourneys: function(opts, cb) {
-        if (opts.from && opts.to && opts.action && typeof cb === 'function') {
+        if (opts.from && opts.to && opts.action) {
             // validate opts.from
             if (!opts.from.name || !opts.from.id || (opts.from.type != 0 && opts.from.type != 1)) {
                 return cb(null, 'Invalid opts.from object. Should have properties name, id and type.');
@@ -57,20 +58,25 @@ module.exports = {
             request(reqString, function (error, response, body) {
                 if (!error && response.statusCode == 200) {
                     if (config.returnXML) {
+                        /* istanbul ignore next */
                         return cb(body, null);
                     } else {
                         xmlParser.parseString(body, function (err, result) {
                             if (!err && result) {
                                 return cb(result['soap:Envelope']['soap:Body'][0]['GetJourneyResponse'][0]['GetJourneyResult'][0]['Journeys'][0]['Journey'], null);
                             } else {
+                                /* istanbul ignore next */
                                 return cb(null, error);
                             }
                         });
                     }
                 } else {
+                    /* istanbul ignore next */
                     return cb(null, error);
                 }
             });
+        } else {
+            return cb(null, 'Invalid opts object. Should have objects from and to and action.');
         }
     }
 }
diff --git a/lib/endpoints/stationresults.js b/lib/endpoints/stationresults.js
@@ -33,18 +33,21 @@ module.exports = {
             request(reqString, function (error, response, body) {
                 if (!error && response.statusCode == 200) {
                     if (config.returnXML) {
+                        /* istanbul ignore next */
                         return cb(body, null);
                     } else {
                         xmlParser.parseString(body, function (err, result) {
                             if (!err && result) {
                                 return cb(result['soap:Envelope']['soap:Body'][0]['GetDepartureArrivalResponse'][0]['GetDepartureArrivalResult'][0]['Lines'][0].Line, null);
                             } else {
+                                /* istanbul ignore next */
                                 return cb(null, err);
                             }
                         });
                     }
 
                 } else {
+                    /* istanbul ignore next */
                     return cb(null, error);
                 }
             });

diff --git a/lib/endpoints/trafficmeans.js b/lib/endpoints/trafficmeans.js
@@ -6,7 +6,7 @@ module.exports = {
 
     /*
     * Finds current traffic means.
-    * 
+    *
     * @returns an array of traffic means
     */
     getTrafficMeans: function(cb) {
@@ -15,18 +15,21 @@ module.exports = {
         request(reqString, function (error, response, body) {
             if (!error && response.statusCode == 200) {
                 if (config.returnXML) {
+                    /* istanbul ignore next */
                     return cb(body, null)
                 } else {
                     xmlParser.parseString(body, function (err, result) {
                         if (!err && result) {
                             return cb(result['soap:Envelope']['soap:Body'][0]['GetMeansOfTransportResponse'][0]['GetMeansOfTransportResult'][0]['TransportModes'], null);
                         } else {
+                            /* istanbul ignore next */
                             return cb(null, error);
                         }
                     });
                 }
 
             } else {
+                /* istanbul ignore next */
                 return cb(null, error);
             }
         });

diff --git a/lib/node_skanetrafiken.js b/lib/node_skanetrafiken.js
@@ -7,6 +7,7 @@ var neareststation = require('./endpoints/neareststation');
 var stationresults = require('./endpoints/stationresults');
 var trafficmeans = require('./endpoints/trafficmeans');
 var resultspage = require('./endpoints/resultspage');
+var journeypath = require('./endpoints/journeypath');
 
 function validate(func, opts, cb, emptyOptsOk) {
     if (opts && cb && typeof cb === 'function' && !emptyOptsOk) {
@@ -51,5 +52,8 @@ module.exports = {
     },
     getJourneys: function(opts, cb) {
         return validate(resultspage.getJourneys, opts, cb, false);
+    },
+    getJourneyPath: function(opts, cb) {
+        return validate(journeypath.getJourneyPath, opts, cb, false);
     }
 };
diff --git a/test/endpoints/journeypath.js b/test/endpoints/journeypath.js
@@ -2,4 +2,23 @@ var chai = require('chai');
 var expect = chai.expect;
 var nodeSkanetrafiken = require('../../lib/node_skanetrafiken');
 
-// TODO implement tests
+/* getJourneyPath- dummy tests for now */
+describe('Get journeypath with correct parameters', function() {
+    it('Should successfully (if the API will start working) return journeypath matching the query', function(done) {
+        nodeSkanetrafiken.getJourneyPath({ journeyKey: '13632115750062105252600390800220033', sequenceNo: '0' }, function(results, err) {
+            expect(results).to.not.be.null;
+            expect(err).to.be.null;
+            done();
+        });
+    });
+});
+
+describe('Get journeypath without correct parameters', function() {
+    it('Should fail to return journeypath', function(done) {
+        nodeSkanetrafiken.getJourneyPath({ sequenceNo: 0 }, function(results, err) {
+            expect(results).to.be.null;
+            expect(err).to.equal('Parameters journeyKey and sequenceNo must be specified.');
+            done();
+        });
+    });
+});
diff --git a/test/endpoints/neareststation.js b/test/endpoints/neareststation.js
@@ -36,3 +36,12 @@ describe('Find nearest stops within specified radius', function() {
     });
 });
 
+describe('Find nearest stops without specifying x and y', function() {
+    it('Should fail to return nearest stops', function(done) {
+        nodeSkanetrafiken.findNearestStops({ radius: 500 }, function(results, err) {
+            expect(results).to.be.null;
+            expect(err).to.equal('Parameters x and y must be specified.');
+            done();
+        });
+    });
+});
diff --git a/test/endpoints/resultspage.js b/test/endpoints/resultspage.js
@@ -124,3 +124,13 @@ describe('Find journeys in specified transport mode', function() {
         });
     });
 });
+
+describe('Find journeys with missing parameters', function() {
+    it('Should fail to return journeys', function(done) {
+        nodeSkanetrafiken.getJourneys({ from: {} }, function(results, err) {
+            expect(results).to.be.null;
+            expect(err).to.equal('Invalid opts object. Should have objects from and to and action.');
+            done();
+        });
+    });
+});