Feature/sql database support (#12)

* got mysql to work

* more progress. model now works with sql

* updated search tag job

* sql model is now tested

* added sql as a model functionality

Author: iolufemi

README.md

@@ -51,12 +51,20 @@ 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
+With the `gulp service` command, you have the option of using either Mongo DB, an SQL compartible DB 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` option for the API to the `gulp service `; for an SQL compartible db, pass the `sql` option. See an example below
+
+### Using an API as a DB
 
 ```
 $ gulp service --name yourEndpointWithAPIAsDB --baseurl http://localhost:8080 --endpoint users
 ```
 
+### Using an SQL compartible database
+
+```
+$ gulp service --name yourEndpointWITHSQL --sql
+```
+
 > Note: You can use -n instead of --name, -b instead of --baseurl, -e instead of --endpoint
 
 Try out your new endpoint.

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 | 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
+| routes/index.js | 298 | Test API versioning
+| routes/index.js | 299 | Test rate limiting
+| routes/index.js | 300 | Test complete route Loader test
+| routes/index.js | 301 | Test _sanitizeRequestUrl middleware function
+| routes/index.js | 302 | Test _allRequestData middleware function for default value scenario
+| routes/index.js | 303 | Test _enforceUserIdAndAppId middle function for when req.body is an array
+| routes/index.js | 304 | Make Log requests testable and write unit tests for it
+| routes/index.js | 305 | Develop the route loader into a separate node module to be publish on npm
+| routes/index.js | 306 | 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

config/development.js

@@ -23,5 +23,12 @@ module.exports = {
     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',
-    apiDBKey: process.env.API_DB_Key || 'MDg4NWM1NTA0ZTZlNTQ5MjAzNzA1ODBlOWVkNzI3MzdlNmYxZTcyMjVkOTA3N2JjYTBhZjA0YmM0N2U4NDZkNi8vLy8vLzQ1MDY='
+    apiDBKey: process.env.API_DB_Key || 'MDg4NWM1NTA0ZTZlNTQ5MjAzNzA1ODBlOWVkNzI3MzdlNmYxZTcyMjVkOTA3N2JjYTBhZjA0YmM0N2U4NDZkNi8vLy8vLzQ1MDY=',
+    SQLUsername: process.env.SQL_USERNAME || 'root',
+    SQLPassword: process.env.SQL_PASSWORD || null,
+    SQLDatabase: process.env.SQL_DATABASE || 'snipe',
+    SQLHost: process.env.SQL_HOST || '192.168.99.100',
+    SQLPort: process.env.SQL_PORT || 3306,
+    SQLDriver: process.env.SQL_DRIVER || 'mysql', //'mysql'|'sqlite'|'postgres'|'mssql'
+    SQLTimezone: process.env.SQL_TIMEZONE || '+01:00'
 };

config/production.js

@@ -23,5 +23,12 @@ module.exports = {
     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',
-    apiDBKey: process.env.API_DB_Key || 'MDg4NWM1NTA0ZTZlNTQ5MjAzNzA1ODBlOWVkNzI3MzdlNmYxZTcyMjVkOTA3N2JjYTBhZjA0YmM0N2U4NDZkNi8vLy8vLzQ1MDY='
+    apiDBKey: process.env.API_DB_Key || 'MDg4NWM1NTA0ZTZlNTQ5MjAzNzA1ODBlOWVkNzI3MzdlNmYxZTcyMjVkOTA3N2JjYTBhZjA0YmM0N2U4NDZkNi8vLy8vLzQ1MDY=',
+    SQLUsername: process.env.SQL_USERNAME || 'root',
+    SQLPassword: process.env.SQL_PASSWORD || null,
+    SQLDatabase: process.env.SQL_DATABASE || 'snipe',
+    SQLHost: process.env.SQL_HOST || 'localhost',
+    SQLPort: process.env.SQL_PORT || 3306,
+    SQLDriver: process.env.SQL_DRIVER || 'mysql', //'mysql'|'sqlite'|'postgres'|'mssql'
+    SQLTimezone: process.env.SQL_TIMEZONE || '+01:00'
 };

gulpfile.js

@@ -62,6 +62,7 @@ gulp.task('service', function(){
     var name;
     var baseurl;
     var endpoint;
+    var isSQL;
     baseurl = args.baseurl;
     endpoint = args.endpoint;
     if(!baseurl){
@@ -71,7 +72,11 @@ gulp.task('service', function(){
     if(!endpoint){
         endpoint = args.e;
     }
+
+    isSQL = args.sql;
+
     name = args.name;
+    
     if(!name){
         name = args.n;
     }
@@ -102,7 +107,7 @@ gulp.task('service', function(){
 });
 
     // Create the Route Unit Test
-    fs.readFile('./template/route_test.tmpl', function(err, data){
+    fs.readFile(isSQL ? './template/route_sql_test.tmpl' : './template/route_test.tmpl', function(err, data){
       if (err){
         throw err;
     } 
@@ -134,7 +139,7 @@ gulp.task('service', function(){
         });
     });
     }else{
-        fs.readFile('./template/model.tmpl', function(err, data){
+        fs.readFile(isSQL ? './template/model_sql.tmpl' : './template/model.tmpl', function(err, data){
           if (err){
             throw err;
         } 
@@ -151,7 +156,7 @@ gulp.task('service', function(){
     }
 
     // Create the Model Unit Test
-    fs.readFile('./template/model_test.tmpl', function(err, data){
+    fs.readFile(isSQL ? './template/model_sql_test.tmpl' : './template/model_test.tmpl', function(err, data){
       if (err){
         throw err;
     } 
@@ -167,7 +172,7 @@ gulp.task('service', function(){
 });
 
     // Create the controller
-    fs.readFile('./template/controller.tmpl', function(err, data){
+    fs.readFile(isSQL ? './template/controller_sql.tmpl' : './template/controller.tmpl', function(err, data){
       if (err){
         throw err;
     } 
@@ -183,7 +188,7 @@ gulp.task('service', function(){
 });
 
     // Create the controller Unit test
-    fs.readFile('./template/controller_test.tmpl', function(err, data){
+    fs.readFile(isSQL ? './template/controller_sql_test.tmpl' : './template/controller_test.tmpl', function(err, data){
       if (err){
         throw err;
     }