#187419064 A seller should be able to CRUD products #21

cyusasnave · 2024-04-24T18:13:12Z

What does this PR do?

As a Seller, I should be able to CRUD items for sale, such that the stock can be seen by any requesting client.

Description of Task to be completed?

A seller should be able to add product
A every should be able to read the products
A seller should be able to update the product
A seller should be able to delete the product

Endpoints:

POST /api/v1/products ---- (or adding/creating items)
GET /api/v1/products ----- (for getting all products/items)
GET /api/v1/products/:id ------ (for getting single product/items)
PATCH /api/v1/products/:id ----- (for updating a single product/items)
DELETE /api/v1/products/:id ----- (for removing a product in seller’s collection)

How should this be manually tested?

Clone the repo nd cd into it
Go to this branch
Run npm install
Check the .env.example and update your .env file ( Added environment variables for CLOUDINARY )
Run npm run dev to start the application
Test every endpoint using postman or Use swagger docs on /api/v1/docs

Pivotracker Id

#187419064

src/controllers/categoryController.ts

src/controllers/productController.ts

src/database/migrations/20240423144255-create-categories-table.js

hound · 2024-04-24T18:13:24Z

src/database/models/category.ts

@@ -0,0 +1,55 @@
+import { DataTypes, Model, Sequelize, UUIDV4 } from "sequelize";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-24T18:13:25Z

src/database/models/product.ts

@@ -0,0 +1,108 @@
+import { DataTypes, Model, Sequelize, UUIDV4 } from "sequelize";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

src/database/seeders/20240423145116-demo-categories.js

src/documention/product/index.ts

src/helpers/cloudinary.ts

src/helpers/upload.ts

src/middlewares/multer.ts

src/documention/category/index.ts

src/middlewares/product.middlewares.ts

src/__test__/category.test.ts

src/database/models/blacklist.ts

src/documention/category/index.ts

codeclimate · 2024-04-25T21:39:42Z

src/__test__/product.test.ts

+		expect(body.message).toStrictEqual("Product not found!");
+	});
+
+	it("should return 400 when product is invalid", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T21:39:42Z

src/__test__/product.test.ts

+		expect(body.product).toBeDefined();
+	});
+
+	it("should return 404 when product doesn't exist", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T21:39:43Z

src/__test__/product.test.ts

+		expect(body.message).toStrictEqual("Product deleted successfully!");
+	});
+
+	it("should return 404 when the product doesn't exist", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-25T21:39:43Z

src/controllers/categoryController.ts

+import { validate as isValidUUID } from "uuid";
+
+const add_category = async (req: Request, res: Response) => {
+	try {


Identical blocks of code found in 8 locations. Consider refactoring.

YvetteNyibuka

Good Job @cyusasnave.

codeclimate · 2024-04-27T07:33:42Z

src/__test__/category.test.ts

+		expect(body.message).toStrictEqual(" Only seller can perform this action!");
+	});
+
+	it("should successfully login a user and return 200", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-27T07:33:43Z

src/__test__/product.test.ts

+		expect(body.product).toBeDefined();
+	});
+
+	it("should delete a product and return 200", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-27T07:33:43Z

src/__test__/category.test.ts

+		expect(body.category).toBeDefined();
+	});
+
+	it("should return 400 when a user provided an invalid id", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-27T07:33:43Z

src/__test__/category.test.ts

+		expect(body.message).toStrictEqual("No field provided to update!");
+	});
+
+	it("should return 400 when you try to update unexisting category", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-27T07:33:43Z

src/controllers/categoryController.ts

+};
+
+const read_all_categories = async (_req: Request, res: Response) => {
+	try {


Identical blocks of code found in 8 locations. Consider refactoring.

hound · 2024-04-29T09:10:38Z

src/database/migrations/20240428090107-create-product-table.js

+
+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+	async up(queryInterface, Sequelize) {


Parsing error: Unexpected token up

hound · 2024-04-29T09:10:38Z

src/database/models/token.ts

@@ -1,32 +1,37 @@
-import { DataTypes, Model, Optional, UUIDV4 } from "sequelize";
-import { sequelizeConnection } from "../config/db.config";
+import { DataTypes, Model, Sequelize, UUIDV4 } from "sequelize";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:10:43Z

src/types/email.ts

@@ -0,0 +1,5 @@
+export type emailAttribute = {


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:10:43Z

src/mock/static.ts

@@ -1,5 +1,24 @@
+import path from "path";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:10:43Z

src/types/model.ts

@@ -0,0 +1,66 @@
+import { Optional } from "sequelize";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:10:43Z

src/types/passport.ts

@@ -0,0 +1,3 @@
+export type InfoAttribute = {


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:10:43Z

src/types/services.ts

@@ -0,0 +1,10 @@
+export type UserInt = {


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:10:43Z

src/types/upload.ts

@@ -0,0 +1,9 @@
+import { Request } from "express";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:10:43Z

src/utils/controller.ts

@@ -0,0 +1,18 @@
+import { Request, Response } from "express";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:10:43Z

src/utils/db_methods.ts

@@ -0,0 +1,58 @@
+/* eslint-disable no-shadow */
+import { CreateOptions, FindOptions, UpdateOptions } from "sequelize";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:10:44Z

src/utils/http.exception.ts

@@ -1,3 +1,5 @@
+import { Response } from "express";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:13:21Z

src/routes/categoryRoutes.ts

@@ -0,0 +1,20 @@
+import express from "express";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:13:21Z

src/routes/productRoutes.ts

@@ -0,0 +1,42 @@
+import express from "express";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:13:21Z

src/utils/database.utils.ts

@@ -1,3 +1,7 @@
+import database_models from "../database/config/db.config";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-29T09:13:21Z

src/validations/product.validation.ts

@@ -0,0 +1,32 @@
+import Joi from "joi";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

codeclimate · 2024-04-29T09:16:57Z

src/__test__/product.test.ts

+		await deleteTableData(database_models.User, "users");
+	});
+
+	it("should successfully login a user and return 200", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-29T09:16:57Z

src/utils/db_methods.ts

+		if (!condition) {
+			throw new Error("Condition is required for update operation");
+		}
+		const result = await (


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-29T09:16:57Z

src/utils/db_methods.ts

+	}
+
+	if (method === "create") {
+		const result = await (


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-29T09:16:57Z

src/__test__/product.test.ts

+		);
+	});
+
+	it("should return 400 if product id is invalid", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-29T09:16:58Z

src/__test__/product.test.ts

+		expect(body.message).toStrictEqual("You provided Invalid ID!");
+	});
+
+	it("should return 404 if product doesn't exist", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

hound · 2024-04-30T21:48:36Z

src/controllers/roleController.ts

@@ -0,0 +1,155 @@
+import { Request, Response } from "express";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-30T21:48:36Z

src/database/models/User.ts

@@ -1,24 +1,31 @@
-import { DataTypes, Model, Optional, Sequelize, UUIDV4 } from "sequelize";
+import { DataTypes, Model, Sequelize, UUIDV4 } from "sequelize";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-30T21:48:36Z

src/database/models/resetPassword.ts

-	email: string;
-	resetToken: string;
-}
+import { DataTypes, Model, Sequelize } from "sequelize";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-30T21:48:36Z

src/database/models/role.ts

@@ -1,10 +1,6 @@
-import { DataTypes, Sequelize, Model, Optional, UUIDV4 } from "sequelize";
+import { DataTypes, Sequelize, Model, UUIDV4 } from "sequelize";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-30T21:48:36Z

src/database/seeders/20240430162648-demo-product.js

+/** @type {import('sequelize-cli').Migration} */
+module.exports = {
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	async up(queryInterface, Sequelize) {


Parsing error: Unexpected token up

hound · 2024-04-30T21:48:36Z

src/documention/basicInfo.ts

@@ -1,4 +1,9 @@
-import { GOOGLE_CALLBACK_URL, PORT } from "../utils/keys";
+import {


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

hound · 2024-04-30T21:48:36Z

src/__test__/product.test.ts

@@ -0,0 +1,312 @@
+import app from "../app";


Parsing error: 'import' and 'export' may appear only with 'sourceType: module'

codeclimate · 2024-04-30T21:50:20Z

src/__test__/product.test.ts

+		await deleteTableData(database_models.User, "users");
+	});
+
+	it("it should  register a user and return 201", async () => {


Similar blocks of code found in 4 locations. Consider refactoring.

codeclimate · 2024-04-30T21:50:20Z

src/__test__/category.test.ts

+		);
+	});
+
+	it("should fetch all catgories and return 200", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-30T21:50:20Z

src/__test__/product.test.ts

+		);
+	});
+
+	it("should fetch all products and return 200", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-30T21:50:20Z

src/__test__/category.test.ts

+		);
+	});
+
+	it("should return 409 when category already exist", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-30T21:50:20Z

src/__test__/category.test.ts

+		category_id = body.data.id;
+	});
+
+	it("should create a new category and return 201", async () => {


Similar blocks of code found in 2 locations. Consider refactoring.

codeclimate · 2024-04-30T21:50:22Z

Code Climate has analyzed commit 8be3be9 and detected 59 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	7
Duplication	52

The test coverage on the diff in this pull request is 88.8% (60% is the threshold).

This pull request will bring the total coverage in the repository to 92.3% (1.0% change).

View more on Code Climate.

cyusasnave added the WIP label Apr 24, 2024

cyusasnave requested review from dniwemugisha, leandreAlly, GarrixA and kwizera-bonheur25 April 24, 2024 18:13

cyusasnave self-assigned this Apr 24, 2024

hound bot reviewed Apr 24, 2024

View reviewed changes

cyusasnave force-pushed the feat-CRUD-product-187419064 branch from f285177 to ed47bd2 Compare April 24, 2024 20:31

hound bot reviewed Apr 24, 2024

View reviewed changes

src/documention/category/index.ts Show resolved Hide resolved

src/middlewares/product.middlewares.ts Show resolved Hide resolved

cyusasnave force-pushed the feat-CRUD-product-187419064 branch from ed47bd2 to 92b7e73 Compare April 25, 2024 20:27

hound bot reviewed Apr 25, 2024

View reviewed changes

src/__test__/category.test.ts Show resolved Hide resolved

cyusasnave force-pushed the feat-CRUD-product-187419064 branch 2 times, most recently from 683843d to 496e857 Compare April 25, 2024 21:36

hound bot reviewed Apr 25, 2024

View reviewed changes

src/database/models/blacklist.ts Show resolved Hide resolved

codeclimate bot reviewed Apr 25, 2024

View reviewed changes

cyusasnave added Ready for Review and removed WIP labels Apr 25, 2024

kwizera-bonheur25 approved these changes Apr 26, 2024

View reviewed changes

cyusasnave requested review from YvetteNyibuka and removed request for GarrixA April 26, 2024 07:33

YvetteNyibuka approved these changes Apr 26, 2024

View reviewed changes

leandreAlly approved these changes Apr 26, 2024

View reviewed changes

cyusasnave force-pushed the feat-CRUD-product-187419064 branch from 496e857 to 2846324 Compare April 27, 2024 07:31

codeclimate bot reviewed Apr 27, 2024

View reviewed changes

cyusasnave force-pushed the feat-CRUD-product-187419064 branch from 2846324 to 568536f Compare April 29, 2024 09:10

hound bot reviewed Apr 29, 2024

View reviewed changes

cyusasnave force-pushed the feat-CRUD-product-187419064 branch from 568536f to 2e314ef Compare April 29, 2024 09:13

hound bot reviewed Apr 29, 2024

View reviewed changes

codeclimate bot reviewed Apr 29, 2024

View reviewed changes

feat(CRUD-products): implemented CRUD for products

8be3be9

cyusasnave force-pushed the feat-CRUD-product-187419064 branch from 2e314ef to 8be3be9 Compare April 30, 2024 21:48

hound bot reviewed Apr 30, 2024

View reviewed changes

codeclimate bot reviewed Apr 30, 2024

View reviewed changes

leandreAlly merged commit ec7e9d9 into develop May 1, 2024
6 checks passed

		@@ -0,0 +1,55 @@
		import { DataTypes, Model, Sequelize, UUIDV4 } from "sequelize";

		@@ -0,0 +1,108 @@
		import { DataTypes, Model, Sequelize, UUIDV4 } from "sequelize";

		@@ -0,0 +1,18 @@
		import { Request, Response } from "express";

		@@ -0,0 +1,58 @@
		/* eslint-disable no-shadow */
		import { CreateOptions, FindOptions, UpdateOptions } from "sequelize";

		@@ -1,3 +1,7 @@
		import database_models from "../database/config/db.config";

		@@ -0,0 +1,155 @@
		import { Request, Response } from "express";

		@@ -1,24 +1,31 @@
		import { DataTypes, Model, Optional, Sequelize, UUIDV4 } from "sequelize";
		import { DataTypes, Model, Sequelize, UUIDV4 } from "sequelize";

		@@ -1,10 +1,6 @@
		import { DataTypes, Sequelize, Model, Optional, UUIDV4 } from "sequelize";
		import { DataTypes, Sequelize, Model, UUIDV4 } from "sequelize";

		@@ -1,4 +1,9 @@
		import { GOOGLE_CALLBACK_URL, PORT } from "../utils/keys";
		import {

#187419064 A seller should be able to CRUD products #21

#187419064 A seller should be able to CRUD products #21

Conversation

cyusasnave commented Apr 24, 2024

hound bot Apr 24, 2024

Choose a reason for hiding this comment

hound bot Apr 24, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 25, 2024

Choose a reason for hiding this comment

YvetteNyibuka left a comment

Choose a reason for hiding this comment

codeclimate bot Apr 27, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 27, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 27, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 27, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 27, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

codeclimate bot Apr 29, 2024

Choose a reason for hiding this comment

hound bot Apr 30, 2024

Choose a reason for hiding this comment

hound bot Apr 30, 2024

Choose a reason for hiding this comment

hound bot Apr 30, 2024

Choose a reason for hiding this comment

hound bot Apr 30, 2024

Choose a reason for hiding this comment

hound bot Apr 30, 2024

Choose a reason for hiding this comment

hound bot Apr 30, 2024

Choose a reason for hiding this comment