contributing rules aplied

Author: Chmod351

LICENCE.MD

@@ -3,6 +3,8 @@
 - [About this project](#About-this-project)
 - [Development Environment Setup](#Development-Environment-Setup)
 - [Available Endpoints](#Available-Endpoints)
+- [Contribution](#Contribution)
+- [Licence](#Licence)
 
 ## About this project
 
@@ -12,10 +14,11 @@ This project is a web application developed using Node.js v16.20.1. It follows t
 
 To set up the development environment for this project, follow these steps:
 
-- [Docker File](https://hub.docker.com/repository/docker/clamshell6412/ecomerce_res_api/general) (production only)
-- Install Node.js v16.20.1 (or a compatible version) on your system.
-- Clone the project repository from [repository URL].
-- Install project dependencies using npm or yarn. Run npm install or yarn install in the project root directory.
+- [Download Docker Desktop](https://www.docker.com/products/docker-desktop/) & [Docker File](https://hub.docker.com/repository/docker/clamshell6412/ecomerce_res_api/general) (production only)
+
+- Or you can just install Node.js [v16.20.1](https://nodejs.org/download/release/latest-gallium/) ([or a compatible version](https://nodejs.org/es/download/releases)) on your system.
+- Clone the project repository using `git clone https://github.com/yamilt351/api-rest.git`
+- Install project dependencies using npm or yarn. Run `npm install` or `yarn install` in the project root directory.
 - Configure the environment variables required for the project.
 
 ```
@@ -31,11 +34,11 @@ PORT=3000
 ```
 
 ```
-STRIPE_TOKEN=sk_text_z&&2DbCJa9d3gZkxFwJdE$&hHbRe47KHxAF%&N#qRVx*zVFG$W
+STRIPE_TOKEN=sk_text_YourStripeToken
 
 ```
 
-- Start the application using the appropriate command. Run npm run dev or yarn run dev to launch the application.
+- Start the application using `npm run dev` or `yarn run dev` to launch the application.
 - Access the application in a web browser using the provided URL or port number.
 
 # Available Endpoints
@@ -81,28 +84,31 @@ STRIPE_TOKEN=sk_text_z&&2DbCJa9d3gZkxFwJdE$&hHbRe47KHxAF%&N#qRVx*zVFG$W
 | Edit Status Purchase  | `/api/purchases/status/:purchaseId` | Put       |
 | Delete Purchase       | `/api/purchases/:purchaseId`        | Delete    |
 
-
 [Postman Documentation](https://documenter.getpostman.com/view/21643141/2s93sXcaLf#31c36708-d610-4480-8c8a-628bb32dcfde)
 
-| Comments Actions      | Routes                 | Http Verb |
-| --------------------- | ---------------------- | --------- |
-| Create Purchase       | `/api/comments/create` | Post      |
-| Payment               | `/api/comments/getAll` | Get       |
-| Get Monthly Purchases | `/api/comments/delete` | Delete    |
+| Comments Actions      | Routes                           | Http Verb |
+| --------------------- | -------------------------------- | --------- |
+| Create Comments       | `/api/comments/create/productId` | Post      |
+| Get Products Comments | `/api/comments/getAll/productId` | Get       |
+| Delete Comments       | `/api/comments/delete/commentId` | Delete    |
 
 [Postman Documentation](https://documenter.getpostman.com/view/21643141/2s93sXcaLf#31c36708-d610-4480-8c8a-628bb32dcfde)
 
-| Responses Actions     | Routes                   | Http Verb |
-| --------------------- | ------------------------ | --------- |
-| Create Purchase       | `/api/purchases/create`  | Post      |
-| Payment               | `/api/purchases/payment` | Get       |
-| Get Monthly Purchases | `/api/purchases/monthly` | Delete    |
+| Responses Actions      | Routes                            | Http Verb |
+| ---------------------- | --------------------------------- | --------- |
+| Create Responses       | `/api/responses/create/commentId` | Post      |
+| Get Comments Responses | `/api/responses/getAll/commentId` | Get       |
+| Delete Responses       | `/api/responses/responseId`       | Delete    |
 
 [Postman Documentation](https://documenter.getpostman.com/view/21643141/2s93sXcaLf#31c36708-d610-4480-8c8a-628bb32dcfde)
 
 ## Tests
 
+- The aplication was tested with [Jest](https://jestjs.io/) and [Supertest](https://www.npmjs.com/package/supertest)
+
 ```
 npm run test
 
 ```
+
+# Contribution.

README.md

@@ -7,6 +7,7 @@ import cart from './server/Routes/shoppingCartRoutes.js';
 import product from './server/Routes/productRoutes.js';
 import purchase from './server/Routes/purchasesRoutes.js';
 import comment from './server/Routes/commentsRoutes.js';
+import response from './server/Routes/responsesRoutes.js';
 import { errorHandler } from './server/helpers/errorHandler.js';
 
 //config
@@ -20,7 +21,6 @@ export const JWT_TOKEN = process.env.JWT_TOKEN;
 const middlewares = await importMiddlewares();
 
 middlewares.forEach((middleware) => {
-  console.log(`Loading middleware /${middlewares.length}: ${middleware.name}`);
   app.use(middleware);
 });
 
@@ -31,6 +31,7 @@ const apiRouthes = [
   { route: '/api/purchases', controller: purchase },
   { route: '/api/products', controller: product },
   { route: '/api/comments', controller: comment },
+  { route: '/api/responses', controller: response },
 ];
 for (const controller of apiRouthes) {
   app.use(controller.route, controller.controller);

index.js

@@ -5,22 +5,22 @@ import isResourceOwner from '../helpers/isOwner.js';
 
 const responseControllers = {
   createResponse,
-  deleteResponse,
+  hideResponse,
   getAllResponse,
 };
 
 function createResponse(req, res, next) {
   responsesActions
-    .createResponse(req.user.id, req.body)
+    .createResponse(req.user.id, req.params.commentId, req.body.description)
     .then((response) => res.json(response))
     .catch((error) => next(error));
 }
 
-function deleteResponse(req, res, next) {
+function hideResponse(req, res, next) {
   const isOwner = isResourceOwner(Response, req.params.responseId, req.user.id);
   if (isOwner) {
     responsesActions
-      .deleteResponse(req.params.responseId)
+      .hideResponse(req.params.responseId)
       .then((response) => res.json(response))
       .catch((error) => next(error));
   } else {

server/Controllers/responsesController.js

@@ -16,6 +16,10 @@ const CommentSchema = new mongoose.Schema(
       maxLength: 400,
       required: true,
     },
+    hide: {
+      type: Boolean,
+      default: false,
+    },
   },
   { timestamps: true },
 );

server/Models/commentModel.js

@@ -46,6 +46,10 @@ const ProductSchema = new mongoose.Schema(
       type: Boolean,
       default: false,
     },
+    hide: {
+      type: Boolean,
+      default: false,
+    },
   },
   { timestamps: true },
 );

server/Models/productModel.js

@@ -17,6 +17,10 @@ const ResponsesSchema = new mongoose.Schema(
       maxLength: 400,
       required: true,
     },
+    hide: {
+      type: Boolean,
+      default: false,
+    },
   },
   { timestamps: true },
 );

server/Models/responsesModel.js

@@ -31,6 +31,10 @@ const UserSchema = new mongoose.Schema(
       type: Boolean,
       default: false,
     },
+    hide: {
+      type: Boolean,
+      default: false,
+    },
     wishList: [
       {
         type: mongoose.Schema.Types.ObjectId,

server/Models/userModel.js

@@ -6,7 +6,7 @@ import { caching } from '../helpers/cache.js';
 import { cleanBody, validateQuery } from '../helpers/sanitizer.js';
 const router = Router();
 
-router.get('/products', caching('10 minutes'), productController.getProduct);
+router.get('/', caching('10 minutes'), productController.getProduct);
 
 router.get(
   '/tag',
@@ -24,11 +24,7 @@ router.get(
   productController.searchProduct,
 );
 
-router.get(
-  '/:id',
-  caching('10 minutes'),
-  productController.getProductById,
-);
+router.get('/:id', caching('10 minutes'), productController.getProductById);
 
 router.post(
   '/create',

server/Routes/productRoutes.js

@@ -4,7 +4,7 @@ import authMiddleware from '../helpers/jwt.js';
 import adminCheck from '../helpers/adminCheck.js';
 const router = Router();
 
-router.post('/purchases/create', authMiddleware, purchaseController.createPurchase);
+router.post('/create', authMiddleware, purchaseController.createPurchase);
 
 router.get(
   '/getAll',

server/Routes/purchasesRoutes.js

@@ -1,24 +1,22 @@
 import responseControllers from '../Controllers/responsesController.js';
 import express from 'express';
-import cleanBody from '../helpers/sanitizer.js';
+import { cleanBody } from '../helpers/sanitizer.js';
 import authMiddleware from '../helpers/jwt.js';
 const router = express.Router();
 
 router.post(
-  '/create',
+  '/create/:commentId',
   authMiddleware,
   cleanBody,
   responseControllers.createResponse,
 );
+
 router.delete(
-'/delete/:responsesId',
+  '/delete/:responsesId',
   authMiddleware,
   responseControllers.deleteResponse,
 );
-router.get(
-  '/getAll',
-  authMiddleware,
-  responseControllers.getAllResponse,
-);
+
+router.get('/getAll', authMiddleware, responseControllers.getAllResponse);
 
 export default router;

server/Routes/responsesRoutes.js

@@ -1,4 +1,3 @@
-import { NotFoundError } from '../helpers/errorHandler.js';
 import Comment from '../Models/commentModel.js';
 
 const commentService = {

server/Service/commentService.js

@@ -18,8 +18,8 @@ async function deleteResponse(responseId) {
   return await Response.findByIdAndDelete(responseId);
 }
 
-async function createResponse(userId, body) {
-  const newResponse = new Response({ ...body, userId });
+async function createResponse(userId, description) {
+  const newResponse = new Response({ description, userId });
   return await newResponse.save();
 }
 

server/Service/responsesService.js

@@ -32,9 +32,8 @@ class BadRequestError extends Error {
 function errorHandler(error, req, res, next) {
   if (error.statusCode) {
     res.status(error.statusCode).json({ error: error.message });
-  } else {
-    res.status(500).json({ error: error.message });
   }
+  next();
 }
 export {
   errorHandler,