Release 1.0.0

Author: romwaldtff

README.md

@@ -11,24 +11,33 @@ The code is written in ES6 and uses Promises.
 
 ## Requirements :
 
-- [NodeJS](https://nodejs.org/en/).
-- [Npm](https://www.npmjs.com/).
+- [Git](https://git-scm.com/) if you want to clone this repository.
+- [NodeJS](https://nodejs.org/en/) to run the application.
+- [Npm](https://www.npmjs.com/) to install dependencies (see the full list below at "Dependencies").
 - [Postman](https://www.getpostman.com/) to test the API.
 
 ## Getting started :
 
-0. Install this application (See Installation).
-1. Start the server with : `node index.js`
-2. Connect Postman to the API at : `http://localhost:3000`
-3. Try the different routes of the API (For more details, see the [documentation](https://github.com/romwaldtff/NodeJS-REST-API-SQLite/wiki)).
+1. Install this application (See Installation).
+2. Start the server with : `node index.js`
+3. Connect Postman to the API at : `http://localhost:3000`
+4. Try the different routes of the API (For more details, see the [documentation](https://github.com/romwaldtff/NodeJS-REST-API-SQLite/wiki)).
 
 Alternatively, you can use `node index.js YOUR_PORT_NUMBER` to start the server with a specific port.  
 
+## Dependencies (installed via `npm install`)
+
+- [Body-parser](https://www.npmjs.com/package/body-parser), a Node.js body parsing middleware.
+- [Ejs](https://www.npmjs.com/package/ejs) embedded JavaScript templates.
+- [Express](https://www.npmjs.com/package/express), a fast and minimalist web framework for node.
+- [Sqlite](https://www.npmjs.com/package/sqlite), a wrapper library that adds ES6 promises and SQL-based migrations API to [sqlite3](https://www.npmjs.com/package/sqlite3)*.
+- [Bluebird](https://www.npmjs.com/package/bluebird) promise library.
+
 ## Credits
 
 - Made by [Romuald Tuffreau](https://github.com/romwaldtff).
 - [Laurent Guerin](https://github.com/l-gu), creator of [Telosys Tools](https://sites.google.com/site/telosystools/).
 
 ## License
 
-This project uses the LGPL v3 License (See the LICENSE file in this repository).
+This project uses the [LGPL v3 License](https://www.gnu.org/licenses/lgpl-3.0.en.html) (See the LICENSE file in this repository).

app/controller/carController.js

@@ -2,7 +2,7 @@
 const CarDao = require('../dao/carDao');
 
 /* Load Controller Common function */
-const controllerCommon = require('./common/controllerCommon');
+const ControllerCommon = require('./common/controllerCommon');
 
 /* Load Car entity */
 const Car = require('../model/car');
@@ -14,7 +14,7 @@ class CarController {
 
     constructor() {
         this.carDao = new CarDao();
-        this.common = new controllerCommon();
+        this.common = new ControllerCommon();
     }
 
     /**
@@ -24,47 +24,31 @@ class CarController {
      */
     findById(req, res) {
         let id = req.params.id;
-        let _self = this;
 
         this.carDao.findById(id)
-            .then(function (result) {
-                _self.common.findSuccess(result, res);
-            })
-            .catch(function (error) {
-                _self.common.findError(error, res);
-            });
+            .then(this.common.findSuccess(res))
+            .catch(this.common.findError(res));
     };
 
     /**
      * Finds all entities.
      * @return all entities
      */
     findAll(res) {
-        let _self = this;
-
         this.carDao.findAll()
-            .then(function (results) {
-                _self.common.findSuccess(results, res);
-            })
-            .catch(function (error) {
-                _self.common.findError(error, res);
-            });
+            .then(this.common.findSuccess(res))
+            .catch(this.common.findError(res));
     };
 
     /**
      * Counts all the records present in the database
      * @return count
      */
     countAll(res) {
-        let _self = this;
 
         this.carDao.countAll()
-            .then(function (result) {
-                _self.common.findSuccess(result, res);
-            })
-            .catch(function (error) {
-                _self.common.serverError(error, res);
-            });
+            .then(this.common.findSuccess(res))
+            .catch(this.common.serverError(res));
     };
 
     /**
@@ -73,16 +57,16 @@ class CarController {
      * @return true if the entity has been updated, false if not found and not updated
      */
     update(req, res) {
-        let _self = this;
-        let car = new Car(req.body.id, req.body.maker, req.body.model, req.body.year, req.body.driver);
+        let car = new Car();
+        car.id = req.body.id;
+        car.maker = req.body.maker;
+        car.model = req.body.model;
+        car.year = req.body.year;
+        car.driver = req.body.driver;
 
         return this.carDao.update(car)
-            .then(function () {
-                _self.common.editSuccess(res);
-            })
-            .catch(function (error) {
-                _self.common.serverError(error, res);
-            });
+            .then(this.common.editSuccess(res))
+            .catch(this.common.serverError(res));
     };
 
     /**
@@ -91,16 +75,26 @@ class CarController {
      * returns database insertion status
      */
     create(req, res) {
-        let _self = this;
-        let car = new Car(0, req.body.maker, req.body.model, req.body.year, req.body.driver);
-
-        return this.carDao.create(car)
-            .then(function () {
-                _self.common.editSuccess(res);
-            })
-            .catch(function (error) {
-                _self.common.serverError(error, res);
-            });
+        let car = new Car();
+        if (req.body.id) {
+            car.id = req.body.id;
+        }
+        car.maker = req.body.maker;
+        car.model = req.body.model;
+        car.year = req.body.year;
+        car.driver = req.body.driver;
+
+        if (req.body.id) {
+            return this.carDao.createWithId(car)
+                .then(this.common.editSuccess(res))
+                .catch(this.common.serverError(res));
+        }
+        else {
+            return this.carDao.create(car)
+                .then(this.common.editSuccess(res))
+                .catch(this.common.serverError(res));
+        }
+
     };
 
     /**
@@ -109,16 +103,11 @@ class CarController {
      * returns database deletion status
      */
     deleteById(req, res) {
-        let _self = this;
         let id = req.params.id;
 
         this.carDao.deleteById(id)
-            .then(function () {
-                _self.common.editSuccess(res);
-            })
-            .catch(function (error) {
-                _self.common.serverError(error, res);
-            });
+            .then(this.common.editSuccess(res))
+            .catch(this.common.serverError(res));
     };
 
     /**
@@ -127,16 +116,11 @@ class CarController {
      * @return
      */
     exists(req, res) {
-        let _self = this;
         let id = req.params.id;
 
         this.carDao.exists(id)
-            .then(function () {
-                _self.common.existsSuccess(res);
-            })
-            .catch(function (error) {
-                _self.common.findError(error, res);
-            });
+            .then(this.common.existsSuccess(res))
+            .catch(this.common.findError(res));
     };
 }
 

app/controller/common/controllerCommon.js

@@ -3,29 +3,39 @@
  */
 class controllerCommon {
 
-    findSuccess(result, res) {
-        res.status(200); // Found
-        res.json(result);
+    findSuccess(res) {
+        return (result) => {
+            res.status(200); // Found
+            res.json(result);
+        }
     }
 
-    existsSuccess(result, res) {
-        res.status(200); // Found
-        res.json(result);
+    existsSuccess(res) {
+        return (result) => {
+            res.status(200); // Found
+            res.json(result);
+        }
     }
 
     editSuccess(res) {
-        res.status(201); // Created/Updated/Deleted
-        res.json();
+        return () => {
+            res.status(201); // Created/Updated/Deleted
+            res.json({});
+        }
     }
 
-    serverError(error, res) {
-        res.status(500); // Not Created/Updated/Deleted
-        res.json(error);
+    serverError(res) {
+        return (error) => {
+            res.status(500);
+            res.json(error);
+        }
     }
 
-    findError(error, res) {
-        res.status(404); // Not found
-        res.json(error);
+    findError(res) {
+        return (error) => {
+            res.status(404); // Not found
+            res.json(error);
+        }
     }
 }