HMAI-316 - Setup new alerts gateway (#754)

* Add URLs to yml files

* Gateway and new models

* Add pagination

* Renamed models

* Rename gateway

* Add paginated model conversion method

* Gateway tests

* Remove isActive

* Corrected example

* Correct mock URL

* Add prism mock

* Make prism mock static file

* Commit changes made by code formatters

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: tomwatkins1994

Dockerfile.prism

@@ -26,5 +26,6 @@ RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/prisoner-offender-search.j
 RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/x4022-personal-relationships.json
 RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/x4023-manage-prison-visits.json
 RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/x4024-incentives.json
+RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/x4025-alerts-api.json
 
 ENTRYPOINT sh -c 'port=4010; for file in $(ls /prismMocks/*.json | sort); do node dist/index.js mock -p $port -h 0.0.0.0 $file & port=$((port + 1)); done; wait'

docker-compose.yml

@@ -18,7 +18,8 @@ services:
         curl -H "Authorization: Bearer abc" -f http://0.0.0.0:4020/inductions/K5995YZ/induction-schedule &&
         curl -H "Authorization: Bearer abc" -f http://0.0.0.0:4021/prisoner/A1234AL/non-associations &&
         curl -H "Authorization: Bearer abc" -f http://0.0.0.0:4022/contact/123456789/linked-prisoners &&
-        curl -H "Authorization: Bearer abc" -f http://0.0.0.0:4024/incentive-reviews/prisoner/A1234AA'
+        curl -H "Authorization: Bearer abc" -f http://0.0.0.0:4024/incentive-reviews/prisoner/A1234AA &&
+        curl -H "Authorization: Bearer abc" -f http://0.0.0.0:4025/prisoners/A1234AA/alerts'
 
     ports:
       - "4010:4010"
@@ -36,6 +37,7 @@ services:
       - "4022:4022"
       - "4023:4023"
       - "4024:4024"
+      - "4025:4025"
 
   local-stack-aws:
     image: localstack/localstack:3.0

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

@@ -0,0 +1,57 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.gateways
+
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.beans.factory.annotation.Value
+import org.springframework.http.HttpMethod
+import org.springframework.stereotype.Component
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.WebClientWrapper
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.WebClientWrapper.WebClientWrapperResponse
+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.prisonerAlerts.PAPaginatedAlerts
+
+@Component
+class PrisonerAlertsGateway(
+  @Value("\${services.alerts.base-url}") baseUrl: String,
+) {
+  private val webClient = WebClientWrapper(baseUrl)
+
+  @Autowired
+  lateinit var hmppsAuthGateway: HmppsAuthGateway
+
+  private fun authenticationHeader(): Map<String, String> {
+    val token = hmppsAuthGateway.getClientToken("PRISONER_ALERTS")
+    return mapOf(
+      "Authorization" to "Bearer $token",
+    )
+  }
+
+  fun getPrisonerAlerts(
+    prisonerNumber: String,
+    page: Int,
+    size: Int,
+  ): Response<PAPaginatedAlerts?> {
+    val result =
+      webClient.request<PAPaginatedAlerts>(
+        HttpMethod.GET,
+        "/prisoners/$prisonerNumber/alerts?page=$page&size=$size",
+        authenticationHeader(),
+        UpstreamApi.PRISONER_ALERTS,
+        badRequestAsError = true,
+      )
+
+    return when (result) {
+      is WebClientWrapperResponse.Success -> {
+        return Response(
+          data = result.data,
+        )
+      }
+      is WebClientWrapperResponse.Error -> {
+        Response(
+          data = null,
+          errors = result.errors,
+        )
+      }
+    }
+  }
+}

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

@@ -22,6 +22,6 @@ data class Alert(
   val dateExpired: LocalDate? = null,
   @Schema(description = "Whether the alert has expired", example = "true")
   val expired: Boolean? = null,
-  @Schema(description = "Whether the alert is active", example = "true")
+  @Schema(description = "Whether the alert is active", example = "false")
   val active: Boolean? = null,
 )

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

@@ -0,0 +1,13 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps
+
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.interfaces.IPaginatedObject
+
+data class PaginatedAlerts(
+  override val content: List<Alert>,
+  override val totalPages: Int,
+  override val totalCount: Long,
+  override val isLastPage: Boolean,
+  override val count: Int,
+  override val page: Int,
+  override val perPage: Int,
+) : IPaginatedObject<Alert>

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

@@ -18,4 +18,5 @@ enum class UpstreamApi {
   PERSONAL_RELATIONSHIPS,
   MANAGE_PRISON_VISITS,
   INCENTIVES,
+  PRISONER_ALERTS,
 }

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

@@ -0,0 +1,40 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.prisonerAlerts
+
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Alert
+import java.time.LocalDate
+import java.time.LocalDateTime
+
+data class PAAlert(
+  val alertUuid: String,
+  val prisonNumber: String,
+  val alertCode: PAAlertCode,
+  val description: String? = null,
+  val authorisedBy: String? = null,
+  val activeFrom: LocalDate,
+  val activeTo: LocalDate? = null,
+  val isActive: Boolean,
+  val createdAt: LocalDateTime,
+  val createdBy: String,
+  val createdByDisplayName: String,
+  val lastModifiedAt: LocalDateTime? = null,
+  val lastModifiedBy: String? = null,
+  val lastModifiedByDisplayName: String? = null,
+  val activeToLastSetAt: LocalDateTime? = null,
+  val activeToLastSetBy: String? = null,
+  val activeToLastSetByDisplayName: String? = null,
+  val prisonCodeWhenCreated: String? = null,
+) {
+  fun toAlert() =
+    Alert(
+      offenderNo = this.prisonNumber,
+      type = this.alertCode.alertTypeCode,
+      typeDescription = this.alertCode.alertTypeDescription,
+      code = this.alertCode.code,
+      codeDescription = this.alertCode.description,
+      comment = this.description,
+      dateCreated = this.activeFrom,
+      dateExpired = this.activeTo,
+      expired = this.activeTo?.isBefore(LocalDate.now().plusDays(1)) ?: false,
+      active = this.isActive,
+    )
+}

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

@@ -0,0 +1,8 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.prisonerAlerts
+
+data class PAAlertCode(
+  val alertTypeCode: String,
+  val alertTypeDescription: String,
+  val code: String,
+  val description: String,
+)

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

@@ -0,0 +1,10 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.prisonerAlerts
+
+data class PAPageable(
+  val offset: Long,
+  val sort: PASort,
+  val unpaged: Boolean,
+  val pageSize: Int,
+  val paged: Boolean,
+  val pageNumber: Int,
+)

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

@@ -0,0 +1,28 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.prisonerAlerts
+
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.PaginatedAlerts
+
+data class PAPaginatedAlerts(
+  val content: List<PAAlert>,
+  val totalElements: Long,
+  val totalPages: Int,
+  val first: Boolean,
+  val last: Boolean,
+  val size: Int,
+  val number: Int,
+  val sort: PASort,
+  val numberOfElements: Int,
+  val pageable: PAPageable,
+  val empty: Boolean,
+) {
+  fun toPaginatedAlerts() =
+    PaginatedAlerts(
+      content = this.content.map { it.toAlert() },
+      totalPages = this.totalPages,
+      totalCount = this.totalElements,
+      isLastPage = this.last,
+      count = this.numberOfElements,
+      page = this.number,
+      perPage = this.size,
+    )
+}

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

@@ -0,0 +1,7 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.prisonerAlerts
+
+data class PASort(
+  val empty: Boolean,
+  val sorted: Boolean,
+  val unsorted: Boolean,
+)