diff --git a/README.md b/README.md
index f03c921d892e1b88655618d09123da1794bab510..ea0bbb51739d672e1608bdfa2ee94f938297533c 100644
--- a/README.md
+++ b/README.md
@@ -26,13 +26,33 @@
**IntershipManager** - The whole lifecycle of internship agreements in one app !
+This is the **REST API** connecting to the InternshipManager front end application to manage **CRUD** operations.
+
## Installation
```bash
$ npm install
```
-In `/src/config/` create a file called `config.json` and copy the content of `config.template.json` in it. Change the values such as the server port to match your needs.
+In `/src/config/`, make a copy of the file `config.template.json` and rename it to `config.json`.
+Set the following field :
+```json
+"server": {
+ "port": 3001
+},
+```
+You may replace `3001` by any port you wish to run the application on.
+
+### Initiating the database
+
+This server uses [Mongodb](https://www.mongodb.com/) for persistent data storage. To initiate the database, you must have an instance of mongo running. You may use the dockerfile located in `docker/` at the root of the project and run the command `docker-compose up -d` to create and run a mongo instance as a background task.
+In the `src/config/config.json`, set the following field :
+```json
+"mongodb": {
+ "uri": "mongodb://localhost:27017/internship-manager"
+}
+```
+In the event you wish to run mongo on another port or use another collection, make sure to update the **uri** in the config file.
## Running the app
diff --git a/package.json b/package.json
index e4b4cca86ba1784e9c3992fb8378c10fc3719065..37f66f78cbed369f51f01c858c2c9eb87d2f9fc5 100644
--- a/package.json
+++ b/package.json
@@ -29,6 +29,7 @@
"@nestjs/core": "^9.0.0",
"@nestjs/mongoose": "^9.2.1",
"@nestjs/platform-express": "^9.0.0",
+ "class-transformer": "^0.5.1",
"class-validator": "^0.13.2",
"fastify": "^4.9.2",
"mongoose": "^6.7.2",
diff --git a/src/app.module.ts b/src/app.module.ts
index ed2937ac9fe292368779678bdd2c6c8121733ca3..83454b396fbe455e342ac10495c8d9d035e20455 100644
--- a/src/app.module.ts
+++ b/src/app.module.ts
@@ -2,8 +2,9 @@ import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';
import { mongodb } from './config';
import { PeopleModule } from './people/people.module';
+import { GroupsModule } from './groups/groups.module';
@Module({
- imports: [PeopleModule, MongooseModule.forRoot(mongodb.uri)],
+ imports: [PeopleModule, GroupsModule, MongooseModule.forRoot(mongodb.uri)],
})
export class AppModule {}
diff --git a/src/groups/dao/groups.dao.ts b/src/groups/dao/groups.dao.ts
new file mode 100644
index 0000000000000000000000000000000000000000..682c742fe1df1316af7bfa491e419b4ea1b80af1
--- /dev/null
+++ b/src/groups/dao/groups.dao.ts
@@ -0,0 +1,73 @@
+import {
+ Injectable,
+ NotFoundException,
+ InternalServerErrorException,
+} from '@nestjs/common';
+import { InjectModel } from '@nestjs/mongoose';
+import { Model } from 'mongoose';
+import { CreateGroupDto } from '../dto/create-group.dto';
+import { UpdateGroupDto } from '../dto/update-group.dto';
+import { Group } from '../schemas/group.schema';
+
+@Injectable()
+export class GroupsDao {
+ constructor(
+ @InjectModel(Group.name)
+ private readonly _groupModel: Model<Group>,
+ ) {}
+
+ find = (): Promise<Group[]> =>
+ new Promise((resolve, reject) => {
+ this._groupModel.find({}, {}, {}, (err, value) => {
+ if (err) reject(err.message);
+ if (!value) reject('No values');
+ resolve(value);
+ });
+ });
+
+ findById = (id: string): Promise<Group | void> =>
+ new Promise((resolve, reject) => {
+ this._groupModel.findOne({ id: id }, {}, {}, (err, value) => {
+ if (err) reject(err.message);
+ if (!value) reject(new NotFoundException());
+ resolve(value);
+ });
+ });
+
+ save = (group: CreateGroupDto): Promise<Group> =>
+ new Promise((resolve, reject) => {
+ new this._groupModel(group).save((err, value) => {
+ if (err) reject(err.message);
+ if (!value) reject(new InternalServerErrorException());
+ resolve(value);
+ });
+ });
+
+ findByIdAndUpdate = (
+ id: string,
+ group: UpdateGroupDto,
+ ): Promise<Group | void> =>
+ new Promise((resolve, reject) => {
+ this._groupModel.updateOne(
+ { id: id },
+ group,
+ {
+ new: true,
+ runValidators: true,
+ },
+ (err, value) => {
+ if (err) reject(err.message);
+ if (value.matchedCount === 0) reject(new NotFoundException());
+ resolve(value);
+ },
+ );
+ });
+
+ findByIdAndRemove = (id: string): Promise<Group | void> =>
+ new Promise((resolve, reject) => {
+ this._groupModel.deleteOne({ id: id }, {}, (err) => {
+ if (err) reject(err.message);
+ resolve();
+ });
+ });
+}
diff --git a/src/groups/dto/create-group.dto.ts b/src/groups/dto/create-group.dto.ts
new file mode 100644
index 0000000000000000000000000000000000000000..2444a73d19142155a47349b19c99240fd0cd34be
--- /dev/null
+++ b/src/groups/dto/create-group.dto.ts
@@ -0,0 +1,14 @@
+import { IsBoolean, IsString, IsNotEmpty } from 'class-validator';
+
+export class CreateGroupDto {
+ @IsString()
+ @IsNotEmpty()
+ id: string;
+
+ @IsBoolean()
+ final: boolean;
+
+ @IsString()
+ @IsNotEmpty()
+ parent: any;
+}
diff --git a/src/groups/dto/update-group.dto.ts b/src/groups/dto/update-group.dto.ts
new file mode 100644
index 0000000000000000000000000000000000000000..6b7f72557fad39fd2b38285b30ede6cc721a720f
--- /dev/null
+++ b/src/groups/dto/update-group.dto.ts
@@ -0,0 +1,15 @@
+import { IsArray, IsOptional } from 'class-validator';
+
+export class UpdateGroupDto {
+ @IsArray()
+ @IsOptional()
+ responsibles: string[];
+
+ @IsArray()
+ @IsOptional()
+ secretaries: string[];
+
+ @IsArray()
+ @IsOptional()
+ students: string[];
+}
diff --git a/src/groups/entities/group.entity.ts b/src/groups/entities/group.entity.ts
new file mode 100644
index 0000000000000000000000000000000000000000..b9182cd90ebb2eaec1c5230088d9777ef7b2d2bb
--- /dev/null
+++ b/src/groups/entities/group.entity.ts
@@ -0,0 +1,15 @@
+import { Group } from '../schemas/group.schema';
+
+export class GroupEntity {
+ _id: string;
+ id: string;
+ final: boolean;
+ responsibles: string[];
+ secretaries: string[];
+ students: string[];
+ parent: string;
+
+ constructor(partial: Partial<Group>) {
+ Object.assign(this, partial);
+ }
+}
diff --git a/src/groups/groups.controller.ts b/src/groups/groups.controller.ts
new file mode 100644
index 0000000000000000000000000000000000000000..25314334873cee15f51c693e8720b26165a3be97
--- /dev/null
+++ b/src/groups/groups.controller.ts
@@ -0,0 +1,50 @@
+import {
+ Controller,
+ Get,
+ Post,
+ Put,
+ Delete,
+ Param,
+ Body,
+ UseInterceptors,
+} from '@nestjs/common';
+import { Observable } from 'rxjs';
+import { HttpInterceptor } from '../interceptors/http.interceptor';
+import { CreateGroupDto } from './dto/create-group.dto';
+import { UpdateGroupDto } from './dto/update-group.dto';
+import { GroupEntity } from './entities/group.entity';
+import { GroupsService } from './groups.service';
+
+@Controller('groups')
+@UseInterceptors(HttpInterceptor)
+export class GroupsController {
+ constructor(private readonly _groupsService: GroupsService) {}
+
+ @Get()
+ findAll(): Promise<GroupEntity[] | void> {
+ return this._groupsService.findAll();
+ }
+
+ @Get(':id')
+ findOne(@Param() params: { id: string }): Promise<GroupEntity | void> {
+ return this._groupsService.findOne(params.id);
+ }
+
+ @Post()
+ create(@Body() createGroupDto: CreateGroupDto): Promise<GroupEntity> {
+ return this._groupsService.create(createGroupDto);
+ }
+
+ @Put(':id')
+ update(
+ @Param() params: { id: string },
+ @Body() updateGroupDto: UpdateGroupDto,
+ ): Promise<GroupEntity | void> {
+ return this._groupsService.update(params.id, updateGroupDto);
+ }
+
+ @Delete(':id')
+ delete(@Param() params: { id: string }): Promise<GroupEntity | void> {
+ return this._groupsService.delete(params.id);
+ }
+}
diff --git a/src/groups/groups.module.ts b/src/groups/groups.module.ts
new file mode 100644
index 0000000000000000000000000000000000000000..b8c3b67845ab5cae0b2b67166bcd743a88abd817
--- /dev/null
+++ b/src/groups/groups.module.ts
@@ -0,0 +1,15 @@
+import { Module, Logger } from '@nestjs/common';
+import { MongooseModule } from '@nestjs/mongoose';
+import { GroupsDao } from './dao/groups.dao';
+import { GroupsController } from './groups.controller';
+import { GroupsService } from './groups.service';
+import { Group, GroupSchema } from './schemas/group.schema';
+
+@Module({
+ imports: [
+ MongooseModule.forFeature([{ name: Group.name, schema: GroupSchema }]),
+ ],
+ controllers: [GroupsController],
+ providers: [GroupsService, GroupsDao, Logger],
+})
+export class GroupsModule {}
diff --git a/src/groups/groups.service.ts b/src/groups/groups.service.ts
new file mode 100644
index 0000000000000000000000000000000000000000..7410d687762ce84cde9923e6b14abd8ca29be307
--- /dev/null
+++ b/src/groups/groups.service.ts
@@ -0,0 +1,24 @@
+import { Injectable } from '@nestjs/common';
+import { GroupsDao } from './dao/groups.dao';
+import { CreateGroupDto } from './dto/create-group.dto';
+import { UpdateGroupDto } from './dto/update-group.dto';
+import { GroupEntity } from './entities/group.entity';
+
+@Injectable()
+export class GroupsService {
+ constructor(private readonly _groupsDao: GroupsDao) {}
+
+ findAll = (): Promise<GroupEntity[] | void> => this._groupsDao.find();
+
+ findOne = (id: string): Promise<GroupEntity | void> =>
+ this._groupsDao.findById(id);
+
+ create = (group: CreateGroupDto): Promise<GroupEntity> =>
+ this._groupsDao.save(group);
+
+ update = (id: string, group: UpdateGroupDto): Promise<GroupEntity | void> =>
+ this._groupsDao.findByIdAndUpdate(id, group);
+
+ delete = (id: string): Promise<GroupEntity | void> =>
+ this._groupsDao.findByIdAndRemove(id);
+}
diff --git a/src/groups/groups.types.ts b/src/groups/groups.types.ts
new file mode 100644
index 0000000000000000000000000000000000000000..ddbd330595cec2678076afcfe88ea02cd5f0e4a4
--- /dev/null
+++ b/src/groups/groups.types.ts
@@ -0,0 +1,10 @@
+export type Group = {
+ _id: any;
+ id: string;
+ final: boolean;
+ responsibles: string[];
+ secretaries: string[];
+ students: string[];
+ subgroups: string[];
+ parent: string;
+};
diff --git a/src/groups/schemas/group.schema.ts b/src/groups/schemas/group.schema.ts
new file mode 100644
index 0000000000000000000000000000000000000000..93698e96bb616bd8c44b0c7e517e654f721cdcc4
--- /dev/null
+++ b/src/groups/schemas/group.schema.ts
@@ -0,0 +1,67 @@
+import * as mongoose from 'mongoose';
+import { Document } from 'mongoose';
+import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
+
+export type GroupDocument = Group & Document;
+
+@Schema({
+ toJSON: {
+ virtuals: true,
+ transform: (doc: any, ret: any) => {
+ delete ret._id;
+ },
+ },
+})
+export class Group {
+ @Prop({
+ type: mongoose.Schema.Types.ObjectId,
+ auto: true,
+ })
+ _id: any;
+
+ @Prop({
+ type: String,
+ required: true,
+ trim: true,
+ })
+ id: string;
+
+ @Prop({
+ type: Boolean,
+ required: true,
+ trim: true,
+ })
+ final: boolean;
+
+ @Prop({
+ type: [String],
+ required: true,
+ trim: true,
+ })
+ responsibles: string[];
+
+ @Prop({
+ type: [String],
+ required: true,
+ trim: true,
+ })
+ secretaries: string[];
+
+ @Prop({
+ type: [String],
+ required: true,
+ trim: true,
+ })
+ students: string[];
+
+ @Prop({
+ type: String,
+ required: true,
+ trim: true,
+ })
+ parent: string;
+}
+
+export const GroupSchema = SchemaFactory.createForClass(Group);
+
+GroupSchema.index({ id: 1 }, { unique: true });
diff --git a/src/interceptors/http.interceptor.ts b/src/interceptors/http.interceptor.ts
index c4620b7d728f3f172028bab56380de66e094c0f7..934929f681ab0a00077de9148aaa3c51348e1f72 100644
--- a/src/interceptors/http.interceptor.ts
+++ b/src/interceptors/http.interceptor.ts
@@ -1,64 +1,64 @@
import {
- CallHandler,
- ExecutionContext,
- Injectable,
- Logger,
- NestInterceptor,
- } from '@nestjs/common';
- import { merge, Observable, of } from 'rxjs';
- import { filter, map, mergeMap, tap } from 'rxjs/operators';
- import { FastifyReply } from 'fastify';
-
- @Injectable()
- export class HttpInterceptor implements NestInterceptor {
- /**
- * Class constructor
- * @param _logger
- */
- constructor(private readonly _logger: Logger) {}
-
- /**
- * Intercepts all HTTP requests and responses
- *
- * @param context
- * @param next
- */
- intercept = (
- context: ExecutionContext,
- next: CallHandler,
- ): Observable<any> => {
- const cls = context.getClass();
- const handler = context.getHandler();
- const response: FastifyReply = context
- .switchToHttp()
- .getResponse<FastifyReply>();
- const logCtx = `${cls.name}.${handler.name}`;
-
- return next.handle().pipe(
- map((_) => of(_)),
- mergeMap((obs: Observable<any>) =>
- merge(
- obs.pipe(
- filter((_) => !!_),
- map((_) => _),
- ),
- obs.pipe(
- filter((_) => !_),
- tap(() => response.status(204)),
- map((_) => _),
- ),
+ CallHandler,
+ ExecutionContext,
+ Injectable,
+ Logger,
+ NestInterceptor,
+} from '@nestjs/common';
+import { merge, Observable, of } from 'rxjs';
+import { filter, map, mergeMap, tap } from 'rxjs/operators';
+import { FastifyReply } from 'fastify';
+
+@Injectable()
+export class HttpInterceptor implements NestInterceptor {
+ /**
+ * Class constructor
+ * @param _logger
+ */
+ constructor(private readonly _logger: Logger) {}
+
+ /**
+ * Intercepts all HTTP requests and responses
+ *
+ * @param context
+ * @param next
+ */
+ intercept = (
+ context: ExecutionContext,
+ next: CallHandler,
+ ): Observable<any> => {
+ const cls = context.getClass();
+ const handler = context.getHandler();
+ const response: FastifyReply = context
+ .switchToHttp()
+ .getResponse<FastifyReply>();
+ const logCtx = `${cls.name}.${handler.name}`;
+
+ return next.handle().pipe(
+ map((_) => of(_)),
+ mergeMap((obs: Observable<any>) =>
+ merge(
+ obs.pipe(
+ filter((_) => !!_),
+ map((_) => _),
+ ),
+ obs.pipe(
+ filter((_) => !_),
+ tap(() => response.status(204)),
+ map((_) => _),
),
),
- tap({
- next: (_) =>
- this._logger.log(!!_ ? JSON.stringify(_) : 'NO CONTENT', logCtx),
- error: (_) =>
- this._logger.error(
- _?.message ?? 'unspecified error',
- JSON.stringify(_),
- logCtx,
- ),
- }),
- );
- };
- }
\ No newline at end of file
+ ),
+ tap({
+ next: (_) =>
+ this._logger.log(!!_ ? JSON.stringify(_) : 'NO CONTENT', logCtx),
+ error: (_) =>
+ this._logger.error(
+ _?.message ?? 'unspecified error',
+ JSON.stringify(_),
+ logCtx,
+ ),
+ }),
+ );
+ };
+}