Merge pull request #1292 from hngprojects/feat/unsubscribe-newsletter

feat: unsubscribe newsletter

src/modules/newsletter-subscription/dto/unsubscribe-newsletter.dto.ts

@@ -0,0 +1,8 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsEmail } from 'class-validator';
+
+export class UnsubscribeNewsletterDto {
+  @ApiProperty({ description: 'Email of the user to unsubscribe' })
+  @IsEmail()
+  email: string;
+}

src/modules/newsletter-subscription/entities/newsletter-subscription.entity.ts

@@ -8,4 +8,7 @@ export class NewsletterSubscription extends AbstractBaseEntity {
 
   @DeleteDateColumn()
   deletedAt: Date;
+
+  @Column({ default: false })
+  isUnsubscribed: boolean;
 }

src/modules/newsletter-subscription/newsletter-subscription.controller.ts

@@ -5,6 +5,7 @@ import { skipAuth } from '@shared/helpers/skipAuth';
 import { ApiBearerAuth, ApiOperation, ApiParam, ApiResponse, ApiTags } from '@nestjs/swagger';
 import { NewsletterSubscriptionResponseDto } from './dto/newsletter-subscription.response.dto';
 import { SuperAdminGuard } from '@guards/super-admin.guard';
+import { UnsubscribeNewsletterDto } from './dto/unsubscribe-newsletter.dto';
 
 @ApiTags('Newsletter Subscription')
 @Controller('newsletter-subscription')
@@ -115,4 +116,14 @@ export class NewsletterSubscriptionController {
   restore(@Param('id') id: string) {
     return this.newsletterSubscriptionService.restore(id);
   }
+
+  @Post('unsubscribe')
+  @skipAuth()
+  @HttpCode(HttpStatus.OK)
+  @ApiOperation({ summary: 'Unsubscribe from the newsletter' })
+  @ApiResponse({ status: 200, description: 'User has been unsubscribed successfully.' })
+  @ApiResponse({ status: 404, description: 'Email not found' })
+  unsubscribe(@Body() unsubscribeDto: UnsubscribeNewsletterDto) {
+    return this.newsletterSubscriptionService.unsubscribe(unsubscribeDto.email);
+  }
 }

src/modules/newsletter-subscription/newsletter-subscription.service.ts

@@ -72,4 +72,17 @@ export class NewsletterSubscriptionService {
       email: newsletterSubscription.email,
     };
   }
+
+  async unsubscribe(email: string) {
+    const subscription = await this.newsletterSubscriptionRepository.findOne({ where: { email } });
+
+    if (!subscription) {
+      throw new NotFoundException(`Email ${email} not found in the subscription list`);
+    }
+
+    subscription.isUnsubscribed = true;
+    await this.newsletterSubscriptionRepository.save(subscription);
+
+    return { message: `Email ${email} has been unsubscribed successfully` };
+  }
 }

src/modules/newsletter-subscription/tests/newsletter-subscription.service.spec.ts

@@ -146,4 +146,47 @@ describe('NewsletterService', () => {
       await expect(service.restore(id)).rejects.toThrow(NotFoundException);
     });
   });
+
+  describe('unsubscribe', () => {
+    it('should successfully unsubscribe a user', async () => {
+      const email = '[email protected]';
+      const mockSubscription = { id: '1', email, isUnsubscribed: false } as NewsletterSubscription;
+
+      // Mock `findOne` to return a subscribed user
+      jest.spyOn(repository, 'findOne').mockResolvedValue(mockSubscription);
+      // Mock `save` to return updated object
+      jest.spyOn(repository, 'save').mockImplementation(
+        async sub =>
+          ({
+            ...sub,
+            isUnsubscribed: true,
+            email: sub.email,
+            deletedAt: sub.deletedAt || new Date(),
+            id: sub.id,
+            created_at: sub.created_at || new Date(),
+            updated_at: new Date(),
+          }) as NewsletterSubscription
+      );
+
+      const result = await service.unsubscribe(email);
+      expect(result).toEqual({ message: `Email ${email} has been unsubscribed successfully` });
+
+      // Ensure `isUnsubscribed` was updated
+      expect(repository.save).toHaveBeenCalledWith(expect.objectContaining({ isUnsubscribed: true }));
+    });
+
+    it('should throw NotFoundException if email is not found', async () => {
+      const email = '[email protected]';
+
+      // Mock `findOne` to return null
+      jest.spyOn(repository, 'findOne').mockResolvedValue(null);
+
+      // Expecting an error
+      await expect(service.unsubscribe(email)).rejects.toThrow(
+        new NotFoundException(`Email ${email} not found in the subscription list`)
+      );
+
+      expect(repository.findOne).toHaveBeenCalledWith({ where: { email } });
+    });
+  });
 });