DTSRD-2136. Update Name for a given organisation

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

@@ -780,6 +780,38 @@ void updatePaymentAccountsShouldReturnForbiddenWhenToggledOff() {
         log.info("updatePaymentAccountsShouldReturnForbiddenWhenToggledOff :: END");
     }
 
+    @Test
+    @ExtendWith(FeatureToggleConditionExtension.class)
+    void updateOrganisationNameAndSraShouldReturnSuccess() {
+        log.info("updateOrganisationNameShouldReturnSuccess :: STARTED");
+        String updatedName = "updatedName";
+        String updatedSra = "updatedSraId";
+        Map<String, Object> response = professionalApiClient.createOrganisation();
+        String organisationIdentifier = (String) response.get("organisationIdentifier");
+        assertThat(organisationIdentifier).isNotEmpty();
+
+        JsonPath orgResponse = professionalApiClient.retrieveOrganisationDetails(
+            organisationIdentifier, hmctsAdmin,OK);
+
+        assertNotNull(orgResponse.get("name"));
+
+        OrganisationCreationRequest organisationCreationRequest = createOrganisationRequest()
+            .name(updatedName).sraId(updatedSra).build();
+
+        professionalApiClient.updatesOrganisationName(organisationCreationRequest,
+            hmctsAdmin,organisationIdentifier, OK);
+
+        JsonPath orgUpdatedNameResponse = professionalApiClient.retrieveOrganisationDetails(
+            organisationIdentifier, hmctsAdmin,OK);
+        assertThat(response).isNotNull();
+        assertNotNull(orgUpdatedNameResponse.get("name"));
+        assertThat(orgUpdatedNameResponse.get("name").toString()).contains(updatedName);
+        assertNotNull(orgUpdatedNameResponse.get("sraId"));
+        assertThat(orgUpdatedNameResponse.get("sraId").toString()).contains(updatedSra);
+
+        log.info("updateOrganisationNameShouldReturnSuccess :: END");
+    }
+
     @Test
     void findOrganisationsWithPaginationShouldReturnSuccess() {
         log.info("findOrganisationsWithPaginationShouldReturnSuccess :: STARTED");

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

@@ -1224,6 +1224,22 @@ public void updateOrganisation(OrganisationCreationRequest organisationCreationR
             .statusCode(expectedStatus.value());
     }
 
+    public void updatesOrganisationName(OrganisationCreationRequest organisationCreationRequest, String role,
+                                   String organisationIdentifier, HttpStatus expectedStatus) {
+
+        Response response = getMultipleAuthHeadersInternal()
+            .body(organisationCreationRequest)
+            .put("/refdata/internal/v1/organisations/nameSra/" + organisationIdentifier)
+            .andReturn();
+
+        log.info("{}:: Update organisation Name or SRA id response: {}",
+            loggingComponentName, response.getStatusCode());
+
+        response.then()
+            .assertThat()
+            .statusCode(expectedStatus.value());
+    }
+
     public void updateOrganisationToReview(String organisationIdentifier, String statusMessage, String role) {
 
         OrganisationCreationRequest organisationCreationRequest = createOrganisationRequest()

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

@@ -0,0 +1,72 @@
+package uk.gov.hmcts.reform.professionalapi;
+
+import org.junit.jupiter.api.Test;
+import uk.gov.hmcts.reform.professionalapi.controller.request.OrganisationCreationRequest;
+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.organisationRequestWithAllFields;
+import static uk.gov.hmcts.reform.professionalapi.helper.OrganisationFixtures.organisationRequestWithAllFieldsAreUpdated;
+
+
+class UpdateOrgNameSraIdIntegrationTest extends AuthorizationEnabledIntegrationTest {
+
+
+    @Test
+    void update_name_or_sra_of_an_active_organisation_with_prd_admin_role_should_return_200() {
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+                .updateOrgNameSraIdStatus(organisationRequestWithAllFields().build(),  hmctsAdmin,getOrganisationId());
+
+        assertThat(updateResponse).containsEntry("http_status", 200);
+    }
+
+    @Test
+    void update_name_or_sra_with_bad_request_should_return_400() {
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+                .updateOrgNameSraIdStatus(null,  hmctsAdmin,getOrganisationId());
+
+        assertThat(updateResponse).containsEntry("http_status", "400");
+    }
+
+    @Test
+    void update_name_or_sra_with_invalid_name_and_sra_should_return_400() {
+        OrganisationCreationRequest organisationUpdateRequest = organisationRequestWithAllFieldsAreUpdated()
+            .name("")
+            .sraId(null)
+            .build();
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+                .updateOrgNameSraIdStatus(organisationUpdateRequest,  hmctsAdmin,getOrganisationId());
+
+        assertThat(updateResponse).containsEntry("http_status", "400");
+        assertThat(updateResponse.get("response_body").toString()).contains("Name or SRA Id not found");
+    }
+
+    void update_name_or_sra_with_invalid_name_and_valid_sra_should_return_200() {
+        OrganisationCreationRequest organisationUpdateRequest = organisationRequestWithAllFieldsAreUpdated()
+            .name(null)
+            .build();
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgNameSraIdStatus(organisationUpdateRequest,  hmctsAdmin,getOrganisationId());
+
+        assertThat(updateResponse).containsEntry("http_status", 200);
+    }
+
+    void update_name_or_sra_with_invalid_sra_and_valid_name_should_return_200() {
+        OrganisationCreationRequest organisationUpdateRequest = organisationRequestWithAllFieldsAreUpdated()
+            .sraId(null)
+            .build();
+        Map<String, Object> updateResponse = professionalReferenceDataClient
+            .updateOrgNameSraIdStatus(organisationUpdateRequest,  hmctsAdmin,getOrganisationId());
+
+        assertThat(updateResponse).containsEntry("http_status", 200);
+    }
+
+    private String getOrganisationId() {
+        String organisationIdentifier = createOrganisationRequest();
+        updateOrganisation(organisationIdentifier, hmctsAdmin, "ACTIVE");
+
+        return organisationIdentifier;
+    }
+}

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

@@ -1021,4 +1021,25 @@ public Map<String, Object> findOrganisationsByUserId(String userId, String role)
         return getResponse(responseEntity);
     }
 
+
+    public Map<String, Object> updateOrgNameSraIdStatus(
+        OrganisationCreationRequest organisationCreationRequest, String role, String organisationIdentifier) {
+
+        ResponseEntity<Map> responseEntity = null;
+        String urlPath = "http://localhost:" + prdApiPort + APP_INT_BASE_PATH + "/nameSra/" + organisationIdentifier;
+        try {
+            HttpEntity<OrganisationCreationRequest> requestEntity = new HttpEntity<>(organisationCreationRequest,
+                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> organisationResponse = new HashMap<>();
+        organisationResponse.put("http_status", responseEntity.getStatusCodeValue());
+        return organisationResponse;
+    }
 }

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

@@ -20,6 +20,10 @@ private ProfessionalApiConstants() {
 
     public static final String NO_ORG_FOUND_FOR_GIVEN_ID
             = "No Organisation was found with the given organisationIdentifier ";
+
+    public static final String NO_CONTACT_FOUND_FOR_GIVEN_ORG
+        = "No Contact Information was found with the given organisationIdentifier ";
+
     public static final String ORG_NOT_ACTIVE_NO_USERS_RETURNED
             = "Organisation is not Active hence not returning any users";
     public static final String ERROR_MESSAGE_403_FORBIDDEN = "403 Forbidden";
@@ -69,6 +73,7 @@ private ProfessionalApiConstants() {
     public static final String EMPTY_USER_ID = "User Id cannot be empty";
 
     public static final String ERROR_MSG_NO_ORGANISATION_FOUND = "No organisation belongs to given email";
+    public static final String ERROR_MSG_EMAIL_FOUND = "email address ";
     public static final String ERROR_MSG_NO_PBA_FOUND = "No PBAs associated with given email";
     public static final String PBA_STATUS_MESSAGE_ACCEPTED = "Edited by Admin";
     public static final String PBA_STATUS_MESSAGE_AUTO_ACCEPTED = "Auto approved by Admin";

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

@@ -56,11 +56,13 @@
 import javax.validation.constraints.NotNull;
 import javax.validation.constraints.Pattern;
 
+import static org.apache.commons.lang.StringUtils.isBlank;
 import static org.apache.commons.lang3.BooleanUtils.isNotTrue;
 import static org.springframework.http.MediaType.APPLICATION_JSON_VALUE;
 import static uk.gov.hmcts.reform.professionalapi.controller.constants.ProfessionalApiConstants.ORGANISATION_IDENTIFIER_FORMAT_REGEX;
 import static uk.gov.hmcts.reform.professionalapi.controller.constants.ProfessionalApiConstants.ORG_ID_VALIDATION_ERROR_MESSAGE;
 import static uk.gov.hmcts.reform.professionalapi.controller.constants.ProfessionalApiConstants.ORG_NOT_ACTIVE;
+import static uk.gov.hmcts.reform.professionalapi.util.RefDataUtil.removeEmptySpaces;
 
 @RequestMapping(
         path = "refdata/internal/v1/organisations"
@@ -696,6 +698,69 @@ public ResponseEntity<OrganisationEntityResponse> retrieveOrganisationByUserId(
         return organisationService.retrieveOrganisationByUserId(userId);
     }
 
+    @Operation(
+        summary = "Updates an Organisation's name",
+        description = "**IDAM Roles to access API** : <br> prd-admin",
+        security = {
+            @SecurityRequirement(name = "ServiceAuthorization"),
+            @SecurityRequirement(name = "Authorization")
+        })
+
+    @ApiResponse(
+        responseCode = "200",
+        description = "Organisation name has been updated",
+        content = @Content(schema = @Schema(implementation = String.class))
+    )
+    @ApiResponse(
+        responseCode = "400",
+        description = "If Organisation request sent with null/invalid values for mandatory fields",
+        content = @Content
+    )
+    @ApiResponse(
+        responseCode = "403",
+        description = "Forbidden Error: Access denied",
+        content = @Content
+    )
+    @ApiResponse(
+        responseCode = "404",
+        description = "No Organisation found with the given ID",
+        content = @Content
+    )
+    @ApiResponse(
+        responseCode = "500",
+        description = "Internal Server Error",
+        content = @Content
+    )
+
+    @PutMapping(
+        value = "/nameSra/{orgId}",
+        consumes = APPLICATION_JSON_VALUE,
+        produces = APPLICATION_JSON_VALUE
+    )
+    @ResponseStatus(value = HttpStatus.CREATED)
+    @ResponseBody
+    @Secured({"prd-admin"})
+    public ResponseEntity<OrganisationResponse> updateOrganisationNameOrSra(
+        @io.swagger.v3.oas.annotations.parameters.RequestBody(description = "organisationCreationRequest")
+        @Valid @NotNull @RequestBody OrganisationCreationRequest organisationCreationRequest,
+        @Pattern(regexp = ORGANISATION_IDENTIFIER_FORMAT_REGEX, message = ORG_ID_VALIDATION_ERROR_MESSAGE)
+        @PathVariable("orgId") @NotBlank  String organisationIdentifier) {
+
+        var orgId = removeEmptySpaces(organisationIdentifier);
+        organisationCreationRequestValidator.validateOrganisationIdentifier(orgId);
+
+        if (isBlank(organisationCreationRequest.getName()) && isBlank(organisationCreationRequest.getSraId())) {
+            throw new InvalidRequest("Name or SRA Id not found");
+        }
+
+        OrganisationResponse organisationResponse = organisationService
+            .updateOrganisationNameOrSra(organisationCreationRequest, orgId);
+
+        ResponseEntity<OrganisationResponse> resp =  ResponseEntity.status(200).body(organisationResponse);
+        return resp;
+    }
+
+
     @Operation(
             summary = "Retrieves Organisations by Organisation Profile IDs",
             description = "**Bearer token not required to access API. Only a valid s2s token**",
@@ -744,4 +809,5 @@ public ResponseEntity<Object> retrieveOrganisationsByProfileIds(
                 .status(HttpStatus.OK)
                 .body(response);
     }
+
 }

src/main/java/uk/gov/hmcts/reform/professionalapi/controller/request/OrganisationCreationRequest.java

@@ -16,13 +16,13 @@
 public class OrganisationCreationRequest {
 
     @NotNull
-    private final String name;
+    private String name;
 
     private String status;
 
     private String statusMessage;
 
-    private final String sraId;
+    private  String sraId;
 
     private String sraRegulated;
 

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

@@ -46,8 +46,11 @@ OrganisationsDetailResponseV2 findByOrganisationStatusForV2Api(LocalDateTime for
 
     OrganisationEntityResponse retrieveOrganisation(String organisationIdentifier, boolean isPendingPbaRequired);
 
+    OrganisationResponse updateOrganisationNameOrSra(
+        OrganisationCreationRequest organisationCreationRequest, String organisationIdentifier);
+
     OrganisationResponse updateOrganisation(OrganisationCreationRequest organisationCreationRequest,
-                                            String organisationIdentifier,Boolean isOrgApprovalRequest);
+                                            String organisationIdentifier, Boolean isOrgApprovalRequest);
 
     Organisation getOrganisationByOrgIdentifier(String organisationIdentifier);
 

src/main/java/uk/gov/hmcts/reform/professionalapi/service/impl/OrganisationServiceImpl.java

@@ -91,6 +91,7 @@
 import java.util.stream.Stream;
 
 import static java.lang.Boolean.TRUE;
+import static org.apache.commons.lang.StringUtils.isNotBlank;
 import static org.apache.commons.lang3.ObjectUtils.isNotEmpty;
 import static org.springframework.util.CollectionUtils.isEmpty;
 import static uk.gov.hmcts.reform.professionalapi.controller.constants.ProfessionalApiConstants.ERROR_MSG_PARTIAL_SUCCESS;
@@ -607,6 +608,23 @@ public OrganisationsDetailResponseV2 findByOrganisationStatusForV2Api(LocalDateT
         return organisationsDetailResponse;
     }
 
+    @Override
+    public OrganisationResponse updateOrganisationNameOrSra(
+        OrganisationCreationRequest organisationCreationRequest, String organisationIdentifier) {
+
+        var existingOrganisation = organisationRepository.findByOrganisationIdentifier(organisationIdentifier);
+        if (isNotBlank(organisationCreationRequest.getName())) {
+            existingOrganisation.setName(RefDataUtil.removeEmptySpaces(organisationCreationRequest.getName()));
+        }
+        if (isNotBlank(organisationCreationRequest.getSraId())) {
+            existingOrganisation.setSraId(RefDataUtil.removeEmptySpaces(organisationCreationRequest.getSraId()));
+        }
+
+        var savedOrganisation = organisationRepository.save(existingOrganisation);
+
+        return new OrganisationResponse(savedOrganisation);
+    }
+
     @Override
     public OrganisationResponse updateOrganisation(
             OrganisationCreationRequest organisationCreationRequest, String organisationIdentifier,

src/test/java/uk/gov/hmcts/reform/professionalapi/controller/internal/OrganisationInternalControllerTest.java

@@ -70,6 +70,7 @@
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyString;
+import static org.mockito.Mockito.doNothing;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
@@ -572,4 +573,37 @@ void testRetrieveOrgByPbaStatus() {
                 .getOrganisationsByPbaStatus(pbaStatus.toString());
     }
 
+    @Test
+    void testUpdateOrgNameAndSra() {
+        final HttpStatus expectedHttpStatus = HttpStatus.OK;
+        String updatedName = "NewName";
+        String updatedSra = "NewSRA";
+        organisation.setName(updatedName);
+        organisation.setSraId(updatedSra);
+        organisationCreationRequest.setName(updatedName);
+        organisationCreationRequest.setSraId(updatedSra);
+
+        doNothing().when(organisationCreationRequestValidatorMock).validateOrganisationIdentifier(any(String.class));
+        assertThat(organisationCreationRequest.getName()).isNotEmpty();
+        assertThat(organisationCreationRequest.getSraId()).isNotEmpty();
+
+
+        when(organisationServiceMock.updateOrganisationNameOrSra(organisationCreationRequest,
+            organisation.getOrganisationIdentifier())).thenReturn(new OrganisationResponse(organisation));
+
+        ResponseEntity<OrganisationResponse> response = organisationInternalController
+            .updateOrganisationNameOrSra(organisationCreationRequest,organisation.getOrganisationIdentifier());
+
+        assertThat(response).isNotNull();
+        assertThat(response.getStatusCode()).isEqualTo(expectedHttpStatus);
+        assertThat(response.getBody().getOrganisationIdentifier()).isEqualTo(organisation.getOrganisationIdentifier());
+
+
+        verify(organisationCreationRequestValidatorMock, times(1))
+            .validateOrganisationIdentifier(any(String.class));
+        verify(organisationServiceMock, times(1))
+            .updateOrganisationNameOrSra(organisationCreationRequest, organisation.getOrganisationIdentifier());
+
+    }
+
 }