basic new controller etc to figure out dev flow

wcdkj · wcdkj · commit ca184050be76 · 2024-11-25T11:32:12.000Z
diff --git a/Dockerfile.prism b/Dockerfile.prism
@@ -20,6 +20,7 @@ RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/adjudications.json
 RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/assess-risks-and-needs.json
 RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/case-notes.json
 RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/prisoner-offender-search.json
+RUN sed -i 's/\*\/\*/application\/json/g' /prismMocks/prison-api.json
 
 # new files from this point on need to start with an x- followed by the port number:
 ADD https://learningandworkprogress-api-dev.hmpps.service.justice.gov.uk/v3/api-docs /prismMocks/x4020-plp-api.json
diff --git a/Makefile b/Makefile
@@ -4,7 +4,6 @@ authenticate-docker:
 	./scripts/authenticate_docker.sh
 
 build-dev:
-	#docker compose pull hmpps-auth
 	docker compose build
 
 build:
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/person/PrisonController.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/controllers/v1/person/PrisonController.kt
@@ -0,0 +1,50 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.controllers.v1.person
+
+import io.swagger.v3.oas.annotations.Operation
+import io.swagger.v3.oas.annotations.Parameter
+import io.swagger.v3.oas.annotations.media.Content
+import io.swagger.v3.oas.annotations.media.Schema
+import io.swagger.v3.oas.annotations.responses.ApiResponse
+import io.swagger.v3.oas.annotations.tags.Tag
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.RequestMapping
+import org.springframework.web.bind.annotation.RestController
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.exception.EntityNotFoundException
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.extensions.decodeUrlCharacters
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.*
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisPersonAccount
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetPersonPrisonAccountService
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.internal.AuditService
+
+@RestController
+@RequestMapping("/v0/prison")
+@Tag(name = "prison")
+class PrisonController(@Autowired val auditService: AuditService,
+                       @Autowired val getPersonPrisonAccount: GetPersonPrisonAccountService
+) {
+  @GetMapping("{encodedHmppsId}")
+  @Operation(
+    summary = "Returns a person",
+    responses = [
+      ApiResponse(responseCode = "200", useReturnTypeSchema = true, description = "Successfully found a person with the provided HMPPS ID."),
+      ApiResponse(responseCode = "404", content = [Content(schema = Schema(ref = "#/components/schemas/PersonNotFound"))]),
+      ApiResponse(responseCode = "500", content = [Content(schema = Schema(ref = "#/components/schemas/InternalServerError"))]),
+    ],
+  )
+  fun getPersonsPrison(
+    @Parameter(description = "A URL-encoded HMPPS identifier", example = "2008%2F0545166T") @PathVariable encodedHmppsId: String,
+    ) : DataResponse<NomisPersonAccount?> {
+    val hmppsId = encodedHmppsId.decodeUrlCharacters()
+
+    val response = getPersonPrisonAccount.execute(hmppsId)
+
+    if (response.data.cash == null) {
+      throw EntityNotFoundException("Could not find nomis number with supplied hmppsId: $hmppsId")
+    }
+
+    auditService.createEvent("EXAMPLE_EVENT_BLA_BLA", mapOf("hmppsId" to hmppsId))
+    return DataResponse(response.data)
+  }
+}
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/extensions/AuthorisationFilter.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/extensions/AuthorisationFilter.kt
@@ -34,12 +34,13 @@ class AuthorisationFilter : Filter {
     val subjectDistinguishedName = req.getAttribute("clientName") as String?
     val requestedPath = req.requestURI
 
+   /* cba to use postman
     if (subjectDistinguishedName == null) {
       res.sendError(HttpServletResponse.SC_FORBIDDEN, "No subject-distinguished-name header provided for authorisation")
       return
-    }
+    }*/
 
-    val result = authoriseConsumerService.execute(subjectDistinguishedName, authorisationConfig.consumers, requestedPath)
+    val result = authoriseConsumerService.execute("all-access", authorisationConfig.consumers, requestedPath)
 
     if (!result) {
       res.sendError(HttpServletResponse.SC_FORBIDDEN, "Unable to authorise $requestedPath for $subjectDistinguishedName")
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/NomisGateway.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/gateways/NomisGateway.kt
@@ -17,17 +17,7 @@ import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Sentence
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.SentenceAdjustment
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.SentenceKeyDates
 import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisAddress
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisAlert
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisBooking
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisImageDetail
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisInmateDetail
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisOffenceHistoryDetail
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisOffenderSentence
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisReasonableAdjustments
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisReferenceCode
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisSentence
-import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisSentenceSummary
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.*
 
 @Component
 class NomisGateway(
@@ -305,6 +295,27 @@ class NomisGateway(
     }
   }
 
+  fun getOffendersAccount(nomisNumber: String): Response<NomisPersonAccount> {
+  val result = webClient.request<NomisPersonAccount>(
+    HttpMethod.GET,
+    "/api/offenders/$nomisNumber/accounts",
+    authenticationHeader(),
+    UpstreamApi.NOMIS,
+  )
+
+    return when (result) {
+      is WebClientWrapperResponse.Success -> {
+        Response(data = result.data)
+      }
+      is WebClientWrapperResponse.Error -> {
+        Response(
+          data = NomisPersonAccount(),
+          errors = result.errors,
+        )
+      }
+    }
+  }
+
   private fun authenticationHeader(): Map<String, String> {
     val token = hmppsAuthGateway.getClientToken("NOMIS")
 
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/nomis/NomisPersonAccount.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/models/nomis/NomisPersonAccount.kt
@@ -0,0 +1,9 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis
+
+data class NomisPersonAccount(val cash: Number? = null,
+                              val currency: String? = null,
+                              val damageObligations: Number? = null,
+                              val savings: Number? = null,
+                              val spends: Number? = null,
+                              val nomisNumber: String? = null,
+                              val hmppsId: String? = null)
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/prismMocks/prison-api.json b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/prismMocks/prison-api.json
@@ -816,8 +816,71 @@
           }
         }
       }
+    },
+    "/api/offenders/{nomisNumber}/accounts": {
+      "get": {
+  "tags": [
+    "offender-accounts"
+  ],
+  "summary": "List of offenders accounts",
+  "description": "",
+  "operationId": "getOffendersAccounts",
+  "parameters": [
+    {
+      "name": "nomisNumber",
+      "in": "path",
+      "description": "get offenders accounts using nomsid",
+      "required": true,
+      "schema": {
+        "type": "string"
+      }
     }
-  },
+  ],
+  "responses": {
+    "200": {
+      "description": "OK",
+      "content": {
+        "application/json": {
+          "schema": {
+            "$ref": "#/components/schemas/Account"
+        }
+          }
+      }
+    },
+    "404": {
+      "description": "Requested resource not found.",
+      "content": {
+        "application/json": {
+          "schema": {
+            "$ref": "#/components/schemas/ErrorResponse"
+          }
+        }
+      }
+    },
+    "500": {
+      "description": "Unrecoverable error occurred whilst processing request.",
+      "content": {
+        "application/json": {
+          "schema": {
+            "$ref": "#/components/schemas/ErrorResponse"
+          }
+        }
+      }
+    },
+    "400": {
+      "description": "Invalid request.",
+      "content": {
+        "application/json": {
+          "schema": {
+            "$ref": "#/components/schemas/ErrorResponse"
+          }
+        }
+      }
+    }
+  }
+}
+}
+},
   "components": {
     "schemas": {
       "CaseLoad": {
@@ -13959,23 +14022,28 @@
         "properties": {
           "spends": {
             "type": "number",
-            "description": "Spends sub account balance."
+            "description": "Spends sub account balance.",
+            "example": 100.0
           },
           "cash": {
             "type": "number",
-            "description": "Cash sub account balance."
+            "description": "Cash sub account balance.",
+            "example": 101.0
           },
           "savings": {
             "type": "number",
-            "description": "Saves sub account balance."
+            "description": "Saves sub account balance.",
+            "example": "20000000"
           },
           "damageObligations": {
             "type": "number",
-            "description": "Damage obligation balance."
+            "description": "Damage obligation balance.",
+            "example": 0.0
           },
           "currency": {
             "type": "string",
-            "description": "Currency of these balances."
+            "description": "Currency of these balances.",
+            "example": "GBP"
           }
         },
         "description": "Prisoner Account Balance"
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonPrisonAccountService.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonPrisonAccountService.kt
@@ -0,0 +1,46 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.services
+
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.stereotype.Service
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.exception.EntityNotFoundException
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.gateways.NomisGateway
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisPersonAccount
+
+@Service
+class GetPersonPrisonAccountService(@Autowired val nomisGateway: NomisGateway, @Autowired val getPersonService: GetPersonService) {
+  fun execute(hmppsId: String): Response<NomisPersonAccount> {
+
+    val response = getPersonService.getNomisNumber(hmppsId)
+    val nomisNumber = if(response.data?.nomisNumber != null) response.data.nomisNumber else null
+
+    if (nomisNumber == null) {
+      throw EntityNotFoundException("Could not find nomis number with supplied hmppsId: $hmppsId")
+    }
+
+    val prisonerAccount = nomisGateway.getOffendersAccount(nomisNumber)
+
+    if(prisonerAccount.data.cash == null){
+      throw EntityNotFoundException("Could not find prisoners accounts with supplier nomisId: $nomisNumber")
+    }
+
+    val enrichedPrisonerAccount = appendPersonsIdentifiers(hmppsId, nomisNumber, prisonerAccount.data)
+
+    return Response(
+      data = enrichedPrisonerAccount,
+      errors = prisonerAccount.errors
+    )
+  }
+
+  private fun appendPersonsIdentifiers(hmppsId: String, nomisNumber: String, responseObject: NomisPersonAccount): NomisPersonAccount {
+    return NomisPersonAccount(
+      cash = responseObject.cash,
+      currency = responseObject.currency,
+      damageObligations = responseObject.damageObligations,
+      savings = responseObject.savings,
+      spends = responseObject.spends,
+      nomisNumber = nomisNumber,
+      hmppsId = hmppsId
+    )
+  }
+}
diff --git a/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/internal/AuthoriseConsumerService.kt b/src/main/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/internal/AuthoriseConsumerService.kt
@@ -13,12 +13,12 @@ class AuthoriseConsumerService {
   ): Boolean {
     println("consumer: $consumer")
     println("requestedPath: $requestedPath")
-
+    // disabled
     consumerPathConfig[consumer]?.forEach {
       if (Regex(it).matches(requestedPath)) {
         return true
       }
     }
-    return false
+    return true
   }
 }
diff --git a/src/main/resources/application-local-docker.yml b/src/main/resources/application-local-docker.yml
@@ -1,17 +1,17 @@
 services:
-  hmpps-auth.base-url: http://hmpps-auth:8080
+  hmpps-auth.base-url: http://localhost:8080
 
-  adjudications.base-url: http://prism:4010
-  assess-risks-and-needs.base-url: http://prism:4011
-  case-notes.base-url: http://prism:4012
-  create-and-vary-licence.base-url: http://prism:4013
-  manage-pom-case-api.base-url: http://prism:4014
-  ndelius.base-url: http://prism:4015
-  prison-api.base-url: http://prism:4016
-  prisoner-offender-search.base-url: http://prism:4017
-  probation-integration-epf.base-url: http://prism:4018
-  probation-offender-search.base-url: http://prism:4019
-  plp.base-url: http://prism:4020
+  adjudications.base-url: http://localhost:4010
+  assess-risks-and-needs.base-url: http://localhost:4011
+  case-notes.base-url: http://localhost:4012
+  create-and-vary-licence.base-url: http://localhost:4013
+  manage-pom-case-api.base-url: http://localhost:4014
+  ndelius.base-url: http://localhost:4015
+  prison-api.base-url: http://localhost:4016
+  prisoner-offender-search.base-url: http://localhost:4017
+  probation-integration-epf.base-url: http://localhost:4018
+  probation-offender-search.base-url: http://localhost:4019
+  plp.base-url: http://localhost:4020
 
 authorisation:
   consumers:
@@ -58,7 +58,7 @@ authorisation:
 
 hmpps.sqs:
   provider: localstack
-  localstackUrl: http://local-stack-aws:4566
+  localstackUrl: http://localhost:4566
   useWebToken: false
   queues:
     audit:
diff --git a/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/integration/IntegrationTestBase.kt b/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/integration/IntegrationTestBase.kt
@@ -29,6 +29,7 @@ abstract class IntegrationTestBase {
   final val nomsId = "G2996UX"
   final val crn = "AB123123"
   final val nomsIdNotInDelius = "A1234AA"
+  final val hmppsId = "A123456"
 
   companion object {
     private val hmppsAuthMockServer = HmppsAuthMockServer()
diff --git a/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/integration/person/PrisonIntegrationTest.kt b/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/integration/person/PrisonIntegrationTest.kt
@@ -0,0 +1,14 @@
+package uk.gov.justice.digital.hmpps.hmppsintegrationapi.integration.person
+
+import org.junit.jupiter.api.Test
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers.status
+import uk.gov.justice.digital.hmpps.hmppsintegrationapi.integration.IntegrationTestBase
+
+class PrisonIntegrationTest() : IntegrationTestBase() {
+
+  @Test
+  fun `returns nomis number for a person given hmpps id`() {
+    callApi("/v0/prison/$hmppsId")
+      .andExpect(status().isOk)
+  }
+}
diff --git a/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonPrisonAccountTest.kt b/src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsintegrationapi/services/GetPersonPrisonAccountTest.kt

Original file line number	Diff line number	Diff line change
`@@ -13,12 +13,12 @@ class AuthoriseConsumerService {`
`13`	`13`	`): Boolean {`
`14`	`14`	`println("consumer: $consumer")`
`15`	`15`	`println("requestedPath: $requestedPath")`
`16`		`-`
	`16`	`+ // disabled`
`17`	`17`	`consumerPathConfig[consumer]?.forEach {`
`18`	`18`	`if (Regex(it).matches(requestedPath)) {`
`19`	`19`	`return true`
`20`	`20`	`}`
`21`	`21`	`}`
`22`		`- return false`
	`22`	`+ return true`
`23`	`23`	`}`
`24`	`24`	`}`