Merge pull request #10 from iolufemi/feature/APIModel

feature(API Model):Added API model feature

Author: iolufemi

.travis.yml

@@ -4,7 +4,7 @@ services:
   - mongodb
   - redis-server
 env:
-  - MONGOLAB_URL=mongodb://127.0.0.1/snipe LOG_MONGOLAB_URL=mongodb://127.0.0.1/snipelogs RATE_LIMIT=10 REDIS_URL=redis://127.0.0.1/1 SECURE_MODE=true NO_CACHE=no ENFORCE_USER_ID_APP_ID_DEVELOPER_ID=yes
+  - MONGOLAB_URL=mongodb://127.0.0.1/snipe LOG_MONGOLAB_URL=mongodb://127.0.0.1/snipelogs REDIS_URL=redis://127.0.0.1/1 SECURE_MODE=true NO_CACHE=no
 addons:
   apt:
     sources:
@@ -19,6 +19,9 @@ before_script:
   - npm install -g gulp mocha gulp-cli codecov istanbul
 install:
   - npm install
+  - gulp service -n api
+  - gulp service -n test -b http://localhost:8080 -e apis
+  - npm start >> femi.log . &
 script:
   - >-
     istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec

README.md

@@ -51,6 +51,14 @@ Then generate your first API endpoint
 $ gulp service --name yourFirstEndpoint // This command will create a CRUD endpoint for yourFirstEndpoint.
 ```
 
+With the `gulp service` command, you have the option of using either Mongo DB for your database model or using an API generated by this Express Generator as a database model. To use an API as a database you can pass the `baseurl` and the `endpoint` for the API to the `gulp service `. See an example below
+
+```
+$ gulp service --name yourEndpointWithAPIAsDB --baseurl http://localhost:8080 --endpoint users
+```
+
+> Note: You can use -n instead of --name, -b instead of --baseurl, -e instead of --endpoint
+
 Try out your new endpoint.
 
 Start the app

TODO.md

@@ -4,15 +4,15 @@
 | app.js | 62 | Write a complete Documentation for this project
 | config/index.js | 12 | Test for production and development senarios
 | models/index.js | 14 | Automatically generate tests with the schema structure
-| routes/index.js | 314 | Test API versioning
-| routes/index.js | 315 | Test rate limiting
-| routes/index.js | 316 | Test complete route Loader test
-| routes/index.js | 317 | Test _sanitizeRequestUrl middleware function
-| routes/index.js | 318 | Test _allRequestData middleware function for default value scenario
-| routes/index.js | 319 | Test _enforceUserIdAndAppId middle function for when req.body is an array
-| routes/index.js | 320 | Make Log requests testable and write unit tests for it
-| routes/index.js | 321 | Develop the route loader into a separate node module to be publish on npm
-| routes/index.js | 322 | Develop all services onto separate node module to be publish on npm
+| routes/index.js | 294 | Test API versioning
+| routes/index.js | 295 | Test rate limiting
+| routes/index.js | 296 | Test complete route Loader test
+| routes/index.js | 297 | Test _sanitizeRequestUrl middleware function
+| routes/index.js | 298 | Test _allRequestData middleware function for default value scenario
+| routes/index.js | 299 | Test _enforceUserIdAndAppId middle function for when req.body is an array
+| routes/index.js | 300 | Make Log requests testable and write unit tests for it
+| routes/index.js | 301 | Develop the route loader into a separate node module to be publish on npm
+| routes/index.js | 302 | Develop all services onto separate node module to be publish on npm
 | services/logger/index.js | 36 | Test Error Handler
 | services/queue/clock.js | 11 | work on a clock functionality so kue can support scheduled jobs
 | services/queue/clock.js | 12 | Use the cron package here https://www.npmjs.com/package/cron for timer

conf.py

@@ -22,5 +22,6 @@ module.exports = {
     queueUIUsername: process.env.QUEUE_UI_USERNAME || 'admin',
     queueUIPassword: process.env.QUEUE_UI_PASSWORD || 'password123/',
     queueUIPort: process.env.QUEUE_UI_PORT || 3000,
-    enforceUserIdAppIdDeveloperId: process.env.ENFORCE_USER_ID_APP_ID_DEVELOPER_ID || 'no'
+    enforceUserIdAppIdDeveloperId: process.env.ENFORCE_USER_ID_APP_ID_DEVELOPER_ID || 'no',
+    apiDBKey: process.env.API_DB_Key || 'MDg4NWM1NTA0ZTZlNTQ5MjAzNzA1ODBlOWVkNzI3MzdlNmYxZTcyMjVkOTA3N2JjYTBhZjA0YmM0N2U4NDZkNi8vLy8vLzQ1MDY='
 };

config/development.js

@@ -22,5 +22,6 @@ module.exports = {
     queueUIUsername: process.env.QUEUE_UI_USERNAME || 'admin',
     queueUIPassword: process.env.QUEUE_UI_PASSWORD || 'password123/',
     queueUIPort: process.env.QUEUE_UI_PORT || 3000,
-    enforceUserIdAppIdDeveloperId: process.env.ENFORCE_USER_ID_APP_ID_DEVELOPER_ID || 'no'
+    enforceUserIdAppIdDeveloperId: process.env.ENFORCE_USER_ID_APP_ID_DEVELOPER_ID || 'no',
+    apiDBKey: process.env.API_DB_Key || 'MDg4NWM1NTA0ZTZlNTQ5MjAzNzA1ODBlOWVkNzI3MzdlNmYxZTcyMjVkOTA3N2JjYTBhZjA0YmM0N2U4NDZkNi8vLy8vLzQ1MDY='
 };

config/production.js

@@ -45,7 +45,6 @@ gulp.task('test', function() {
     process.env.SECURE_MODE = true;
     process.env.NO_CACHE = 'no';
     process.env.NODE_ENV = 'test';
-    process.env.ENFORCE_USER_ID_APP_ID_DEVELOPER_ID = 'yes';
     gulp.src('./test', {read: false})
         // `gulp-mocha` needs filepaths so you can't have any plugins before it 
         .pipe(mocha({
@@ -55,10 +54,23 @@ gulp.task('test', function() {
     );
 
 // Remember to pass argument '--name TheServiceName' or '-n TheServiceName' to the service creation command
+// If you want to use an API as a database model, pass the base url and the endpoint. '--baseurl http://google.com' or '--b http://google.com'
+// '--endpoint users' or '--e users'
 // Note that the name must be singular
 gulp.task('service', function(){
     var args = argv(process.argv.slice(2));
     var name;
+    var baseurl;
+    var endpoint;
+    baseurl = args.baseurl;
+    endpoint = args.endpoint;
+    if(!baseurl){
+        baseurl = args.b;
+    }
+
+    if(!endpoint){
+        endpoint = args.e;
+    }
     name = args.name;
     if(!name){
         name = args.n;
@@ -106,20 +118,37 @@ gulp.task('service', function(){
 });
 
     // Create the Model
-    fs.readFile('./template/model.tmpl', function(err, data){
-      if (err){
-        throw err;
-    } 
-    var tpl = _.template(data);
-    var result = tpl({service: nameCapitalise, object: nameLowerCase});
+    if(baseurl && endpoint){
+        fs.readFile('./template/model_api.tmpl', function(err, data){
+          if (err){
+            throw err;
+        } 
+        var tpl = _.template(data);
+        var result = tpl({baseurl: baseurl, endpoint: endpoint});
 
-    fs.writeFile('./models/'+nameCapitalisePlural+'.js', result, function(err){
-        if (err){
+        fs.writeFile('./models/'+nameCapitalisePlural+'.js', result, function(err){
+            if (err){
+                throw err;
+            } 
+            console.log('Model created at ./models/'+nameCapitalisePlural+'.js');
+        });
+    });
+    }else{
+        fs.readFile('./template/model.tmpl', function(err, data){
+          if (err){
             throw err;
         } 
-        console.log('Model created at ./models/'+nameCapitalisePlural+'.js');
+        var tpl = _.template(data);
+        var result = tpl({service: nameCapitalise, object: nameLowerCase});
+
+        fs.writeFile('./models/'+nameCapitalisePlural+'.js', result, function(err){
+            if (err){
+                throw err;
+            } 
+            console.log('Model created at ./models/'+nameCapitalisePlural+'.js');
+        });
     });
-});
+    }
 
     // Create the Model Unit Test
     fs.readFile('./template/model_test.tmpl', function(err, data){

gulpfile.js

@@ -179,7 +179,7 @@ Schema.pre('update', function(next) {
         queue.create('searchIndex', ourDoc)
         .save();
     }
-    
+    ourDoc.updatedAt = new Date(Date.now()).toISOString();
     next();
 });
 

models/RequestLogs.js

@@ -148,7 +148,7 @@ Schema.pre('update', function(next) {
         queue.create('searchIndex', ourDoc)
         .save();
     }
-    
+    ourDoc.updatedAt = new Date(Date.now()).toISOString();
     next();
 });
 

models/Trash.js

@@ -108,7 +108,7 @@ router._enforceUserIdAndAppId = function(req,res,next){
   var appId = req.param('appId');
   var developer = req.param('developer');
   // The routes after this line will require userid, appid and developer.
-  if(config.enforceUserIdAppIdDeveloperId === 'yes'){
+  if(config.enforceUserIdAppIdDeveloperId === 'yes' || req.test){
     // Make userId compolsory in every request
     if(!userId){
         return res.badRequest(false,'No userId parameter was passed in the payload of this request. Please pass a userId.');
@@ -140,27 +140,7 @@ router._enforceUserIdAndAppId = function(req,res,next){
       } 
   }
 }else{
-    req.userId = userId;
-    req.appId = appId;
-    req.developer = developer;
-    if(req.body){
-        if(req.body && 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();
-      }
-  }
+    next();
 }
 };