artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 16:16:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

feature/OBPv500 tweaked the create/get ConsentRequest endpoints

Browse Source
This commit is contained in:
hongwei 2022-06-27 15:21:49 +02:00
parent 0722ed84e2
commit 7f3b3451c9
6 changed files with 116 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
obp-api/src/main/scala/code/api/ResourceDocs1_4_0/SwaggerDefinitionsJSON.scala
View File

@ -4672,6 +4672,20 @@ object SwaggerDefinitionsJSON {
consent_request_id = Some(consentRequestIdExample.value)
)
val postConsentRequestJsonV500 = PostConsentRequestJsonV500(
everything = false,
account_access = List(AccountAccessV500(
account_routing = accountRoutingJsonV121,
view_id = viewIdExample.value
)),
entitlements = Some(List(PostConsentEntitlementJsonV310(bankIdExample.value, "CanGetCustomer"))),
consumer_id = Some(consumerIdExample.value),
phone_number = Some(mobileNumberExample.value),
email = Some(emailExample.value),
valid_from = Some(new Date()),
time_to_live = Some(3600)
)
//The common error or success format.
//Just some helper format to use in Json
case class NotSupportedYet()

12
obp-api/src/main/scala/code/api/util/ExampleValue.scala
View File

@ -1459,9 +1459,15 @@ object ExampleValue {
glossaryItems += makeGlossaryItem("consent_id", consentIdExample)
lazy val consentRequestPayloadExample = ConnectorField(
"""{"everything":false,"views":[{"bank_id":"gh.29.uk",
|"account_id":"8ca8a7e4-6d02-40e3-a129-0b2bf89de9f0","view_id":"owner"}],
|"entitlements":[{"bank_id":"gh.29.uk","role_name":"CanGetCustomer"}],
"""{
|"everything":false,
| "account_routing": {
| "scheme": "AccountNumber",
| "address": "4930396"
| },
| "view_id": "owner"
|}],
|"entitlements":[],
|"phone_number":"+44 07972 444 876",
|"valid_from":"2022-06-14T12:42:00Z",
|"time_to_live":3600

99
obp-api/src/main/scala/code/api/v5_0_0/APIMethods500.scala
View File

@ -7,7 +7,7 @@ import code.api.util.ApiTag._
import code.api.util.ErrorMessages._
import code.api.util.{APIUtil, ApiRole, Consent, NewStyle}
import code.api.util.NewStyle.HttpCode
import code.api.v3_1_0.{PostConsentBodyCommonJson, PostConsentEmailJsonV310, PostConsentPhoneJsonV310, PostUserAuthContextJson, PostUserAuthContextUpdateJsonV310}
import code.api.v3_1_0.{PostConsentBodyCommonJson, PostConsentEmailJsonV310, PostConsentEntitlementJsonV310, PostConsentPhoneJsonV310, PostConsentViewJsonV310, PostUserAuthContextJson, PostUserAuthContextUpdateJsonV310}
import code.bankconnectors.Connector
import code.consent.{ConsentRequests, Consents}
import code.entitlement.Entitlement
@ -238,10 +238,10 @@ trait APIMethods500 {
implementedInApiVersion,
nameOf(createConsentRequest),
"POST",
"/banks/BANK_ID/consent-requests",
"/consumer/consent-requests",
"Create Consent Request",
s"""""",
postConsentRequestJsonV310,
postConsentRequestJsonV500,
consentRequestResponseJson,
List(
$BankNotFound,
@ -253,14 +253,14 @@ trait APIMethods500 {
)
lazy val createConsentRequest : OBPEndpoint = {
case "banks" :: BankId(bankId) :: "consent-requests" :: Nil JsonPost json -> _ => {
case "consumer" :: "consent-requests" :: Nil JsonPost json -> _ => {
cc =>
for {
(_, callContext) <- applicationAccess(cc)
_ <- passesPsd2Aisp(callContext)
failMsg = s"$InvalidJsonFormat The Json body should be the $PostConsentBodyCommonJson "
consentJson: PostConsentBodyCommonJson <- NewStyle.function.tryons(failMsg, 400, callContext) {
json.extract[PostConsentBodyCommonJson]
consentJson: PostConsentRequestJsonV500 <- NewStyle.function.tryons(failMsg, 400, callContext) {
json.extract[PostConsentRequestJsonV500]
}
maxTimeToLive = APIUtil.getPropsAsIntValue(nameOfProperty="consents.max_time_to_live", defaultValue=3600)
_ <- Helper.booleanToFuture(s"$ConsentMaxTTL ($maxTimeToLive)", cc=callContext){
@ -293,7 +293,7 @@ trait APIMethods500 {
implementedInApiVersion,
nameOf(getConsentRequest),
"GET",
"/banks/BANK_ID/consent-requests/CONSENT_REQUEST_ID",
"/consumer/consent-requests/CONSENT_REQUEST_ID",
"Get Consent Request",
s"""""",
EmptyBody,
@ -307,7 +307,7 @@ trait APIMethods500 {
)
lazy val getConsentRequest : OBPEndpoint = {
case "banks" :: BankId(bankId) ::"consent-requests" :: consentRequestId :: Nil JsonGet _ => {
case "consumer" :: "consent-requests" :: consentRequestId :: Nil JsonGet _ => {
cc =>
for {
(_, callContext) <- applicationAccess(cc)
@ -334,7 +334,7 @@ trait APIMethods500 {
implementedInApiVersion,
nameOf(getConsentByConsentRequestId),
"GET",
"/banks/BANK_ID/consents/consent-requests/CONSENT_REQUEST_ID",
"/consumer/consent-requests/CONSENT_REQUEST_ID/consents",
"Get Consent By Consent Request Id",
s"""
|
@ -347,12 +347,11 @@ trait APIMethods500 {
consentJsonV500,
List(
$UserNotLoggedIn,
$BankNotFound,
UnknownError
),
List(apiTagConsent, apiTagPSD2AIS, apiTagPsd2, apiTagNewStyle))
lazy val getConsentByConsentRequestId: OBPEndpoint = {
case "banks" :: BankId(bankId) :: "consents" :: "consent-requests" :: consentRequestId :: Nil JsonGet _ => {
case "consumer" :: "consent-requests" :: consentRequestId :: "consents" :: Nil JsonGet _ => {
cc =>
for {
(_, callContext) <- applicationAccess(cc)
@ -378,7 +377,7 @@ trait APIMethods500 {
implementedInApiVersion,
nameOf(createConsentByConsentRequestIdEmail),
"POST",
"/banks/BANK_ID/consents/consent-requests/CONSENT_REQUEST_ID/EMAIL",
"/consumer/consent-requests/CONSENT_REQUEST_ID/EMAIL/consents",
"Create Consent By Request Id(EMAIL)",
s"""
|
@ -405,7 +404,7 @@ trait APIMethods500 {
implementedInApiVersion,
nameOf(createConsentByConsentRequestIdSms),
"POST",
"/banks/BANK_ID/consents/consent-requests/CONSENT_REQUEST_ID/SMS",
"/consumer/consent-requests/CONSENT_REQUEST_ID/SMS/consents",
"Create Consent By Request Id (SMS)",
s"""
|
@ -434,7 +433,7 @@ trait APIMethods500 {
lazy val createConsentByConsentRequestIdSms = createConsentByConsentRequestId
lazy val createConsentByConsentRequestId : OBPEndpoint = {
case "banks" :: BankId(bankId) :: "consents" :: "consent-requests":: consentRequestId :: scaMethod :: Nil JsonPost _ -> _ => {
case "consumer" :: "consent-requests":: consentRequestId :: scaMethod :: "consents" :: Nil JsonPost _ -> _ => {
cc =>
for {
(Full(user), callContext) <- authenticatedAccess(cc)
@ -450,17 +449,17 @@ trait APIMethods500 {
List(StrongCustomerAuthentication.SMS.toString(), StrongCustomerAuthentication.EMAIL.toString()).exists(_ == scaMethod)
}
failMsg = s"$InvalidJsonFormat The Json body should be the $PostConsentBodyCommonJson "
consentJson <- NewStyle.function.tryons(failMsg, 400, callContext) {
json.parse(createdConsentRequest.payload).extract[PostConsentBodyCommonJson].copy(consent_request_id = Some(createdConsentRequest.consentRequestId))
consentRequestJson <- NewStyle.function.tryons(failMsg, 400, callContext) {
json.parse(createdConsentRequest.payload).extract[PostConsentRequestJsonV500]
}
maxTimeToLive = APIUtil.getPropsAsIntValue(nameOfProperty="consents.max_time_to_live", defaultValue=3600)
_ <- Helper.booleanToFuture(s"$ConsentMaxTTL ($maxTimeToLive)", cc=callContext){
consentJson.time_to_live match {
consentRequestJson.time_to_live match {
case Some(ttl) => ttl <= maxTimeToLive
case _ => true
}
}
requestedEntitlements = consentJson.entitlements
requestedEntitlements = consentRequestJson.entitlements.getOrElse(Nil)
myEntitlements <- Entitlement.entitlement.vend.getEntitlementsByUserIdFuture(user.userId)
_ <- Helper.booleanToFuture(RolesAllowedInConsent, cc=callContext){
requestedEntitlements.forall(
@ -469,10 +468,22 @@ trait APIMethods500 {
)
)
}
requestedViews = consentJson.views
postConsentViewJsons <- Future.sequence(
consentRequestJson.account_access.map(
access =>
NewStyle.function.getBankAccountByRouting(None,access.account_routing.scheme, access.account_routing.address, cc.callContext)
.map(result =>PostConsentViewJsonV310(
result._1.bankId.value,
result._1.accountId.value,
access.view_id
))
)
)
(_, assignedViews) <- Future(Views.views.vend.privateViewsUserCanAccess(user))
_ <- Helper.booleanToFuture(ViewsAllowedInConsent, cc=callContext){
requestedViews.forall(
postConsentViewJsons.forall(
rv => assignedViews.exists{
e =>
e.view_id == rv.view_id &&
@ -481,38 +492,39 @@ trait APIMethods500 {
}
)
}
(consumerId, applicationText) <- consentJson.consumer_id match {
(consumerId, applicationText) <- consentRequestJson.consumer_id match {
case Some(id) => NewStyle.function.checkConsumerByConsumerId(id, callContext) map {
c => (Some(c.consumerId.get), c.description)
}
case None => Future(None, "Any application")
}
_ <- Helper.booleanToFuture(ConsentRequestNotFound, cc=callContext){
consentJson.consent_request_id match {
case Some(id) => //If it is existing in Json, we need to check it from database.
ConsentRequests.consentRequestProvider.vend.getConsentRequestById(id).isDefined
case None => //If it is not, just pass
true
}
}
challengeAnswer = Props.mode match {
case Props.RunModes.Test => Consent.challengeAnswerAtTestEnvironment
case _ => Random.nextInt(99999999).toString()
}
createdConsent <- Future(Consents.consentProvider.vend.createObpConsent(user, challengeAnswer, consentJson.consent_request_id)) map {
createdConsent <- Future(Consents.consentProvider.vend.createObpConsent(user, challengeAnswer, Some(consentRequestId))) map {
i => connectorEmptyResponse(i, callContext)
}
consentJWT =
Consent.createConsentJWT(
postConsentBodyCommonJson = PostConsentBodyCommonJson(
everything = consentRequestJson.everything,
views = postConsentViewJsons,
entitlements = consentRequestJson.entitlements.getOrElse(Nil),
consumer_id = consentRequestJson.consumer_id,
consent_request_id = Some(consentRequestId),
valid_from = consentRequestJson.valid_from,
time_to_live = consentRequestJson.time_to_live,
)
consentJWT = Consent.createConsentJWT(
user,
consentJson,
postConsentBodyCommonJson,
createdConsent.secret,
createdConsent.consentId,
consumerId,
consentJson.valid_from,
consentJson.time_to_live.getOrElse(3600)
postConsentBodyCommonJson.valid_from,
postConsentBodyCommonJson.time_to_live.getOrElse(3600)
)
_ <- Future(Consents.consentProvider.vend.setJsonWebToken(createdConsent.consentId, consentJWT)) map {
i => connectorEmptyResponse(i, callContext)
@ -522,12 +534,12 @@ trait APIMethods500 {
case v if v == StrongCustomerAuthentication.EMAIL.toString => // Send the email
for{
failMsg <- Future {s"$InvalidJsonFormat The Json body should be the $PostConsentEmailJsonV310"}
postConsentEmailJson <- NewStyle.function.tryons(failMsg, 400, callContext) {
json.parse(createdConsentRequest.payload).extract[PostConsentEmailJsonV310]
consentScaEmail <- NewStyle.function.tryons(failMsg, 400, callContext) {
consentRequestJson.email.head
}
(Full(status), callContext) <- Connector.connector.vend.sendCustomerNotification(
StrongCustomerAuthentication.EMAIL,
postConsentEmailJson.email,
consentScaEmail,
Some("OBP Consent Challenge"),
challengeText,
callContext
@ -538,13 +550,12 @@ trait APIMethods500 {
failMsg <- Future {
s"$InvalidJsonFormat The Json body should be the $PostConsentPhoneJsonV310"
}
postConsentPhoneJson <- NewStyle.function.tryons(failMsg, 400, callContext) {
json.parse(createdConsentRequest.payload).extract[PostConsentPhoneJsonV310]
consentScaPhoneNumber <- NewStyle.function.tryons(failMsg, 400, callContext) {
consentRequestJson.phone_number.head
}
phoneNumber = postConsentPhoneJson.phone_number
(Full(status), callContext) <- Connector.connector.vend.sendCustomerNotification(
StrongCustomerAuthentication.SMS,
phoneNumber,
consentScaPhoneNumber,
None,
challengeText,
callContext

24
obp-api/src/main/scala/code/api/v5_0_0/JSONFactory5.0.0.scala
View File

@ -26,10 +26,12 @@
*/
package code.api.v5_0_0
import com.openbankproject.commons.model.{UserAuthContext, UserAuthContextUpdate}
import net.liftweb.json.JsonAST.{JValue}
import code.api.v3_1_0.{PostConsentEntitlementJsonV310}
import com.openbankproject.commons.model.{AccountRoutingJsonV121, UserAuthContext, UserAuthContextUpdate}
import net.liftweb.json.JsonAST.JValue
import java.util.Date
import scala.collection.immutable.List
case class UserAuthContextJsonV500(
user_auth_context_id: String,
@ -61,6 +63,24 @@ case class ConsentRequestResponseJson(
payload : JValue,
consumer_id : String
)
case class AccountAccessV500(
// bank_routing: Option[BankRoutingJsonV121],
// branch_routing: Option[BranchRoutingJsonV141],
account_routing: AccountRoutingJsonV121,
view_id: String
)
case class PostConsentRequestJsonV500(
everything: Boolean,
account_access: List[AccountAccessV500],
entitlements: Option[List[PostConsentEntitlementJsonV310]],
consumer_id: Option[String],
email: Option[String],
phone_number: Option[String],
valid_from: Option[Date],
time_to_live: Option[Long]
)
case class ConsentJsonV500(consent_id: String, jwt: String, status: String, consent_request_id: Option[String])
object JSONFactory500 {

25
obp-api/src/test/scala/code/api/v5_0_0/ConsentRequestTest.scala
View File

@ -35,7 +35,7 @@ import code.api.v5_0_0.OBPAPI5_0_0.Implementations5_0_0
import code.consent.ConsentStatus
import code.entitlement.Entitlement
import com.github.dwickern.macros.NameOf.nameOf
import com.openbankproject.commons.model.{ErrorMessage}
import com.openbankproject.commons.model.{AccountRoutingJsonV121, ErrorMessage}
import com.openbankproject.commons.util.ApiVersion
import net.liftweb.json.Serialization.write
import org.scalatest.Tag
@ -53,22 +53,25 @@ class ConsentRequestTest extends V500ServerSetupAsync {
*/
object VersionOfApi extends Tag(ApiVersion.v5_0_0.toString)
object ApiEndpoint1 extends Tag(nameOf(Implementations5_0_0.createConsentRequest))
object ApiEndpoint2 extends Tag(nameOf(Implementations5_0_0.getConsentRequest))
object ApiEndpoint2 extends Tag(nameOf(Implementations5_0_0.getConsentByConsentRequestId))
object ApiEndpoint3 extends Tag(nameOf(Implementations5_0_0.createConsentByConsentRequestId))
object ApiEndpoint4 extends Tag(nameOf(Implementations5_0_0.getConsentByConsentRequestId))
lazy val entitlements = List(PostConsentEntitlementJsonV310("", CanGetAnyUser.toString()))
lazy val views = List(PostConsentViewJsonV310(testBankId1.value,testAccountId1.value, "owner"))
lazy val postConsentRequestJsonV310 = SwaggerDefinitionsJSON.postConsentEmailJsonV310
.copy(entitlements=entitlements)
lazy val accountAccess = List(AccountAccessV500(
account_routing = AccountRoutingJsonV121(
scheme = "AccountId",
address = testAccountId1.value), "owner"))
lazy val postConsentRequestJsonV310 = SwaggerDefinitionsJSON.postConsentRequestJsonV500
.copy(entitlements=Some(entitlements))
.copy(consumer_id=None)
.copy(views=views)
.copy(account_access=accountAccess)
val createConsentRequestWithoutLoginUrl = (v5_0_0_Request / "banks" / testBankId1.value / "consent-requests")
val createConsentRequestUrl = (v5_0_0_Request / "banks" / testBankId1.value / "consent-requests").POST<@(user1)
def getConsentRequestUrl(requestId:String) = (v5_0_0_Request / "banks" / testBankId1.value / "consent-requests"/requestId).GET<@(user1)
def createConsentByRequestIdUrl(requestId:String) = (v5_0_0_Request / "banks" / testBankId1.value /"consents"/ "consent-requests"/requestId/"EMAIL").POST<@(user1)
def getConsentByRequestIdUrl(requestId:String) = (v5_0_0_Request / "banks" / testBankId1.value /"consents"/ "consent-requests"/requestId).GET<@(user1)
val createConsentRequestWithoutLoginUrl = (v5_0_0_Request / "consumer" / "consent-requests")
val createConsentRequestUrl = (v5_0_0_Request / "consumer"/ "consent-requests").POST<@(user1)
def getConsentRequestUrl(requestId:String) = (v5_0_0_Request / "consumer"/ "consent-requests"/requestId).GET<@(user1)
def createConsentByRequestIdUrl(requestId:String) = (v5_0_0_Request / "consumer"/ "consent-requests"/requestId/"EMAIL"/"consents").POST<@(user1)
def getConsentByRequestIdUrl(requestId:String) = (v5_0_0_Request / "consumer"/ "consent-requests"/requestId/"consents").GET<@(user1)
feature("Create/Get Consent Request v5.0.0") {
scenario("We will call the Create endpoint without a user credentials", ApiEndpoint1, VersionOfApi) {

4
obp-api/src/test/scala/code/setup/LocalMappedConnectorTestSetup.scala
View File

@ -71,8 +71,8 @@ trait LocalMappedConnectorTestSetup extends TestConnectorSetupWithStandardPermis
BankAccountRouting.create
.BankId(bankId.value)
.AccountId(accountId.value)
.AccountRoutingScheme(randomString(4))
.AccountRoutingAddress(randomString(4))
.AccountRoutingScheme("AccountId")
.AccountRoutingAddress(accountId.value)
.saveMe
MappedBankAccount.create
.bank(bankId.value)