DTSRD-2132.Update contactinformation for an organisation

src/functionalTest/java/uk/gov/hmcts/reform/professionalapi/ProfessionalInternalUserFunctionalTest.java

@@ -13,6 +13,7 @@
 import org.springframework.http.HttpStatus;
 import uk.gov.hmcts.reform.lib.util.serenity5.SerenityTest;
 import uk.gov.hmcts.reform.professionalapi.controller.constants.IdamStatus;
+import uk.gov.hmcts.reform.professionalapi.controller.request.ContactInformationCreationRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.MfaUpdateRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.NewUserCreationRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationCreationRequest;
@@ -54,6 +55,7 @@
 import static org.springframework.http.HttpStatus.TOO_MANY_REQUESTS;
 import static uk.gov.hmcts.reform.professionalapi.client.ProfessionalApiClient.createOrganisationRequest;
 import static uk.gov.hmcts.reform.professionalapi.controller.constants.ProfessionalApiConstants.PBA_STATUS_MESSAGE_ACCEPTED;
+import static uk.gov.hmcts.reform.professionalapi.controller.request.ContactInformationCreationRequest.aContactInformationCreationRequest;
 import static uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationCreationRequest.anOrganisationCreationRequest;
 import static uk.gov.hmcts.reform.professionalapi.controller.request.UserCreationRequest.aUserCreationRequest;
 import static uk.gov.hmcts.reform.professionalapi.domain.OrganisationStatus.REVIEW;
@@ -1231,4 +1233,61 @@ private static List<Map<String, Object>> sortByValue(final List<Map<String, Obje
                 .sorted(Comparator.comparing(map -> (String) map.get(key)))
                 .collect(Collectors.toList());
     }
+
+    @Test
+    void updateContactInformationForOrganisationShouldReturnSuccess() {
+        log.info("updateContactInformationForOrganisationShouldReturnSuccess :: STARTED");
+
+        Map<String, Object> response = professionalApiClient.createOrganisation();
+        String organisationIdentifier = (String) response.get("organisationIdentifier");
+
+        assertThat(organisationIdentifier).isNotEmpty();
+        JsonPath orgResponse = professionalApiClient.retrieveOrganisationDetails(
+            organisationIdentifier, hmctsAdmin,OK);
+        assertNotNull(orgResponse);
+        List<HashMap>  existingContactInformationList =  (List) orgResponse.get("contactInformation");
+
+        assertThat(existingContactInformationList).isNotEmpty()
+            .hasSizeGreaterThan(0);
+
+        List<ContactInformationCreationRequest> contactInformationCreationRequestList =
+            professionalApiClient.createContactInformationCreationRequests();
+        assertThat(contactInformationCreationRequestList).isNotEmpty()
+            .hasSizeGreaterThan(0);
+        ContactInformationCreationRequest contactInformationCreationRequest =
+            contactInformationCreationRequestList.get(0);
+
+        existingContactInformationList.forEach(existingContactInfo -> {
+
+            assertThat(existingContactInfo.get("addressLine1")).isNotNull();
+            assertThat(existingContactInfo.get("addressLine2")).isNotNull();
+            assertThat(existingContactInfo.get("addressLine3")).isNotNull();
+            assertThat(existingContactInfo.get("uprn")).isNotNull();
+            assertThat(existingContactInfo.get("country")).isNotNull();
+            assertThat(existingContactInfo.get("townCity")).isNotNull();
+            assertThat(existingContactInfo.get("country")).isNotNull();
+            assertThat(existingContactInfo.get("postCode")).isNotNull();
+
+            Response result =
+                professionalApiClient.updateContactInformationsToOrganisation(aContactInformationCreationRequest()
+                    .uprn(contactInformationCreationRequest.getUprn())
+                    .addressLine1(contactInformationCreationRequest.getAddressLine1())
+                    .addressLine2(contactInformationCreationRequest.getAddressLine2())
+                    .addressLine3(contactInformationCreationRequest.getAddressLine3())
+                    .country(contactInformationCreationRequest.getCountry())
+                    .county(contactInformationCreationRequest.getCounty())
+                    .townCity(contactInformationCreationRequest.getTownCity())
+                    .postCode(contactInformationCreationRequest.getPostCode())
+                    .dxAddress(contactInformationCreationRequest.getDxAddress())
+                    .build(),
+                    OK,organisationIdentifier);
+
+            assertNotNull(result);
+            assertThat(result.getBody()).isNotNull();
+            assertThat(result.statusCode()).isEqualTo(200);
+        });
+
+        log.info("updateContactInformationForOrganisationShouldReturnSuccess :: END");
+    }
+
 }

src/functionalTest/java/uk/gov/hmcts/reform/professionalapi/client/ProfessionalApiClient.java

@@ -1752,4 +1752,28 @@ public void deleteMultipleAddressesOfOrganisation(List<DeleteMultipleAddressRequ
         log.info("{}:: Delete Multiple Addresses of an organisation status response: {}",
                 loggingComponentName, response.getStatusCode());
     }
+
+    @SuppressWarnings("unchecked")
+    public Response updateContactInformationsToOrganisation(
+
+        ContactInformationCreationRequest
+            contactInformationCreationRequest,
+        HttpStatus expectedStatus,
+        String organisationId) {
+
+        Response response = getMultipleAuthHeadersInternal()
+            .body(contactInformationCreationRequest)
+            .put("/refdata/internal/v1/organisations/contactInformation/" + organisationId)
+            .andReturn();
+
+        response.then()
+            .assertThat()
+            .statusCode(expectedStatus.value());
+
+        log.info("{}:: Update organisation contact information response: {}",
+            loggingComponentName, response.getStatusCode());
+
+        return response;
+
+    }
 }

src/integrationTest/java/uk/gov/hmcts/reform/professionalapi/UpdateOrgContactInformationIntegrationTest.java

@@ -0,0 +1,113 @@
+package uk.gov.hmcts.reform.professionalapi;
+
+import org.junit.jupiter.api.Test;
+import uk.gov.hmcts.reform.professionalapi.controller.request.ContactInformationCreationRequest;
+import uk.gov.hmcts.reform.professionalapi.util.AuthorizationEnabledIntegrationTest;
+
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static uk.gov.hmcts.reform.professionalapi.helper.OrganisationFixtures.createContactInformationRequest;
+import static uk.gov.hmcts.reform.professionalapi.helper.OrganisationFixtures.organisationRequestWithAllFieldsAreUpdated;
+import static uk.gov.hmcts.reform.professionalapi.helper.OrganisationFixtures.organisationRequestWithMultipleAddressAllFields;
+
+class UpdateOrgContactInformationIntegrationTest extends AuthorizationEnabledIntegrationTest {
+
+    @Test
+    void update_addressline1_for_organisation_with_prd_admin_role_should_return_200() {
+        ContactInformationCreationRequest contactInformationCreationRequest =
+            createContactInformationRequest().build();
+
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgContactInformation(contactInformationCreationRequest,
+                hmctsAdmin,createOrganisationRequest());
+
+        assertThat(updateResponse).containsEntry("http_status", 200);
+    }
+
+    @Test
+    void update_contact_with_bad_request_should_return_400() {
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgContactInformation(null,  hmctsAdmin,createOrganisationRequest());
+
+        assertThat(updateResponse).containsEntry("http_status", "400");
+    }
+
+    @Test
+    void update_contact_information_invalid_addressline1_should_return_400() {
+        ContactInformationCreationRequest contactInformationCreationRequest =
+            createContactInformationRequest().addressLine1(null).build();
+
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgContactInformation(contactInformationCreationRequest,
+                hmctsAdmin,createOrganisationRequest());
+
+        assertThat(updateResponse).containsEntry("http_status", "400");
+        assertThat(updateResponse.get("response_body").toString()).contains(
+            "Field error in object 'contactInformationCreationRequest' on field 'addressLine1'");
+    }
+
+    @Test
+    void update_contact_information_multiple_requests_existing_for_org_should_return_200() {
+
+        ContactInformationCreationRequest contactInformationCreationRequest =
+            createContactInformationRequest().build();
+
+        java.util.Map<String, Object> responseForOrganisationCreation = professionalReferenceDataClient
+            .createOrganisation(organisationRequestWithMultipleAddressAllFields().build());
+
+
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgContactInformation(contactInformationCreationRequest,
+                hmctsAdmin,(String)responseForOrganisationCreation.get(ORG_IDENTIFIER));
+
+        assertThat(updateResponse).containsEntry("http_status", 200);
+    }
+
+    @Test
+    void update_contact_information_single_requests_existing_for_org_should_return_200() {
+
+        ContactInformationCreationRequest contactInformationCreationRequest =
+            createContactInformationRequest().build();
+
+
+        java.util.Map<String, Object> responseForOrganisationCreation = professionalReferenceDataClient
+            .createOrganisation(organisationRequestWithAllFieldsAreUpdated().build());
+
+
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgContactInformation(contactInformationCreationRequest,
+                hmctsAdmin,(String)responseForOrganisationCreation.get(ORG_IDENTIFIER));
+
+        assertThat(updateResponse).containsEntry("http_status", 200);
+    }
+
+    @Test
+    void update_contact_information_for_non_existing_organisation_should_return_400() {
+        ContactInformationCreationRequest contactInformationCreationRequest =
+            createContactInformationRequest().build();
+
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgContactInformation(contactInformationCreationRequest,  hmctsAdmin,"ABCDEF7");
+
+        assertThat(updateResponse).containsEntry("http_status", "404");
+        assertThat(updateResponse.get("response_body").toString())
+            .contains("errorMessage\":\"4 : Resource not found\",\"errorDescription\":\"Organisation does not exist");
+
+    }
+
+    @Test
+    void update_contact_information_invalid_request_should_return_400() {
+
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgContactInformation(new ContactInformationCreationRequest(null,null,
+                null,null,null,null,null,
+                null,null), hmctsAdmin,createOrganisationRequest());
+
+        assertThat(updateResponse).containsEntry("http_status", "400");
+        assertThat(updateResponse.get("response_body").toString())
+            .contains("validation on an argument failed");
+
+    }
+
+}

src/integrationTest/java/uk/gov/hmcts/reform/professionalapi/util/ProfessionalReferenceDataClient.java

@@ -1039,4 +1039,30 @@ public Map<String, Object> retrieveUsersInOrganisationsByOrganisationIdentifiers
         String uriPath = sb.toString();
         return postRequest(uriPath, request, null, null);
     }
+
+    public Map<String, Object> updateOrgContactInformation(
+        ContactInformationCreationRequest contactInformationCreationRequest,
+        String role, String organisationIdentifier) {
+
+        ResponseEntity<Map> responseEntity = null;
+        String urlPath = "http://localhost:" + prdApiPort + APP_INT_BASE_PATH
+            + "/contactInformation/" + organisationIdentifier;
+        try {
+            HttpEntity<ContactInformationCreationRequest> requestEntity =
+                new HttpEntity<>(contactInformationCreationRequest,
+                getMultipleAuthHeaders(role));
+            responseEntity = restTemplate.exchange(urlPath, HttpMethod.PUT, requestEntity, Map.class);
+        } catch (RestClientResponseException ex) {
+            HashMap<String, Object> statusAndBody = new HashMap<>(2);
+            statusAndBody.put("http_status", String.valueOf(ex.getRawStatusCode()));
+            statusAndBody.put("response_body", ex.getResponseBodyAsString());
+            return statusAndBody;
+        }
+
+        Map<String, Object> contactInformationResponse = new HashMap<>();
+        contactInformationResponse.put("http_status", responseEntity.getStatusCodeValue());
+        return contactInformationResponse;
+    }
+
+
 }

src/main/java/uk/gov/hmcts/reform/professionalapi/controller/constants/ProfessionalApiConstants.java

@@ -10,6 +10,9 @@ private ProfessionalApiConstants() {
     public static final String EMAIL_REGEX = "^[A-Za-z0-9]+[\\w!#$%&'’.*+/=?`{|}~^-]+(?:\\.[\\w!#$%&’*+/=?`{|}~^-]+)*@"
             + "[A-Za-z0-9]+(?:[a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,6}$";
 
+    public static final String NO_CONTACT_FOUND_FOR_GIVEN_ORG
+        = "No Contact Information was found with the given organisationIdentifier ";
+
     public static final int LENGTH_OF_UUID = 36;
     public static final int LENGTH_OF_ORGANISATION_IDENTIFIER = 7;
     public static final String ORG_ID_VALIDATION_ERROR_MESSAGE

src/main/java/uk/gov/hmcts/reform/professionalapi/controller/internal/OrganisationInternalController.java

@@ -29,6 +29,8 @@
 import uk.gov.hmcts.reform.professionalapi.configuration.resolver.UserId;
 import uk.gov.hmcts.reform.professionalapi.controller.SuperController;
 import uk.gov.hmcts.reform.professionalapi.controller.advice.ErrorResponse;
+import uk.gov.hmcts.reform.professionalapi.controller.advice.ResourceNotFoundException;
+import uk.gov.hmcts.reform.professionalapi.controller.request.ContactInformationCreationRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.InvalidRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.MfaUpdateRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.NewUserCreationRequest;
@@ -37,6 +39,7 @@
 import uk.gov.hmcts.reform.professionalapi.controller.request.PbaRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.UpdatePbaRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.validator.impl.OrganisationByProfileIdsRequestValidator;
+import uk.gov.hmcts.reform.professionalapi.controller.response.ContactInformationResponse;
 import uk.gov.hmcts.reform.professionalapi.controller.response.DeleteOrganisationResponse;
 import uk.gov.hmcts.reform.professionalapi.controller.response.MultipleOrganisationsResponse;
 import uk.gov.hmcts.reform.professionalapi.controller.response.NewUserResponse;
@@ -49,6 +52,7 @@
 import uk.gov.hmcts.reform.professionalapi.domain.Organisation;
 import uk.gov.hmcts.reform.professionalapi.domain.PbaResponse;
 
+import java.util.Arrays;
 import java.util.Optional;
 import java.util.UUID;
 import javax.validation.Valid;
@@ -744,4 +748,71 @@ public ResponseEntity<Object> retrieveOrganisationsByProfileIds(
                 .status(HttpStatus.OK)
                 .body(response);
     }
+
+
+    @Operation(
+        summary = "Updates contact informations(address details) to organisation",
+        description = "**IDAM Roles to access API** :<br> pui-organisation-manager",
+        security = {
+            @SecurityRequirement(name = "ServiceAuthorization"),
+            @SecurityRequirement(name = "Authorization")
+        }
+
+    )
+
+    @ApiResponse(
+        responseCode = "200",
+        description = "Updated Contact Information",
+        content = @Content
+    )
+    @ApiResponse(
+        responseCode = "400",
+        description = "An invalid request has been provided",
+        content = @Content
+    )
+    @ApiResponse(
+        responseCode = "401",
+        description = "Unauthorized Error : "
+            + "The requested resource is restricted and requires authentication",
+        content = @Content
+    )
+
+    @ApiResponse(
+        responseCode = "403",
+        description = "Forbidden Error: Access denied",
+        content = @Content
+    )
+    @ApiResponse(
+        responseCode = "500",
+        description = "Internal Server Error",
+        content = @Content
+    )
+
+
+    @PutMapping(
+        path = "/contactInformation/{orgId}",
+        consumes = APPLICATION_JSON_VALUE,
+        produces = APPLICATION_JSON_VALUE
+    )
+    @ResponseStatus(value = HttpStatus.CREATED)
+    @ResponseBody
+    @Secured({"prd-admin"})
+    public ResponseEntity<ContactInformationResponse> updateContactInformationForOrganisation(
+        @io.swagger.v3.oas.annotations.parameters.RequestBody(description = "contactInformationCreationRequests")
+        @Valid @NotNull @RequestBody ContactInformationCreationRequest contactInformationCreationRequest,
+        @PathVariable("orgId") @NotBlank  String organisationIdentifier) {
+
+        organisationCreationRequestValidator.validateContactInformations(Arrays
+            .asList(contactInformationCreationRequest));
+
+        var organisation = organisationService.getOrganisationByOrgIdentifier(organisationIdentifier);
+
+        if (organisation == null) {
+            throw new ResourceNotFoundException("Organisation does not exist");
+        }
+
+        return organisationService.updateContactInformationForOrganisation(
+            contactInformationCreationRequest,organisationIdentifier);
+
+    }
 }

src/main/java/uk/gov/hmcts/reform/professionalapi/service/OrganisationService.java

@@ -7,6 +7,7 @@
 import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationCreationRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.request.PbaRequest;
 import uk.gov.hmcts.reform.professionalapi.controller.response.BulkCustomerOrganisationsDetailResponse;
+import uk.gov.hmcts.reform.professionalapi.controller.response.ContactInformationResponse;
 import uk.gov.hmcts.reform.professionalapi.controller.response.DeleteOrganisationResponse;
 import uk.gov.hmcts.reform.professionalapi.controller.response.MultipleOrganisationsResponse;
 import uk.gov.hmcts.reform.professionalapi.controller.response.OrganisationEntityResponse;
@@ -32,6 +33,9 @@ public interface OrganisationService {
     BulkCustomerOrganisationsDetailResponse retrieveOrganisationDetailsForBulkCustomer(String bulkCustId,
                                                                                        String idamId);
 
+    ResponseEntity<ContactInformationResponse> updateContactInformationForOrganisation(
+        ContactInformationCreationRequest contactInfo, String organisationIdentifier);
+
     OrganisationsDetailResponseV2 retrieveAllOrganisationsForV2Api(LocalDateTime formattedSince, Pageable pageable);
 
     OrganisationEntityResponseV2 retrieveOrganisationForV2Api(String organisationIdentifier,