12 Commits

Author SHA1 Message Date
f51079eeb4 Refactor code and include yaml file reading. 2020-09-26 12:54:31 +02:00
fae622aafc Add security layer. 2020-09-26 12:41:12 +02:00
5e6da61ccb Update repository functions. 2020-09-26 12:09:46 +02:00
59c4b0de38 Code cleaning. 2020-09-06 19:37:38 +02:00
29411d3c87 Clean code. 2020-09-06 19:36:58 +02:00
dc79b7bc0e Correct crud functions. 2020-09-06 19:23:11 +02:00
Pierre THIERRY
d4cc887bf5 WIP 2020-09-06 12:20:22 +02:00
Pierre THIERRY
14da8bf0f1 Correct the insert function in base repository. 2020-09-06 11:54:57 +02:00
Pierre THIERRY
c618675a9a Add src folder and correct base repository functions. 2020-09-05 19:18:51 +02:00
Pierre THIERRY
80253cabf8 Add mongo init database script. 2020-09-05 16:30:41 +02:00
Pierre THIERRY
2c424ac5d6 Add other function to base repository. 2020-09-05 16:30:25 +02:00
Pierre THIERRY
a558f09fb4 Add generics functions to mongo class. 2020-09-05 13:01:05 +02:00
20 changed files with 486 additions and 68 deletions

46
.eslintrc.json Normal file
View File

@@ -0,0 +1,46 @@
{
"root": true,
"env": {
"node": true,
"browser": true,
"es6": true
},
"extends": [
"eslint:recommended"
],
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly",
"$": "readonly",
"google": "readonly",
"exampleGlobalVariable": true
},
"plugins": [
// "jquery"
],
"parserOptions": {
"ecmaVersion": 2018,
"sourceType": "module"
},
"rules": {
"semi": ["error", "always"],
"no-inner-declarations": 0,
"indent": ["error", 4],
"eqeqeq": ["warn", "always"],
"curly": "error",
"default-case": "error",
"no-var": "error",
"no-multi-spaces": "error",
"no-useless-constructor": "error",
"prefer-const": "error",
"prefer-rest-params": "error",
"prefer-spread": "error",
"no-console": "off",
"prefer-template": "warn",
"quotes": [
"warn",
"single",
{ "avoidEscape": true }
]
}
}

17
.vscode/launch.json vendored Normal file
View File

@@ -0,0 +1,17 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Launch Program",
"skipFiles": [
"<node_internals>/**"
],
"program": "${workspaceFolder}/src/js/app.js"
}
]
}

80
README.md Normal file
View File

@@ -0,0 +1,80 @@
# Présentation
Ce projet sert de socle technique facilitant le développement de "back-end" d'applications en NodeJS, communiquant avec une base MongoDB.
## Base de données
Il s'agit d'une base MongoDB.
On peut simplement créer/démarrer la base en utilisant le fichier `docker-compose.yml` :
```bash
$ cd <PROJECT_PATH>/docker
$ docker-compose up -d
```
Par défaut, la base utilise le port `27017`.
# Application Back-end
## Notions théoriques
### Route
Une route correspond à l'URI associée à un service exposé.
Typiquement, une route est composée d'un chemin, par exemple `/users`, et d'un verbe http, par exemple `POST`.
### Controleurs
Un controlleur est un composant qui expose des services via la déclaration de routes.
## Controlleurs
### Création
Pour créer un controlleur, il suffit de copier-coller le fichier `src/js/controller/templateCtrl.js` et de renommer la copie, de préférence, de cette façon `<entity>Ctrl.js`.
Par exemple, si on veut exposer un service sur des entités représentant des voitures, on appelerait ce controlleur `carCtrl.js`.
### Déclaration
Une fois le controlleur créé, les routes qu'il contient ne sont pas effectives. En effet, le controlleur est créé mais n'est pas lié à l'application `Express`.
Pour que notre nouveau controlleur soit utilisée par notre application, il va falloir le déclarer en modifiant le fichier `src/js/app.js`.
Dans un premier temps, il va falloir importer notre controlleur, en utilisant l'instruction suivante, mais de préférence en haut du fichier `src/js/app.js` :
```javascript
const carController = require('./controller/carCtrl');
```
Puis, dans un second temps, il va falloir déclarer le controlleur dans l'application `Express`, en utilisant la méthode `use` comme ce qui suit :
```javascript
app.use('/cars', carController);
```
Voilà, votre controlleur est effectif, les services qu'il expose sont désormais accéssibles.
# Communication avec la base de données
## Notions théoriques
MongoDB est un gestionnaire de base de données `NoSQL`, et orienté `Document`s.
Un document est la représentation `JSON` d'entités.
Les documents sont stockés dans des `collections`, ce sont des sortes de "dépôts".
Par convention, on stocke les mêmes types d'entités dans une seule et même collection.
Imaginons que notre application permette de gérer des voitures et des clients, alors on créera deux collections dans notre base de données : `cars` et `customers`.
Si notre application doit gérer plusieurs types de véhicules, des voitures essences, diesel, électriques, hybrides etc., alors on doit se demander si toutes ces entités doivent être stockées dans la même collection `cars`, ou si c'est plus pertinent d'en créer d'autres.
Si la différence entre les différentes catégories de véhicules n'est pas très grande et peu importante dans la logique métier de l'application, alors il vaut mieux stocker toutes les voitures dans la même collection.
## Manipulation d'une collection
Il existe une classe permettant de créer/modifier/supprimer/récupérer des entités dans la base Mongo.
Il s'agit de la classe `Repository`, définie dans le fichier `src/js/repository/repository.js`.
Si on veut exposer des services pour manipuler des voitures, qui sont stockées dans la collection `cars`, il suffit alors de créer un objet `Repository`, en passant en paramètre du constructeur de cette classe, le nom de la collection :
```javascript
// En haut du fichier :
const Repository = require('../repository/repository');
...
const carRepository = new Repository('cars');
```
Ensuite, il suffira d'utiliser les méthodes suivantes en fonction de l'implémentation souaitée des services qu'on veut exposer : `find`, `insert`, `update` et `delete`.

12
app.js
View File

@@ -1,12 +0,0 @@
const express = require('express');
const Mongo = require('./mongo');
const app = express();
const port = 3000;
app.get('/test', (request, response) => {
const mongoClient = new Mongo();
})
app.listen(port, () => console.log('Mock is listening at port ', port, '\n'));

View File

@@ -0,0 +1,7 @@
version: "3.6"
services:
mongo:
container_name: "mongo"
image: "mongo:latest"
ports:
- "27017:27017"

View File

@@ -1,27 +0,0 @@
const mongodb = require('mongodb');
const assert = require('assert');
const mongoConfig = {
url: 'mongodb://localhost:27017',
username: 'express-user',
password: 'P@ssword1',
database: 'express-test'
}
class Mongo {
constructor() {
mongodb.MongoClient.connect(mongoConfig.url, (err, client) => {
assert.equal(null, err);
console.log('Connected successfuly to mongodb');
this.db = client.db(mongoConfig.database);
this.db.collection('test').find({}, (err, results) => {
results.forEach(console.log);
});
client.close();
})
}
}
module.exports = Mongo;

34
package-lock.json generated
View File

@@ -1,5 +1,5 @@
{ {
"name": "Mock-SDS", "name": "ExpressJS",
"version": "1.0.0", "version": "1.0.0",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
@@ -179,7 +179,6 @@
"version": "2.2.1", "version": "2.2.1",
"resolved": "https://registry.npmjs.org/bl/-/bl-2.2.1.tgz", "resolved": "https://registry.npmjs.org/bl/-/bl-2.2.1.tgz",
"integrity": "sha512-6Pesp1w0DEX1N550i/uGV/TqucVL4AM/pgThFSN/Qq9si1/DF9aIHs1BxD8V/QU0HoeHO6cQRTAuYnLPKq1e4g==", "integrity": "sha512-6Pesp1w0DEX1N550i/uGV/TqucVL4AM/pgThFSN/Qq9si1/DF9aIHs1BxD8V/QU0HoeHO6cQRTAuYnLPKq1e4g==",
"dev": true,
"requires": { "requires": {
"readable-stream": "^2.3.5", "readable-stream": "^2.3.5",
"safe-buffer": "^5.1.1" "safe-buffer": "^5.1.1"
@@ -315,8 +314,7 @@
"bson": { "bson": {
"version": "1.1.5", "version": "1.1.5",
"resolved": "https://registry.npmjs.org/bson/-/bson-1.1.5.tgz", "resolved": "https://registry.npmjs.org/bson/-/bson-1.1.5.tgz",
"integrity": "sha512-kDuEzldR21lHciPQAIulLs1LZlCXdLziXI6Mb/TDkwXhb//UORJNPXgcRs2CuO4H0DcMkpfT3/ySsP3unoZjBg==", "integrity": "sha512-kDuEzldR21lHciPQAIulLs1LZlCXdLziXI6Mb/TDkwXhb//UORJNPXgcRs2CuO4H0DcMkpfT3/ySsP3unoZjBg=="
"dev": true
}, },
"bytes": { "bytes": {
"version": "3.1.0", "version": "3.1.0",
@@ -517,8 +515,7 @@
"core-util-is": { "core-util-is": {
"version": "1.0.2", "version": "1.0.2",
"resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz",
"integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac="
"dev": true
}, },
"cross-spawn": { "cross-spawn": {
"version": "7.0.3", "version": "7.0.3",
@@ -575,8 +572,7 @@
"denque": { "denque": {
"version": "1.4.1", "version": "1.4.1",
"resolved": "https://registry.npmjs.org/denque/-/denque-1.4.1.tgz", "resolved": "https://registry.npmjs.org/denque/-/denque-1.4.1.tgz",
"integrity": "sha512-OfzPuSZKGcgr96rf1oODnfjqBFmr1DVoc/TrItj3Ohe0Ah1C5WX5Baquw/9U9KovnQ88EqmJbD66rKYUQYN1tQ==", "integrity": "sha512-OfzPuSZKGcgr96rf1oODnfjqBFmr1DVoc/TrItj3Ohe0Ah1C5WX5Baquw/9U9KovnQ88EqmJbD66rKYUQYN1tQ=="
"dev": true
}, },
"depd": { "depd": {
"version": "1.1.2", "version": "1.1.2",
@@ -1241,8 +1237,7 @@
"isarray": { "isarray": {
"version": "1.0.0", "version": "1.0.0",
"resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz", "resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz",
"integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=", "integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE="
"dev": true
}, },
"isexe": { "isexe": {
"version": "2.0.0", "version": "2.0.0",
@@ -1350,7 +1345,6 @@
"version": "1.5.0", "version": "1.5.0",
"resolved": "https://registry.npmjs.org/memory-pager/-/memory-pager-1.5.0.tgz", "resolved": "https://registry.npmjs.org/memory-pager/-/memory-pager-1.5.0.tgz",
"integrity": "sha512-ZS4Bp4r/Zoeq6+NLJpP+0Zzm0pR8whtGPf1XExKLJBAczGMnSi3It14OiNCStjQjM6NU1okjQGSxgEZN8eBYKg==", "integrity": "sha512-ZS4Bp4r/Zoeq6+NLJpP+0Zzm0pR8whtGPf1XExKLJBAczGMnSi3It14OiNCStjQjM6NU1okjQGSxgEZN8eBYKg==",
"dev": true,
"optional": true "optional": true
}, },
"merge-descriptors": { "merge-descriptors": {
@@ -1415,7 +1409,6 @@
"version": "3.6.1", "version": "3.6.1",
"resolved": "https://registry.npmjs.org/mongodb/-/mongodb-3.6.1.tgz", "resolved": "https://registry.npmjs.org/mongodb/-/mongodb-3.6.1.tgz",
"integrity": "sha512-uH76Zzr5wPptnjEKJRQnwTsomtFOU/kQEU8a9hKHr2M7y9qVk7Q4Pkv0EQVp88742z9+RwvsdTw6dRjDZCNu1g==", "integrity": "sha512-uH76Zzr5wPptnjEKJRQnwTsomtFOU/kQEU8a9hKHr2M7y9qVk7Q4Pkv0EQVp88742z9+RwvsdTw6dRjDZCNu1g==",
"dev": true,
"requires": { "requires": {
"bl": "^2.2.0", "bl": "^2.2.0",
"bson": "^1.1.4", "bson": "^1.1.4",
@@ -1618,8 +1611,7 @@
"process-nextick-args": { "process-nextick-args": {
"version": "2.0.1", "version": "2.0.1",
"resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz",
"integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag=="
"dev": true
}, },
"progress": { "progress": {
"version": "2.0.3", "version": "2.0.3",
@@ -1712,7 +1704,6 @@
"version": "2.3.7", "version": "2.3.7",
"resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.7.tgz", "resolved": "https://registry.npmjs.org/readable-stream/-/readable-stream-2.3.7.tgz",
"integrity": "sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw==", "integrity": "sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw==",
"dev": true,
"requires": { "requires": {
"core-util-is": "~1.0.0", "core-util-is": "~1.0.0",
"inherits": "~2.0.3", "inherits": "~2.0.3",
@@ -1760,7 +1751,6 @@
"version": "1.0.1", "version": "1.0.1",
"resolved": "https://registry.npmjs.org/require_optional/-/require_optional-1.0.1.tgz", "resolved": "https://registry.npmjs.org/require_optional/-/require_optional-1.0.1.tgz",
"integrity": "sha512-qhM/y57enGWHAe3v/NcwML6a3/vfESLe/sGM2dII+gEO0BpKRUkWZow/tyloNqJyN6kXSl3RyyM8Ll5D/sJP8g==", "integrity": "sha512-qhM/y57enGWHAe3v/NcwML6a3/vfESLe/sGM2dII+gEO0BpKRUkWZow/tyloNqJyN6kXSl3RyyM8Ll5D/sJP8g==",
"dev": true,
"requires": { "requires": {
"resolve-from": "^2.0.0", "resolve-from": "^2.0.0",
"semver": "^5.1.0" "semver": "^5.1.0"
@@ -1769,14 +1759,12 @@
"resolve-from": { "resolve-from": {
"version": "2.0.0", "version": "2.0.0",
"resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-2.0.0.tgz", "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-2.0.0.tgz",
"integrity": "sha1-lICrIOlP+h2egKgEx+oUdhGWa1c=", "integrity": "sha1-lICrIOlP+h2egKgEx+oUdhGWa1c="
"dev": true
}, },
"semver": { "semver": {
"version": "5.7.1", "version": "5.7.1",
"resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz",
"integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ=="
"dev": true
} }
} }
}, },
@@ -1827,7 +1815,6 @@
"version": "1.0.3", "version": "1.0.3",
"resolved": "https://registry.npmjs.org/saslprep/-/saslprep-1.0.3.tgz", "resolved": "https://registry.npmjs.org/saslprep/-/saslprep-1.0.3.tgz",
"integrity": "sha512-/MY/PEMbk2SuY5sScONwhUDsV2p77Znkb/q3nSVstq/yQzYJOH/Azh29p9oJLsl3LnQwSvZDKagDGBsBwSooag==", "integrity": "sha512-/MY/PEMbk2SuY5sScONwhUDsV2p77Znkb/q3nSVstq/yQzYJOH/Azh29p9oJLsl3LnQwSvZDKagDGBsBwSooag==",
"dev": true,
"optional": true, "optional": true,
"requires": { "requires": {
"sparse-bitfield": "^3.0.3" "sparse-bitfield": "^3.0.3"
@@ -1935,7 +1922,6 @@
"version": "3.0.3", "version": "3.0.3",
"resolved": "https://registry.npmjs.org/sparse-bitfield/-/sparse-bitfield-3.0.3.tgz", "resolved": "https://registry.npmjs.org/sparse-bitfield/-/sparse-bitfield-3.0.3.tgz",
"integrity": "sha1-/0rm5oZWBWuks+eSqzM004JzyhE=", "integrity": "sha1-/0rm5oZWBWuks+eSqzM004JzyhE=",
"dev": true,
"optional": true, "optional": true,
"requires": { "requires": {
"memory-pager": "^1.0.2" "memory-pager": "^1.0.2"
@@ -1984,7 +1970,6 @@
"version": "1.1.1", "version": "1.1.1",
"resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz",
"integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==",
"dev": true,
"requires": { "requires": {
"safe-buffer": "~5.1.0" "safe-buffer": "~5.1.0"
} }
@@ -2216,8 +2201,7 @@
"util-deprecate": { "util-deprecate": {
"version": "1.0.2", "version": "1.0.2",
"resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
"integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8=", "integrity": "sha1-RQ1Nyfpw3nMnYvvS1KKJgUGaDM8="
"dev": true
}, },
"utils-merge": { "utils-merge": {
"version": "1.0.1", "version": "1.0.1",

View File

@@ -4,19 +4,22 @@
"description": "", "description": "",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {
"start": "nodemon ./app.js localhost 3000", "start": "nodemon ./src/js/app.js localhost 3000",
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
}, },
"keywords": [], "keywords": [],
"author": "", "author": "",
"license": "ISC", "license": "ISC",
"dependencies": { "dependencies": {
"express": "^4.17.1" "bcrypt": "^5.0.0",
"express": "^4.17.1",
"jsonwebtoken": "^8.5.1",
"mongodb": "^3.6.1",
"yaml": "^1.10.0"
}, },
"devDependencies": { "devDependencies": {
"eslint": "^7.4.0", "eslint": "^7.4.0",
"eslint-plugin-node": "^11.1.0", "eslint-plugin-node": "^11.1.0",
"nodemon": "^2.0.4", "nodemon": "^2.0.4"
"mongodb": "^3.6.1"
} }
} }

15
src/js/app.js Normal file
View File

@@ -0,0 +1,15 @@
const express = require('express');
const bodyParser = require('body-parser');
const applicationController = require('./controller/applicationCtrl');
const userController = require('./controller/userCtrl');
const port = 3000;
const app = express();
app.use(bodyParser.urlencoded({ extended: true }));
app.use(bodyParser.json());
app.use('/apps', applicationController);
app.use('/users', userController);
app.listen(port, () => console.log('Mock is listening at port ', port, '\n'));

16
src/js/configuration.js Normal file
View File

@@ -0,0 +1,16 @@
const fs = require('fs');
const yaml = require('yaml');
const configurationFile = fs.readFileSync('src/resources/application.yml', 'utf8');
const configuration = yaml.parse(configurationFile);
console.log(configuration);
module.exports = configuration;
// module.exports = {
// database: {
// url: 'mongodb://localhost:27017',
// username: 'express-user',
// password: 'P@ssword1',
// database: 'express-test'
// }
// };

View File

@@ -0,0 +1,52 @@
const Repository = require('../repository/repository');
const router = require('express').Router();
const applicationRepository = new Repository('applications');
router.get('/', (request, response) => {
applicationRepository.find({}, results => {
response.json(results);
});
});
router.get('/:applicationId', (request, response) => {
applicationRepository.find({_id: request.params.applicationId}, (result) => {
response.json(result[0]);
});
});
router.post('/', (request, response) => {
applicationRepository.insert(request.body, (result) => {
response.json(result);
});
});
router.put('/:applicationId', (request, response) => {
const applicationId = request.params.applicationId;
applicationRepository.find({_id: applicationId}, entity => {
if (entity.length === 0) {
response.status(404).send();
} else {
const applicationToUpdate = request.body;
applicationToUpdate._id = applicationId;
applicationRepository.update(applicationToUpdate, () => {
response.status(204).send();
});
}
});
});
router.delete('/:applicationId', (request, response) => {
const applicationId = request.params.applicationId;
applicationRepository.find({_id: applicationId}, entity => {
if (entity.length === 0) {
response.status(404).send();
} else {
applicationRepository.delete(applicationId, () => {
response.status(204).send();
});
}
});
});
module.exports = router;

View File

@@ -0,0 +1,6 @@
const Repository = require('../repository/repository');
const router = require('express').Router();
// Develop routes here
module.exports = router;

View File

@@ -0,0 +1,17 @@
const router = require('express').Router();
const tokenService = require('../service/tokenService');
const userService = require('../service/userService');
// Develop routes here
router.post('/login', (request, response) => {
const loginRequest = request.body;
if (!!loginRequest && userService.areCredentialsValid(loginRequest.login, loginRequest.password)) {
const tokenPayload = { login: loginRequest.login };
response.json(tokenService.build(tokenPayload));
} else {
response.status(403).send();
}
});
module.exports = router;

View File

@@ -0,0 +1,65 @@
const mongodb = require('mongodb');
const configuration = require('../configuration');
const mongoConfig = configuration.mongodb;
class MongoClient {
constructor() {
mongodb.MongoClient.connect(mongoConfig.url, (error, client) => {
if (error !== null) {
throw new Error(`Unable de connect to Mongo database: ${error}`);
}
console.log('Connected successfuly to mongodb');
this.db = client.db(mongoConfig.database);
});
}
find(collectionName, query, callback) {
this.db.collection(collectionName).find(query).toArray()
.then(results => {
console.log(`Entities ${collectionName} founded.`);
callback(results);
})
.catch(error => {
throw new Error(`Unable to find entities in collection ${collectionName}: ${error}`);
});
}
insert(collectionName, entity, callback) {
this.db.collection(collectionName).insertOne(entity, (error, result) => {
if (error !== null) {
throw new Error(`Unable to insert ${collectionName} entity: ${error}`);
}
console.log(`Entity ${collectionName} inserted.`);
// Return only the inserted document.
callback(result.ops[0]);
});
}
update(collectionName, entity, callback) {
this.db.collection(collectionName).updateOne({_id: mongodb.ObjectId(entity._id)}, {$set: entity}, {upsert: true}, (error) => {
if (error !== null) {
throw new Error(`Unable to update ${collectionName} entity: ${error}`);
}
console.log(`Entity ${collectionName} updated.`);
callback();
});
}
delete(collectionName, entityId, callback) {
this.db.collection(collectionName).deleteOne({_id: mongodb.ObjectId(entityId)}, (error) => {
if (error !== null) {
throw new Error(`Unable to delete ${collectionName} entity with id ${entityId}: ${error}`);
}
console.log(`Entity ${collectionName} with id ${entityId} deleted.`);
callback();
});
}
}
// Define a singleton of class "MongoClient".
const mongoClient = new MongoClient();
module.exports = mongoClient;

View File

@@ -0,0 +1,63 @@
const mongoClient = require('./mongoClient');
const ObjectId = require('mongodb').ObjectId;
/**
* If entity in parameters has an attribute named "_id", this function converts it into a MongoDB {@code ObjectId}.
*/
function convertIdToMongodbFormat(entity) {
if (!!entity._id && !(entity._id instanceof ObjectId)) {
entity._id = ObjectId(entity._id);
}
}
module.exports = class Repository {
/**
* Creates a new repository which read and write into the {@code collectionName} collection in database.
* @param {*} collectionName
*/
constructor(collectionName) {
this.collectionName = collectionName;
this.mongoClient = mongoClient;
}
/**
* Returns the entities that matches criteria in {@code query}.
* @param {*} query The query which contains criteria to find some entities.
* @param {*} callback The function to execute after getting entities.
*/
find(query, callback) {
convertIdToMongodbFormat(query);
this.mongoClient.find(this.collectionName, query, callback);
}
/**
* Insert entity in database.
* @param {*} entity The entity to insert into database.
* @param {*} callback The function to execute after inserting entity.
*/
insert(entity, callback) {
this.mongoClient.insert(this.collectionName, entity, callback);
}
/**
* Update the whole entity in database.
* @param {*} entity The entity to update into database.
* @param {*} callback The function to execute after updating entity.
*/
update(entity, callback) {
convertIdToMongodbFormat(entity);
this.mongoClient.update(this.collectionName, entity, callback);
}
/**
* Delete entity in database.
* @param {*} entityId Entity to delete id.
* @param {*} callback The function to execute after deleting entity.
*/
delete(entityId, callback) {
if (!(entityId instanceof ObjectId)) {
entityId = ObjectId(entityId);
}
this.mongoClient.delete(this.collectionName, entityId, callback);
}
};

View File

@@ -0,0 +1,16 @@
const bcrypt = require('bcrypt');
const saltRounds = 10;
class PasswordService {
hashPassword(password) {
const salt = bcrypt.genSaltSync(saltRounds);
return bcrypt.hashSync(password, salt);
}
areSamePasswords(plainTextPassword, hashedPassword) {
return bcrypt.compareSync(plainTextPassword, hashedPassword);
}
}
const singleton = new PasswordService();
module.exports = singleton;

View File

@@ -0,0 +1,21 @@
const jwt = require('jsonwebtoken');
const configuration = require('../configuration');
const securityConfig = configuration.security;
class TokenService {
build(tokenPayload) {
return jwt.sign(tokenPayload, securityConfig.jwt.secret, {expiresIn: securityConfig.jwt.validity});
}
isValid(token) {
try {
jwt.verify(token, securityConfig.jwt.secret);
} catch (exception) {
return false;
}
return true;
}
}
const jwtInstance = new TokenService();
module.exports = jwtInstance;

View File

@@ -0,0 +1,26 @@
const Repository = require('../repository/repository');
const passwordService = require('./passwordService');
const userRepository = new Repository('users');
class UserService {
getUser(login) {
return login === 'toto'
? {login: 'toto', password: passwordService.hashPassword('pwd')}
: undefined;
}
isAuthenticated() {
return false;
}
areCredentialsValid(login, password) {
const user = this.getUser(login);
// If login is incorrect, the "getUser" function will return "undefined".
// So if "user" is not "undefined", this proofs that login is correct.
return !!user && passwordService.areSamePasswords(password, user.password);
}
}
const singleton = new UserService();
module.exports = singleton;

View File

@@ -0,0 +1,14 @@
use express-test;
db.collection.test.insert({id: 'test'});
db.createUser(
{
user: "express-user",
pwd: "P@ssword1",
roles:
[
{ role: "readWrite", db: "express-test" }
]
}
)

View File

@@ -0,0 +1,9 @@
mongodb:
url: 'mongodb://localhost:27017'
username: 'express-user'
password: 'P@ssword1'
database: 'express-test'
security:
jwt:
secret: 5ubtcCCo7hWBqjNGtzzVKnLT1KxN9uS4D6kRZowCunZAYPmxtKy6mvgoxANe4WqLVfiVI7AZSVqZCtvlSWFwIsnXGH6lxeKG0U8Wu7Kw0jwfFOGLvlO8bXaB
validity: 1h