TRIB-289: Refactors AttributeAPI applyPhraseToUser endpoint and all related services to use a DTO

src/main/java/com/savvato/tribeapp/controllers/AttributesAPIController.java

@@ -6,7 +6,7 @@
 import com.savvato.tribeapp.controllers.annotations.controllers.AttributesAPIController.GetUserPhrasesToBeReviewed;
 import com.savvato.tribeapp.controllers.dto.AttributesRequest;
 import com.savvato.tribeapp.dto.AttributeDTO;
-import com.savvato.tribeapp.dto.GenericResponseDTO;
+import com.savvato.tribeapp.dto.AttributesApplyPhraseToUserDTO;
 import com.savvato.tribeapp.dto.ToBeReviewedDTO;
 import com.savvato.tribeapp.entities.NotificationType;
 import com.savvato.tribeapp.services.*;
@@ -71,25 +71,18 @@ public ResponseEntity<List<ToBeReviewedDTO>> getUserPhrasesToBeReviewed(
 
     @ApplyPhraseToUser
     @PostMapping
-    public ResponseEntity<GenericResponseDTO> applyPhraseToUser(@RequestBody @Valid AttributesRequest req) {
-      if (phraseService.isPhraseValid(req.adverb, req.verb, req.preposition, req.noun)) {
-        boolean isPhraseApplied =
-            phraseService.applyPhraseToUser(
-                req.userId, req.adverb, req.verb, req.preposition, req.noun);
-        if (isPhraseApplied) {
-          sendNotification(true, req.userId);
-          GenericResponseDTO rtn = GenericResponseService.createDTO("true");
-          return ResponseEntity.status(HttpStatus.OK).body(rtn);
-        } else {
-          sendNotification(false, req.userId);
-          GenericResponseDTO rtn = GenericResponseService.createDTO("false");
-          return ResponseEntity.status(HttpStatus.OK).body(rtn);
-        }
-      } else {
-          sendNotification(false, req.userId);
-          GenericResponseDTO rtn = GenericResponseService.createDTO("false");
+    public ResponseEntity<AttributesApplyPhraseToUserDTO> applyPhraseToUser(@RequestBody @Valid AttributesRequest req) {
+
+      if (!phraseService.isPhraseValid(req.adverb, req.verb, req.preposition, req.noun)) {
+          AttributesApplyPhraseToUserDTO rtn = phraseService.constructAttributesApplyPhraseToUserDTO(false, false, true, false);
+          sendNotification(rtn, req.userId);
           return ResponseEntity.status(HttpStatus.OK).body(rtn);
       }
+
+      AttributesApplyPhraseToUserDTO rtn = phraseService.applyPhraseToUser(req.userId, req.adverb, req.verb, req.preposition, req.noun);
+      sendNotification(rtn, req.userId);
+
+      return ResponseEntity.status(HttpStatus.OK).body(rtn);
     }
 
     ///api/attributes/?phraseId=xx&userId=xx
@@ -100,15 +93,18 @@ public ResponseEntity deletePhraseFromUser(@Parameter(description = "Phrase ID o
         return ResponseEntity.ok().build();
     }
 
-    private void sendNotification(Boolean approved, Long userId) {
-        if (approved) {
+    private void sendNotification(AttributesApplyPhraseToUserDTO dto, Long userId) {
+        if (dto.isSuccess && dto.isApproved) {
             notificationService.createNotification(
                     NotificationType.ATTRIBUTE_REQUEST_APPROVED,
                     userId,
                     NotificationType.ATTRIBUTE_REQUEST_APPROVED.getName(),
                     "Your attribute has been approved!");
 
-        } else {
+        } else if (dto.isInReview) {
+            notificationService.createNotification(NotificationType.ATTRIBUTE_REQUEST_IN_REVIEW, userId, NotificationType.ATTRIBUTE_REQUEST_IN_REVIEW.getName(), "Your attribute will be reviewed.");
+
+        } else if (dto.isRejected) {
             notificationService.createNotification(
                     NotificationType.ATTRIBUTE_REQUEST_REJECTED,
                     userId,

src/main/java/com/savvato/tribeapp/controllers/annotations/controllers/AttributesAPIController/ApplyPhraseToUser.java

@@ -3,6 +3,8 @@
 import com.savvato.tribeapp.controllers.annotations.requests.DocumentedRequestBody;
 import com.savvato.tribeapp.controllers.annotations.responses.Success;
 import com.savvato.tribeapp.controllers.dto.AttributesRequest;
+import com.savvato.tribeapp.dto.AttributesApplyPhraseToUserDTO;
+import com.savvato.tribeapp.dto.ToBeReviewedDTO;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.media.ExampleObject;
 import java.lang.annotation.*;
@@ -16,10 +18,5 @@
     description = "Provided a valid AttributesRequest (see schemas), apply phrase to user.")
 @DocumentedRequestBody(implementation = AttributesRequest.class)
 @Success(
-    description = "Successfully applied phrase",
-    examples = {
-      @ExampleObject(name = "Phrase applied successfully", value = "true"),
-      @ExampleObject(name = "Failed to apply phrase", value = "false"),
-      @ExampleObject(name = "Phrase was invalid", value = "false")
-    })
+    description = "Successfully applied phrase", implementation = AttributesApplyPhraseToUserDTO.class)
 public @interface ApplyPhraseToUser {}

src/main/java/com/savvato/tribeapp/dto/AttributesApplyPhraseToUserDTO.java

@@ -0,0 +1,22 @@
+package com.savvato.tribeapp.dto;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Builder;
+
+@Builder
+@Schema(description = "Result of applying phrase to user")
+public class AttributesApplyPhraseToUserDTO {
+
+    @Schema(example = "true")
+    public boolean isSuccess;
+
+    @Schema(example = "true")
+    public boolean isApproved;
+
+    @Schema(example = "true")
+    public boolean isRejected;
+
+    @Schema(example = "true")
+    public boolean isInReview;
+
+}

src/main/java/com/savvato/tribeapp/entities/NotificationType.java

@@ -7,7 +7,8 @@
 public class NotificationType {
 
     public static final NotificationType ATTRIBUTE_REQUEST_APPROVED = new NotificationType(1L, "Attribute request approved", null);
-    public static final NotificationType ATTRIBUTE_REQUEST_REJECTED = new NotificationType(1L, "Attribute request rejected", null);
+    public static final NotificationType ATTRIBUTE_REQUEST_REJECTED = new NotificationType(2L, "Attribute request rejected", null);
+    public static final NotificationType ATTRIBUTE_REQUEST_IN_REVIEW = new NotificationType(3L, "Attribute request in review", null);
 
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)

src/main/java/com/savvato/tribeapp/services/PhraseService.java

@@ -1,6 +1,7 @@
 package com.savvato.tribeapp.services;
 
 import com.savvato.tribeapp.dto.PhraseDTO;
+import com.savvato.tribeapp.dto.AttributesApplyPhraseToUserDTO;
 
 import java.util.Map;
 import java.util.Optional;
@@ -9,9 +10,11 @@ public interface PhraseService {
 
     boolean isPhraseValid(String adverb, String verb, String preposition, String noun);
 
-    boolean applyPhraseToUser(Long userId, String adverb, String verb, String preposition, String noun);
+    AttributesApplyPhraseToUserDTO applyPhraseToUser(Long userId, String adverb, String verb, String preposition, String noun);
 
     Optional<Long> findPreviouslyApprovedPhraseId(String adverb, String verb, String preposition, String noun);
 
     Optional<Map<PhraseDTO, Integer>> getPhraseInformationByUserId(Long userId);
+
+    AttributesApplyPhraseToUserDTO constructAttributesApplyPhraseToUserDTO(boolean success, boolean approved, boolean rejected, boolean inReview);
 }

src/main/java/com/savvato/tribeapp/services/PhraseServiceImpl.java

@@ -3,6 +3,7 @@
 import com.savvato.tribeapp.constants.Constants;
 import com.savvato.tribeapp.dto.PhraseDTO;
 import com.savvato.tribeapp.dto.projections.PhraseWithUserCountDTO;
+import com.savvato.tribeapp.dto.AttributesApplyPhraseToUserDTO;
 import com.savvato.tribeapp.entities.*;
 import com.savvato.tribeapp.repositories.*;
 import lombok.extern.slf4j.Slf4j;
@@ -128,7 +129,7 @@ public boolean isPhrasePreviouslyRejected(String adverb, String verb, String pre
     }
 
     @Override
-    public boolean applyPhraseToUser(Long userId, String adverb, String verb, String preposition, String noun) {
+    public AttributesApplyPhraseToUserDTO applyPhraseToUser(Long userId, String adverb, String verb, String preposition, String noun) {
 
         String adverbLowerCase = adverb.isBlank() ? Constants.NULL_VALUE_WORD : changeToLowerCase(adverb);
         String verbLowerCase = changeToLowerCase(verb);
@@ -144,7 +145,8 @@ public boolean applyPhraseToUser(Long userId, String adverb, String verb, String
             userPhraseRepository.save(userPhrase);
             log.info("Phrase added to user " + userId);
 
-            return true;
+            return constructAttributesApplyPhraseToUserDTO(true,true,false, false);
+
         } else {
             Optional<ToBeReviewed> toBeReviewedPhrase = toBeReviewedRepository.findByAdverbAndVerbAndNounAndPreposition(adverbLowerCase, verbLowerCase, nounLowerCase, prepositionLowerCase);
 
@@ -166,7 +168,7 @@ public boolean applyPhraseToUser(Long userId, String adverb, String verb, String
                 log.info("ToBeReviewed phrase has been mapped to user " + userId);
             }
 
-            return false;
+            return constructAttributesApplyPhraseToUserDTO(true,false,false,true);
         }
     }
 
@@ -277,4 +279,15 @@ public PhraseDTO constructPhraseDTOFromPhraseInformation(Long phraseId, Long adv
                 .build();
     }
 
+    @Override
+    public AttributesApplyPhraseToUserDTO constructAttributesApplyPhraseToUserDTO(boolean success, boolean approved, boolean rejected, boolean inReview){
+        AttributesApplyPhraseToUserDTO rtn = AttributesApplyPhraseToUserDTO.builder()
+                .isSuccess(success)
+                .isApproved(approved)
+                .isRejected(rejected)
+                .isInReview(inReview)
+                .build();
+        return rtn;
+    }
+
 }

src/main/resources/db/migration/changelog-202410031119.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+        xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+                      http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.1.xsd">
+
+    <changeSet author="audra" id="202410031119-01">
+        <insert tableName="notification_type">
+            <column name="id" value="3"/>
+            <column name="name" value="Attribute request in review"/>
+            <column name="icon_url" value="hourglass-outline"/>
+        </insert>
+    </changeSet>
+
+</databaseChangeLog>

src/main/resources/db/migration/changelog-master.xml

@@ -47,6 +47,7 @@
     <include file="changelog-202401111012.xml" relativeToChangelogFile="true"/>
     <include file="changelog-202401090508.xml" relativeToChangelogFile="true"/>
     <include file="changelog-202403270537.xml" relativeToChangelogFile="true"/>
+    <include file="changelog-202410031119.xml" relativeToChangelogFile="true"/>
 
 </databaseChangeLog>
 

src/test/java/com/savvato/tribeapp/integration/controllers/AttributesAPIIT.java

@@ -8,10 +8,7 @@
 import com.savvato.tribeapp.constants.UserTestConstants;
 import com.savvato.tribeapp.controllers.AttributesAPIController;
 import com.savvato.tribeapp.controllers.dto.AttributesRequest;
-import com.savvato.tribeapp.dto.AttributeDTO;
-import com.savvato.tribeapp.dto.PhraseDTO;
-import com.savvato.tribeapp.dto.ToBeReviewedDTO;
-import com.savvato.tribeapp.dto.GenericResponseDTO;
+import com.savvato.tribeapp.dto.*;
 import com.savvato.tribeapp.entities.NotificationType;
 import com.savvato.tribeapp.entities.User;
 import com.savvato.tribeapp.services.*;
@@ -156,27 +153,31 @@ public void applyPhraseToUserWhenPhraseValidAndApplicable() throws Exception {
         attributesRequest.noun = NOUN1_WORD;
         attributesRequest.preposition = PREPOSITION1_WORD;
         String notificationContent = "Your attribute has been approved!";
+
+        AttributesApplyPhraseToUserDTO expectedDTO = AttributesApplyPhraseToUserDTO
+                .builder()
+                .isSuccess(true)
+                .isApproved(true)
+                .isRejected(false)
+                .isInReview(false)
+                .build();
+
         when(phraseService.isPhraseValid(anyString(), anyString(), anyString(), anyString()))
                 .thenReturn(true);
         when(phraseService.applyPhraseToUser(
                 anyLong(), anyString(), anyString(), anyString(), anyString()))
-                .thenReturn(true);
+                .thenReturn(expectedDTO);
         when(notificationService.createNotification(
                 any(NotificationType.class), anyLong(), anyString(), anyString()))
                 .thenReturn(null);
-        when(GenericResponseService.createDTO(
-                anyString()))
-                .thenReturn(GenericResponseDTO.builder()
-                        .responseMessage("true")
-                        .build());
+
         ArgumentCaptor<NotificationType> notificationTypeCaptor =
                 ArgumentCaptor.forClass(NotificationType.class);
         ArgumentCaptor<Long> userIdCaptor = ArgumentCaptor.forClass(Long.class);
         ArgumentCaptor<String> notificationTypeNameCaptor = ArgumentCaptor.forClass(String.class);
         ArgumentCaptor<String> notificationContentCaptor = ArgumentCaptor.forClass(String.class);
 
-        String template = "{\"responseMessage\": \"%s\"}";
-        String expectedMessage = String.format(template, "true");
+        String expectedMessage = "{\"isSuccess\": true, \"isApproved\": true, \"isRejected\": false, \"isInReview\": false}";
 
         this.mockMvc
                 .perform(
@@ -217,29 +218,32 @@ public void applyPhraseToUserWhenPhraseValidButNotApplied() throws Exception {
         attributesRequest.noun = NOUN1_WORD;
         attributesRequest.preposition = PREPOSITION1_WORD;
 
+        AttributesApplyPhraseToUserDTO expectedDTO = AttributesApplyPhraseToUserDTO
+                .builder()
+                .isSuccess(true)
+                .isApproved(false)
+                .isRejected(false)
+                .isInReview(true)
+                .build();
+
         when(phraseService.isPhraseValid(anyString(), anyString(), anyString(), anyString()))
                 .thenReturn(true);
         when(phraseService.applyPhraseToUser(
                 anyLong(), anyString(), anyString(), anyString(), anyString()))
-                .thenReturn(false);
+                .thenReturn(expectedDTO);
         when(notificationService.createNotification(
                 any(NotificationType.class), anyLong(), anyString(), anyString()))
                 .thenReturn(null);
-        when(GenericResponseService.createDTO(
-                anyString()))
-                .thenReturn(GenericResponseDTO.builder()
-                        .responseMessage("false")
-                        .build());
+
         ArgumentCaptor<NotificationType> notificationTypeCaptor =
                 ArgumentCaptor.forClass(NotificationType.class);
         ArgumentCaptor<Long> userIdCaptor = ArgumentCaptor.forClass(Long.class);
         ArgumentCaptor<String> notificationTypeNameCaptor = ArgumentCaptor.forClass(String.class);
         ArgumentCaptor<String> notificationContentCaptor = ArgumentCaptor.forClass(String.class);
         String notificationContent =
-                "Your attribute was rejected. This attribute is unsuitable and cannot be applied to users.";
+                "Your attribute will be reviewed.";
 
-        String template = "{\"responseMessage\": \"%s\"}";
-        String expectedMessage = String.format(template, "false");
+        String expectedMessage = "{\"isSuccess\": true, \"isApproved\": false, \"isRejected\": false, \"isInReview\": true}";
 
         this.mockMvc
                 .perform(
@@ -258,11 +262,11 @@ public void applyPhraseToUserWhenPhraseValidButNotApplied() throws Exception {
                         userIdCaptor.capture(),
                         notificationTypeNameCaptor.capture(),
                         notificationContentCaptor.capture());
-        assertThat(notificationTypeCaptor.getValue()).usingRecursiveComparison().isEqualTo(NotificationType.ATTRIBUTE_REQUEST_REJECTED);
+        assertThat(notificationTypeCaptor.getValue()).usingRecursiveComparison().isEqualTo(NotificationType.ATTRIBUTE_REQUEST_IN_REVIEW);
         assertEquals(userIdCaptor.getValue(), userId);
         assertEquals(
                 notificationTypeNameCaptor.getValue(),
-                NotificationType.ATTRIBUTE_REQUEST_REJECTED.getName());
+                NotificationType.ATTRIBUTE_REQUEST_IN_REVIEW.getName());
         assertEquals(notificationContentCaptor.getValue(), notificationContent);
     }
 
@@ -280,16 +284,21 @@ public void applyPhraseToUserWhenPhraseInvalid() throws Exception {
         attributesRequest.noun = NOUN1_WORD;
         attributesRequest.preposition = PREPOSITION1_WORD;
 
+        AttributesApplyPhraseToUserDTO expectedDTO = AttributesApplyPhraseToUserDTO
+                .builder()
+                .isSuccess(false)
+                .isApproved(false)
+                .isRejected(true)
+                .isInReview(false)
+                .build();
+
         when(phraseService.isPhraseValid(anyString(), anyString(), anyString(), anyString()))
                 .thenReturn(false);
+        when((phraseService.constructAttributesApplyPhraseToUserDTO(anyBoolean(),anyBoolean(),anyBoolean(),anyBoolean()))).thenReturn(expectedDTO);
         when(notificationService.createNotification(
                 any(NotificationType.class), anyLong(), anyString(), anyString()))
                 .thenReturn(null);
-        when(GenericResponseService.createDTO(
-                anyString()))
-                .thenReturn(GenericResponseDTO.builder()
-                        .responseMessage("false")
-                        .build());
+
         ArgumentCaptor<NotificationType> notificationTypeCaptor =
                 ArgumentCaptor.forClass(NotificationType.class);
         ArgumentCaptor<Long> userIdCaptor = ArgumentCaptor.forClass(Long.class);
@@ -298,8 +307,7 @@ public void applyPhraseToUserWhenPhraseInvalid() throws Exception {
         String notificationContent =
                 "Your attribute was rejected. This attribute is unsuitable and cannot be applied to users.";
 
-        String template = "{\"responseMessage\": \"%s\"}";
-        String expectedMessage = String.format(template, "false");
+        String expectedMessage = "{\"isSuccess\": false, \"isApproved\": false, \"isRejected\": true, \"isInReview\": false}";
 
         this.mockMvc
                 .perform(