Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HMAI-105 Implement /{clientUniqueRef}/transactions #579

Merged
merged 6 commits into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ 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.responses.ApiResponse
import io.swagger.v3.oas.annotations.tags.Tag
import jakarta.validation.ValidationException
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.web.bind.annotation.GetMapping
Expand All @@ -14,18 +15,22 @@ import org.springframework.web.bind.annotation.RequestParam
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.Transaction
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Transactions
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApiError
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.roleconfig.ConsumerFilters
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetTransactionForPersonService
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.GetTransactionsForPersonService
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.services.internal.AuditService
import java.time.LocalDate

@RestController
@RequestMapping("/v1/prison/{prisonId}/prisoners/{hmppsId}/accounts/{accountCode}/transactions")
@RequestMapping("/v1/prison/{prisonId}/prisoners/{hmppsId}")
@Tag(name = "prison")
class TransactionsController(
@Autowired val auditService: AuditService,
@Autowired val getTransactionsForPersonService: GetTransactionsForPersonService,
@Autowired val getTransactionForPersonService: GetTransactionForPersonService,
) {
@Operation(
summary = "Returns all transactions for a prisoner associated with an account code that they have at a prison.",
Expand Down Expand Up @@ -65,7 +70,7 @@ class TransactionsController(
),
],
)
@GetMapping()
@GetMapping("/accounts/{accountCode}/transactions")
fun getTransactionsByAccountCode(
@PathVariable hmppsId: String,
@PathVariable prisonId: String,
Expand Down Expand Up @@ -99,4 +104,63 @@ class TransactionsController(
auditService.createEvent("GET_TRANSACTIONS_FOR_PERSON", mapOf("hmppsId" to hmppsId, "prisonId" to prisonId, "fromDate" to fromDate, "toDate" to toDate))
return DataResponse(response.data)
}

@Operation(
summary = "Get transaction by clientUniqueRef.",
description = "<b>Applicable filters</b>: <ul><li>prisons</li></ul>",
responses = [
ApiResponse(responseCode = "200", useReturnTypeSchema = true, description = "Successfully found a transaction."),
ApiResponse(
responseCode = "400",
description = "The request data has an invalid format or the prisoner does not have transaction associated with the clientUniqueRef.",
content = [
Content(
schema =
io.swagger.v3.oas.annotations.media
.Schema(ref = "#/components/schemas/BadRequest"),
),
],
),
ApiResponse(
responseCode = "404",
content = [
Content(
schema =
io.swagger.v3.oas.annotations.media
.Schema(ref = "#/components/schemas/PersonNotFound"),
),
],
),
ApiResponse(
responseCode = "500",
content = [
Content(
schema =
io.swagger.v3.oas.annotations.media
.Schema(ref = "#/components/schemas/InternalServerError"),
),
],
),
],
)
@GetMapping("/transactions/{clientUniqueRef}")
fun getTransactionsByClientUniqueRef(
@PathVariable prisonId: String,
@PathVariable hmppsId: String,
@PathVariable clientUniqueRef: String,
@RequestAttribute filters: ConsumerFilters?,
): DataResponse<Transaction?> {
val response = getTransactionForPersonService.execute(hmppsId, prisonId, clientUniqueRef, filters)

if (response.hasError(UpstreamApiError.Type.ENTITY_NOT_FOUND)) {
throw EntityNotFoundException("Could not find transaction with id: $hmppsId")
}

if (response.hasError(UpstreamApiError.Type.BAD_REQUEST)) {
throw ValidationException("Either invalid HMPPS ID: $hmppsId at or incorrect prison: $prisonId")
}

auditService.createEvent("GET_TRANSACTION_FOR_PERSON", mapOf("hmppsId" to hmppsId, "prisonId" to prisonId, "clientUniqueRef" to clientUniqueRef))
return DataResponse(response.data)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.RiskCategor
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.Transaction
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Transactions
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.UpstreamApi
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.nomis.NomisAccounts
Expand Down Expand Up @@ -364,6 +365,32 @@ class NomisGateway(
}
}

fun getTransactionForPerson(
prisonId: String,
nomisNumber: String,
clientUniqueRef: String,
): Response<Transaction?> {
val result =
webClient.request<Transaction>(
HttpMethod.GET,
"/api/v1/prison/$prisonId/offenders/$nomisNumber/transactions/$clientUniqueRef",
authenticationHeader(),
UpstreamApi.NOMIS,
)
return when (result) {
is WebClientWrapperResponse.Success -> {
Response(data = result.data)
}

is WebClientWrapperResponse.Error -> {
Response(
data = null,
errors = result.errors,
)
}
}
}

private fun authenticationHeader(): Map<String, String> {
val token = hmppsAuthGateway.getClientToken("NOMIS")

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
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.gateways.NomisGateway
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Response
import uk.gov.justice.digital.hmpps.hmppsintegrationapi.models.hmpps.Transaction
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.roleconfig.ConsumerFilters

@Service
class GetTransactionForPersonService(
@Autowired val nomisGateway: NomisGateway,
@Autowired val getPersonService: GetPersonService,
) {
fun execute(
hmppsId: String,
prisonId: String,
clientUniqueRef: String,
filters: ConsumerFilters? = null,
): Response<Transaction?> {
if (
filters != null && !filters.matchesPrison(prisonId)
) {
return Response(
data = null,
errors = listOf(UpstreamApiError(UpstreamApi.NOMIS, UpstreamApiError.Type.ENTITY_NOT_FOUND, "Not found")),
)
}

val personResponse = getPersonService.getNomisNumber(hmppsId = hmppsId)

if (personResponse == null) {
return Response(
data = null,
errors = listOf(UpstreamApiError(UpstreamApi.NOMIS, UpstreamApiError.Type.ENTITY_NOT_FOUND, "Nomis number not found")),
)
}

val nomisNumber = personResponse.data?.nomisNumber

if (nomisNumber == null) {
return Response(
data = null,
errors = personResponse.errors,
)
}

val nomisTransaction =
nomisGateway.getTransactionForPerson(
prisonId,
nomisNumber,
clientUniqueRef,
)

if (nomisTransaction.errors.isNotEmpty()) {
return Response(
data = null,
errors = nomisTransaction.errors,
)
}

return Response(
data = nomisTransaction.data,
errors = emptyList(),
)
}
}
2 changes: 2 additions & 0 deletions src/main/resources/application-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ authorisation:
- "/v1/prison/.*/prisoners/[^/]*/balances$"
- "/v1/prison/.*/prisoners/.*/accounts/.*/balances"
- "/v1/prison/.*/prisoners/.*/accounts/.*/transactions"
- "/v1/prison/.*/prisoners/.*/transactions/[^/]*$"
filters:
kilco:
include:
Expand All @@ -141,6 +142,7 @@ authorisation:
- "/v1/prison/.*/prisoners/[^/]*/balances$"
- "/v1/prison/.*/prisoners/.*/accounts/.*/balances"
- "/v1/prison/.*/prisoners/.*/accounts/.*/transactions"
- "/v1/prison/.*/prisoners/.*/transactions/[^/]*$"
filters:
meganexus:
include:
Expand Down
2 changes: 2 additions & 0 deletions src/main/resources/application-integration-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ authorisation:
- "/v1/prison/.*/prisoners/[^/]*/balances$"
- "/v1/prison/.*/prisoners/.*/accounts/.*/balances"
- "/v1/prison/.*/prisoners/.*/accounts/.*/transactions"
- "/v1/prison/.*/prisoners/.*/transactions/[^/]*$"
filters:
config-test:
include:
Expand All @@ -100,6 +101,7 @@ authorisation:
include:
- "/v1/prison/prisoners/[^/]*$"
- "/v1/prison/.*/prisoners/.*/accounts/.*/transactions"
- "/v1/prison/.*/prisoners/.*/transactions/[^/]*$"
filters:
prisons:
- ABC
Expand Down
1 change: 1 addition & 0 deletions src/main/resources/application-local-docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ authorisation:
- "/v1/prison/.*/prisoners/[^/]*/balances$"
- "/v1/prison/.*/prisoners/.*/accounts/.*/balances"
- "/v1/prison/.*/prisoners/.*/accounts/.*/transactions"
- "/v1/prison/.*/prisoners/.*/transactions/[^/]*$"
filters:
config-test:
include:
Expand Down
1 change: 1 addition & 0 deletions src/main/resources/application-local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ authorisation:
- "/v1/prison/.*/prisoners/[^/]*/balances$"
- "/v1/prison/.*/prisoners/.*/accounts/.*/balances"
- "/v1/prison/.*/prisoners/.*/accounts/.*/transactions"
- "/v1/prison/.*/prisoners/.*/transactions/[^/]*$"
filters:
config-test:
include:
Expand Down
1 change: 1 addition & 0 deletions src/main/resources/application-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ authorisation:
- "/v1/prison/.*/prisoners/[^/]*/balances$"
- "/v1/prison/.*/prisoners/.*/accounts/.*/balances"
- "/v1/prison/.*/prisoners/.*/accounts/.*/transactions"
- "/v1/prison/.*/prisoners/.*/transactions/[^/]*$"
config-test:
include:
- "/v1/config/authorisation"
Expand Down
Loading
Loading