CDPS-1090: Edit country of birth

Author: brightonsbox

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/common/client/PrisonApiClient.kt

@@ -5,6 +5,7 @@ import org.springframework.web.bind.annotation.PathVariable
 import org.springframework.web.bind.annotation.RequestBody
 import org.springframework.web.service.annotation.HttpExchange
 import org.springframework.web.service.annotation.PutExchange
+import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateBirthCountry
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateBirthPlace
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateNationality
 
@@ -16,6 +17,12 @@ interface PrisonApiClient {
     @RequestBody updateBirthPlace: UpdateBirthPlace,
   ): ResponseEntity<Void>
 
+  @PutExchange("/{offenderNo}/birth-country")
+  fun updateBirthCountryForWorkingName(
+    @PathVariable offenderNo: String,
+    @RequestBody updateBirthCountry: UpdateBirthCountry,
+  ): ResponseEntity<Void>
+
   @PutExchange("/{offenderNo}/nationality")
   fun updateNationalityForWorkingName(
     @PathVariable offenderNo: String,

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/common/client/dto/UpdateBirthCountry.kt

@@ -0,0 +1,9 @@
+package uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto
+
+import io.swagger.v3.oas.annotations.media.Schema
+
+@Schema(description = "Update to prisoner birth country")
+data class UpdateBirthCountry(
+  @Schema(description = "Country code", example = "GBR", required = true, nullable = true)
+  val countryCode: String?,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/corepersonrecord/service/CorePersonRecordService.kt

@@ -2,10 +2,12 @@ package uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.servi
 
 import org.springframework.stereotype.Service
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.PrisonApiClient
+import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateBirthCountry
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateBirthPlace
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateNationality
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.dto.v1.request.BirthplaceUpdateDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.dto.v1.request.CorePersonRecordV1UpdateRequestDto
+import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.dto.v1.request.CountryOfBirthUpdateDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.dto.v1.request.NationalityUpdateDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.exception.UnknownCorePersonFieldException
 
@@ -17,6 +19,7 @@ class CorePersonRecordService(
   fun updateCorePersonRecordField(prisonerNumber: String, updateRequestDto: CorePersonRecordV1UpdateRequestDto) {
     when (updateRequestDto) {
       is BirthplaceUpdateDto -> prisonApiClient.updateBirthPlaceForWorkingName(prisonerNumber, UpdateBirthPlace(updateRequestDto.value))
+      is CountryOfBirthUpdateDto -> prisonApiClient.updateBirthCountryForWorkingName(prisonerNumber, UpdateBirthCountry(updateRequestDto.value))
       is NationalityUpdateDto -> prisonApiClient.updateNationalityForWorkingName(prisonerNumber, UpdateNationality(updateRequestDto.value))
       else -> throw UnknownCorePersonFieldException("Field '${updateRequestDto.fieldName}' cannot be updated.")
     }

src/test/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/corepersonrecord/resource/CorePersonRecordV1ResourceIntTest.kt

@@ -51,40 +51,39 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
 
       @Test
       fun `can patch core person record birthplace by prisoner number`() {
-        webTestClient.patch().uri("/v1/core-person-record?prisonerNumber=$PRISONER_NUMBER")
-          .contentType(MediaType.APPLICATION_JSON)
-          .headers(setAuthorisation(roles = listOf(CorePersonRecordRoleConstants.CORE_PERSON_RECORD_READ_WRITE_ROLE)))
-          .bodyValue(BIRTHPLACE_PATCH_REQUEST_BODY)
-          .exchange()
-          .expectStatus().isNoContent
+        expectSuccessfulRequestWith(BIRTHPLACE_PATCH_REQUEST_BODY)
       }
 
       @Test
       fun `patch core person record birthplace accepts null value`() {
-        webTestClient.patch().uri("/v1/core-person-record?prisonerNumber=$PRISONER_NUMBER")
-          .contentType(MediaType.APPLICATION_JSON)
-          .headers(setAuthorisation(roles = listOf(CorePersonRecordRoleConstants.CORE_PERSON_RECORD_READ_WRITE_ROLE)))
-          .bodyValue(NULL_BIRTHPLACE_PATCH_REQUEST_BODY)
-          .exchange()
-          .expectStatus().isNoContent
+        expectSuccessfulRequestWith(NULL_BIRTHPLACE_PATCH_REQUEST_BODY)
+      }
+
+      @Test
+      fun `can patch core person record country of birth by prisoner number`() {
+        expectSuccessfulRequestWith(COUNTRY_OF_BIRTH_PATCH_REQUEST_BODY)
+      }
+
+      @Test
+      fun `patch core person record country of birth accepts null value`() {
+        expectSuccessfulRequestWith(NULL_COUNTRY_OF_BIRTH_PATCH_REQUEST_BODY)
       }
 
       @Test
       fun `can patch core person record nationality by prisoner number`() {
-        webTestClient.patch().uri("/v1/core-person-record?prisonerNumber=$PRISONER_NUMBER")
-          .contentType(MediaType.APPLICATION_JSON)
-          .headers(setAuthorisation(roles = listOf(CorePersonRecordRoleConstants.CORE_PERSON_RECORD_READ_WRITE_ROLE)))
-          .bodyValue(NATIONALITY_PATCH_REQUEST_BODY)
-          .exchange()
-          .expectStatus().isNoContent
+        expectSuccessfulRequestWith(NATIONALITY_PATCH_REQUEST_BODY)
       }
 
       @Test
       fun `patch core person record nationality accepts null value`() {
+        expectSuccessfulRequestWith(NULL_NATIONALITY_PATCH_REQUEST_BODY)
+      }
+
+      private fun expectSuccessfulRequestWith(body: Any) {
         webTestClient.patch().uri("/v1/core-person-record?prisonerNumber=$PRISONER_NUMBER")
           .contentType(MediaType.APPLICATION_JSON)
           .headers(setAuthorisation(roles = listOf(CorePersonRecordRoleConstants.CORE_PERSON_RECORD_READ_WRITE_ROLE)))
-          .bodyValue(NULL_NATIONALITY_PATCH_REQUEST_BODY)
+          .bodyValue(body)
           .exchange()
           .expectStatus().isNoContent
       }
@@ -211,6 +210,24 @@ class CorePersonRecordV1ResourceIntTest : IntegrationTestBase() {
         }
       """.trimIndent()
 
+    val COUNTRY_OF_BIRTH_PATCH_REQUEST_BODY =
+      // language=json
+      """
+        {
+          "fieldName": "COUNTRY_OF_BIRTH",
+          "value": "London"
+        }
+      """.trimIndent()
+
+    val NULL_COUNTRY_OF_BIRTH_PATCH_REQUEST_BODY =
+      // language=json
+      """
+        {
+          "fieldName": "BIRTHPLACE",
+          "value": null 
+        }
+      """.trimIndent()
+
     val NATIONALITY_PATCH_REQUEST_BODY =
       // language=json
       """

src/test/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/corepersonrecord/service/CorePersonRecordServiceTest.kt

@@ -13,9 +13,11 @@ import org.mockito.kotlin.reset
 import org.mockito.kotlin.whenever
 import org.springframework.http.ResponseEntity
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.PrisonApiClient
+import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateBirthCountry
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateBirthPlace
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.dto.UpdateNationality
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.dto.v1.request.BirthplaceUpdateDto
+import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.dto.v1.request.CountryOfBirthUpdateDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.dto.v1.request.DateOfBirthUpdateDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.dto.v1.request.NationalityUpdateDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.corepersonrecord.exception.UnknownCorePersonFieldException
@@ -39,6 +41,8 @@ class CorePersonRecordServiceTest {
   fun beforeEach() {
     whenever(prisonApiClient.updateBirthPlaceForWorkingName(PRISONER_NUMBER, TEST_BIRTHPLACE_BODY))
       .thenReturn(ResponseEntity.noContent().build())
+    whenever(prisonApiClient.updateBirthCountryForWorkingName(PRISONER_NUMBER, TEST_COUNTRY_OF_BIRTH_BODY))
+      .thenReturn(ResponseEntity.noContent().build())
     whenever(prisonApiClient.updateNationalityForWorkingName(PRISONER_NUMBER, TEST_NATIONALITY_BODY))
       .thenReturn(ResponseEntity.noContent().build())
   }
@@ -50,6 +54,11 @@ class CorePersonRecordServiceTest {
       underTest.updateCorePersonRecordField(PRISONER_NUMBER, BirthplaceUpdateDto(TEST_BIRTHPLACE_VALUE))
     }
 
+    @Test
+    fun `can update the country of birth field`() {
+      underTest.updateCorePersonRecordField(PRISONER_NUMBER, CountryOfBirthUpdateDto(TEST_COUNTRY_OF_BIRTH_VALUE))
+    }
+
     @Test
     fun `can update the nationality field`() {
       underTest.updateCorePersonRecordField(PRISONER_NUMBER, NationalityUpdateDto(TEST_NATIONALITY_VALUE))
@@ -66,8 +75,10 @@ class CorePersonRecordServiceTest {
   private companion object {
     const val PRISONER_NUMBER = "A1234AA"
     const val TEST_BIRTHPLACE_VALUE = "London"
+    const val TEST_COUNTRY_OF_BIRTH_VALUE = "ENG"
     const val TEST_NATIONALITY_VALUE = "BRIT"
     val TEST_BIRTHPLACE_BODY = UpdateBirthPlace("London")
+    val TEST_COUNTRY_OF_BIRTH_BODY = UpdateBirthCountry("ENG")
     val TEST_NATIONALITY_BODY = UpdateNationality("BRIT")
   }
 }

src/test/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/integration/wiremock/PrisonApiMockServer.kt

@@ -45,6 +45,18 @@ class PrisonApiMockServer : WireMockServer(8082) {
     )
   }
 
+  fun stubUpdateBirthCountryForWorkingName() {
+    val endpoint = "birth-country"
+    stubOffenderEndpoint(endpoint, HttpStatus.NO_CONTENT, PRISONER_NUMBER)
+    stubOffenderEndpoint(endpoint, HttpStatus.INTERNAL_SERVER_ERROR, PRISONER_NUMBER_THROW_EXCEPTION)
+    stubOffenderEndpoint(
+      endpoint,
+      HttpStatus.NOT_FOUND,
+      PRISONER_NUMBER_NOT_FOUND,
+      PRISON_API_NOT_FOUND_RESPONSE.trimIndent(),
+    )
+  }
+
   fun stubUpdateNationalityForWorkingName() {
     val endpoint = "nationality"
     stubOffenderEndpoint(endpoint, HttpStatus.NO_CONTENT, PRISONER_NUMBER)
@@ -78,6 +90,7 @@ class PrisonApiExtension : BeforeAllCallback, AfterAllCallback, BeforeEachCallba
   override fun beforeEach(context: ExtensionContext) {
     prisonApi.resetAll()
     prisonApi.stubUpdateBirthPlaceForWorkingName()
+    prisonApi.stubUpdateBirthCountryForWorkingName()
     prisonApi.stubUpdateNationalityForWorkingName()
   }