Added announcements endpoints with swagger doc completed for it (#103)

* added announcements endpoints with swagger doc completed for it

* removed stuff that was not needed and fixed camelCasing

* add created_by

* fix a small issue of required

* rsolve conflicts

Author: Devesh21700Kumar

.eslintignore

@@ -1 +1,2 @@
-src/config/example.service.json
+src/config/example.service.json
+src/config/service.json

src/app.module.ts

@@ -11,6 +11,7 @@ import { ChatModule } from './modules/chat/chat.module';
 import * as path from 'path';
 import { CourseModule } from './modules/course/course.module';
 import { DoubtModule } from './modules/doubt/doubt.module';
+import { AnnouncementModule } from 'modules/announcements/announcement.module';
 import { MentorModule } from './modules/mentor/mentor.module';
 
 import * as dotenv from 'dotenv';
@@ -29,6 +30,7 @@ dotenv.config({ path: path.resolve(__dirname, '..', '.env') });
     CourseModule,
     ChatModule,
     DoubtModule,
+    AnnouncementModule,
     MentorModule,
   ],
   controllers: [AppController],

src/modules/announcements/announcement.controller.ts

@@ -0,0 +1,71 @@
+import {
+  Controller,
+  Get,
+  Post,
+  Body,
+  Put,
+  Delete,
+  Param,
+} from '@nestjs/common';
+import { AnnouncementService } from './announcement.service'; //eslint-disable-line 
+import { CreateAnnouncementDTO } from './dto/create-announcement.dto'; //eslint-disable-line 
+import {
+  ApiCreatedResponse,
+  ApiOkResponse,
+  ApiParam,
+  ApiTags,
+} from '@nestjs/swagger';
+import { UpdateAnnouncementDTO } from './dto/update-announcement.dto';
+import responsedoc from './docUtils/apidoc';
+import { announcementId } from './docUtils/announcement.paramdocs';
+
+@ApiTags('Announcement')
+@Controller('Announcement')
+export class AnnouncementController {
+  constructor(private announcementService: AnnouncementService) {}
+
+  // add a Announcement
+  @Post()
+  @ApiCreatedResponse(responsedoc.addAnnouncement)
+  async addAnnouncement(@Body() CreateAnnouncementDTO: CreateAnnouncementDTO) {
+    return await this.announcementService.addAnnouncement(
+      CreateAnnouncementDTO,
+    );
+  }
+
+  // Retrieve Announcements list
+  @Get()
+  @ApiOkResponse(responsedoc.getAllAnnouncement)
+  async getAllAnnouncement() {
+    return await this.announcementService.getAllAnnouncement();
+  }
+
+  // Fetch a particular Announcement using ID
+  @Get('/:announcementId')
+  @ApiParam(announcementId)
+  @ApiOkResponse(responsedoc.getAnnouncement)
+  async getAnnouncement(@Param('announcementId') announcementId: string) {
+    return await this.announcementService.getAnnouncement(announcementId);
+  }
+
+  @Put('/:announcementId')
+  @ApiParam(announcementId)
+  @ApiOkResponse(responsedoc.updateAnnouncement)
+  async updateAnnouncement(
+    @Param('announcementId') announcementId: string,
+    @Body() updateAnnouncementDTO: UpdateAnnouncementDTO,
+  ) {
+    return await this.announcementService.updateAnnouncement(
+      announcementId,
+      updateAnnouncementDTO,
+    );
+  }
+
+  // Delete a Announcement
+  @Delete('/:announcementId')
+  @ApiParam(announcementId)
+  @ApiOkResponse(responsedoc.deleteAnnouncement)
+  async deleteAnnouncement(@Param('announcementId') announcementId: string) {
+    return await this.announcementService.deleteAnnouncement(announcementId);
+  }
+}

src/modules/announcements/announcement.module.ts

@@ -0,0 +1,15 @@
+import { Module } from '@nestjs/common';
+import { AnnouncementController } from './announcement.controller';
+import { AnnouncementService } from './announcement.service';
+import { MongooseModule } from '@nestjs/mongoose';
+import { AnnouncementSchema } from './schema/announcement.schema';
+@Module({
+  imports: [
+    MongooseModule.forFeature([
+      { name: 'Announcement', schema: AnnouncementSchema },
+    ]),
+  ],
+  controllers: [AnnouncementController],
+  providers: [AnnouncementService],
+})
+export class AnnouncementModule {}

src/modules/announcements/announcement.service.ts

@@ -0,0 +1,94 @@
+import {
+  Injectable,
+  InternalServerErrorException,
+  NotFoundException,
+} from '@nestjs/common';
+import { Model } from 'mongoose';
+import { InjectModel } from '@nestjs/mongoose';
+import { AnnouncementDocument as Announcement } from './schema/announcement.schema';
+import { CreateAnnouncementDTO } from './dto/create-announcement.dto';
+import { UpdateAnnouncementDTO } from './dto/update-announcement.dto';
+
+@Injectable()
+export class AnnouncementService {
+  constructor(
+    @InjectModel('Announcement')
+    private readonly AnnouncementModel: Model<Announcement>,
+  ) {}
+
+  // fetch all Announcements
+  async getAllAnnouncement(): Promise<Announcement[]> {
+    try {
+      const Announcements = await this.AnnouncementModel.find().exec();
+      return Announcements;
+    } catch (e) {
+      throw new InternalServerErrorException(e);
+    }
+  }
+
+  // Get a single Announcement
+  async getAnnouncement(announcementId): Promise<Announcement> {
+    try {
+      const Announcement = await this.AnnouncementModel.findById(
+        announcementId,
+      );
+      if (Announcement) {
+        return Announcement;
+      }
+    } catch (e) {
+      throw new InternalServerErrorException(e);
+    }
+
+    throw new NotFoundException('Announcement not found');
+  }
+
+  // post a single Announcement
+  async addAnnouncement(
+    CreateAnnouncementDTO: CreateAnnouncementDTO,
+  ): Promise<Announcement> {
+    try {
+      const newAnnouncement = await new this.AnnouncementModel(
+        CreateAnnouncementDTO,
+      );
+      await newAnnouncement.save();
+      return newAnnouncement;
+    } catch (e) {
+      throw new InternalServerErrorException(e);
+    }
+  }
+
+  // Edit Announcement details
+  async updateAnnouncement(
+    announcementId,
+    updateAnnouncementDTO: UpdateAnnouncementDTO,
+  ): Promise<Announcement> {
+    try {
+      const updatedAnnouncement =
+        await this.AnnouncementModel.findByIdAndUpdate(
+          announcementId,
+          updateAnnouncementDTO,
+          { new: true },
+        );
+      if (updatedAnnouncement) {
+        return updatedAnnouncement;
+      }
+    } catch (e) {
+      throw new InternalServerErrorException(e);
+    }
+    throw new NotFoundException('Announcement not found!');
+  }
+
+  // Delete a Announcement
+  async deleteAnnouncement(announcementId): Promise<any> {
+    try {
+      const deletedAnnouncement =
+        await this.AnnouncementModel.findByIdAndRemove(announcementId);
+      if (deletedAnnouncement) {
+        return deletedAnnouncement;
+      }
+      throw new NotFoundException('Announcement not found!');
+    } catch (e) {
+      throw new InternalServerErrorException(e);
+    }
+  }
+}

src/modules/announcements/docUtils/announcement.paramdocs.ts

@@ -0,0 +1,8 @@
+import { ApiParamOptions } from '@nestjs/swagger';
+
+export const announcementId: ApiParamOptions = {
+  name: 'announcementId',
+  type: String,
+  description: 'Announcement Id in the form of MongoId',
+  example: '60ccf3758dc53371bd4d0154',
+};

src/modules/announcements/docUtils/announcement.responsedoc.ts

@@ -0,0 +1,25 @@
+export default class AnnouncementResponseBody {
+  /**
+   * The title of the announcement
+   * @example 'New course on Web Development'
+   */
+  title: string;
+
+  /**
+   * The description of the announcement
+   * @example 'The wait is finally over as teh new course on Web Development has been released. The course will take you through the basics and help you learn and make projects along the way'
+   */
+  description: string;
+
+  /**
+   * Whether the announcement was read or not
+   * @example true
+   */
+  read: boolean;
+
+  /**
+   * Creator of the announcement
+   * @example 'John Doe'
+   */
+  created_by: string;
+}

src/modules/announcements/docUtils/apidoc.ts

@@ -0,0 +1,37 @@
+import AnnouncementResponseBody from './announcement.responsedoc';
+import { ApiResponseOptions } from '@nestjs/swagger';
+
+const getAllAnnouncement: ApiResponseOptions = {
+  description: 'Get all the courses available in the database',
+  type: [AnnouncementResponseBody],
+};
+
+const getAnnouncement: ApiResponseOptions = {
+  description: 'Get course by id from the database',
+  type: AnnouncementResponseBody,
+};
+
+const addAnnouncement: ApiResponseOptions = {
+  description: 'Add a course',
+  type: AnnouncementResponseBody,
+};
+
+const updateAnnouncement: ApiResponseOptions = {
+  description: 'Update a course',
+  type: AnnouncementResponseBody,
+};
+
+const deleteAnnouncement: ApiResponseOptions = {
+  description: 'Delete a course',
+  type: AnnouncementResponseBody,
+};
+
+const responses = {
+  getAllAnnouncement,
+  getAnnouncement,
+  addAnnouncement,
+  updateAnnouncement,
+  deleteAnnouncement,
+};
+
+export default responses;

src/modules/announcements/dto/create-announcement.dto.ts

@@ -0,0 +1,35 @@
+import { IsBoolean, IsNotEmpty, IsString } from 'class-validator';
+
+export class CreateAnnouncementDTO {
+  /**
+   * The title of the announcement
+   * @example 'New course on Web Development'
+   */
+  @IsNotEmpty()
+  @IsString()
+  title: string;
+
+  /**
+   * The description of the announcement
+   * @example 'The wait is finally over as teh new course on Web Development has been released. The course will take you through the basics and help you learn and make projects along the way'
+   */
+  @IsNotEmpty()
+  @IsString()
+  description: string;
+
+  /**
+   * Whether the announcement was read or not
+   * @example true
+   */
+  @IsNotEmpty()
+  @IsBoolean()
+  read: boolean;
+
+  /**
+   * Creator of the announcement
+   * @example 'John Doe'
+   */
+  @IsNotEmpty()
+  @IsString()
+  created_by: string;
+}

src/modules/announcements/dto/update-announcement.dto.ts

@@ -0,0 +1,35 @@
+import { IsNotEmpty, IsString, IsBoolean } from 'class-validator';
+
+export class UpdateAnnouncementDTO {
+  /**
+   * The title of the announcement
+   * @example 'New course on Web Development'
+   */
+  @IsNotEmpty()
+  @IsString()
+  title: string;
+
+  /**
+   * The description of the announcement
+   * @example 'The wait is finally over as teh new course on Web Development has been released. The course will take you through the basics and help you learn and make projects along the way'
+   */
+  @IsNotEmpty()
+  @IsString()
+  description: string;
+
+  /**
+   * Whether the announcement was read or not
+   * @example true
+   */
+  @IsNotEmpty()
+  @IsBoolean()
+  read: boolean;
+
+  /**
+   * Creator of the announcement
+   * @example 'John Doe'
+   */
+  @IsNotEmpty()
+  @IsString()
+  created_by: string;
+}

src/modules/announcements/schema/announcement.schema.ts

@@ -0,0 +1,31 @@
+import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
+import { Document } from 'mongoose';
+
+export type AnnouncementDocument = Announcement & Document;
+
+@Schema({ timestamps: true })
+export class Announcement {
+  @Prop({ required: true })
+  title: string;
+
+  @Prop({ required: true })
+  description: string;
+
+  @Prop({ default: false })
+  read: boolean;
+
+  @Prop({ required: true })
+  created_by: string;
+}
+
+export const AnnouncementSchema = SchemaFactory.createForClass(Announcement);
+
+AnnouncementSchema.methods.toJSON = function () {
+  const announcementObject = this.toObject();
+  announcementObject.id = announcementObject._id;
+
+  delete announcementObject.__v;
+  delete announcementObject._id;
+
+  return announcementObject;
+};