Endpoint for registering new users (#231)

* added API endpoint, DTO, updated API schema * only enabled users get authenticated * Update backend/src/db/repositories/user.repository.ts --------- Co-authored-by: Henry Brink <[email protected]>
SE-TINF22B2 · Jun 12, 2024 · 3efbdd6 · 3efbdd6
1 parent e1c48b0
commit 3efbdd6
Show file tree

Hide file tree

Showing 8 changed files with 129 additions and 19 deletions.
diff --git a/backend/package-lock.json b/backend/package-lock.json
diff --git a/backend/package.json b/backend/package.json
@@ -31,6 +31,7 @@
     "@nestjs/core": "^10.0.0",
     "@nestjs/passport": "^10.0.3",
     "@nestjs/platform-express": "^10.3.7",
+    "@nestjs/swagger": "^7.3.1",
     "@prisma/client": "^5.11.0",
     "@types/bcrypt": "^5.0.2",
     "@types/nodemailer": "^6.4.14",

diff --git a/backend/src/api/user/patch.user.dto.ts b/backend/src/api/user/patch.user.dto.ts
@@ -1,15 +1,4 @@
-import { IsEmail, IsOptional, Length } from 'class-validator';
+import { PartialType } from '@nestjs/swagger';
+import { RegisterUserDTO } from './register.user.dto';
 
-export class PatchUserDTO {
-  @IsEmail()
-  @IsOptional()
-  email: string | undefined;
-
-  @Length(12, 72)
-  @IsOptional()
-  password: string | undefined;
-
-  @Length(2, 128)
-  @IsOptional()
-  displayName: string | undefined;
-}
+export class PatchUserDTO extends PartialType(RegisterUserDTO) {}
diff --git a/backend/src/api/user/register.user.dto.ts b/backend/src/api/user/register.user.dto.ts
@@ -0,0 +1,12 @@
+import { IsEmail, Length } from 'class-validator';
+
+export class RegisterUserDTO {
+  @IsEmail()
+  email: string;
+
+  @Length(12, 72)
+  password: string;
+
+  @Length(2, 128)
+  displayName: string;
+}
diff --git a/backend/src/api/user/user.controller.ts b/backend/src/api/user/user.controller.ts
@@ -3,6 +3,7 @@ import {
   Controller,
   Get,
   Patch,
+  Post,
   Req,
   Res,
   UseGuards,
@@ -11,6 +12,7 @@ import { Prisma, User } from '@prisma/client';
 import { Response } from 'express';
 import { AutoGuard } from '../../auth/auto.guard';
 import { PatchUserDTO } from './patch.user.dto';
+import { RegisterUserDTO } from './register.user.dto';
 import { AuthService } from '../../auth/auth.service';
 import { UserRepository } from '../../db/repositories/user.repository';
 import { NestRequest } from '../../types/request.type';
@@ -31,6 +33,16 @@ export class UserController {
     return sanitizedUser;
   }
 
+  @Post('/')
+  async postRegister(@Body() userPatch: RegisterUserDTO) {
+    this.userRepository.createUser(
+      userPatch.email,
+      userPatch.displayName,
+      userPatch.password,
+      false,
+    );
+  }
+
   /**
    * /user/me
    *

diff --git a/backend/src/auth/auth.service.ts b/backend/src/auth/auth.service.ts
@@ -21,7 +21,11 @@ export class AuthService {
   ): Promise<User | null> {
     const user = await this.userRepository.findByEmail(username);
 
-    if (user && (await bcrypt.compare(password, user.password))) {
+    if (
+      user &&
+      user.enabled &&
+      (await bcrypt.compare(password, user.password))
+    ) {
       return user;
     }
 

diff --git a/backend/src/db/repositories/user.repository.ts b/backend/src/db/repositories/user.repository.ts
@@ -32,12 +32,14 @@ export class UserRepository {
     email: string,
     displayName: string,
     password: string,
+    enabled: boolean = false,
   ): Promise<User> {
     return await this.prisma.user.create({
       data: {
         email,
         displayName,
         password,
+        enabled,
       },
     });
   }

diff --git a/docs/public/api/schema.yaml b/docs/public/api/schema.yaml
@@ -15,13 +15,39 @@ externalDocs:
   url: https://github.com/SE-TINF22B2/G5-DuoGradus
 tags:
   - name: User
-    description: Endpoints relatexd to the user, his account and other personal configurations
+    description: Endpoints related to the user, his account and other personal configurations
   - name: Datasource
     description: Thirdparty data sources, like FitBit
   - name: Leaderboard
   - name: Goal
     description: User and system defined Goals
 paths:
+  '/user':
+    post:
+      summary: Registers a new user
+      tags:
+        - User
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                email:
+                  type: string
+                displayName:
+                  type: string
+                password:
+                  type: string
+            example:
+              name: Ingolf Neiße
+              email: [email protected]
+              password: password123
+      responses:
+        '200':
+          description: User registered successfully
+        '400':
+          description: Invalid content
   '/user/me':
     get:
       summary: Displays the current users settings