Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEAT:newsletter unsubscribe endpoint #699

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,9 @@ public SecurityFilterChain httpSecurity(HttpSecurity httpSecurity) throws Except
"/api/v1/categories",
"/api/v1/payment/plans",
"/api/v1/payment/webhook",
"/api/v1/notification-settings"
"/api/v1/notification-settings",
"/api/v1/newsletter-subscription",
"/api/v1/newsletter-subscription/{subscriberId}"
).permitAll()
.requestMatchers(

Expand Down
Original file line number Diff line number Diff line change
@@ -1,26 +1,40 @@
package hng_java_boilerplate.newsletter.controller;

import hng_java_boilerplate.exception.UnAuthorizedException;
import hng_java_boilerplate.newsletter.dto.SubscribeRequest;
import hng_java_boilerplate.newsletter.dto.SubscribeResponse;
import hng_java_boilerplate.newsletter.dto.UnsubscribeResponse;
import hng_java_boilerplate.newsletter.service.NewsletterService;
import hng_java_boilerplate.user.entity.User;
import hng_java_boilerplate.user.service.UserService;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.*;

@RestController
@RequiredArgsConstructor
@RequestMapping("/api/v1/newsletter-subscription")
public class NewsletterController {
private final NewsletterService newsletterService;
private final UserService userService;

@PostMapping
public ResponseEntity<SubscribeResponse> subscribe(@RequestBody @Valid SubscribeRequest request) {
return ResponseEntity.status(HttpStatus.CREATED)
.body(newsletterService.subscribeToNewsletter(request));
}
// ✅ Unsubscribe from Newsletter
@DeleteMapping("/{subscriberId}")
public ResponseEntity<?> unsubscribe(
@PathVariable("subscriberId") String subscriberId
) {
User authenticateduser =userService.getLoggedInUser();
if(authenticateduser==null){
throw new UnAuthorizedException("unathorised user");
}
UnsubscribeResponse bun=newsletterService.unsubscribeFromNews(subscriberId);
return ResponseEntity.status(HttpStatus.OK).body(bun);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package hng_java_boilerplate.newsletter.dto;

import jakarta.validation.constraints.Email;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
import lombok.Builder;

@Builder
public record UnsubscribeRequest(
@Email(message="email must be a valid email")
@NotBlank(message = "email cannot be blank")
String email
)
{

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package hng_java_boilerplate.newsletter.dto;

import lombok.Builder;

@Builder
public record UnsubscribeResponse(int status_code,String message) {
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
package hng_java_boilerplate.newsletter.service;

import hng_java_boilerplate.exception.NotFoundException;
import hng_java_boilerplate.exception.UnAuthorizedException;
import hng_java_boilerplate.newsletter.dto.SubscribeRequest;
import hng_java_boilerplate.newsletter.dto.SubscribeResponse;
import hng_java_boilerplate.newsletter.dto.UnsubscribeResponse;
import hng_java_boilerplate.newsletter.entity.Newsletter;
import hng_java_boilerplate.newsletter.repository.NewsletterRepository;
import hng_java_boilerplate.user.entity.User;
Expand Down Expand Up @@ -34,4 +36,25 @@ public SubscribeResponse subscribeToNewsletter(SubscribeRequest request) {

return new SubscribeResponse(201, "subscription successful");
}

// ✅ Unsubscribe from Newsletter (Soft Delete)
public UnsubscribeResponse unsubscribeFromNews(String subscriberId){
User user = userRepository.findById(subscriberId)
.orElseThrow(() -> new NotFoundException("User not found with email"));


if (!user.getId().equals(subscriberId)) {
throw new UnAuthorizedException("unauthorized user");
}


Newsletter subscriber = newsletterRepository.findById(subscriberId).
orElseThrow(() -> new NotFoundException("subscriber not found"));




newsletterRepository.delete(subscriber);
return null;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
package hng_java_boilerplate.newsletter;


import hng_java_boilerplate.exception.NotFoundException;
import hng_java_boilerplate.exception.UnAuthorizedException;
import hng_java_boilerplate.newsletter.dto.UnsubscribeResponse;
import hng_java_boilerplate.newsletter.entity.Newsletter;
import hng_java_boilerplate.newsletter.repository.NewsletterRepository;
import hng_java_boilerplate.newsletter.service.NewsletterService;
import hng_java_boilerplate.user.entity.User;
import hng_java_boilerplate.user.repository.UserRepository;
import hng_java_boilerplate.user.service.UserService;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import java.util.Optional;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;

@ExtendWith(MockitoExtension.class)
public class NewsletterServiceTest {

@Mock
private UserRepository userRepository;

@Mock
private NewsletterRepository newsletterRepository;

@InjectMocks
private NewsletterService newsletterService;

@Test
public void testUnsubscribeFromNews_successfulUnsubscribe() {
String subscriberId = "testId";
User user = new User();
user.setId(subscriberId);
Newsletter subscriber = new Newsletter();
subscriber.setId(subscriberId);

when(userRepository.findById(subscriberId)).thenReturn(Optional.of(user));
when(newsletterRepository.findById(subscriberId)).thenReturn(Optional.of(subscriber));

UnsubscribeResponse response = newsletterService.unsubscribeFromNews(subscriberId);

assertNull(response); // Or assert the expected response if not null
verify(newsletterRepository, times(1)).delete(subscriber);
}

@Test
public void testUnsubscribeFromNews_userNotFound() {
String subscriberId = "nonExistentId";
when(userRepository.findById(subscriberId)).thenReturn(Optional.empty());

assertThrows(NotFoundException.class, () -> newsletterService.unsubscribeFromNews(subscriberId));
verify(newsletterRepository, never()).delete(any());
}

@Test
public void testUnsubscribeFromNews_subscriberNotFound() {
String subscriberId = "testId";
User user = new User();
user.setId(subscriberId);

when(userRepository.findById(subscriberId)).thenReturn(Optional.of(user));
when(newsletterRepository.findById(subscriberId)).thenReturn(Optional.empty());

assertThrows(NotFoundException.class, () -> newsletterService.unsubscribeFromNews(subscriberId));
verify(newsletterRepository, never()).delete(any());
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this commented out section

// @Test
// public void testUnsubscribeFromNews_unauthorizedUser() {
// String subscriberId = "testId";
// User user = new User();
// user.setId("differentId");
// Newsletter subscriber = new Newsletter();
// subscriber.setId(subscriberId);

// when(userRepository.findById(subscriberId)).thenReturn(Optional.of(user));
// when(newsletterRepository.findById(subscriberId)).thenReturn(Optional.of(subscriber));
//
// assertThrows(UnAuthorizedException.class, () -> newsletterService.unsubscribeFromNews(subscriberId));
// verify(newsletterRepository, never()).delete(any());
// }
}
Loading