Preliminary Donation Routes (#13)

* finish get allDonations route (it works!)

* add more donation routes

* Add working create donation route

* Refactor routes location

* add working create donation route

* add recurrence enum

* Add route testing docs in swagger

* fix route to get donations by id

* test linting

* called prettier

* more linting fixes

* hopefully final lint fixes

README.md

@@ -41,7 +41,7 @@ cd don-efficace
 /.env
 /frontend/.env
 ```
-3. Run the application
+3. Run the application. Make sure the DATABASE_URL is with scv2_db when building the container.
 ```bash
 docker compose up --build
 ```
@@ -67,7 +67,7 @@ docker exec -it scv2-frontend bash -c "yarn fix"
 ## Database/Prisma Information
 "npx prisma generate" to generate at the start
 "npx prisma db push" to push
-"npx prisma studio" to run prisma
+"npx prisma studio" to run prisma. Make sure the DATABASE_URL is with localhost
 
 ### Creating Prisma Migration
 

backend/typescript/models/entity.model.ts

@@ -22,4 +22,3 @@ export default class Entity extends Model {
   @Column
   file_name!: string;
 }
-

backend/typescript/prisma/migrations/20240324164213_/migration.sql → backend/typescript/prisma/migrations/20240328014614_/migration.sql

@@ -1,6 +1,9 @@
 -- CreateEnum
 CREATE TYPE "RoleType" AS ENUM ('Admin', 'User');
 
+-- CreateEnum
+CREATE TYPE "Recurrence" AS ENUM ('None', 'Weekly', 'Monthly', 'Annually');
+
 -- CreateTable
 CREATE TABLE "User" (
     "id" TEXT NOT NULL,
@@ -23,20 +26,13 @@ CREATE TABLE "Donation" (
     "user_id" TEXT NOT NULL,
     "amount" DOUBLE PRECISION NOT NULL,
     "donation_date" TIMESTAMP(3) NOT NULL,
-    "is_recurring" BOOLEAN NOT NULL,
+    "cause_id" INTEGER NOT NULL,
+    "is_recurring" "Recurrence" NOT NULL,
     "confirmation_email_sent" BOOLEAN NOT NULL,
 
     CONSTRAINT "Donation_pkey" PRIMARY KEY ("id")
 );
 
--- CreateTable
-CREATE TABLE "CauseDonation" (
-    "donation_id" INTEGER NOT NULL,
-    "cause_id" INTEGER NOT NULL,
-
-    CONSTRAINT "CauseDonation_pkey" PRIMARY KEY ("donation_id","cause_id")
-);
-
 -- CreateTable
 CREATE TABLE "Cause" (
     "id" SERIAL NOT NULL,
@@ -67,9 +63,6 @@ CREATE TABLE "Item" (
     CONSTRAINT "Item_pkey" PRIMARY KEY ("id")
 );
 
--- CreateIndex
-CREATE UNIQUE INDEX "Donation_user_id_key" ON "Donation"("user_id");
-
 -- CreateIndex
 CREATE UNIQUE INDEX "NPO_item_id_key" ON "NPO"("item_id");
 

backend/typescript/prisma/schema.prisma

@@ -19,8 +19,8 @@ model User {
   opt_in       Boolean?
   createdAt    DateTime   @default(now())
   updatedAt    DateTime?
-  role         RoleType    
-  donations    Donation?
+  role         RoleType
+  donations    Donation[]
 }
 
 enum RoleType{
@@ -32,15 +32,22 @@ enum RoleType{
 model Donation {
   id                      Int             @id @default(autoincrement())
   user                    User            @relation(fields: [user_id], references: [id])
-  user_id                 String          @unique
+  user_id                 String
   amount                  Float
   donation_date           DateTime
   cause                   Cause           @relation(fields: [cause_id], references: [id])
   cause_id                Int
-  is_recurring            Boolean
+  is_recurring            Recurrence
   confirmation_email_sent Boolean
 }
 
+enum Recurrence {
+  None
+  Weekly
+  Monthly
+  Annually
+}
+
 // Cause and NPO: One-to-Many: A single cause can be associated with many NPOs, and each NPO is linked to one cause
 model Cause {
   id          Int             @id @default(autoincrement())

backend/typescript/rest/donationsRoutes.ts

@@ -1,6 +1,6 @@
 // import { Prisma } from "@prisma/client";
 import { Router } from "express";
-import prisma from '../prisma';
+import prisma from "../prisma";
 import DonationService from "../services/implementations/donationService";
 import IDonationService from "../services/interfaces/donationService";
 import { getErrorMessage } from "../utilities/errorUtils";
@@ -11,44 +11,45 @@ const donationRouter = Router();
 
 // display all donations
 donationRouter.get("/", async (req: any, res: any) => {
-    try {
-        const allDonations = await donationService.getAllDonations();
-
-        res.status(200).json(allDonations);
-    } catch (error) {
-        res.status(500).json({ error: getErrorMessage(error) });
-    }
+  try {
+    const allDonations = await donationService.getAllDonations();
+    console.log("getting donations");
+    res.status(200).json(allDonations);
+  } catch (error) {
+    res.status(500).json({ error: getErrorMessage(error) });
+  }
 });
 
 // display all donations made by a user
 donationRouter.get("/:id", async (req: any, res: any) => {
-    const id = req.params.id;
+  const { id } = req.params;
 
-    try {
-        const userDonations = donationService.getUserDonation(id);
+  try {
+    const userDonations = await donationService.getUserDonation(id);
 
-        res.status(200).json(userDonations);
-    } catch (error) {
-        res.status(500).json({ error: getErrorMessage(error) });
-    }
+    res.status(200).json(userDonations);
+  } catch (error) {
+    res.status(500).json({ error: getErrorMessage(error) });
+  }
 });
 
 // Each donation has 1 cause associated with it, the donation from user will be split before calling this route.
 donationRouter.post("/give", async (req: any, res: any) => {
-    try {
-        const { user_id, amount, cause_id, is_recurring, confirmation_email_sent } = req.body;
-
-        const newDonation = await donationService.createDonation(
-            user_id,
-            amount,
-            cause_id,
-            is_recurring,
-            confirmation_email_sent
-        );
-        res.status(200).json(newDonation);
-    } catch (error) {
-        res.status(500).json({ error: getErrorMessage(error) });
-    }
-})
-
-export default donationRouter;
+  try {
+    const { userId, amount, causeId, isRecurring, confirmationEmailSent } =
+      req.body;
+
+    const newDonation = await donationService.createDonation(
+      userId,
+      amount,
+      causeId,
+      isRecurring,
+      confirmationEmailSent,
+    );
+    res.status(200).json(newDonation);
+  } catch (error) {
+    res.status(500).json({ error: getErrorMessage(error) });
+  }
+});
+
+export default donationRouter;

backend/typescript/rest/userRoutes.ts

@@ -95,7 +95,7 @@ userRouter.post("/", createUserDtoValidator, async (req, res) => {
     });
 
     await authService.sendEmailVerificationLink(req.body.email);
-    
+
     res.status(201).json(newUser);
   } catch (error: unknown) {
     res.status(500).json({ error: getErrorMessage(error) });

backend/typescript/server.ts

@@ -37,11 +37,11 @@ app.use("/entities", entityRouter);
 app.use("/simple-entities", simpleEntityRouter);
 app.use("/users", userRouter);
 app.use("/api-docs", swaggerUi.serve, swaggerUi.setup(swaggerDocument));
-app.use('/donations', donationRouter);
+app.use("/donations", donationRouter);
 
 // Health check
 app.get("/test", async (req: any, res: any) => {
-  res.status(200).json('endpoint hath been hit');
+  res.status(200).json("endpoint hath been hit");
 });
 
 sequelize.authenticate();

backend/typescript/services/implementations/__tests__/userService.test.ts

@@ -29,7 +29,6 @@ jest.mock("firebase-admin", () => {
   return { auth };
 });
 
-
 describe("pg userService", () => {
   let userService: UserService;
 

backend/typescript/services/implementations/authService.ts

@@ -168,9 +168,8 @@ class AuthService implements IAuthService {
     roles: Set<Role>,
   ): Promise<boolean> {
     try {
-      const decodedIdToken: firebaseAdmin.auth.DecodedIdToken = await firebaseAdmin
-        .auth()
-        .verifyIdToken(accessToken, true);
+      const decodedIdToken: firebaseAdmin.auth.DecodedIdToken =
+        await firebaseAdmin.auth().verifyIdToken(accessToken, true);
       const userRole = await this.userService.getUserRoleByAuthId(
         decodedIdToken.uid,
       );
@@ -190,9 +189,8 @@ class AuthService implements IAuthService {
     requestedUserId: string,
   ): Promise<boolean> {
     try {
-      const decodedIdToken: firebaseAdmin.auth.DecodedIdToken = await firebaseAdmin
-        .auth()
-        .verifyIdToken(accessToken, true);
+      const decodedIdToken: firebaseAdmin.auth.DecodedIdToken =
+        await firebaseAdmin.auth().verifyIdToken(accessToken, true);
       const tokenUserId = await this.userService.getUserIdByAuthId(
         decodedIdToken.uid,
       );
@@ -214,9 +212,8 @@ class AuthService implements IAuthService {
     requestedEmail: string,
   ): Promise<boolean> {
     try {
-      const decodedIdToken: firebaseAdmin.auth.DecodedIdToken = await firebaseAdmin
-        .auth()
-        .verifyIdToken(accessToken, true);
+      const decodedIdToken: firebaseAdmin.auth.DecodedIdToken =
+        await firebaseAdmin.auth().verifyIdToken(accessToken, true);
 
       const firebaseUser = await firebaseAdmin
         .auth()