add more fields to prisoner search response

emmalanigan · emmalanigan · commit 05a53bfc1e6f · 2025-01-23T17:03:56.000Z
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/prison/PrisonController.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/prison/PrisonController.kt
@@ -17,6 +17,7 @@ import org.springframework.web.bind.annotation.RestController
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.exception.EntityNotFoundException
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.DataResponse
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PersonInPrison
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError.Type.BAD_REQUEST
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError.Type.ENTITY_NOT_FOUND
@@ -55,7 +56,7 @@ class PrisonController(
   fun getPerson(
     @PathVariable hmppsId: String,
     @RequestAttribute filters: ConsumerFilters?,
-  ): DataResponse<Person?> {
+  ): DataResponse<PersonInPrison?> {
     val response = getPersonService.getPrisoner(hmppsId, filters)
 
     if (response.hasErrorCausedBy(BAD_REQUEST, causedBy = UpstreamApi.NOMIS)) {
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/PersonInPrison.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/PersonInPrison.kt
@@ -0,0 +1,28 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps
+
+class PersonInPrison(
+  person: Person,
+  val category: String?,
+  val crsa: String?,
+  val dateOfReception: String?,
+  val status: String?,
+  val prisonId: String?,
+  val prisonName: String?,
+  val cellLocation: String?,
+) : Person(
+    firstName = person.firstName,
+    lastName = person.lastName,
+    middleName = person.middleName,
+    dateOfBirth = person.dateOfBirth,
+    gender = person.gender,
+    ethnicity = person.ethnicity,
+    aliases = person.aliases,
+    identifiers = person.identifiers,
+    pncId = person.pncId,
+    hmppsId = person.hmppsId,
+    contactDetails = person.contactDetails,
+    currentExclusion = person.currentExclusion,
+    exclusionMessage = person.exclusionMessage,
+    currentRestriction = person.currentRestriction,
+    restrictionMessage = person.restrictionMessage,
+  )
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/prisoneroffendersearch/POSPrisoner.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/prisoneroffendersearch/POSPrisoner.kt
@@ -2,6 +2,7 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.prisoneroffender
 
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Identifiers
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PersonInPrison
 import java.time.LocalDate
 
 data class POSPrisoner(
@@ -21,6 +22,10 @@ data class POSPrisoner(
   val prisonName: String? = null,
   val cellLocation: String? = null,
   val inOutStatus: String? = null,
+  val category: String? = null,
+  val crsa: String? = null,
+  val dateOfReception: String? = null,
+  val status: String? = null,
 ) {
   fun toPerson(): Person =
     Person(
@@ -38,4 +43,30 @@ data class POSPrisoner(
         ),
       pncId = this.pncNumber,
     )
+
+  fun toPersonInPrison(): PersonInPrison =
+    PersonInPrison(
+      Person(
+        firstName = this.firstName,
+        lastName = this.lastName,
+        middleName = this.middleNames,
+        dateOfBirth = this.dateOfBirth,
+        gender = this.gender,
+        ethnicity = this.ethnicity,
+        aliases = this.aliases.map { it.toAlias() },
+        identifiers =
+          Identifiers(
+            nomisNumber = this.prisonerNumber,
+            croNumber = this.croNumber,
+          ),
+        pncId = this.pncNumber,
+      ),
+      cellLocation = this.cellLocation,
+      prisonId = this.prisonId,
+      prisonName = this.prisonName,
+      category = this.category,
+      crsa = this.crsa,
+      dateOfReception = this.dateOfReception,
+      status = this.status,
+    )
 }
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonService.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonService.kt
@@ -7,6 +7,7 @@ import uk.gov.justice.digital.hmpps.hmppsintegrationapi.gateways.ProbationOffend
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.NomisNumber
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.OffenderSearchResponse
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PersonInPrison
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError
@@ -120,7 +121,7 @@ class GetPersonService(
   fun getPrisoner(
     hmppsId: String,
     filters: ConsumerFilters?,
-  ): Response<Person?> {
+  ): Response<PersonInPrison?> {
     val prisonerNomisNumber = getNomisNumber(hmppsId)
 
     if (prisonerNomisNumber.errors.isNotEmpty()) {
@@ -167,7 +168,7 @@ class GetPersonService(
     }
 
     return Response(
-      data = posPrisoner?.toPerson(),
+      data = posPrisoner?.toPersonInPrison(),
       errors = prisonResponse.errors,
     )
   }
diff --git a/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/prison/PrisonControllerTest.kt b/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/prison/PrisonControllerTest.kt
@@ -18,6 +18,7 @@ import org.springframework.test.web.servlet.MockMvc
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.removeWhitespaceAndNewlines
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.helpers.IntegrationAPIMockMvc
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PersonInPrison
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError
@@ -68,18 +69,27 @@ internal class PrisonControllerTest(
         whenever(getPersonService.getPrisoner(eq(hmppsId), anyOrNull())).thenReturn(
           Response(
             data =
-              Person(
-                firstName = "Barry",
-                lastName = "Allen",
-                middleName = "Jonas",
-                dateOfBirth = LocalDate.parse("2023-03-01"),
-                gender = "Male",
-                ethnicity = "Caucasian",
-                pncId = "PNC123456",
-                currentExclusion = true,
-                exclusionMessage = "An exclusion is present",
-                currentRestriction = true,
-                restrictionMessage = "A restriction is present",
+              PersonInPrison(
+                Person(
+                  firstName = "Barry",
+                  lastName = "Allen",
+                  middleName = "Jonas",
+                  dateOfBirth = LocalDate.parse("2023-03-01"),
+                  gender = "Male",
+                  ethnicity = "Caucasian",
+                  pncId = "PNC123456",
+                  currentExclusion = true,
+                  exclusionMessage = "An exclusion is present",
+                  currentRestriction = true,
+                  restrictionMessage = "A restriction is present",
+                ),
+                category = "C",
+                crsa = "HIGH",
+                dateOfReception = "2023-05-01",
+                status = "ACTIVE IN",
+                prisonId = "MDI",
+                prisonName = "HMP Leeds",
+                cellLocation = "A-1-002",
               ),
           ),
         )
@@ -90,6 +100,13 @@ internal class PrisonControllerTest(
           """
             {
              "data":{
+                   "category": "C",
+                   "crsa": "HIGH",
+                   "dateOfReception": "2023-05-01",
+                   "status": "ACTIVE IN",
+                   "prisonId": "MDI",
+                   "prisonName": "HMP Leeds",
+                   "cellLocation": "A-1-002",
                    "firstName":"Barry",
                    "lastName":"Allen",
                    "middleName":"Jonas",
@@ -119,14 +136,23 @@ internal class PrisonControllerTest(
         whenever(getPersonService.getPrisoner(eq(hmppsId), anyOrNull())).thenReturn(
           Response(
             data =
-              Person(
-                firstName = "Barry",
-                lastName = "Allen",
-                middleName = "Jonas",
-                dateOfBirth = LocalDate.parse("2023-03-01"),
-                gender = "Male",
-                ethnicity = "Caucasian",
-                pncId = "PNC123456",
+              PersonInPrison(
+                Person(
+                  firstName = "Barry",
+                  lastName = "Allen",
+                  middleName = "Jonas",
+                  dateOfBirth = LocalDate.parse("2023-03-01"),
+                  gender = "Male",
+                  ethnicity = "Caucasian",
+                  pncId = "PNC123456",
+                ),
+                category = "C",
+                crsa = "HIGH",
+                dateOfReception = "2023-05-01",
+                status = "ACTIVE IN",
+                prisonId = "MDI",
+                prisonName = "HMP Leeds",
+                cellLocation = "A-1-002",
               ),
           ),
         )
diff --git a/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonServiceTest.kt b/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonServiceTest.kt
@@ -18,6 +18,7 @@ import uk.gov.justice.digital.hmpps.hmppsintegrationapi.gateways.ProbationOffend
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Identifiers
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.OffenderSearchResponse
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PersonInPrison
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PersonOnProbation
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
@@ -141,14 +142,14 @@ internal class GetPersonServiceTest(
 
       it("returns a prisoner when valid hmppsId is provided") {
         val validHmppsId = "G2996UX"
-        val person = Person(firstName = "Sam", lastName = "Mills")
+        val person = PersonInPrison(Person(firstName = "Sam", lastName = "Mills"), category = null, crsa = null, dateOfReception = null, status = null, prisonId = null, prisonName = null, cellLocation = null)
         whenever(prisonerOffenderSearchGateway.getPrisonOffender(nomsNumber = "G2996UX")).thenReturn(
           Response(data = POSPrisoner(firstName = "Sam", lastName = "Mills")),
         )
 
         val result = getPersonService.getPrisoner(validHmppsId, blankConsumerFilters)
 
-        result.data.shouldBeTypeOf<Person>()
+        result.data.shouldBeTypeOf<PersonInPrison>()
         result.data!!.firstName.shouldBe(person.firstName)
         result.data!!.lastName.shouldBe(person.lastName)
         result.errors.shouldBe(emptyList())
@@ -212,23 +213,23 @@ internal class GetPersonServiceTest(
 
         val result = getPersonService.getPrisoner(correctPrisonHmppsId, ConsumerFilters(prisons = listOf(prisonId)))
 
-        result.data.shouldBeTypeOf<Person>()
+        result.data.shouldBeTypeOf<PersonInPrison>()
         result.data!!.firstName.shouldBe(posPrisoner.firstName)
         result.data!!.lastName.shouldBe(posPrisoner.lastName)
         result.errors.shouldBe(emptyList())
       }
 
       it("returns prisoner if no prison filter present") {
         val validHmppsId = "G2996UX"
-        val person = Person(firstName = "Sam", lastName = "Mills")
+        val person = PersonInPrison(Person(firstName = "Sam", lastName = "Mills"), category = null, crsa = null, dateOfReception = null, status = null, prisonId = null, prisonName = null, cellLocation = null)
 
         whenever(prisonerOffenderSearchGateway.getPrisonOffender(nomsNumber = validHmppsId)).thenReturn(
           Response(data = POSPrisoner(firstName = "Sam", lastName = "Mills")),
         )
 
         val result = getPersonService.getPrisoner(validHmppsId, ConsumerFilters(prisons = null))
 
-        result.data.shouldBeTypeOf<Person>()
+        result.data.shouldBeTypeOf<PersonInPrison>()
         result.data!!.firstName.shouldBe(person.firstName)
         result.data!!.lastName.shouldBe(person.lastName)
         result.errors.shouldBe(emptyList())
@@ -258,15 +259,15 @@ internal class GetPersonServiceTest(
 
       it("returns prisoner if no consumer filters present") {
         val validHmppsId = "G2996UX"
-        val person = Person(firstName = "Sam", lastName = "Mills")
+        val person = PersonInPrison(Person(firstName = "Sam", lastName = "Mills"), category = null, crsa = null, dateOfReception = null, status = null, prisonId = null, prisonName = null, cellLocation = null)
 
         whenever(prisonerOffenderSearchGateway.getPrisonOffender(nomsNumber = validHmppsId)).thenReturn(
           Response(data = POSPrisoner(firstName = "Sam", lastName = "Mills")),
         )
 
         val result = getPersonService.getPrisoner(validHmppsId, null)
 
-        result.data.shouldBeTypeOf<Person>()
+        result.data.shouldBeTypeOf<PersonInPrison>()
         result.data!!.firstName.shouldBe(person.firstName)
         result.data!!.lastName.shouldBe(person.lastName)
         result.errors.shouldBe(emptyList())
