feat: data exclusion endpoint; fix messages; minor improvements

Author: g-otn

pom.xml

@@ -11,9 +11,9 @@
     </parent>
     <groupId>br.com.grupo63</groupId>
     <artifactId>serviceidentification</artifactId>
-    <version>4.3.2</version>
+    <version>5.0.0</version>
     <name>Service Identification</name>
-    <description>FIAP SOAT1 2023 - Group 63 - Phase 4</description>
+    <description>FIAP SOAT1 2023 - Group 63 - Phase 5</description>
     <properties>
         <java.version>17</java.version>
         <sonar.coverage.exclusions>

src/main/java/br/com/grupo63/serviceidentification/api/controller/client/ClientAPIController.java

@@ -26,7 +26,7 @@ public class ClientAPIController extends AbstractAPIController {
             summary = "Identificar o cliente (Utilizado pelo Lambda de identificação)",
             description = "Recupera o ID do cliente caso ele exista e se não existir já o cria")
     @PostMapping("/identification")
-    public ResponseEntity<ClientControllerDTO> identify(@RequestParam String nationalId) throws NotFoundException {
+    public ResponseEntity<ClientControllerDTO> identify(@RequestParam String nationalId) {
         ClientControllerDTO clientDTO = new ClientControllerDTO(nationalId);
         return ResponseEntity.ok(clientController.identify(clientDTO));
     }
@@ -35,7 +35,7 @@ public ResponseEntity<ClientControllerDTO> identify(@RequestParam String nationa
             summary = "Cria um cliente",
             description = "Registra um cliente através de seu CPF")
     @PostMapping
-    public ResponseEntity<ClientControllerDTO> create(@RequestParam String nationalId) throws NotFoundException {
+    public ResponseEntity<ClientControllerDTO> create(@RequestParam String nationalId) {
         ClientControllerDTO clientDTO = new ClientControllerDTO(nationalId);
         return ResponseEntity.ok(clientController.create(clientDTO));
     }
@@ -68,10 +68,24 @@ public ResponseEntity<ClientControllerDTO> update(@Valid @RequestBody ClientCont
             summary = "Excluir cliente",
             description = "Exclui um cliente por id")
     @DeleteMapping("/{id}")
-    public ResponseEntity delete(@PathVariable("id") String id) throws NotFoundException {
+    public ResponseEntity<Void> delete(@PathVariable("id") String id) throws NotFoundException {
         clientController.delete(id);
         return ResponseEntity.ok().build();
     }
 
+    @Operation(
+            tags = "LGPD",
+            summary = "Exclusão de dados pessoais",
+            description = "Exclui um cliente por CPF e realiza anonimização dos dados pessoais. Utiliza os dados extras para validar se é o próprio usuário excluindo os dados.")
+    @DeleteMapping("/delete-personal-data")
+    public ResponseEntity<Void> deletePersonalData(
+            @RequestParam String nationalId,
+            @RequestParam String name,
+            @RequestParam String address,
+            @RequestParam String phoneNumber
+    ) throws NotFoundException {
+        clientController.deletePersonalData(nationalId);
+        return ResponseEntity.ok().build();
+    }
 
 }

src/main/java/br/com/grupo63/serviceidentification/controller/ClientController.java

@@ -17,13 +17,13 @@ public class ClientController {
 
     private final ClientUseCase clientUseCase;
 
-    public ClientControllerDTO identify(ClientControllerDTO dto) throws NotFoundException {
+    public ClientControllerDTO identify(ClientControllerDTO dto) {
         Client entity = new Client();
         ClientAdapter.fillEntity(dto, entity);
         return ClientPresenter.toDto(clientUseCase.identify(entity));
     }
 
-    public ClientControllerDTO create(ClientControllerDTO dto) throws NotFoundException {
+    public ClientControllerDTO create(ClientControllerDTO dto) {
         Client entity = new Client();
         ClientAdapter.fillEntity(dto, entity);
         entity = clientUseCase.create(entity);
@@ -50,4 +50,9 @@ public void delete(String id) throws NotFoundException {
         Client entity = clientUseCase.read(id);
         clientUseCase.delete(entity);
     }
+
+    public void deletePersonalData(String nationalId) throws NotFoundException {
+        Client entity = clientUseCase.findByNationalId(nationalId);
+        clientUseCase.deletePersonalData(entity);
+    }
 }

src/main/java/br/com/grupo63/serviceidentification/entity/client/Client.java

@@ -19,4 +19,5 @@ public class Client {
     public void delete() {
         this.deleted = true;
     }
+
 }

src/main/java/br/com/grupo63/serviceidentification/gateway/client/entity/ClientPersistenceEntity.java

@@ -31,6 +31,7 @@ public class ClientPersistenceEntity {
     public ClientPersistenceEntity(Client client) {
         this.id = client.getId();
         this.nationalId = client.getNationalId();
+        this.deleted = client.isDeleted();
     }
 
     public Client toModel() {

src/main/java/br/com/grupo63/serviceidentification/usecase/client/ClientUseCase.java

@@ -58,4 +58,11 @@ public void delete(Client client) {
         gateway.saveAndFlush(client);
     }
 
+    @Override
+    public void deletePersonalData(Client client) {
+        client.setNationalId("00000000000");
+        client.delete();
+        gateway.saveAndFlush(client);
+    }
+
 }

src/main/java/br/com/grupo63/serviceidentification/usecase/client/IClientUseCase.java

@@ -21,4 +21,5 @@ public interface IClientUseCase {
 
     void delete(Client entity);
 
+    void deletePersonalData(Client client);
 }

src/main/resources/messages.properties

@@ -0,0 +1 @@
+# Due to how Spring Boot autoconfiguration works, this file needs to exist for the locale files to be detected.

src/test/java/br/com/grupo63/serviceidentification/ClientIntegrationTest.java

@@ -139,7 +139,7 @@ public void testDelete_EndToEnd() {
         when(clientJpaRepository.findByIdAndDeletedFalse(defaultClientPersistenceEntity.getId())).thenReturn(Optional.of(defaultClientPersistenceEntity));
         when(clientJpaRepository.save(any())).thenReturn(new ClientPersistenceEntity(defaultClientPersistenceEntity.getId(), true, defaultClientPersistenceEntity.getNationalId()));
 
-        ResponseEntity<DefaultResponseDTO> response = clientAPIController.delete(defaultClientPersistenceEntity.getId());
+        ResponseEntity<Void> response = clientAPIController.delete(defaultClientPersistenceEntity.getId());
 
         assertEquals(HttpStatus.OK, response.getStatusCode());
         assertNull(response.getBody());