Merge pull request #50 from companieshouse/feature/lp-284-patch-email

lduranteau · web-flow · commit 16417da6be11 · 2024-12-09T15:29:10.000Z
Feature/lp 284 patch email
diff --git a/spec/schema.json b/spec/schema.json
@@ -56,6 +56,50 @@
         }
       }
     },
+    "/transactions/{transactionId}/limited-partnership/partnership/{submissionId}": {
+      "patch": {
+        "tags": [
+          "Limited Partnerships"
+        ],
+        "summary": "Update a Limited Partnership submission",
+        "parameters": [
+          {
+            "name": "transactionId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "submissionId",
+            "in": "path",
+            "required": true,
+            "type": "string"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/LimitedPartnershipSubmissionUpdate"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Limited Partnership Submission has been successfully updated."
+          },
+          "400": {
+            "description": "Bad Request"
+          },
+          "401": {
+            "description": "Unauthorised"
+          },
+          "500": {
+            "description": "Internal Server Error"
+          }
+        }
+      }
+    },
     "/limited-partnership/healthcheck": {
       "get": {
         "summary": "Health check URL returns 200 if service is running",
@@ -86,6 +130,21 @@
         }
       }
     },
+    "LimitedPartnershipSubmissionUpdate": {
+      "type": "object",
+      "required": [
+        "type",
+        "data"
+      ],
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "data": {
+          "type": "object"
+        }
+      }
+    },
     "Data": {
       "type": "object",
       "properties": {
diff --git a/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/controller/PartnershipController.java b/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/controller/PartnershipController.java
@@ -1,8 +1,13 @@
 package uk.gov.companieshouse.limitedpartnershipsapi.controller;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.ObjectWriter;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PatchMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestAttribute;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -11,17 +16,20 @@
 import org.springframework.web.bind.annotation.RestController;
 import uk.gov.companieshouse.api.model.transaction.Transaction;
 import uk.gov.companieshouse.limitedpartnershipsapi.exception.ServiceException;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.DataType;
 import uk.gov.companieshouse.limitedpartnershipsapi.model.dto.LimitedPartnershipSubmissionCreatedResponseDto;
 import uk.gov.companieshouse.limitedpartnershipsapi.model.dto.LimitedPartnershipSubmissionDto;
 import uk.gov.companieshouse.limitedpartnershipsapi.service.LimitedPartnershipService;
 import uk.gov.companieshouse.limitedpartnershipsapi.utils.ApiLogger;
 
 import java.net.URI;
 import java.util.HashMap;
+import java.util.Map;
 
 import static uk.gov.companieshouse.api.util.security.EricConstants.ERIC_IDENTITY;
 import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.ERIC_REQUEST_ID_KEY;
 import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.TRANSACTION_KEY;
+import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.URL_PARAM_SUBMISSION_ID;
 import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.URL_PARAM_TRANSACTION_ID;
 
 @RestController
@@ -62,4 +70,39 @@ public ResponseEntity<Object> createPartnership(
             return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
         }
     }
+
+    @PatchMapping("/{" + URL_PARAM_SUBMISSION_ID + "}")
+    public ResponseEntity<Object> updatePartnership(
+            @RequestAttribute(TRANSACTION_KEY) Transaction transaction,
+            @PathVariable(URL_PARAM_SUBMISSION_ID) String submissionId,
+            @RequestBody Map<String, Object> body,
+            @RequestHeader(value = ERIC_REQUEST_ID_KEY) String requestId,
+            @RequestHeader(value = ERIC_IDENTITY) String userId
+    ) {
+
+        String transactionId = transaction.getId();
+        HashMap<String, Object> logMap = new HashMap<>();
+        logMap.put(URL_PARAM_TRANSACTION_ID, transactionId);
+
+        try {
+            String type = (String) body.get("type");
+            var dataType = DataType.valueOf(type.toUpperCase());
+            final Map<String, Object> data = extractData(body);
+
+            limitedPartnershipService.updateLimitedPartnership(submissionId, dataType, data);
+
+            return new ResponseEntity<>(HttpStatus.OK);
+        } catch (JsonProcessingException | ServiceException e) {
+            ApiLogger.errorContext(requestId, "Error updating Limited Partnership submission", e, logMap);
+            return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR);
+        }
+    }
+
+    private static Map<String, Object> extractData(Map<String, Object> body) throws JsonProcessingException {
+        ObjectWriter ow = new ObjectMapper().writer().withDefaultPrettyPrinter();
+        var json = ow.writeValueAsString(body.get("data"));
+
+        return new ObjectMapper().readValue(json, Map.class);
+    }
+
 }
diff --git a/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/mapper/LimitedPartnershipMapper.java b/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/mapper/LimitedPartnershipMapper.java
@@ -15,6 +15,8 @@ public interface LimitedPartnershipMapper {
 
   LimitedPartnershipSubmissionDao dtoToDao(LimitedPartnershipSubmissionDto dto);
 
+  LimitedPartnershipSubmissionDto daoToDto(LimitedPartnershipSubmissionDao dao);
+
   default String mapPartnershipNameEndingToString(PartnershipNameEnding nameEnding){
     return nameEnding.getDescription();
   }
diff --git a/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/DataType.java b/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/DataType.java
@@ -0,0 +1,16 @@
+package uk.gov.companieshouse.limitedpartnershipsapi.model;
+
+public enum DataType {
+    EMAIL("email");
+
+    private final String description;
+
+    DataType(String description) {
+        this.description = description;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+}
diff --git a/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/dao/DataDao.java b/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/dao/DataDao.java
@@ -10,6 +10,9 @@ public class DataDao {
     @Field("name_ending")
     private String nameEnding;
 
+    @Field("registered_email_address")
+    private String email;
+
     public String getPartnershipName() {
         return partnershipName;
     }
@@ -25,4 +28,12 @@ public String getNameEnding() {
     public void setNameEnding(String nameEnding) {
         this.nameEnding = nameEnding;
     }
+
+    public String getEmail() {
+        return email;
+    }
+
+    public void setEmail(String email) {
+        this.email = email;
+    }
 }
diff --git a/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/dto/DataDto.java b/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/model/dto/DataDto.java
@@ -15,6 +15,9 @@ public class DataDto {
     @JsonProperty("name_ending")
     private PartnershipNameEnding nameEnding;
 
+    @JsonProperty("email")
+    private String email;
+
     public String getPartnershipName() {
         return partnershipName;
     }
@@ -30,4 +33,12 @@ public PartnershipNameEnding getNameEnding() {
     public void setNameEnding(PartnershipNameEnding nameEnding) {
         this.nameEnding = nameEnding;
     }
+
+    public String getEmail() {
+        return email;
+    }
+
+    public void setEmail(String email) {
+        this.email = email;
+    }
 }
diff --git a/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/service/LimitedPartnershipService.java b/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/service/LimitedPartnershipService.java
@@ -6,6 +6,7 @@
 import uk.gov.companieshouse.api.model.transaction.Transaction;
 import uk.gov.companieshouse.limitedpartnershipsapi.exception.ServiceException;
 import uk.gov.companieshouse.limitedpartnershipsapi.mapper.LimitedPartnershipMapper;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.DataType;
 import uk.gov.companieshouse.limitedpartnershipsapi.model.dao.LimitedPartnershipSubmissionDao;
 import uk.gov.companieshouse.limitedpartnershipsapi.model.dto.LimitedPartnershipSubmissionDto;
 import uk.gov.companieshouse.limitedpartnershipsapi.repository.LimitedPartnershipSubmissionsRepository;
@@ -17,8 +18,8 @@
 import java.util.Map;
 
 import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.FILING_KIND_LIMITED_PARTNERSHIP;
-import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.SUBMISSION_URI_PATTERN;
 import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.LINK_SELF;
+import static uk.gov.companieshouse.limitedpartnershipsapi.utils.Constants.SUBMISSION_URI_PATTERN;
 
 @Service
 public class LimitedPartnershipService {
@@ -69,6 +70,27 @@ public String createLimitedPartnership(Transaction transaction,
         return insertedSubmission.getId();
     }
 
+    public void updateLimitedPartnership(String submissionId,
+                                         DataType type,
+                                         Map<String, Object> data) throws ServiceException {
+
+        var limitedPartnershipSubmissionDao = repository.findById(submissionId);
+
+        if (limitedPartnershipSubmissionDao.isEmpty()) {
+            throw new ServiceException(String.format(
+                    "Submission with id %s not found", submissionId));
+        }
+
+        if (type == DataType.EMAIL) {
+            var dataDao = limitedPartnershipSubmissionDao.get().getData();
+
+            String email = (String) data.get("email");
+            dataDao.setEmail(email);
+
+            repository.save(limitedPartnershipSubmissionDao.get());
+        }
+    }
+
     private Resource createLimitedPartnershipTransactionResource(String submissionUri) {
         var limitedPartnershipResource = new Resource();
 
diff --git a/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/utils/Constants.java b/src/main/java/uk/gov/companieshouse/limitedpartnershipsapi/utils/Constants.java
@@ -10,6 +10,7 @@ private Constants() {
 
     // URL path parameters
     public static final String URL_PARAM_TRANSACTION_ID = "transactionId";
+    public static final String URL_PARAM_SUBMISSION_ID = "submissionId";
 
     public static final String TRANSACTION_KEY = "transaction";
 
diff --git a/src/test/java/uk/gov/companieshouse/limitedpartnershipsapi/controller/PartnershipControllerTest.java b/src/test/java/uk/gov/companieshouse/limitedpartnershipsapi/controller/PartnershipControllerTest.java
@@ -1,5 +1,6 @@
 package uk.gov.companieshouse.limitedpartnershipsapi.controller;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -10,16 +11,19 @@
 import org.springframework.http.HttpStatus;
 import uk.gov.companieshouse.api.model.transaction.Transaction;
 import uk.gov.companieshouse.limitedpartnershipsapi.exception.ServiceException;
+import uk.gov.companieshouse.limitedpartnershipsapi.model.DataType;
 import uk.gov.companieshouse.limitedpartnershipsapi.model.dto.DataDto;
 import uk.gov.companieshouse.limitedpartnershipsapi.model.dto.LimitedPartnershipSubmissionCreatedResponseDto;
 import uk.gov.companieshouse.limitedpartnershipsapi.model.dto.LimitedPartnershipSubmissionDto;
 import uk.gov.companieshouse.limitedpartnershipsapi.service.LimitedPartnershipService;
 
+import java.util.HashMap;
 import java.util.Objects;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.doThrow;
 import static org.mockito.Mockito.when;
 import static uk.gov.companieshouse.limitedpartnershipsapi.controller.PartnershipController.URL_GET_PARTNERSHIP;
 
@@ -93,4 +97,48 @@ void testCreatePartnershipInternalServerError() throws ServiceException {
 
         assertEquals(HttpStatus.INTERNAL_SERVER_ERROR.value(), response.getStatusCode().value());
     }
+
+    @Test
+    void testUpdatePartnership() throws JsonProcessingException {
+        HashMap<String, Object> body = new HashMap<String, Object>();
+        body.put("type", "email");
+        HashMap<String, Object> data = new HashMap<String, Object>();
+        data.put("email", "test@email.com");
+        body.put("data", data);
+
+        when(transaction.getId()).thenReturn(TRANSACTION_ID);
+
+        var response = partnershipController.updatePartnership(
+                transaction,
+                SUBMISSION_ID,
+                body,
+                REQUEST_ID,
+                USER_ID);
+
+        assertEquals(HttpStatus.OK.value(), response.getStatusCode().value());
+    }
+
+    @Test
+    void testUpdatePartnershipInternalServerError() throws ServiceException, JsonProcessingException {
+        HashMap<String, Object> body = new HashMap<String, Object>();
+        body.put("type", "email");
+        HashMap<String, Object> data = new HashMap<String, Object>();
+        data.put("email", "test@email.com");
+        body.put("data", data);
+
+        doThrow(new ServiceException(String.format(
+                "Submission with id %s not found", SUBMISSION_ID))).when(limitedPartnershipService).updateLimitedPartnership(
+                SUBMISSION_ID,
+                DataType.EMAIL,
+                data);
+
+        var response = partnershipController.updatePartnership(
+                transaction,
+                SUBMISSION_ID,
+                body,
+                REQUEST_ID,
+                USER_ID);
+
+        assertEquals(HttpStatus.INTERNAL_SERVER_ERROR.value(), response.getStatusCode().value());
+    }
 }
diff --git a/src/test/java/uk/gov/companieshouse/limitedpartnershipsapi/service/LimitedPartnershipServiceTest.java b/src/test/java/uk/gov/companieshouse/limitedpartnershipsapi/service/LimitedPartnershipServiceTest.java

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,8 @@ public interface LimitedPartnershipMapper {`
`15`	`15`
`16`	`16`	`LimitedPartnershipSubmissionDao dtoToDao(LimitedPartnershipSubmissionDto dto);`
`17`	`17`
	`18`	`+ LimitedPartnershipSubmissionDto daoToDto(LimitedPartnershipSubmissionDao dao);`
	`19`	`+`
`18`	`20`	`default String mapPartnershipNameEndingToString(PartnershipNameEnding nameEnding){`
`19`	`21`	`return nameEnding.getDescription();`
`20`	`22`	`}`