CDPS-1071 update religion (#19)

* CDPS-1071 Implement update religion endpoint

* CDPS-1071 Make some properties of religion update request optional

Author: scottrowley

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

@@ -9,6 +9,7 @@ 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.request.UpdateBirthPlace
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateNationality
+import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateReligion
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.response.MilitaryRecordPrisonDto
 
 @HttpExchange("/api/offenders")
@@ -35,4 +36,10 @@ interface PrisonApiClient {
   fun getMilitaryRecords(
     @PathVariable offenderNo: String,
   ): ResponseEntity<MilitaryRecordPrisonDto>
+
+  @PutExchange("/{offenderNo}/religion")
+  fun updateReligionForWorkingName(
+    @PathVariable offenderNo: String,
+    @RequestBody updateNationality: UpdateReligion,
+  ): ResponseEntity<Void>
 }

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

@@ -0,0 +1,18 @@
+package uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request
+
+import io.swagger.v3.oas.annotations.media.Schema
+import jakarta.validation.constraints.Size
+import java.time.LocalDate
+
+@Schema(description = "Update to prisoner religion")
+data class UpdateReligion(
+  @Schema(description = "The religion code", example = "ZORO", required = true)
+  val religion: String,
+  @Schema(description = "Reason for the religion change", example = "Some information")
+  @Size(max = 4000, message = "Comment text must be a maximum of 4000 characters")
+  val comment: String?,
+  @Schema(description = "The date the religious belief is valid from (in YYYY-MM-DD format)")
+  val effectiveFromDate: LocalDate?,
+  @Schema(description = "Has the religious belief been verified?", example = "false", defaultValue = "false")
+  val verified: Boolean,
+)

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/personprotectercharacteristics/dto/request/ReligionV1RequestDto.kt

@@ -16,24 +16,20 @@ data class ReligionV1RequestDto(
   @Schema(
     description = "Reason for the religion change",
     example = "Religion has changed",
-    required = false,
-    nullable = false,
+    nullable = true,
   )
-  val reasonForChange: String,
+  val reasonForChange: String?,
 
   @Schema(
     description = "The date the religious belief is valid from",
-    required = true,
-    nullable = false,
+    nullable = true,
   )
-  val effectiveFromDate: LocalDate,
+  val effectiveFromDate: LocalDate?,
 
   @Schema(
     description = "Boolean indicating if the religious belief has been verified.",
     example = "false",
     defaultValue = "false",
-    required = true,
-    nullable = false,
   )
   val isVerified: Boolean,
 )

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/personprotectercharacteristics/resource/PersonProtectedCharacteristicsV1Resource.kt

@@ -10,7 +10,7 @@ import jakarta.validation.Valid
 import org.springframework.http.HttpStatus
 import org.springframework.http.MediaType
 import org.springframework.http.ResponseEntity
-import org.springframework.http.ResponseEntity.ok
+import org.springframework.http.ResponseEntity.noContent
 import org.springframework.security.access.prepost.PreAuthorize
 import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.PathVariable
@@ -22,10 +22,9 @@ import org.springframework.web.bind.annotation.ResponseStatus
 import org.springframework.web.bind.annotation.RestController
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.annotation.ValidPrisonerNumber
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.dto.ReferenceDataCodeDto
-import uk.gov.justice.digital.hmpps.personintegrationapi.personprotectedcharacteristics.dto.v1.common.ReligionDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.personprotectedcharacteristics.dto.v1.request.ReligionV1RequestDto
-import uk.gov.justice.digital.hmpps.personintegrationapi.personprotectedcharacteristics.dto.v1.response.PersonReligionInformationV1ResponseDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.personprotectercharacteristics.PersonProtectedCharacteristicsRoleConstants
+import uk.gov.justice.digital.hmpps.personintegrationapi.personprotectercharacteristics.service.PersonProtectedCharacteristicsService
 import uk.gov.justice.hmpps.kotlin.common.ErrorResponse
 
 @RestController
@@ -37,15 +36,17 @@ import uk.gov.justice.hmpps.kotlin.common.ErrorResponse
   value = ["v1/person-protected-characteristics"],
   produces = [MediaType.APPLICATION_JSON_VALUE],
 )
-class PersonProtectedCharacteristicsV1Resource {
+class PersonProtectedCharacteristicsV1Resource(
+  private val personProtectedCharacteristicsService: PersonProtectedCharacteristicsService,
+) {
 
   @PutMapping("/religion")
   @ResponseStatus(HttpStatus.OK)
   @Operation(
     description = "Requires role `${PersonProtectedCharacteristicsRoleConstants.PROTECTED_CHARACTERISTICS_READ_WRITE_ROLE}`",
     responses = [
       ApiResponse(
-        responseCode = "200",
+        responseCode = "204",
         description = "Religion data successfully added/updated.",
       ),
       ApiResponse(
@@ -84,12 +85,10 @@ class PersonProtectedCharacteristicsV1Resource {
   fun putReligionByPrisonerNumber(
     @RequestParam(required = true) @Valid @ValidPrisonerNumber prisonerNumber: String,
     @RequestBody(required = true) @Valid religionV1RequestDto: ReligionV1RequestDto,
-  ): ResponseEntity<PersonReligionInformationV1ResponseDto> = ok().body(
-    PersonReligionInformationV1ResponseDto(
-      currentReligion = ReligionDto(),
-      religionHistory = emptySet(),
-    ),
-  )
+  ): ResponseEntity<Void> {
+    personProtectedCharacteristicsService.updateReligion(prisonerNumber, religionV1RequestDto)
+    return noContent().build()
+  }
 
   @GetMapping("reference-data/domain/{domain}/codes")
   @ResponseStatus(HttpStatus.OK)

src/main/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/personprotectercharacteristics/service/PersonProtectedCharacteristicsService.kt

@@ -0,0 +1,23 @@
+package uk.gov.justice.digital.hmpps.personintegrationapi.personprotectercharacteristics.service
+
+import org.springframework.stereotype.Service
+import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.PrisonApiClient
+import uk.gov.justice.digital.hmpps.personintegrationapi.common.client.request.UpdateReligion
+import uk.gov.justice.digital.hmpps.personintegrationapi.personprotectedcharacteristics.dto.v1.request.ReligionV1RequestDto
+
+@Service
+class PersonProtectedCharacteristicsService(
+  private val prisonApiClient: PrisonApiClient,
+) {
+  fun updateReligion(prisonerNumber: String, updateRequest: ReligionV1RequestDto) {
+    prisonApiClient.updateReligionForWorkingName(
+      prisonerNumber,
+      UpdateReligion(
+        updateRequest.religionCode,
+        updateRequest.reasonForChange,
+        updateRequest.effectiveFromDate,
+        updateRequest.isVerified,
+      ),
+    )
+  }
+}

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

@@ -135,6 +135,18 @@ class PrisonApiMockServer : WireMockServer(8082) {
     )
   }
 
+  fun stubUpdateReligionForWorkingName() {
+    val endpoint = "religion"
+    stubOffenderPutEndpoint(endpoint, HttpStatus.NO_CONTENT, PRISONER_NUMBER)
+    stubOffenderPutEndpoint(endpoint, HttpStatus.INTERNAL_SERVER_ERROR, PRISONER_NUMBER_THROW_EXCEPTION)
+    stubOffenderPutEndpoint(
+      endpoint,
+      HttpStatus.NOT_FOUND,
+      PRISONER_NUMBER_NOT_FOUND,
+      PRISON_API_NOT_FOUND_RESPONSE.trimIndent(),
+    )
+  }
+
   fun stubReferenceDataCodes(domain: String = "TEST", body: String = PRISON_API_REFERENCE_CODES) {
     stubFor(
       get(urlPathMatching("/api/reference-domains/domains/$domain/all-codes")).willReturn(
@@ -193,6 +205,7 @@ class PrisonApiExtension :
     prisonApi.stubUpdateBirthPlaceForWorkingName()
     prisonApi.stubUpdateBirthCountryForWorkingName()
     prisonApi.stubUpdateNationalityForWorkingName()
+    prisonApi.stubUpdateReligionForWorkingName()
     prisonApi.stubReferenceDataCodes()
     prisonApi.stubGetMilitaryRecords()
   }

src/test/kotlin/uk/gov/justice/digital/hmpps/personintegrationapi/personprotectercharacteristics/resource/PersonProtectedCharacteristicsV1ResourceIntTest.kt

@@ -8,9 +8,9 @@ import org.springframework.http.MediaType
 import uk.gov.justice.digital.hmpps.personintegrationapi.common.dto.ReferenceDataCodeDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.integration.IntegrationTestBase
 import uk.gov.justice.digital.hmpps.personintegrationapi.integration.wiremock.PRISONER_NUMBER
-import uk.gov.justice.digital.hmpps.personintegrationapi.personprotectedcharacteristics.dto.v1.common.ReligionDto
+import uk.gov.justice.digital.hmpps.personintegrationapi.integration.wiremock.PRISONER_NUMBER_NOT_FOUND
+import uk.gov.justice.digital.hmpps.personintegrationapi.integration.wiremock.PRISON_API_NOT_FOUND_RESPONSE
 import uk.gov.justice.digital.hmpps.personintegrationapi.personprotectedcharacteristics.dto.v1.request.ReligionV1RequestDto
-import uk.gov.justice.digital.hmpps.personintegrationapi.personprotectedcharacteristics.dto.v1.response.PersonReligionInformationV1ResponseDto
 import uk.gov.justice.digital.hmpps.personintegrationapi.personprotectercharacteristics.PersonProtectedCharacteristicsRoleConstants
 import java.time.LocalDate
 
@@ -48,17 +48,40 @@ class PersonProtectedCharacteristicsV1ResourceIntTest : IntegrationTestBase() {
 
       @Test
       fun `can update a persons religion by prisoner number`() {
-        val response = webTestClient.put()
+        webTestClient.put()
           .uri("v1/person-protected-characteristics/religion?prisonerNumber=$PRISONER_NUMBER")
           .contentType(MediaType.APPLICATION_JSON)
           .headers(setAuthorisation(roles = listOf(PersonProtectedCharacteristicsRoleConstants.PROTECTED_CHARACTERISTICS_READ_WRITE_ROLE)))
           .bodyValue(TEST_RELIGION_REQUEST_DTO)
           .exchange()
-          .expectStatus().isOk
-          .expectBody(PersonReligionInformationV1ResponseDto::class.java)
-          .returnResult().responseBody
+          .expectStatus().isNoContent
+      }
 
-        assertThat(response).isEqualTo(EXPECTED_RELIGION_UPDATE_RESPONSE)
+      @Test
+      fun `can update a persons religion by prisoner number - minimal request example`() {
+        webTestClient.put()
+          .uri("v1/person-protected-characteristics/religion?prisonerNumber=$PRISONER_NUMBER")
+          .contentType(MediaType.APPLICATION_JSON)
+          .headers(setAuthorisation(roles = listOf(PersonProtectedCharacteristicsRoleConstants.PROTECTED_CHARACTERISTICS_READ_WRITE_ROLE)))
+          .bodyValue(MINIMAL_RELIGION_REQUEST_DTO)
+          .exchange()
+          .expectStatus().isNoContent
+      }
+    }
+
+    @Nested
+    inner class NotFound {
+
+      @Test
+      fun `handles a 404 not found response from downstream api`() {
+        webTestClient.put()
+          .uri("v1/person-protected-characteristics/religion?prisonerNumber=$PRISONER_NUMBER_NOT_FOUND")
+          .contentType(MediaType.APPLICATION_JSON)
+          .headers(setAuthorisation(roles = listOf(PersonProtectedCharacteristicsRoleConstants.PROTECTED_CHARACTERISTICS_READ_WRITE_ROLE)))
+          .bodyValue(TEST_RELIGION_REQUEST_DTO)
+          .exchange()
+          .expectStatus().isNotFound
+          .expectBody().json(PRISON_API_NOT_FOUND_RESPONSE.trimIndent())
       }
     }
   }
@@ -113,10 +136,13 @@ class PersonProtectedCharacteristicsV1ResourceIntTest : IntegrationTestBase() {
         false,
       )
 
-    val EXPECTED_RELIGION_UPDATE_RESPONSE = PersonReligionInformationV1ResponseDto(
-      currentReligion = ReligionDto(),
-      religionHistory = emptySet(),
-    )
+    val MINIMAL_RELIGION_REQUEST_DTO =
+      ReligionV1RequestDto(
+        "AGNO",
+        null,
+        null,
+        false,
+      )
 
     const val TEST_DOMAIN = "RELIGION"
   }