feature/fullstack

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "docwriter.language": "English",
+    "docwriter.style": "JSDoc",
+    "docwriter.progress.trackClasses": true
+}

staff/mario-aller/fullstack/api/README.md

@@ -0,0 +1,84 @@
+# api
+
+## Functional Description (FDS)
+
+This process manage the connection of database to the user interface
+
+## Technical Specs.
+
+### Enviroment Variables (.env)
+
+- API_PORT = port of API
+
+- JWT_SECRET = secret string for jsonwebtoken
+
+- MONGOOSE_URL = mongodb address
+
+### Modules to be installed previosly
+- cors
+- dotenv
+- express
+- jsonwebtoken
+- dat
+```sh
+npm install
+```
+
+### To execute the api
+
+Place in api root directory ~/quad/api
+
+- execute MongoDB
+
+```sh
+~/mongodb --dbpath data
+```
+
+- run
+```sh
+npm run start
+```
+
+### Test Coverage
+
+File                                  | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
+--------------------------------------|---------|----------|---------|---------|-------------------
+All files                             |     100 |      100 |     100 |     100 |                   
+ panels                               |     100 |      100 |     100 |     100 |                   
+  createBlock.js                      |     100 |      100 |     100 |     100 |                   
+  createBlock.spec.js                 |     100 |      100 |     100 |     100 |                   
+  createPanel.js                      |     100 |      100 |     100 |     100 |                   
+  createPanel.spec.js                 |     100 |      100 |     100 |     100 |                   
+  deleteBlock.js                      |     100 |      100 |     100 |     100 |                   
+  deleteBlock.spec.js                 |     100 |      100 |     100 |     100 |                   
+  deletePanel.js                      |     100 |      100 |     100 |     100 |                   
+  deletePanel.spec.js                 |     100 |      100 |     100 |     100 |                   
+  index.js                            |     100 |      100 |     100 |     100 |                   
+  retrievePanelOne.js                 |     100 |      100 |     100 |     100 |                   
+  retrievePanelOne.spec.js            |     100 |      100 |     100 |     100 |                   
+  retrievePanelWorking.js             |     100 |      100 |     100 |     100 |                   
+  retrievePanelWorking.spec.js        |     100 |      100 |     100 |     100 |                   
+  retrievePanels.js                   |     100 |      100 |     100 |     100 |                   
+  retrievePanels.spec.js              |     100 |      100 |     100 |     100 |                   
+  updatePanel.js                      |     100 |      100 |     100 |     100 |                   
+  updatePanel.spec.js                 |     100 |      100 |     100 |     100 |                   
+  updatePanelStatusReEdit.js          |     100 |      100 |     100 |     100 |                   
+  updatePanelStatusReEdit.spec.js     |     100 |      100 |     100 |     100 |                   
+  updatePanelStatusToOptimize.js      |     100 |      100 |     100 |     100 |                   
+  updatePanelStatusToOptimize.spec.js |     100 |      100 |     100 |     100 |                   
+ users                                |     100 |      100 |     100 |     100 |                   
+  authenticateUser.js                 |     100 |      100 |     100 |     100 |                   
+  authenticateUser.spec.js            |     100 |      100 |     100 |     100 |                   
+  index.js                            |     100 |      100 |     100 |     100 |                   
+  registerUser.js                     |     100 |      100 |     100 |     100 |                   
+  registerUser.spec.js                |     100 |      100 |     100 |     100 |                   
+  retrieveUser.js                     |     100 |      100 |     100 |     100 |                   
+  retrieveUser.spec.js                |     100 |      100 |     100 |     100 |                   
+  updateUser.js                       |     100 |      100 |     100 |     100 |                   
+  updateUser.spec.js                  |     100 |      100 |     100 |     100 |
+
+Lines	
+- panels 630/630
+- users 153/153
+
+[Home](../doc/README.md)

staff/mario-aller/fullstack/api/index.js

@@ -0,0 +1,263 @@
+// Enviroment
+require('dotenv').config()
+const {
+    API_PORT,
+    JWT_SECRET,
+    MONGOOSE_URL
+} = process.env
+
+// Modules
+const { mongoose } = require('dat')
+const express = require('express')
+const bodyParser = require('body-parser')
+const cors = require('cors')
+const jwt = require('jsonwebtoken')
+
+// User-defined modules
+// const { Dimension, Dimension2D, Block, Panel } = require('./logic/classes')
+// const { sleep, display, validateString } = require('./logic/helpers')
+
+const {
+    registerUser,
+    authenticateUser,
+    retrieveUser,
+    updateUser
+} = require('./logic/users')
+
+const {
+    createPanel,
+    retrievePanels,
+    retrievePanelOne,
+    retrievePanelWorking,
+    updatePanel,
+    updatePanelStatusToOptimize,
+    updatePanelStatusReEdit,
+    deletePanel,
+    createBlock,
+    deleteBlock
+} = require('./logic/panels')
+
+const api = express()
+const jsonBodyParser = bodyParser.json()
+
+mongoose.connect(MONGOOSE_URL)
+    .then(() => {
+        api.use(cors())
+
+        // registerUser
+        /* This code is defining a route for the HTTP POST method at the '/users' endpoint. When a POST
+        request is made to this endpoint, the code inside the callback function will be executed. */
+        api.post('/users', jsonBodyParser, (req, res) => {
+            try {
+                const { name, surname, zip, email, password } = req.body
+
+                registerUser(name, surname, zip, email, password)
+                    .then(() => res.status(201).send())
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // authenticateUser
+        /* This code defines a route for the HTTP POST method at the '/users/auth' endpoint. When a
+        POST request is made to this endpoint, the code inside the callback function will be
+        executed. */
+        api.post('/users/auth', jsonBodyParser, (req, res) => {
+            try {
+                const { email, password } = req.body
+
+                authenticateUser(email, password)
+                    .then((userId) => {
+                        const token = jwt.sign({ sub: userId }, JWT_SECRET)
+                        res.json(token)
+                    })
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // retrieveUser
+        /* This code defines a route for the HTTP GET method at the '/users' endpoint. When a GET request is
+        made to this endpoint, the code inside the callback function will be executed. */
+        api.get('/users', (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+                retrieveUser(userId)
+                    .then(user => res.json(user))
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // updateUser
+        /* This code is defining a route for the HTTP PATCH method at the '/users' endpoint. When a PATCH
+        request is made to this endpoint, the code inside the callback function will be executed. */
+        api.patch('/users', jsonBodyParser, (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+
+                const { name, surname, zip } = req.body
+
+                updateUser(userId, name, surname, zip)
+                    .then(() => res.send())
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // createPanel
+        /* This code is defining a route for the HTTP POST method at the '/panels' endpoint. When a POST
+        request is made to this endpoint, the code inside the callback function will be executed. */
+        api.post('/panels', jsonBodyParser, (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+
+                const { reference, width, height } = req.body
+
+                createPanel(userId, reference, width, height)
+                    .then(() => res.status(201).send())
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // retrievePanels
+        /* This code is defining a route for the HTTP GET method at the '/panels' endpoint. When a GET request
+        is made to this endpoint, the code inside the callback function will be executed. */
+        api.get('/panels', (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+                retrievePanels(userId)
+                    .then(panels => res.json(panels))
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // retrievePanelOne
+        /* This code is defining a route for the HTTP GET method at the '/panels/:panelId' endpoint. When a GET
+        request is made to this endpoint, the code inside the callback function will be executed. */
+        api.get('/panels/:panelId', (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+                const { panelId } = req.params
+
+                retrievePanelOne(userId, panelId)
+                    .then(panel => res.json(panel))
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // retrievePanelWorking
+        /* This code defines a route for the HTTP GET method at the '/panels/:panelId/work' endpoint. When a
+        GET request is made to this endpoint, the code inside the callback function will be executed. */
+        api.get('/panels/:panelId/work', (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+                const { panelId } = req.params
+
+                retrievePanelWorking(userId, panelId)
+                    .then(coors => res.json(coors))
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // updatePanel
+        /* The code you provided is defining a route for the HTTP PATCH method at the '/panels/:panelId'
+        endpoint. When a PATCH request is made to this endpoint, the code inside the callback function will
+        be executed. */
+        api.patch('/panels/:panelId', jsonBodyParser, (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+                const { panelId } = req.params
+
+                const { reference, width, height } = req.body
+
+                updatePanel(userId, panelId, reference, width, height)
+                    .then(() => res.send())
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // updatePanelStatusToOptimize
+        /* This code is defining a route for the HTTP PATCH method at the '/panels/:panelId/optimize' endpoint.
+        When a PATCH request is made to this endpoint, the code inside the callback function will be
+        executed. */
+        api.patch('/panels/:panelId/optimize', (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+                const { panelId } = req.params
+
+                return updatePanelStatusToOptimize(userId, panelId)
+                    .then(() => res.send())
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // updatePanelStatusReEdit
+        /* This code defines a route for the HTTP PATCH method at the '/panels/status/reedit/:panelId'
+        endpoint. When a PATCH request is made to this endpoint, the code inside the callback function will
+        be executed. */
+        api.patch('/panels/status/reedit/:panelId', (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+                const { panelId } = req.params
+
+                updatePanelStatusReEdit(userId, panelId)
+                    .then(() => res.send())
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // deletePanel
+        /* This code is defining a route for the HTTP DELETE method at the '/panels/:panelId' endpoint. When a
+        DELETE request is made to this endpoint, the code inside the callback function will be executed. */
+        api.delete('/panels/:panelId', jsonBodyParser, (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+                const { panelId } = req.params
+
+                deletePanel(userId, panelId)
+                    .then(() => res.send())
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // createBlock
+        /* This code is defining a route for the HTTP POST method at the '/blocks' endpoint. When a POST
+        request is made to this endpoint, the code inside the callback function will be executed. */
+        api.post('/blocks', jsonBodyParser, (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+
+                const { panelId, width, height } = req.body
+
+                createBlock(userId, panelId, width, height)
+                    .then(() => res.status(201).send())
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        // deleteBlock
+        /* The above code is defining a route handler for a DELETE request to '/blocks/:panelId/:blockId'. It
+        first extracts the token from the 'Authorization' header and verifies it using a JWT secret. Then,
+        it extracts the 'panelId' and 'blockId' parameters from the request URL. */
+        api.delete('/blocks/:panelId/:blockId', jsonBodyParser, (req, res) => {
+            try {
+                const token = req.headers.authorization.slice(7)
+                const userId = jwt.verify(token, JWT_SECRET).sub
+                const { panelId, blockId } = req.params
+
+                deleteBlock(userId, panelId, blockId)
+                    .then(() => res.send())
+                    .catch(error => res.status(400).json({ error: error.message }))
+            } catch (error) { res.status(400).json({ error: error.message }) }
+        })
+
+        api.listen(API_PORT, () => console.log(`API working in port ${API_PORT} ...`))
+    })

staff/mario-aller/fullstack/api/logic/panels/createBlock.js

@@ -0,0 +1,32 @@
+const { models: { UserModel, PanelModel } } = require('dat')
+const { validateString } = require('com')
+
+/**
+ * The function creates a block with the specified width and height in a panel associated with a user.
+ * @param userId - The `userId` parameter is the unique identifier of the user for whom the block is
+ * being created.
+ * @param panelId - The `panelId` parameter is the unique identifier of the panel where the block will
+ * be created.
+ * @param width - The width of the block to be created.
+ * @param height - The height parameter represents the height of the block that will be created.
+ * @returns a Promise.
+ */
+function createBlock(userId, panelId, width, height) {
+    return Promise.all([UserModel.findById(userId, '_id').lean(), PanelModel.findById(panelId)])
+        .then(([user, panel]) => {
+            if (!user) throw new Error('user does not exist')
+            if (!panel) throw new Error('panel does not exist')
+
+            const x = -1
+            const y = -1
+            const orientation = 0
+            const block = { x, y, width: Number(width), height: Number(height), orientation }
+            panel.blocks.push(block)
+            panel.status = 0
+            return panel.save()
+        })
+        .then(() => { })
+
+}
+
+module.exports = createBlock