Merge pull request #175 from it-at-m/feature/my-checklists-backend

Feature/my checklists backend

Author: FabianWilms

personalization-service/src/main/java/de/muenchen/dbs/personalization/checklist/ChecklistController.java

@@ -8,6 +8,7 @@
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
+import java.time.ZonedDateTime;
 import java.util.List;
 import java.util.UUID;
 import lombok.RequiredArgsConstructor;
@@ -22,6 +23,11 @@
 @Tag(name = "Checklists", description = "Creating, reading and deleting Checklists.")
 public class ChecklistController {
 
+    public static final String CHECKLIST_ID = "checklistID";
+    public static final String SERVICE_ID = "serviceID";
+    public static final String PATH_VAR_CHECKLIST_ID = "/{" + CHECKLIST_ID + "}";
+    public static final String PATH_VAR_SERVICE_ID = "/{" + SERVICE_ID + "}";
+
     private final ChecklistService checklistService;
     private final ChecklistMapper checklistMapper;
 
@@ -33,10 +39,10 @@ public List<ChecklistReadDTO> getChecklists() {
         return checklists.stream().map(checklistMapper::toReadDTO).toList();
     }
 
-    @GetMapping(path = "/{checklistID}")
+    @GetMapping(path = PATH_VAR_CHECKLIST_ID)
     @Operation(summary = "Get specific checklist by checklist-id.", description = "Returns a checklist by checklistId")
     @ResponseStatus(HttpStatus.OK)
-    public ChecklistReadDTO getChecklist(@PathVariable("checklistID") final UUID checklistID) {
+    public ChecklistReadDTO getChecklist(@PathVariable(CHECKLIST_ID) final UUID checklistID) {
         return checklistMapper.toReadDTO(checklistService.getChecklist(checklistID));
     }
 
@@ -48,18 +54,34 @@ public ChecklistReadDTO createChecklist(@Valid @RequestBody final ChecklistCreat
                 .toReadDTO(checklistService.createChecklist(checklistMapper.toCreateChecklist(checklistCreateDTO)));
     }
 
-    @PutMapping("/{checklistID}")
+    @PutMapping(PATH_VAR_CHECKLIST_ID)
     @Operation(summary = "Update a checklist", description = "Updates a checklist using the provided checklist details.")
     @ResponseStatus(HttpStatus.OK)
     public ChecklistReadDTO updateChecklist(@Valid @RequestBody final ChecklistUpdateDTO checklistUpdateDTO,
-            @PathVariable("checklistID") final UUID checklistID) {
+            @PathVariable(CHECKLIST_ID) final UUID checklistID) {
         return checklistMapper.toReadDTO(checklistService.updateChecklist(checklistMapper.toUpdateChecklist(checklistUpdateDTO), checklistID));
     }
 
-    @DeleteMapping("/{checklistID}")
+    @DeleteMapping(PATH_VAR_CHECKLIST_ID)
     @Operation(summary = "Delete a checklist", description = "Deletes a checklist by checklistId.")
     @ResponseStatus(HttpStatus.OK)
-    public void deleteChecklist(@PathVariable("checklistID") final UUID checklistID) {
+    public void deleteChecklist(@PathVariable(CHECKLIST_ID) final UUID checklistID) {
         checklistService.deleteChecklist(checklistID);
     }
+
+    @PostMapping(PATH_VAR_CHECKLIST_ID + PATH_VAR_SERVICE_ID + "/check")
+    @Operation(summary = "Check a Checklist-Entry", description = "Checks a checklist-entry.")
+    @ResponseStatus(HttpStatus.OK)
+    public ChecklistReadDTO checkChecklistEntry(@PathVariable(CHECKLIST_ID) final UUID checklistID,
+            @PathVariable(SERVICE_ID) final String serviceID) {
+        return checklistMapper.toReadDTO(checklistService.changeChecklistEntry(checklistID, serviceID, ZonedDateTime.now()));
+    }
+
+    @PostMapping(PATH_VAR_CHECKLIST_ID + PATH_VAR_SERVICE_ID + "/uncheck")
+    @Operation(summary = "Uncheck a Checklist-Entry", description = "Unchecks a checklist-entry.")
+    @ResponseStatus(HttpStatus.OK)
+    public ChecklistReadDTO uncheckChecklistEntry(@PathVariable(CHECKLIST_ID) final UUID checklistID,
+            @PathVariable(SERVICE_ID) final String serviceID) {
+        return checklistMapper.toReadDTO(checklistService.changeChecklistEntry(checklistID, serviceID, null));
+    }
 }

personalization-service/src/main/java/de/muenchen/dbs/personalization/checklist/ChecklistService.java

@@ -10,6 +10,7 @@
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.text.StringEscapeUtils;
 import org.springframework.http.HttpStatus;
 import org.springframework.security.core.Authentication;
 import org.springframework.security.core.context.SecurityContextHolder;
@@ -70,6 +71,26 @@ public void deleteChecklist(final UUID checklistId) {
         checklistRepository.deleteById(checklistId);
     }
 
+    public Checklist changeChecklistEntry(final UUID checklistId, final String serviceId, final ZonedDateTime newCheckedValue) {
+        final String lhmExtId = getLhmExtIdFromAuthenticationOrThrow();
+        final String sanitizedServiceId = StringEscapeUtils.escapeHtml4(serviceId);
+        log.debug("Update checklist with checklist-ID {} and service-ID {} for {}", checklistId, sanitizedServiceId, lhmExtId);
+        final Checklist foundChecklist = getChecklistOrThrowException(checklistId);
+
+        isChecklistOwnerOrThrow(foundChecklist, lhmExtId);
+
+        foundChecklist.getChecklistItems().forEach(checklistItem -> {
+            if (checklistItem.getServiceID().equals(sanitizedServiceId)) {
+                checklistItem.setChecked(newCheckedValue);
+            }
+        });
+        foundChecklist.setLastUpdate(ZonedDateTime.now());
+
+        log.debug("Update Checklist {}", foundChecklist);
+
+        return checklistRepository.save(foundChecklist);
+    }
+
     private Checklist getChecklistOrThrowException(final UUID checklistId) {
         return checklistRepository
                 .findById(checklistId)