Feat/jwt (#6)

Dafloresdiaz · Daniel Flores Diaz · web-flow · commit 78411dd22822 · 2024-01-08T12:53:56.000-06:00
Co-authored-by: Daniel Flores Diaz &lt;daniel.flores@Daniel-Mac-Work.local&gt;
diff --git a/.env b/.env
@@ -0,0 +1 @@
+SECRET_KEY = "secret_key_value"
diff --git a/.env.example b/.env.example
@@ -0,0 +1 @@
+SECRET_KEY = "secret_key_value"
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@ node_modules/
 coverage/
 dist/
 .vscode/
+.env
diff --git a/README.md b/README.md
@@ -39,6 +39,10 @@ A Microservice API based on the hexagonal architecture using NodeJS + ExpressJS
 ```zsh
 npm install
 ```
+### Before running the project
+```zsh
+cp .env.example .env
+```
 
 #### Run
 
diff --git a/app/internal/adapters/auth/index.js b/app/internal/adapters/auth/index.js
@@ -0,0 +1 @@
+export * from './jwt';
diff --git a/app/internal/adapters/auth/jwt.js b/app/internal/adapters/auth/jwt.js
@@ -0,0 +1,24 @@
+import jsonwebtoken from "jsonwebtoken";
+import { defaultConfig } from "../../core/providers";
+
+const generateToken = (admin_id, expires_in) => {
+    return jsonwebtoken.sign({id: admin_id}, defaultConfig.security_key, {expiresIn:expires_in});
+}
+
+export const VerifyToken = (req, res, next) => {
+    const token = req.headers["authorization"] && req.headers["authorization"].split(" ")[1];
+    if (token !== "undefined"){
+        try {
+            jsonwebtoken.verify(token, defaultConfig.security_key);
+            next();
+        } catch(err){
+            next(err);
+        }
+    }else{
+        next();
+    }
+};
+
+export const Token ={
+    generateToken,
+};
diff --git a/app/internal/adapters/index.js b/app/internal/adapters/index.js
@@ -1,5 +1,5 @@
-import { MainRoute, UsersRoute} from './routes';
+import { MainRoute, UsersRoute, AuthRoute} from './routes';
 
 export const Adapters = {
-  Routes: { MainRoute, UsersRoute},
+  Routes: { MainRoute, UsersRoute, AuthRoute},
 };
diff --git a/app/internal/adapters/routes/auth.routes.js b/app/internal/adapters/routes/auth.routes.js
@@ -0,0 +1,14 @@
+import express from "express";
+import { AuthController } from "../../core/controllers";
+
+/**
+ * Create a new instance of UserRoutes.
+ * @param {express.Application} app - The Express application instance.
+ */
+export const AuthRoute = (app) =>{
+    const router = express.Router();
+    app.use('/auth', router);
+
+    //Get Token
+    router.get('/token', AuthController.getToken);
+};
diff --git a/app/internal/adapters/routes/index.js b/app/internal/adapters/routes/index.js
@@ -1,2 +1,3 @@
 export * from './main.routes';
 export * from './users.routes';
+export * from './auth.routes';
diff --git a/app/internal/adapters/routes/users.routes.js b/app/internal/adapters/routes/users.routes.js
@@ -8,7 +8,7 @@ import { UsersController } from "../../core/controllers";
 export const UsersRoute = (app) =>{
     const router = express.Router();
     app.use('/users', router);
-
+    
     //List by id
     router.get('/:id', UsersController.getById);
     // Create a new user
diff --git a/app/internal/core/controllers/auth.controller.js b/app/internal/core/controllers/auth.controller.js
@@ -0,0 +1,20 @@
+import { AuthServices } from '../services';
+import { constants } from 'http2';
+
+/**
+ * Callback function for performing a CRUD.
+ * @param {import('express').Request} req - Express request object.
+ * @param {import('express').Response} res - Express response object.
+ * @param {import('express').NextFunction} next - Express next middleware function.
+ * @function getToken - Obtain the JWT token.
+ */
+export const AuthController = {
+    getToken: (req, res, next) => {
+      try {
+        const token = AuthServices.getToken(req.body.admin_id, req.body.expires_in);
+        res.status(constants.HTTP_STATUS_OK).json(token);
+      } catch (err) {
+        next(err);
+      }
+    },
+};
diff --git a/app/internal/core/controllers/index.js b/app/internal/core/controllers/index.js
@@ -1,2 +1,3 @@
 export * from './main.controller';
-export * from './users.controller';
+export * from './users.controller';
+export * from './auth.controller';
diff --git a/app/internal/core/domain/models/responses.models.js b/app/internal/core/domain/models/responses.models.js
@@ -13,6 +13,28 @@ const simple = (message) => ({
   message,
 });
 
+/**
+ * Represents a token response object.
+ * @typedef {Object} TokenResponse
+ * @property {string} access_token - The token created.
+ * @property {string} expires_in - The expiration time of the toke.
+ * @property {string} token_type - The token type for the request, by default is Bearer.
+ */
+
+/**
+ * Creates a token response object.
+ * @param {string} token - The token created with the expiration time.
+ * @property {string} expires_in - The expiration time of the token.
+ * @returns {TokenResponse} The token response with the information about the token created.
+ */
+
+const tokenResponse = (token, expires_in) =>({
+  access_token: token,
+  expires_in: expires_in,
+  token_type: "Bearer"
+});
+
 export const Responses = {
   simple,
+  tokenResponse,
 };
diff --git a/app/internal/core/middlewares/configurations.js b/app/internal/core/middlewares/configurations.js
@@ -0,0 +1,6 @@
+import { defaultConfig } from '../providers';
+
+export const configurations = (req, res, next) => {
+  req.config = defaultConfig;
+  next();
+};
diff --git a/app/internal/core/middlewares/index.js b/app/internal/core/middlewares/index.js
@@ -1,2 +1,3 @@
 export * from './logs';
 export * from './error';
+export * from './configurations';
diff --git a/app/internal/core/providers/config.provider.js b/app/internal/core/providers/config.provider.js
@@ -0,0 +1,5 @@
+import 'dotenv/config';
+
+export const defaultConfig = {
+  security_key: process.env.SECRET_KEY,
+};
diff --git a/app/internal/core/providers/index.js b/app/internal/core/providers/index.js
@@ -0,0 +1 @@
+export * from './config.provider';
diff --git a/app/internal/core/services/auth.services.js b/app/internal/core/services/auth.services.js
@@ -0,0 +1,17 @@
+import { Domain } from '../domain';
+import { Token } from '../../adapters/auth';
+
+const {
+  Models: { Responses },
+} = Domain;
+
+/**
+ * Get Token response.
+ * @returns {import('../domain/models/responses.models.js').TokenResponse} The getByID response.
+ */
+export const AuthServices = {
+    getToken:(admin_id, expires_in) =>{
+      const token = Token.generateToken(admin_id, expires_in);
+      return Responses.tokenResponse(token, expires_in);
+    },
+};
diff --git a/app/internal/core/services/index.js b/app/internal/core/services/index.js
@@ -1,2 +1,3 @@
 export * from './main.services';
-export * from './users.services'
+export * from './users.services';
+export * from './auth.services';
diff --git a/app/internal/core/services/users.services.js b/app/internal/core/services/users.services.js
@@ -1,4 +1,3 @@
-import {UserModel} from '../models';
 import { Domain } from '../domain';
 
 const {
diff --git a/app/server/index.js b/app/server/index.js
@@ -2,7 +2,8 @@ import bodyParser from 'body-parser';
 import cors from 'cors';
 import express from 'express';
 import { Adapters } from '../internal/adapters';
-import { Logger, HandlerError } from '../internal/core/middlewares';
+import { VerifyToken } from '../internal/adapters/auth';
+import { Logger, HandlerError, configurations } from '../internal/core/middlewares';
 
 const { Routes } = Adapters;
 
@@ -11,8 +12,11 @@ App.use(cors());
 App.use(bodyParser.json());
 App.use(bodyParser.urlencoded({ extended: false }));
 App.use(Logger);
+App.use(configurations);
+App.use(VerifyToken);
 
 Routes.MainRoute(App);
+Routes.AuthRoute(App);
 Routes.UsersRoute(App);
 
 App.use(HandlerError);
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/test/functional/controllers/auth.controller.test.js b/test/functional/controllers/auth.controller.test.js
diff --git a/test/functional/controllers/main.controller.test.js b/test/functional/controllers/main.controller.test.js
diff --git a/test/functional/services/auth.services.test.js b/test/functional/services/auth.services.test.js
diff --git a/test/integration/routes/auth.routes.test.js b/test/integration/routes/auth.routes.test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`export * from './main.routes';`
`2`	`2`	`export * from './users.routes';`
	`3`	`+export * from './auth.routes';`