Merge branch 'main' into dependabot/pip/scripts/data_analysis/requests-2.32.0

Author: popey2700

.gitignore

@@ -86,3 +86,6 @@ __pycache__/
 *.key
 *.csr
 *.pem
+
+# Localstack
+localstack/cache

docker-compose.yml

@@ -112,7 +112,7 @@ services:
       dockerfile: Dockerfile.setup-create-and-vary-a-licence-api
     container_name: create-and-vary-licence-api
     healthcheck:
-      test: 'wget --header="Authorization: Bearer abc" http://0.0.0.0:4010/public/licences/id/abc -O /dev/null'
+      test: 'wget --header="Authorization: Bearer abc" http://0.0.0.0:4010/public/licences/id/123 -O /dev/null'
     ports:
       - '4070:4010'
 

docs/adr/0003-manually-manage-openapi-file.md

@@ -11,8 +11,8 @@ Accepted
 The [OpenAPI specification](https://spec.openapis.org/oas/latest.html) is a standard for describing REST APIs and
 [Swagger UI](https://swagger.io/tools/swagger-ui/) is used to visualise and interact with a specification file in more
 user-friendly manner. These are used widely used within HMPPS to document APIs,
-e.g. [Prison API's OpenAPI specification](https://api.prison.service.justice.gov.uk/v3/api-docs)
-and [Prison API's Swagger UI](https://api.prison.service.justice.gov.uk/swagger-ui/index.html). This is achieved by
+e.g. [Prison API's OpenAPI specification](https://prison-api.prison.service.justice.gov.uk/v3/api-docs)
+and [Prison API's Swagger UI](https://prison-api.prison.service.justice.gov.uk/swagger-ui/index.html). This is achieved by
 using the [SpringDoc OpenAPI library](https://springdoc.org) and annotating the codebase which the library then uses to
 expose two endpoints: one for the OpenAPI specification in JSON format and another for Swagger UI.
 

openapi.yml

@@ -1671,6 +1671,10 @@ components:
           example:
             - "2018-02-10"
             - "2019-02-10"
+        courtName:
+          type: string
+          description: The court name
+          example: "London Magistrates Court"
         description:
           type: string
           example: Commit an act / series of acts with intent to pervert the course of public justice

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/CreateAndVaryLicenceGateway.kt

@@ -45,7 +45,7 @@ class CreateAndVaryLicenceGateway(
     }
   }
 
-  fun getLicenceConditions(id: String): Response<List<LicenceCondition>> {
+  fun getLicenceConditions(id: Int): Response<List<LicenceCondition>> {
     val result =
       webClient.request<CvlLicence>(
         HttpMethod.GET,

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/ProbationOffenderSearchGateway.kt

@@ -11,6 +11,7 @@ import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Person
 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
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch.ContactDetailsWithAddress
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch.Offender
 
 @Component
@@ -116,8 +117,26 @@ class ProbationOffenderSearchGateway(
   }
 
   fun getAddressesForPerson(hmppsId: String): Response<List<Address>> {
-    val offender = getOffender(hmppsId)
-    return Response(data = offender.data?.contactDetails?.addresses.orEmpty().map { it.toAddress() }, errors = offender.errors)
+    val result =
+      webClient.requestList<ContactDetailsWithAddress>(
+        HttpMethod.POST,
+        "/search",
+        authenticationHeader(),
+        UpstreamApi.PROBATION_OFFENDER_SEARCH,
+        mapOf("crn" to hmppsId),
+      )
+
+    return when (result) {
+      is WebClientWrapperResponse.Success -> {
+        return Response(result.data.firstOrNull()?.contactDetails?.addresses.orEmpty().map { it.toAddress() })
+      }
+      is WebClientWrapperResponse.Error -> {
+        Response(
+          data = emptyList(),
+          errors = result.errors,
+        )
+      }
+    }
   }
 
   private fun authenticationHeader(): Map<String, String> {

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/ContactDetailsWithEmailAndPhone.kt

@@ -1,9 +1,6 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps
 
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch.Address
-
 data class ContactDetailsWithEmailAndPhone(
-  val addresses: List<Address>?,
   val phoneNumbers: List<PhoneNumber>?,
   val emails: List<String>?,
 )

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/hmpps/Offence.kt

@@ -8,6 +8,7 @@ data class Offence(
   val cjsCode: String? = null,
   val hoCode: String? = null,
   val courtDates: List<LocalDate?> = listOf(),
+  val courtName: String? = null,
   val description: String? = null,
   val endDate: LocalDate? = null,
   val startDate: LocalDate? = null,

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/ndelius/NDeliusAdditionalOffence.kt

@@ -10,13 +10,17 @@ data class NDeliusAdditionalOffence(
   val code: String? = null,
   val date: String? = null,
 ) {
-  fun toOffence(courtDates: List<LocalDate>): Offence =
+  fun toOffence(
+    courtDates: List<LocalDate>,
+    courtName: String?,
+  ): Offence =
     Offence(
       serviceSource = UpstreamApi.NDELIUS,
       systemSource = SystemSource.PROBATION_SYSTEMS,
       cjsCode = null,
       hoCode = this.code,
       courtDates = courtDates,
+      courtName = courtName,
       endDate = null,
       startDate = if (!this.date.isNullOrEmpty()) LocalDate.parse(this.date) else null,
       statuteCode = null,

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/ndelius/NDeliusCourtAppearance.kt

@@ -2,4 +2,5 @@ package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.ndelius
 
 data class NDeliusCourtAppearance(
   val date: CharSequence? = null,
+  val court: String? = null,
 )

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/ndelius/NDeliusMainOffence.kt

@@ -10,13 +10,17 @@ data class NDeliusMainOffence(
   val code: String? = null,
   val date: String? = null,
 ) {
-  fun toOffence(courtDates: List<LocalDate>): Offence =
+  fun toOffence(
+    courtDates: List<LocalDate>,
+    courtName: String?,
+  ): Offence =
     Offence(
       serviceSource = UpstreamApi.NDELIUS,
       systemSource = SystemSource.PROBATION_SYSTEMS,
       cjsCode = null,
       hoCode = this.code,
       courtDates = courtDates,
+      courtName = courtName,
       endDate = null,
       startDate = LocalDate.parse(this.date),
       statuteCode = null,

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/ndelius/NDeliusSupervision.kt

@@ -17,7 +17,10 @@ data class NDeliusSupervision(
 ) {
   fun toOffences(): List<Offence> {
     val courtDates = this.courtAppearances.mapNotNull { LocalDate.parse(it.date, DateTimeFormatter.ISO_OFFSET_DATE_TIME) }
-    return listOf(this.mainOffence.toOffence(courtDates)) + this.additionalOffences.map { it.toOffence(courtDates) }
+    val courtName = this.courtAppearances.firstOrNull()?.court
+    val mainOffence = this.mainOffence.toOffence(courtDates, courtName)
+    val additionalOffences = this.additionalOffences.map { it.toOffence(courtDates, courtName) }
+    return listOf(mainOffence) + additionalOffences
   }
 
   fun toSentence(): Sentence {

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/Address.kt

@@ -1,7 +1,15 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch
 
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Address
 import java.time.LocalDate
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Address as HmppsAddress
+
+data class ContactDetailsWithAddress(
+  val contactDetails: Addresses? = null,
+)
+
+data class Addresses(
+  val addresses: List<Address>? = listOf(),
+)
 
 data class Address(
   val addressNumber: String?,
@@ -18,7 +26,7 @@ data class Address(
   val notes: String?,
 ) {
   fun toAddress() =
-    Address(
+    HmppsAddress(
       country = null,
       county = this.county,
       endDate = this.to,
@@ -39,7 +47,7 @@ data class Address(
     val description: String?,
   ) {
     fun toAddressType() =
-      Address.Type(
+      HmppsAddress.Type(
         code = this.code,
         description = this.description ?: this.code,
       )

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/ContactDetails.kt

@@ -1,5 +1,15 @@
 package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.probationoffendersearch
 
-open class ContactDetails(
-  open val addresses: List<Address>? = listOf(),
-)
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PhoneNumber
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.ContactDetailsWithEmailAndPhone as PersonContactDetails
+
+class ContactDetails(
+  val phoneNumbers: List<PhoneNumber>?,
+  val emailAddresses: List<String>?,
+) {
+  fun toContactDetails(): PersonContactDetails =
+    PersonContactDetails(
+      phoneNumbers = this.phoneNumbers,
+      emails = this.emailAddresses,
+    )
+}

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/ContactDetailsWithEmailAndPhone.kt

@@ -13,7 +13,7 @@ data class Offender(
   val gender: String? = null,
   val offenderProfile: OffenderProfile = OffenderProfile(),
   val offenderAliases: List<OffenderAlias> = listOf(),
-  val contactDetails: ContactDetailsWithEmailAndPhone? = null,
+  val contactDetails: ContactDetails? = null,
   val otherIds: OtherIds = OtherIds(),
   val age: Number = 0,
 ) {
@@ -34,7 +34,7 @@ data class Offender(
         ),
       pncId = otherIds.pncNumber,
       hmppsId = otherIds.crn,
-      contactDetails = this.contactDetails?.toContactdetails(),
+      contactDetails = this.contactDetails?.toContactDetails(),
     )
 
   fun toPersonProtectedCharacteristics(): PersonProtectedCharacteristics =

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/probationoffendersearch/Offender.kt

@@ -21,8 +21,13 @@ class GetLicenceConditionService(
     if (crn != null) {
       licences = createAndVaryLicenceGateway.getLicenceSummaries(id = crn)
       licences.data.forEach {
-        val conditions = createAndVaryLicenceGateway.getLicenceConditions(it.id)
-        it.conditions = conditions.data
+        val licenceId = it.id.toIntOrNull()
+        if (licenceId != null) {
+          val conditions = createAndVaryLicenceGateway.getLicenceConditions(licenceId)
+          it.conditions = conditions.data
+        } else {
+          it.conditions = emptyList()
+        }
       }
       personLicences = PersonLicences(hmppsId, licences.data.firstOrNull()?.offenderNumber, licences.data)
     }

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetLicenceConditionService.kt

@@ -32,11 +32,9 @@ class GetPersonService(
         "probationOffenderSearch" to probationResponse.data,
       )
 
-    val errors = (prisonResponse?.errors ?: emptyList()) + probationResponse.errors
-
     return Response(
       data = data,
-      errors = errors,
+      errors = (prisonResponse?.errors ?: emptyList()) + probationResponse.errors,
     )
   }
 }

src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonService.kt

@@ -1,6 +1,6 @@
 services:
   prison-api:
-    base-url: https://api-preprod.prison.service.justice.gov.uk
+    base-url: https://prison-api-preprod.prison.service.justice.gov.uk
   prisoner-offender-search:
     base-url: https://prisoner-search-preprod.prison.service.justice.gov.uk
   probation-offender-search:

src/main/resources/application-preprod.yml

@@ -1,6 +1,6 @@
 services:
   prison-api:
-    base-url: https://api.prison.service.justice.gov.uk
+    base-url: https://prison-api.prison.service.justice.gov.uk
   prisoner-offender-search:
     base-url: https://prisoner-search.prison.service.justice.gov.uk
   probation-offender-search:

src/main/resources/application-prod.yml

@@ -56,6 +56,7 @@ internal class OffencesControllerTest(
                     cjsCode = "RR99999",
                     hoCode = "05800",
                     courtDates = listOf(LocalDate.parse("2023-03-03")),
+                    courtName = "Llandudno Magistrates Court",
                     description = "This is a description of an offence.",
                     endDate = LocalDate.parse("2023-02-01"),
                     startDate = LocalDate.parse("2023-01-01"),
@@ -90,6 +91,7 @@ internal class OffencesControllerTest(
               "cjsCode": "RR99999",
               "hoCode": "05800",
               "courtDates": ["2023-03-03"],
+              "courtName": "Llandudno Magistrates Court",
               "description": "This is a description of an offence.",
               "endDate":"2023-02-01",
               "startDate": "2023-01-01",
@@ -154,6 +156,7 @@ internal class OffencesControllerTest(
                     systemSource = SystemSource.PROBATION_SYSTEMS,
                     cjsCode = "RR99999",
                     courtDates = listOf(LocalDate.parse("2023-03-03")),
+                    courtName = "Llandudno Magistrates Court",
                     description = "This is a description of an offence.",
                     endDate = LocalDate.parse("2023-02-01"),
                     startDate = LocalDate.parse("2023-01-01"),

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/person/OffencesControllerTest.kt

@@ -76,14 +76,14 @@ internal class PersonControllerTest(
                     lastName = "Allen",
                     middleName = "Jonas",
                     dateOfBirth = LocalDate.parse("2023-03-01"),
-                    contactDetails = ContactDetailsWithEmailAndPhone(emptyList(), phoneNumbers, emails),
+                    contactDetails = ContactDetailsWithEmailAndPhone(phoneNumbers, emails),
                   ),
                   Person(
                     firstName = "Barry",
                     lastName = "Allen",
                     middleName = "Rock",
                     dateOfBirth = LocalDate.parse("2022-07-22"),
-                    contactDetails = ContactDetailsWithEmailAndPhone(emptyList(), phoneNumbers, emails),
+                    contactDetails = ContactDetailsWithEmailAndPhone(phoneNumbers, emails),
                   ),
                 ),
             ),

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/person/PersonControllerTest.kt

@@ -29,7 +29,7 @@ class GetLicenceConditionsTests(
 ) : DescribeSpec(
     {
       val createAndVaryLicenceApiMockServer = CreateAndVaryLicenceApiMockServer()
-      val conditionId = "X777776"
+      val conditionId = 12345
 
       beforeEach {
         createAndVaryLicenceApiMockServer.start()

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/createAndVaryLicence/GetLicenceConditionsTests.kt

@@ -73,6 +73,7 @@ class GetOffencesForPersonTest(
                     LocalDate.parse("2009-07-07"),
                     LocalDate.parse("2009-07-07"),
                   ),
+                courtName = "Llandudno Magistrates Court",
                 description = "Common assault and battery - 10501",
                 endDate = null,
                 startDate = LocalDate.parse("2009-03-31"),
@@ -86,6 +87,7 @@ class GetOffencesForPersonTest(
                     LocalDate.parse("2009-07-07"),
                     LocalDate.parse("2009-07-07"),
                   ),
+                courtName = "Llandudno Magistrates Court",
                 description = "Other Criminal Damage (including causing explosion)  - 05800",
                 endDate = null,
                 startDate = LocalDate.parse("2009-03-31"),
@@ -99,6 +101,7 @@ class GetOffencesForPersonTest(
                     LocalDate.parse("2009-09-01"),
                     LocalDate.parse("2009-08-11"),
                   ),
+                courtName = "Llandudno Magistrates Court",
                 description = "Threatening behaviour, fear or provocation of violence (Public Order Act 1986) - 12511",
                 endDate = null,
                 startDate = LocalDate.parse("2009-07-31"),
@@ -112,6 +115,7 @@ class GetOffencesForPersonTest(
                     LocalDate.parse("2009-09-01"),
                     LocalDate.parse("2009-08-11"),
                   ),
+                courtName = "Llandudno Magistrates Court",
                 description = "Stealing from the person of another - 03900",
                 endDate = null,
                 startDate = LocalDate.parse("2009-08-14"),
@@ -125,6 +129,7 @@ class GetOffencesForPersonTest(
                     LocalDate.parse("2009-09-01"),
                     LocalDate.parse("2009-08-11"),
                   ),
+                courtName = "Llandudno Magistrates Court",
                 description = "Migrated Breach Offences",
                 endDate = null,
                 startDate = LocalDate.parse("1900-01-01"),

src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/ndelius/GetOffencesForPersonTest.kt

@@ -139,13 +139,13 @@
         {
           "type": "Sentence",
           "date": "2009-09-01T00:00:00+01:00",
-          "court": "Rhuddlan Magistrates Court",
+          "court": "Llandudno Magistrates Court",
           "plea": "Guilty"
         },
         {
           "type": "Trial/Adjournment",
           "date": "2009-08-11T00:00:00+01:00",
-          "court": "Rhuddlan Magistrates Court",
+          "court": "Llandudno Magistrates Court",
           "plea": "Guilty"
         }
       ]