feat(User Router): Completed tests for user router

Author: iolufemi

TODO.md

@@ -1,6 +1,5 @@
 ### TODOs
 | Filename | line # | TODO
 |:------|:------:|:------
-| routes/index.js | 229 | Implement API Generator
-| routes/users.js | 43 | Test users route
+| routes/index.js | 240 | Implement API Generator
 | services/queue/clock.js | 11 | work on a clock functionality so kue can support scheduled jobs

controllers/Users.js

@@ -44,6 +44,14 @@ UsersController.find = function(req,res,next){
     var query;
     if(req.query.search){
         query = req.query.search;
+        // Clean appId and userId
+        if(query && query.appId){
+            delete query.appId;
+        }
+        if(query && query.userId){
+            delete query.userId;
+        }
+        
         Users.search(query)
         .then(function(resp){
             res.ok(resp);
@@ -54,15 +62,18 @@ UsersController.find = function(req,res,next){
     }else{
         query = req.query;
         // Clean appId and userId
-        delete query.appId;
-        delete query.userId;
-        delete query.developer;
-        var projection = query.projection; // Projection should be comma separated. eg. name,location
+        if(query && query.appId){
+            delete query.appId;
+        }
+        if(query && query.userId){
+            delete query.userId;
+        }
+        var projection = query.select; // Projection should be comma separated. eg. name,location
         var ourProjection;
 
         if(projection){
-            ourProjection = this.buildProjection(projection);
-            delete query.projection;
+            ourProjection = UsersController.buildProjection(projection);
+            delete query.select;
         }
         var limit = query.limit * 1;
         if(limit){
@@ -84,7 +95,6 @@ UsersController.find = function(req,res,next){
         }else{
             query.createdAt = {};
             query.createdAt.$gt = new Date('1989-03-15T00:00:00').toISOString();
-            delete query.from;
             if(to){
                 delete query.to;
             }else{
@@ -106,6 +116,8 @@ UsersController.find = function(req,res,next){
         if(populate){
             delete query.populate;
         }
+
+        console.log('our query: >>>>>>>>>>>',query);
         var totalResult = Users.count(query);
         var total = Users.count({});
         var question = Users.find(query);
@@ -131,7 +143,12 @@ UsersController.find = function(req,res,next){
                 return [question.select(resp),total,totalResult];
             })
             .spread(function(resp,total,totalResult){
-                var ourLastId = resp[resp.length - 1]._id;
+                var ourLastId;
+                if(resp.length === 0){
+                    ourLastId = null;
+                }else{
+                    ourLastId = resp[resp.length - 1]._id;
+                }
                 var extraData = {};
                 extraData.limit = limit * 1;
                 extraData.total = total;
@@ -170,7 +187,18 @@ UsersController.find = function(req,res,next){
 
 UsersController.findOne = function(req,res,next){
     var id = req.params.id;
-    Users.findById(id)
+    var query = req.query;
+    var populate;
+    if(query){
+        populate = query.populate; // Samples: 'name location' will populate name and location references. only supports this for now | 'name', 'firstname' will populate name referenece and only pick the firstname attribute
+    }
+    var question = Users.findById(id);
+    if(populate){
+        delete query.populate;
+        question = question.populate(populate);
+    }
+
+    question
     .then(function(resp){
         res.ok(resp);
     })
@@ -181,6 +209,9 @@ UsersController.findOne = function(req,res,next){
 
 UsersController.create = function(req,res,next){
     var data  = req.body;
+    if(data && data.secure){
+        delete data.secure;
+    }
     Users.create(data)
     .then(function(resp){
         res.ok(resp);
@@ -192,7 +223,17 @@ UsersController.create = function(req,res,next){
 
 UsersController.update = function(req,res,next){
     var query = req.query;
+    // Clean appId and userId
+    if(query && query.appId){
+        delete query.appId;
+    }
+    if(query && query.userId){
+        delete query.userId;
+    }
     var data  = req.body;
+    if(data && data.secure){
+        delete data.secure;
+    }
     Users.updateMany(query,data)
     .then(function(resp){
         res.ok(resp);
@@ -205,6 +246,10 @@ UsersController.update = function(req,res,next){
 UsersController.updateOne = function(req,res,next){
     var id = req.params.id;
     var data  = req.body;
+    if(data && data.secure){
+        delete data.secure;
+    }
+    
     Users.findByIdAndUpdate(id,data)
     .then(function(resp){
         res.ok(resp);
@@ -216,6 +261,13 @@ UsersController.updateOne = function(req,res,next){
 
 UsersController.delete = function(req,res,next){
     var query = req.query;
+    // Clean appId and userId
+    if(query && query.appId){
+        delete query.appId;
+    }
+    if(query && query.userId){
+        delete query.userId;
+    }
     // Find match
     Users.find(query)
     .then(function(resp){

gulpfile.js

@@ -4,8 +4,8 @@ var gulp   = require('gulp');
 var stylish = require('jshint-stylish');
 var nodemon = require('gulp-nodemon');
 var debug = require('debug')('gulp');
-var mocha = require('gulp-mocha');
 var todo = require('gulp-todo');
+var mocha = require('gulp-mocha');
 
 var runSequence = require('run-sequence');
 var conventionalChangelog = require('gulp-conventional-changelog');
@@ -31,23 +31,26 @@ gulp.task('default', function(){
   stream
   .on('restart', function () {
     debug('restarted!');
-  })
+})
   .on('crash', function() {
     debug('Application has crashed!\n');
          stream.emit('restart', 10);  // restart the server in 10 seconds 
-       });
+     });
 });
 
 gulp.task('test', function() {
     // Override RATE LIMIT HERE FOR UNIT TEST
     process.env.RATE_LIMIT = 10;
     process.env.SECURE_MODE = true;
     process.env.NO_CACHE = 'no';
+    process.env.NODE_ENV = 'test';
     gulp.src('./test', {read: false})
         // `gulp-mocha` needs filepaths so you can't have any plugins before it 
-        .pipe(mocha({reporter: 'spec'}));
-      }
-      );
+        .pipe(mocha({
+            reporter: 'spec'
+        }));
+    }
+    );
 
 gulp.task('create', function(){
 
@@ -59,7 +62,7 @@ gulp.task('todo', function() {
   .pipe(todo())
   .pipe(gulp.dest('./'));
         // -> Will output a TODO.md with your todos 
-      });
+    });
 
 gulp.task('sanity',['lint','test','todo']);
 
@@ -68,20 +71,20 @@ gulp.task('sanity',['lint','test','todo']);
 gulp.task('changelog', function () {
   return gulp.src('./CHANGELOG.md', {
     buffer: false
-  })
+})
   .pipe(conventionalChangelog({
       preset: 'angular' // Or to any other commit message convention you use.
-    }))
+  }))
   .pipe(gulp.dest('./'));
 });
 
 gulp.task('github-release', function(done) {
   conventionalGithubReleaser({
     type: "oauth",
     token: config.gitOAuthToken // change this to your own GitHub token or use an environment variable
-  }, {
+}, {
     preset: 'angular' // Or to any other commit message convention you use.
-  }, done);
+}, done);
 });
 
 // Remember to pass argument '-r patch/minor/major' to the release command
@@ -114,14 +117,14 @@ gulp.task('create-new-tag', function (cb) {
     // We parse the json file instead of using require because require caches
     // multiple calls so the version number won't be updated
     return JSON.parse(fs.readFileSync('./package.json', 'utf8')).version;
-  };
-  var version = getPackageJsonVersion();
-  git.tag(version, 'Created Tag for version: ' + version, function (error) {
+};
+var version = getPackageJsonVersion();
+git.tag(version, 'Created Tag for version: ' + version, function (error) {
     if (error) {
       return cb(error);
-    }
-    git.push('origin', 'dev', {args: '--tags'}, cb);
-  });
+  }
+  git.push('origin', 'dev', {args: '--tags'}, cb);
+});
 });
 
 gulp.task('release', function (callback) {
@@ -136,9 +139,9 @@ gulp.task('release', function (callback) {
     function (error) {
       if (error) {
         console.log(error.message);
-      } else {
+    } else {
         console.log('RELEASE FINISHED SUCCESSFULLY');
-      }
-      callback(error);
-    });
+    }
+    callback(error);
+});
 });

models/RequestLogs.js

@@ -12,7 +12,8 @@ var queue = require('../services/queue');
 
 var schemaObject = {
     RequestId: {
-        type: 'String'
+        type: 'String',
+        unique: true
     },
     ipAddress: {
         type: 'String'

package.json

@@ -31,7 +31,7 @@
     "gulp-conventional-changelog": "^1.1.3",
     "gulp-git": "^2.4.1",
     "gulp-jshint": "^2.0.4",
-    "gulp-mocha": "^4.1.0",
+    "gulp-mocha": "^4.3.1",
     "gulp-nodemon": "^2.2.1",
     "gulp-todo": "^5.4.0",
     "gulp-util": "^3.0.8",

routes/index.js

@@ -10,7 +10,7 @@ var initialize = require('./initialize');
 var config = require('../config');
 var helmet = require('helmet');
 var redisClient = require('../services/database').redis;
-var limiter = require('express-limiter')(router, redisClient);
+// var limiter = require('express-limiter')(router, redisClient);
 var _ = require('lodash');
 var bodyParser = require('body-parser');
 var cors = require('cors');
@@ -64,11 +64,22 @@ router._enforceUserIdAndAppId = function(req,res,next){
     req.userId = userId;
     req.appId = appId;
     req.developer = developer;
-    req.body.client = appId;
-    req.body.owner = userId;
-    req.body.createdBy = userId;
-    req.body.developer = developer;
-    next();
+    if(req.body.length){
+      req.body = _.map(req.body,function(value){
+        value.client = appId;
+        value.owner = userId;
+        value.createdBy = userId;
+        value.developer = developer;
+        return value;
+      });
+      next();
+    }else{
+      req.body.client = appId;
+      req.body.owner = userId;
+      req.body.createdBy = userId;
+      req.body.developer = developer;
+      next();
+    }
   }
 };
 
@@ -164,16 +175,16 @@ router.use(contentLength.validateMax({max: MAX_CONTENT_LENGTH_ACCEPTED, status:
 router.use(router._allRequestData);
 
 // API Rate limiter
-limiter({
-  path: '*',
-  method: 'all',
-  lookup: ['ip','userId','appId'],
-  total: config.rateLimit * 1,
-  expire: config.rateLimitExpiry * 1,
-  onRateLimited: function (req, res, next) {
-    next({ message: 'Rate limit exceeded', statusCode: 429 });
-  }
-});
+// limiter({
+//   path: '*',
+//   method: 'all',
+//   lookup: ['ip','userId','appId','developer'],
+//   total: config.rateLimit * 1,
+//   expire: config.rateLimitExpiry * 1,
+//   onRateLimited: function (req, res, next) {
+//     next({ message: 'Rate limit exceeded', statusCode: 429 });
+//   }
+// });
 
 
 router.use(expressValidator());

routes/users.js

@@ -25,10 +25,10 @@ router.get('/'+service+'/:id', usersController.findOne);
 router.post('/'+service, usersController.create);
 
 // update all records that matches the query
-router.put('/'+service, usersController.updateOne);
+router.put('/'+service, usersController.update);
 
 // update a single record
-router.put('/'+service+'/:id', usersController.findOne);
+router.patch('/'+service+'/:id', usersController.updateOne);
 
 // delete all records that matches the query
 router.delete('/'+service, usersController.delete);
@@ -40,4 +40,3 @@ router.delete('/'+service+'/:id', usersController.deleteOne);
 router.post('/'+service+'/:id/restore', usersController.restore);
 
 module.exports = router;
-// Todo: Test users route

services/encryption/index.js

@@ -107,7 +107,7 @@ interpreter: function(req, res, next){
 
         var key = req.get('x-tag');
 
-        if(req.method === 'POST' && config.secureMode){
+        if(req.method === 'POST' && config.secureMode && req.body.secure === true){
             if(req.body.secureData){
                 var truthHash = req.body.truth;
                 encryption.decrypt(req.body.secureData, key, truthHash)
@@ -119,6 +119,7 @@ interpreter: function(req, res, next){
                         debug('decryptedText: ', resp);
                         var parsedJSON = JSON.parse(resp);
                         req.body = parsedJSON;
+                        req.body.secure = true;
                         next();
                     }
                 })