Merge pull request #12 from companieshouse/feature/change-return-status-code

Change returned status to 201

Author: EmrysRoberts

src/main/java/uk/gov/companieshouse/pscdataapi/controller/CompanyPscController.java

@@ -1,6 +1,7 @@
 package uk.gov.companieshouse.pscdataapi.controller;
 
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -37,7 +38,7 @@ public ResponseEntity<Void> submitPscData(@RequestHeader("x-request-id") String
         try {
             LOGGER.info("Payload received, inserting record...");
             pscService.insertPscRecord(contextId, request);
-            return ResponseEntity.ok().build();
+            return ResponseEntity.status(HttpStatus.CREATED).build();
         } catch (ServiceUnavailableException exception) {
             LOGGER.info(exception.getMessage());
             return ResponseEntity.internalServerError().build();

src/test/java/uk/gov/companieshouse/pscdataapi/controller/CompanyPscControllerTest.java

@@ -0,0 +1,52 @@
+package uk.gov.companieshouse.pscdataapi.controller;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.test.web.servlet.MockMvc;
+import uk.gov.companieshouse.api.psc.FullRecordCompanyPSCApi;
+import uk.gov.companieshouse.pscdataapi.service.CompanyPscService;
+import uk.gov.companieshouse.pscdataapi.util.TestHelper;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.ArgumentMatchers.isA;
+import static org.mockito.Mockito.doNothing;
+import static org.springframework.http.MediaType.APPLICATION_JSON;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+@SpringBootTest
+@AutoConfigureMockMvc
+class CompanyPscControllerTest {
+    private static final String PUT_URL =
+            "/company/123456789/persons-with-significant-control/123456789/full_record";
+    private static final String X_REQUEST_ID = "123456";
+
+    @MockBean
+    private CompanyPscService companyPscService;
+    @Autowired
+    private MockMvc mockMvc;
+    @Autowired
+    private CompanyPscController companyPscController;
+
+    @Test
+    void contextLoads() {
+        assertThat(companyPscController).isNotNull();
+    }
+
+
+    @Test
+    void callPutRequest() throws Exception {
+        doNothing()
+                .when(companyPscService).insertPscRecord(anyString(), isA(FullRecordCompanyPSCApi.class));
+
+        mockMvc.perform(put(PUT_URL)
+                .contentType(APPLICATION_JSON)
+                .header("x-request-id", X_REQUEST_ID)
+                .content(TestHelper.createJsonPayload()))
+                .andExpect(status().isCreated());
+    }
+}

src/test/java/uk/gov/companieshouse/pscdataapi/util/TestHelper.java

@@ -1,9 +1,12 @@
 package uk.gov.companieshouse.pscdataapi.util;
 
+import java.io.InputStreamReader;
+import java.io.IOException;
 import java.time.LocalDate;
 import java.time.OffsetDateTime;
 import java.util.List;
 
+import org.springframework.util.FileCopyUtils;
 import uk.gov.companieshouse.api.psc.Data;
 import uk.gov.companieshouse.api.psc.ExternalData;
 import uk.gov.companieshouse.api.psc.FullRecordCompanyPSCApi;
@@ -90,4 +93,11 @@ public static PscDocument buildPscDocument(String kind) {
 
         return output;
     }
+
+    public static String createJsonPayload() throws IOException {
+        InputStreamReader exampleJsonPayload = new InputStreamReader(
+                ClassLoader.getSystemClassLoader().getResourceAsStream("psc_payload.json"));
+
+        return FileCopyUtils.copyToString(exampleJsonPayload);
+    }
 }

src/test/resources/psc_payload.json

@@ -0,0 +1,64 @@
+{
+  "_id": "YfTs9WeeqpXTqf6dc6FZ4C0H0RQ",
+  "internal_data": {
+    "created_at" : "2021-11-02T08:47:45",
+    "updated_at" :"2021-09-14T10:30:16.000Z",
+    "updated_by" :"CHIPS",
+    "delta_at" : "2023-11-02T08:47:45.378Z"
+  },
+  "external_data": {
+    "notification_id": "ZfTs9WeeqpXTqf6dc6FZ4C0H0RQ",
+    "psc_id" : "YfTs9WeeqpXTqf6dc6FZ4C0H0RQ",
+    "sensitive_data": {
+      "usual_residential_address" : {
+        "address_line_1" : "ura_line1",
+        "address_line_2" : "ura_line2",
+        "care_of" : "ura_care_of",
+        "country" : "United Kingdom",
+        "locality" : "Cardiff",
+        "po_box" : "ura_po",
+        "postal_code" : "CF2 1B6",
+        "premises" : "URA",
+        "region" : "ura_region"
+      },
+      "date_of_birth": {
+        "day": 21,
+        "year": 1995,
+        "month": 10
+      },
+      "residential_address_same_as_service_address": true
+    },
+    "data" : {
+      "service_address" : {
+        "address_line_1" : "sa_line1",
+        "address_line_2" : "sa_line2",
+        "care_of" : "sa_care_of",
+        "country" : "United Kingdom",
+        "locality" : "Cardiff",
+        "po_box" : "sa_po",
+        "postal_code" : "CF2 1B6",
+        "premises" : "SA",
+        "region" : "sa_region"
+      },
+      "natures_of_control": [
+        "part-right-to-share-surplus-assets-75-to-100-percent"
+      ],
+      "country_of_residence" : "United Kingdom",
+      "links" : [{
+        "self" : "/company/34777770/appointments/YfTs9WeeqpXTqf6dc6FZ4C0H0RQ"
+      }],
+      "nationality" : "British",
+      "occupation" : "Lawyer",
+      "kind" : "individual-person-with-significant-control",
+      "surname" : "JONES",
+      "forename" : "PHIL",
+      "other_forenames" : "tom",
+      "company_number": "34777770",
+      "name_elements": {
+        "surname" : "JONES",
+        "forename" : "PHIL",
+        "other_forenames" : "tom"
+      }
+    }
+  }
+}