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

Merge pull request #2210 from constantine2nd/develop

Browse Source 
ATM attributes
This commit is contained in:
Simon Redfern 2023-03-31 10:37:07 +02:00 committed by GitHub
commit faaa71b8ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 983 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
obp-api/src/main/scala/bootstrap/liftweb/Boot.scala
View File

@ -50,6 +50,7 @@ import code.api.util.migration.Migration
import code.api.util.migration.Migration.DbFunction
import code.apicollection.ApiCollection
import code.apicollectionendpoint.ApiCollectionEndpoint
import code.atmattribute.AtmAttribute
import code.atms.MappedAtm
import code.authtypevalidation.AuthenticationTypeValidation
import code.bankattribute.BankAttribute
@ -1010,6 +1011,7 @@ object ToSchemify {
// The following tables are accessed directly via Mapper / JDBC
val models: List[MetaMapper[_]] = List(
AuthUser,
AtmAttribute,
Admin,
MappedBank,
MappedBankAccount,

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

@ -36,7 +36,7 @@ import com.openbankproject.commons.util.{ApiVersion, FieldNameApiVersions, Refle
import net.liftweb.json
import java.net.URLEncoder
import code.api.v5_1_0.CertificateInfoJsonV510
import code.api.v5_1_0.{AtmAttributeJsonV510, AtmAttributeResponseJsonV510, CertificateInfoJsonV510, CurrenciesJsonV510, CurrencyJsonV510}
import code.endpointMapping.EndpointMappingCommons
import scala.collection.immutable.List
@ -3050,6 +3050,8 @@ object SwaggerDefinitionsJSON {
inverse_conversion_value = 0.998,
effective_date = DateWithDayExampleObject
)
val currenciesJsonV510 = CurrenciesJsonV510(currencies = List(CurrencyJsonV510(alphanumeric_code = "EUR")))
val counterpartyJsonV220 = CounterpartyJsonV220(
name = postCounterpartyJSON.name,
@ -3997,6 +3999,12 @@ object SwaggerDefinitionsJSON {
value = "12345678",
is_active = Some(true)
)
val atmAttributeJsonV510 = AtmAttributeJsonV510(
name = "TAX_ID",
`type` = "INTEGER",
value = "12345678",
is_active = Some(true)
)
val bankAttributeResponseJsonV400 = BankAttributeResponseJsonV400(
bank_id = bankIdExample.value,
bank_attribute_id = "613c83ea-80f9-4560-8404-b9cd4ec42a7f",
@ -4005,6 +4013,15 @@ object SwaggerDefinitionsJSON {
value = "2012-04-23",
is_active = Some(true)
)
val atmAttributeResponseJsonV510 = AtmAttributeResponseJsonV510(
bank_id = bankIdExample.value,
atm_id = atmIdExample.value,
atm_attribute_id = "613c83ea-80f9-4560-8404-b9cd4ec42a7f",
name = "OVERDRAFT_START_DATE",
`type` = "DATE_WITH_DAY",
value = "2012-04-23",
is_active = Some(true)
)
val accountAttributeJson = AccountAttributeJson(

18
obp-api/src/main/scala/code/api/util/ApiRole.scala
View File

@ -474,10 +474,16 @@ object ApiRole {
lazy val canUpdateProductAttribute = CanUpdateProductAttribute()
case class CanUpdateBankAttribute(requiresBankId: Boolean = true) extends ApiRole
lazy val canUpdateBankAttribute = CanUpdateBankAttribute()
lazy val canUpdateBankAttribute = CanUpdateBankAttribute()
case class CanUpdateAtmAttribute(requiresBankId: Boolean = true) extends ApiRole
lazy val canUpdateAtmAttribute = CanUpdateAtmAttribute()
case class CanGetBankAttribute(requiresBankId: Boolean = true) extends ApiRole
lazy val canGetBankAttribute = CanGetBankAttribute()
lazy val canGetBankAttribute = CanGetBankAttribute()
case class CanGetAtmAttribute(requiresBankId: Boolean = true) extends ApiRole
lazy val canGetAtmAttribute = CanGetAtmAttribute()
case class CanGetProductAttribute(requiresBankId: Boolean = true) extends ApiRole
lazy val canGetProductAttribute = CanGetProductAttribute()
@ -486,13 +492,19 @@ object ApiRole {
lazy val canDeleteProductAttribute = CanDeleteProductAttribute()
case class CanDeleteBankAttribute(requiresBankId: Boolean = true) extends ApiRole
lazy val canDeleteBankAttribute = CanDeleteBankAttribute()
lazy val canDeleteBankAttribute = CanDeleteBankAttribute()
case class CanDeleteAtmAttribute(requiresBankId: Boolean = true) extends ApiRole
lazy val canDeleteAtmAttribute = CanDeleteAtmAttribute()
case class CanCreateProductAttribute(requiresBankId: Boolean = true) extends ApiRole
lazy val canCreateProductAttribute = CanCreateProductAttribute()
case class CanCreateBankAttribute(requiresBankId: Boolean = true) extends ApiRole
lazy val canCreateBankAttribute = CanCreateBankAttribute()
case class CanCreateAtmAttribute(requiresBankId: Boolean = true) extends ApiRole
lazy val canCreateAtmAttribute = CanCreateAtmAttribute()
case class CanUpdateProductFee(requiresBankId: Boolean = true) extends ApiRole
lazy val canUpdateProductFee = CanUpdateProductFee()

67
obp-api/src/main/scala/code/api/util/NewStyle.scala
View File

@ -3,6 +3,7 @@ package code.api.util
import java.util.Date
import java.util.UUID.randomUUID
import akka.http.scaladsl.model.HttpMethod
import code.DynamicEndpoint.{DynamicEndpointProvider, DynamicEndpointT}
import code.api.{APIFailureNewStyle, Constant, JsonResponseException}
@ -67,6 +68,7 @@ import code.api.dynamic.endpoint.helper.DynamicEndpointHelper
import code.api.v4_0_0.JSONFactory400
import code.api.dynamic.endpoint.helper.DynamicEndpointHelper
import code.api.dynamic.entity.helper.{DynamicEntityHelper, DynamicEntityInfo}
import code.atmattribute.AtmAttribute
import code.bankattribute.BankAttribute
import code.connectormethod.{ConnectorMethodProvider, JsonConnectorMethod}
import code.customeraccountlinks.CustomerAccountLinkTrait
@ -1660,6 +1662,30 @@ object NewStyle extends MdcLoggable{
i => (connectorEmptyResponse(i._1, callContext), i._2)
}
}
def createOrUpdateAtmAttribute(
bankId: BankId,
atmId: AtmId,
atmAttributeId: Option[String],
name: String,
attributeType: AtmAttributeType.Value,
value: String,
isActive: Option[Boolean],
callContext: Option[CallContext]
): OBPReturnType[AtmAttribute] = {
Connector.connector.vend.createOrUpdateAtmAttribute(
bankId: BankId,
atmId: AtmId,
atmAttributeId: Option[String],
name: String,
attributeType: AtmAttributeType.Value,
value: String,
isActive: Option[Boolean],
callContext: Option[CallContext]
) map {
i => (connectorEmptyResponse(i._1, callContext), i._2)
}
}
def getBankAttributesByBank(bank: BankId,callContext: Option[CallContext]): OBPReturnType[List[BankAttribute]] = {
Connector.connector.vend.getBankAttributesByBank(
@ -1669,6 +1695,15 @@ object NewStyle extends MdcLoggable{
i => (connectorEmptyResponse(i._1, callContext), i._2)
}
}
def getAtmAttributesByAtm(bank: BankId, atm: AtmId, callContext: Option[CallContext]): OBPReturnType[List[AtmAttribute]] = {
Connector.connector.vend.getAtmAttributesByAtm(
bank: BankId,
atm: AtmId,
callContext: Option[CallContext]
) map {
i => (connectorEmptyResponse(i._1, callContext), i._2)
}
}
def getProductAttributesByBankAndCode(
bank: BankId,
productCode: ProductCode,
@ -1707,6 +1742,18 @@ object NewStyle extends MdcLoggable{
}
}
def getAtmAttributeById(
atmAttributeId: String,
callContext: Option[CallContext]
): OBPReturnType[AtmAttribute] = {
Connector.connector.vend.getAtmAttributeById(
atmAttributeId: String,
callContext: Option[CallContext]
) map {
i => (connectorEmptyResponse(i._1, callContext), i._2)
}
}
def deleteBankAttribute(
bankAttributeId: String,
callContext: Option[CallContext]
@ -1717,6 +1764,18 @@ object NewStyle extends MdcLoggable{
) map {
i => (connectorEmptyResponse(i._1, callContext), i._2)
}
}
def deleteAtmAttribute(
atmAttributeId: String,
callContext: Option[CallContext]
): OBPReturnType[Boolean] = {
Connector.connector.vend.deleteAtmAttribute(
atmAttributeId: String,
callContext: Option[CallContext]
) map {
i => (connectorEmptyResponse(i._1, callContext), i._2)
}
}
def deleteProductAttribute(
@ -2177,7 +2236,13 @@ object NewStyle extends MdcLoggable{
}
}
}
def getCurrentCurrencies(bankId: BankId, callContext: Option[CallContext]): OBPReturnType[List[String]] = {
Connector.connector.vend.getCurrentCurrencies(bankId, callContext) map {
i => (unboxFullOrFail(i._1, callContext, s"$InvalidConnectorResponse", 400), i._2)
}
}
def getExchangeRate(bankId: BankId, fromCurrencyCode: String, toCurrencyCode: String, callContext: Option[CallContext]): Future[FXRate] =
Future(Connector.connector.vend.getCurrentFxRate(bankId, fromCurrencyCode, toCurrencyCode)) map {

291
obp-api/src/main/scala/code/api/v5_1_0/APIMethods510.scala
View File

@ -7,7 +7,7 @@ import code.api.util.APIUtil._
import code.api.util.ApiRole._
import code.api.util.ApiTag._
import code.api.util.ErrorMessages.{$UserNotLoggedIn, BankNotFound, ConsentNotFound, InvalidJsonFormat, UnknownError, UserNotFoundByUserId, UserNotLoggedIn, _}
import code.api.util.{APIUtil, ApiRole, CurrencyUtil, NewStyle, X509}
import code.api.util.{APIUtil, ApiRole, CallContext, CurrencyUtil, NewStyle, X509}
import code.api.util.NewStyle.HttpCode
import code.api.v3_0_0.JSONFactory300.createAggregateMetricJson
import code.api.v3_1_0.ConsentJsonV310
@ -24,7 +24,8 @@ import code.util.Helper
import code.views.system.{AccountAccess, ViewDefinition}
import com.github.dwickern.macros.NameOf.nameOf
import com.openbankproject.commons.ExecutionContext.Implicits.global
import com.openbankproject.commons.model.BankId
import com.openbankproject.commons.model.{AtmId, BankId}
import com.openbankproject.commons.model.enums.AtmAttributeType
import com.openbankproject.commons.util.{ApiVersion, ScannedApiVersion}
import net.liftweb.common.Full
import net.liftweb.http.rest.RestHelper
@ -225,9 +226,9 @@ trait APIMethods510 {
implementedInApiVersion,
nameOf(accountCurrencyCheck),
"GET",
"/management/system/integrity/account-currency-check",
"/management/system/integrity/banks/BANK_ID/account-currency-check",
"Check for Sensible Currencies",
s"""Check for sensible currencies at account access table.
s"""Check for sensible currencies at Bank Account model
|
|${authenticationRequiredMessage(true)}
|""".stripMargin,
@ -243,19 +244,293 @@ trait APIMethods510 {
)
lazy val accountCurrencyCheck: OBPEndpoint = {
case "management" :: "system" :: "integrity" :: "account-currency-check" :: Nil JsonGet _ => {
case "management" :: "system" :: "integrity" :: "banks" :: BankId(bankId) :: "account-currency-check" :: Nil JsonGet _ => {
cc =>
for {
currenciess: List[String] <- Future {
currencies: List[String] <- Future {
MappedBankAccount.findAll().map(_.accountCurrency.get).distinct
}
currentCurrencies: List[String] <- Future { CurrencyUtil.getCurrencyCodes() }
(bankCurrencies, callContext) <- NewStyle.function.getCurrentCurrencies(bankId, cc.callContext)
} yield {
(JSONFactory510.getSensibleCurrenciesCheck(currenciess, currentCurrencies), HttpCode.`200`(cc.callContext))
(JSONFactory510.getSensibleCurrenciesCheck(bankCurrencies, currencies), HttpCode.`200`(callContext))
}
}
}
staticResourceDocs += ResourceDoc(
getCurrenciesAtBank,
implementedInApiVersion,
nameOf(getCurrenciesAtBank),
"GET",
"/banks/BANK_ID/currencies",
"Get Currencies at a Bank",
"""Get Currencies specified by BANK_ID
|
""".stripMargin,
emptyObjectJson,
currenciesJsonV510,
List(
$UserNotLoggedIn,
UnknownError
),
List(apiTagFx, apiTagNewStyle)
)
lazy val getCurrenciesAtBank: OBPEndpoint = {
case "banks" :: BankId(bankId) :: "currencies" :: Nil JsonGet _ => {
cc =>
for {
_ <- Helper.booleanToFuture(failMsg = ConsumerHasMissingRoles + CanReadFx, cc=cc.callContext) {
checkScope(bankId.value, getConsumerPrimaryKey(cc.callContext), ApiRole.canReadFx)
}
(_, callContext) <- NewStyle.function.getBank(bankId, cc.callContext)
(currencies, callContext) <- NewStyle.function.getCurrentCurrencies(bankId, callContext)
} yield {
val json = CurrenciesJsonV510(currencies.map(CurrencyJsonV510(_)))
(json, HttpCode.`200`(callContext))
}
}
}
staticResourceDocs += ResourceDoc(
createAtmAttribute,
implementedInApiVersion,
nameOf(createAtmAttribute),
"POST",
"/banks/BANK_ID/atms/ATM_ID/attributes",
"Create ATM Attribute",
s""" Create ATM Attribute
|
|The type field must be one of "STRING", "INTEGER", "DOUBLE" or DATE_WITH_DAY"
|
|${authenticationRequiredMessage(true)}
|
|""",
atmAttributeJsonV510,
atmAttributeResponseJsonV510,
List(
$UserNotLoggedIn,
$BankNotFound,
InvalidJsonFormat,
UnknownError
),
List(apiTagATM, apiTagNewStyle),
Some(List(canCreateAtmAttribute))
)
lazy val createAtmAttribute : OBPEndpoint = {
case "banks" :: BankId(bankId) :: "atms" :: AtmId(atmId) :: "attributes" :: Nil JsonPost json -> _=> {
cc =>
for {
(_, callContext) <- NewStyle.function.getAtm(bankId, atmId, cc.callContext)
failMsg = s"$InvalidJsonFormat The Json body should be the $AtmAttributeJsonV510 "
postedData <- NewStyle.function.tryons(failMsg, 400, callContext) {
json.extract[AtmAttributeJsonV510]
}
failMsg = s"$InvalidJsonFormat The `Type` field can only accept the following field: " +
s"${AtmAttributeType.DOUBLE}(12.1234), ${AtmAttributeType.STRING}(TAX_NUMBER), ${AtmAttributeType.INTEGER}(123) and ${AtmAttributeType.DATE_WITH_DAY}(2012-04-23)"
bankAttributeType <- NewStyle.function.tryons(failMsg, 400, callContext) {
AtmAttributeType.withName(postedData.`type`)
}
(atmAttribute, callContext) <- NewStyle.function.createOrUpdateAtmAttribute(
bankId,
atmId,
None,
postedData.name,
bankAttributeType,
postedData.value,
postedData.is_active,
callContext: Option[CallContext]
)
} yield {
(JSONFactory510.createAtmAttributeJson(atmAttribute), HttpCode.`201`(callContext))
}
}
}
staticResourceDocs += ResourceDoc(
getAtmAttributes,
implementedInApiVersion,
nameOf(getAtmAttributes),
"GET",
"/banks/BANK_ID/atms/ATM_ID/attributes",
"Get ATM Attributes",
s""" Get ATM Attributes
|
|${authenticationRequiredMessage(true)}
|
|""",
EmptyBody,
transactionAttributesResponseJson,
List(
$UserNotLoggedIn,
$BankNotFound,
InvalidJsonFormat,
UnknownError
),
List(apiTagATM, apiTagNewStyle),
Some(List(canGetAtmAttribute))
)
lazy val getAtmAttributes : OBPEndpoint = {
case "banks" :: BankId(bankId) :: "atms" :: AtmId(atmId) :: "attributes" :: Nil JsonGet _ => {
cc =>
for {
(_, callContext) <- NewStyle.function.getAtm(bankId, atmId, cc.callContext)
(attributes, callContext) <- NewStyle.function.getAtmAttributesByAtm(bankId, atmId, callContext)
} yield {
(JSONFactory510.createAtmAttributesJson(attributes), HttpCode.`200`(callContext))
}
}
}
staticResourceDocs += ResourceDoc(
getAtmAttribute,
implementedInApiVersion,
nameOf(getAtmAttribute),
"GET",
"/banks/BANK_ID/atms/ATM_ID/attributes/ATM_ATTRIBUTE_ID",
"Get ATM Attribute By ATM_ATTRIBUTE_ID",
s""" Get ATM Attribute By ATM_ATTRIBUTE_ID
|
|${authenticationRequiredMessage(true)}
|
|""",
EmptyBody,
atmAttributeResponseJsonV510,
List(
$UserNotLoggedIn,
$BankNotFound,
InvalidJsonFormat,
UnknownError
),
List(apiTagATM, apiTagNewStyle),
Some(List(canGetAtmAttribute))
)
lazy val getAtmAttribute : OBPEndpoint = {
case "banks" :: BankId(bankId) :: "atms" :: AtmId(atmId) :: "attributes" :: atmAttributeId :: Nil JsonGet _ => {
cc =>
for {
(_, callContext) <- NewStyle.function.getAtm(bankId, atmId, cc.callContext)
(attribute, callContext) <- NewStyle.function.getAtmAttributeById(atmAttributeId, callContext)
} yield {
(JSONFactory510.createAtmAttributeJson(attribute), HttpCode.`200`(callContext))
}
}
}
staticResourceDocs += ResourceDoc(
updateAtmAttribute,
implementedInApiVersion,
nameOf(updateAtmAttribute),
"PUT",
"/banks/BANK_ID/atms/ATM_ID/attributes/ATM_ATTRIBUTE_ID",
"Update ATM Attribute",
s""" Update ATM Attribute.
|
|Update an ATM Attribute by its id.
|
|${authenticationRequiredMessage(true)}
|
|""",
atmAttributeJsonV510,
atmAttributeResponseJsonV510,
List(
$UserNotLoggedIn,
$BankNotFound,
UserHasMissingRoles,
UnknownError
),
List(apiTagATM, apiTagNewStyle),
Some(List(canUpdateAtmAttribute))
)
lazy val updateAtmAttribute : OBPEndpoint = {
case "banks" :: BankId(bankId) :: "atms" :: AtmId(atmId) :: "attributes" :: atmAttributeId :: Nil JsonPut json -> _ =>{
cc =>
for {
(_, callContext) <- NewStyle.function.getAtm(bankId, atmId, cc.callContext)
failMsg = s"$InvalidJsonFormat The Json body should be the $AtmAttributeJsonV510 "
postedData <- NewStyle.function.tryons(failMsg, 400, callContext) {
json.extract[AtmAttributeJsonV510]
}
failMsg = s"$InvalidJsonFormat The `Type` field can only accept the following field: " +
s"${AtmAttributeType.DOUBLE}(12.1234), ${AtmAttributeType.STRING}(TAX_NUMBER), ${AtmAttributeType.INTEGER}(123) and ${AtmAttributeType.DATE_WITH_DAY}(2012-04-23)"
atmAttributeType <- NewStyle.function.tryons(failMsg, 400, cc.callContext) {
AtmAttributeType.withName(postedData.`type`)
}
(_, callContext) <- NewStyle.function.getAtmAttributeById(atmAttributeId, cc.callContext)
(atmAttribute, callContext) <- NewStyle.function.createOrUpdateAtmAttribute(
bankId,
atmId,
Some(atmAttributeId),
postedData.name,
atmAttributeType,
postedData.value,
postedData.is_active,
callContext: Option[CallContext]
)
} yield {
(JSONFactory510.createAtmAttributeJson(atmAttribute), HttpCode.`200`(callContext))
}
}
}
staticResourceDocs += ResourceDoc(
deleteAtmAttribute,
implementedInApiVersion,
nameOf(deleteAtmAttribute),
"DELETE",
"/banks/BANK_ID/atms/ATM_ID/attributes/ATM_ATTRIBUTE_ID",
"Delete ATM Attribute",
s""" Delete ATM Attribute
|
|Delete a Atm Attribute by its id.
|
|${authenticationRequiredMessage(true)}
|
|""",
EmptyBody,
EmptyBody,
List(
$UserNotLoggedIn,
$BankNotFound,
UserHasMissingRoles,
UnknownError
),
List(apiTagATM, apiTagNewStyle),
Some(List(canDeleteAtmAttribute))
)
lazy val deleteAtmAttribute : OBPEndpoint = {
case "banks" :: BankId(bankId) :: "atms" :: AtmId(atmId) :: "attributes" :: atmAttributeId :: Nil JsonDelete _=> {
cc =>
for {
(_, callContext) <- NewStyle.function.getAtm(bankId, atmId, cc.callContext)
(atmAttribute, callContext) <- NewStyle.function.deleteAtmAttribute(atmAttributeId, callContext)
} yield {
(Full(atmAttribute), HttpCode.`204`(callContext))
}
}
}
staticResourceDocs += ResourceDoc(
revokeConsentAtBank,
implementedInApiVersion,

68
obp-api/src/main/scala/code/api/v5_1_0/JSONFactory5.1.0.scala
View File

@ -30,6 +30,7 @@ import code.api.Constant
import code.api.util.APIUtil
import code.api.util.APIUtil.gitCommit
import code.api.v4_0_0.{EnergySource400, HostedAt400, HostedBy400}
import code.atmattribute.AtmAttribute
import code.views.system.{AccountAccess, ViewDefinition}
import com.openbankproject.commons.util.{ApiVersion, ScannedApiVersion}
@ -63,6 +64,55 @@ case class CheckSystemIntegrityJsonV510(
success: Boolean,
debug_info: Option[String] = None
)
case class CurrencyJsonV510(alphanumeric_code: String)
case class CurrenciesJsonV510(currencies: List[CurrencyJsonV510])
case class ProductAttributeJsonV510(
name: String,
`type`: String,
value: String,
is_active: Option[Boolean]
)
case class ProductAttributeResponseJsonV510(
bank_id: String,
product_code: String,
product_attribute_id: String,
name: String,
`type`: String,
value: String,
is_active: Option[Boolean]
)
case class ProductAttributeResponseWithoutBankIdJsonV510(
product_code: String,
product_attribute_id: String,
name: String,
`type`: String,
value: String,
is_active: Option[Boolean]
)
case class AtmAttributeJsonV510(
name: String,
`type`: String,
value: String,
is_active: Option[Boolean])
case class AtmAttributeResponseJsonV510(
bank_id: String,
atm_id: String,
atm_attribute_id: String,
name: String,
`type`: String,
value: String,
is_active: Option[Boolean]
)
case class AtmAttributesResponseJsonV510(bank_attributes: List[AtmAttributeResponseJsonV510])
case class AtmAttributeBankResponseJsonV510(name: String,
value: String)
case class AtmAttributesResponseJson(list: List[AtmAttributeBankResponseJsonV510])
object JSONFactory510 {
@ -91,8 +141,8 @@ object JSONFactory510 {
debug_info = debugInfo
)
}
def getSensibleCurrenciesCheck(currencies: List[String], currentCurrencies: List[String]): CheckSystemIntegrityJsonV510 = {
val incorrectCurrencies: List[String] = currencies.filterNot(c => currentCurrencies.contains(c))
def getSensibleCurrenciesCheck(bankCurrencies: List[String], accountCurrencies: List[String]): CheckSystemIntegrityJsonV510 = {
val incorrectCurrencies: List[String] = bankCurrencies.filterNot(c => accountCurrencies.contains(c))
val success = incorrectCurrencies.size == 0
val debugInfo = if(success) None else Some(s"Incorrect currencies: ${incorrectCurrencies.mkString(",")}")
CheckSystemIntegrityJsonV510(
@ -134,6 +184,20 @@ object JSONFactory510 {
)
}
def createAtmAttributeJson(atmAttribute: AtmAttribute): AtmAttributeResponseJsonV510 =
AtmAttributeResponseJsonV510(
bank_id = atmAttribute.bankId.value,
atm_id = atmAttribute.atmId.value,
atm_attribute_id = atmAttribute.atmAttributeId,
name = atmAttribute.name,
`type` = atmAttribute.attributeType.toString,
value = atmAttribute.value,
is_active = atmAttribute.isActive
)
def createAtmAttributesJson(bankAttributes: List[AtmAttribute]): AtmAttributesResponseJsonV510 =
AtmAttributesResponseJsonV510(bankAttributes.map(createAtmAttributeJson))
}

47
obp-api/src/main/scala/code/atmattribute/AtmAttribute.scala Normal file
View File

@ -0,0 +1,47 @@
package code.atmattribute
/* For ProductAttribute */
import com.openbankproject.commons.model.{AtmId, BankId}
import com.openbankproject.commons.model.enums.AtmAttributeType
import net.liftweb.common.{Box, Logger}
import net.liftweb.util.SimpleInjector
import scala.concurrent.Future
object AtmAttributeX extends SimpleInjector {
val atmAttributeProvider = new Inject(buildOne _) {}
def buildOne: AtmAttributeProviderTrait = AtmAttributeProvider
// Helper to get the count out of an option
def countOfAtmAttribute(listOpt: Option[List[AtmAttribute]]): Int = {
val count = listOpt match {
case Some(list) => list.size
case None => 0
}
count
}
}
trait AtmAttributeProviderTrait {
private val logger = Logger(classOf[AtmAttributeProviderTrait])
def getAtmAttributesFromProvider(bankId: BankId, atmId: AtmId): Future[Box[List[AtmAttribute]]]
def getAtmAttributeById(AtmAttributeId: String): Future[Box[AtmAttribute]]
def createOrUpdateAtmAttribute(bankId : BankId,
atmId: AtmId,
AtmAttributeId: Option[String],
name: String,
attributeType: AtmAttributeType.Value,
value: String,
isActive: Option[Boolean]): Future[Box[AtmAttribute]]
def deleteAtmAttribute(AtmAttributeId: String): Future[Box[Boolean]]
// End of Trait
}

105
obp-api/src/main/scala/code/atmattribute/MappedAtmAttributeProvider.scala Normal file
View File

@ -0,0 +1,105 @@
package code.atmattribute
import code.util.{MappedUUID, UUIDString}
import com.openbankproject.commons.ExecutionContext.Implicits.global
import com.openbankproject.commons.model.enums.AtmAttributeType
import com.openbankproject.commons.model.{AtmAttributeTrait, AtmId, BankId}
import net.liftweb.common.{Box, Empty, Full}
import net.liftweb.mapper.{MappedBoolean, _}
import net.liftweb.util.Helpers.tryo
import scala.concurrent.Future
object AtmAttributeProvider extends AtmAttributeProviderTrait {
override def getAtmAttributesFromProvider(bankId: BankId, atmId: AtmId): Future[Box[List[AtmAttribute]]] =
Future {
Box !! AtmAttribute.findAll(
By(AtmAttribute.BankId_, bankId.value),
By(AtmAttribute.AtmId_, atmId.value)
)
}
override def getAtmAttributeById(AtmAttributeId: String): Future[Box[AtmAttribute]] = Future {
AtmAttribute.find(By(AtmAttribute.AtmAttributeId, AtmAttributeId))
}
override def createOrUpdateAtmAttribute(bankId: BankId,
atmId: AtmId,
AtmAttributeId: Option[String],
name: String,
attributeType: AtmAttributeType.Value,
value: String,
isActive: Option[Boolean]): Future[Box[AtmAttribute]] = {
AtmAttributeId match {
case Some(id) => Future {
AtmAttribute.find(By(AtmAttribute.AtmAttributeId, id)) match {
case Full(attribute) => tryo {
attribute
.BankId_(bankId.value)
.AtmId_(atmId.value)
.Name(name)
.Type(attributeType.toString)
.`Value`(value)
.IsActive(isActive.getOrElse(true))
.saveMe()
}
case _ => Empty
}
}
case None => Future {
Full {
AtmAttribute.create
.BankId_(bankId.value)
.AtmId_(atmId.value)
.Name(name)
.Type(attributeType.toString())
.`Value`(value)
.IsActive(isActive.getOrElse(true))
.saveMe()
}
}
}
}
override def deleteAtmAttribute(AtmAttributeId: String): Future[Box[Boolean]] = Future {
Some(
AtmAttribute.bulkDelete_!!(By(AtmAttribute.AtmAttributeId, AtmAttributeId))
)
}
}
class AtmAttribute extends AtmAttributeTrait with LongKeyedMapper[AtmAttribute] with IdPK {
override def getSingleton = AtmAttribute
object BankId_ extends UUIDString(this) {
override def dbColumnName = "BankId"
}
object AtmId_ extends UUIDString(this) {
override def dbColumnName = "AtmId"
}
object AtmAttributeId extends MappedUUID(this)
object Name extends MappedString(this, 50)
object Type extends MappedString(this, 50)
object `Value` extends MappedString(this, 255)
object IsActive extends MappedBoolean(this) {
override def defaultValue = true
}
override def bankId: BankId = BankId(BankId_.get)
override def atmId: AtmId = AtmId(AtmId_.get)
override def atmAttributeId: String = AtmAttributeId.get
override def name: String = Name.get
override def attributeType: AtmAttributeType.Value = AtmAttributeType.withName(Type.get)
override def value: String = `Value`.get
override def isActive: Option[Boolean] = if (IsActive.jdbcFriendly(IsActive.calcFieldName) == null) { None } else Some(IsActive.get)
}
object AtmAttribute extends AtmAttribute with LongKeyedMetaMapper[AtmAttribute] {
override def dbIndexes: List[BaseIndex[AtmAttribute]] = Index(BankId_, AtmId_) :: super.dbIndexes
}

25
obp-api/src/main/scala/code/bankconnectors/Connector.scala
View File

@ -2,6 +2,7 @@ package code.bankconnectors
import java.util.Date
import java.util.UUID.randomUUID
import _root_.akka.http.scaladsl.model.HttpMethod
import code.accountholders.{AccountHolders, MapperAccountHolders}
import code.api.Constant.{SYSTEM_ACCOUNTANT_VIEW_ID, SYSTEM_AUDITOR_VIEW_ID, SYSTEM_OWNER_VIEW_ID, localIdentityProvider}
@ -15,6 +16,7 @@ import code.api.v1_4_0.JSONFactory1_4_0.TransactionRequestAccountJsonV140
import code.api.v2_1_0._
import code.api.v4_0_0.ModeratedFirehoseAccountsJsonV400
import code.api.{APIFailure, APIFailureNewStyle}
import code.atmattribute.AtmAttribute
import code.bankattribute.BankAttribute
import code.bankconnectors.LocalMappedConnector.setUnimplementedError
import code.bankconnectors.akka.AkkaConnector_vDec2018
@ -1795,6 +1797,8 @@ trait Connector extends MdcLoggable {
// def resetBadLoginAttempts(username:String):Unit
def getCurrentCurrencies(bankId: BankId, callContext: Option[CallContext]): OBPReturnType[Box[List[String]]] = Future{Failure(setUnimplementedError)}
def getCurrentFxRate(bankId: BankId, fromCurrencyCode: String, toCurrencyCode: String): Box[FXRate] = Failure(setUnimplementedError)
def getCurrentFxRateCached(bankId: BankId, fromCurrencyCode: String, toCurrencyCode: String): Box[FXRate] = {
/**
@ -2119,13 +2123,30 @@ trait Connector extends MdcLoggable {
isActive: Option[Boolean],
callContext: Option[CallContext]
): OBPReturnType[Box[BankAttribute]] = Future{(Failure(setUnimplementedError), callContext)}
def createOrUpdateAtmAttribute(bankId: BankId,
atmId: AtmId,
atmAttributeId: Option[String],
name: String,
atmAttributeType: AtmAttributeType.Value,
value: String,
isActive: Option[Boolean],
callContext: Option[CallContext]
): OBPReturnType[Box[AtmAttribute]] = Future{(Failure(setUnimplementedError), callContext)}
def getBankAttributesByBank(bank: BankId, callContext: Option[CallContext]): OBPReturnType[Box[List[BankAttribute]]] =
Future{(Failure(setUnimplementedError), callContext)}
def getAtmAttributesByAtm(bank: BankId, atm: AtmId, callContext: Option[CallContext]): OBPReturnType[Box[List[AtmAttribute]]] =
Future{(Failure(setUnimplementedError), callContext)}
def getBankAttributeById(bankAttributeId: String,
callContext: Option[CallContext]
): OBPReturnType[Box[BankAttribute]] = Future{(Failure(setUnimplementedError), callContext)}
def getAtmAttributeById(atmAttributeId: String,
callContext: Option[CallContext]): OBPReturnType[Box[AtmAttribute]] =
Future{(Failure(setUnimplementedError), callContext)}
def getProductAttributeById(
productAttributeId: String,
@ -2143,6 +2164,10 @@ trait Connector extends MdcLoggable {
callContext: Option[CallContext]
): OBPReturnType[Box[Boolean]] = Future{(Failure(setUnimplementedError), callContext)}
def deleteAtmAttribute(atmAttributeId: String,
callContext: Option[CallContext]
): OBPReturnType[Box[Boolean]] = Future{(Failure(setUnimplementedError), callContext)}
def deleteProductAttribute(
productAttributeId: String,
callContext: Option[CallContext]

46
obp-api/src/main/scala/code/bankconnectors/LocalMappedConnector.scala
View File

@ -2,6 +2,7 @@ package code.bankconnectors
import java.util.Date
import java.util.UUID.randomUUID
import _root_.akka.http.scaladsl.model.HttpMethod
import code.DynamicData.DynamicDataProvider
import code.DynamicEndpoint.{DynamicEndpointProvider, DynamicEndpointT}
@ -21,6 +22,7 @@ import code.api.util._
import code.api.v1_4_0.JSONFactory1_4_0.TransactionRequestAccountJsonV140
import code.api.v2_1_0._
import code.api.v4_0_0.{PostSimpleCounterpartyJson400, TransactionRequestBodySimpleJsonV400}
import code.atmattribute.{AtmAttribute, AtmAttributeX}
import code.atms.Atms.Atm
import code.atms.{Atms, MappedAtm}
import code.bankattribute.{BankAttribute, BankAttributeX}
@ -3214,6 +3216,16 @@ object LocalMappedConnector extends Connector with MdcLoggable {
}
}
override def getCurrentCurrencies(bankId: BankId, callContext: Option[CallContext]): OBPReturnType[Box[List[String]]] = Future {
val rates = MappedFXRate.findAll(By(MappedFXRate.mBankId, bankId.value))
val result = rates.map(_.fromCurrencyCode) ::: rates.map(_.toCurrencyCode)
Some(result.distinct)
} map {
(_, callContext)
}
/**
* get the latest record from FXRate table by the fields: fromCurrencyCode and toCurrencyCode.
* If it is not found by (fromCurrencyCode, toCurrencyCode) order, it will try (toCurrencyCode, fromCurrencyCode) order .
@ -3822,12 +3834,36 @@ object LocalMappedConnector extends Connector with MdcLoggable {
value: String, isActive: Option[Boolean]) map {
(_, callContext)
}
override def createOrUpdateAtmAttribute(bankId: BankId,
atmId: AtmId,
atmAttributeId: Option[String],
name: String,
atmAttributeType: AtmAttributeType.Value,
value: String,
isActive: Option[Boolean],
callContext: Option[CallContext]
): OBPReturnType[Box[AtmAttribute]] =
AtmAttributeX.atmAttributeProvider.vend.createOrUpdateAtmAttribute(
bankId: BankId,
atmId: AtmId,
atmAttributeId: Option[String],
name: String,
atmAttributeType: AtmAttributeType.Value,
value: String, isActive: Option[Boolean]) map {
(_, callContext)
}
override def getBankAttributesByBank(bank: BankId, callContext: Option[CallContext]): OBPReturnType[Box[List[BankAttribute]]] =
BankAttributeX.bankAttributeProvider.vend.getBankAttributesFromProvider(bank: BankId) map {
(_, callContext)
}
override def getAtmAttributesByAtm(bank: BankId, atm: AtmId, callContext: Option[CallContext]): OBPReturnType[Box[List[AtmAttribute]]] =
AtmAttributeX.atmAttributeProvider.vend.getAtmAttributesFromProvider(bank: BankId, atm: AtmId) map {
(_, callContext)
}
override def getProductAttributesByBankAndCode(
bank: BankId,
@ -3843,6 +3879,11 @@ object LocalMappedConnector extends Connector with MdcLoggable {
(_, callContext)
}
override def getAtmAttributeById(atmAttributeId: String, callContext: Option[CallContext]): OBPReturnType[Box[AtmAttribute]] =
AtmAttributeX.atmAttributeProvider.vend.getAtmAttributeById(atmAttributeId: String) map {
(_, callContext)
}
override def getProductAttributeById(
productAttributeId: String,
callContext: Option[CallContext]
@ -3856,6 +3897,11 @@ object LocalMappedConnector extends Connector with MdcLoggable {
BankAttributeX.bankAttributeProvider.vend.deleteBankAttribute(bankAttributeId: String) map {
(_, callContext)
}
override def deleteAtmAttribute(atmAttributeId: String,
callContext: Option[CallContext]): OBPReturnType[Box[Boolean]] =
AtmAttributeX.atmAttributeProvider.vend.deleteAtmAttribute(atmAttributeId: String) map {
(_, callContext)
}
override def deleteProductAttribute(
productAttributeId: String,

209
obp-api/src/test/scala/code/api/v5_1_0/AtmAttributeTest.scala Normal file
View File

@ -0,0 +1,209 @@
package code.api.v5_1_0
import code.api.ResourceDocs1_4_0.SwaggerDefinitionsJSON._
import code.api.util.APIUtil.OAuth._
import code.api.util.ApiRole._
import code.api.util.{ApiRole, ErrorMessages}
import code.api.util.ErrorMessages.{AtmNotFoundByAtmId, UserHasMissingRoles}
import code.api.v5_1_0.APIMethods510.Implementations5_1_0
import code.entitlement.Entitlement
import code.setup.DefaultUsers
import com.github.dwickern.macros.NameOf.nameOf
import com.openbankproject.commons.model.ErrorMessage
import com.openbankproject.commons.util.ApiVersion
import net.liftweb.json.Serialization.write
import org.scalatest.Tag
class AtmAttributeTest extends V510ServerSetup with DefaultUsers {
override def beforeAll() {
super.beforeAll()
}
override def afterAll() {
super.afterAll()
}
/**
* Test tags
* Example: To run tests with tag "getPermissions":
* mvn test -D tagsToInclude
*
* This is made possible by the scalatest maven plugin
*/
object VersionOfApi extends Tag(ApiVersion.v5_1_0.toString)
object ApiEndpoint1 extends Tag(nameOf(Implementations5_1_0.createAtmAttribute))
object ApiEndpoint2 extends Tag(nameOf(Implementations5_1_0.updateAtmAttribute))
object ApiEndpoint3 extends Tag(nameOf(Implementations5_1_0.deleteAtmAttribute))
object ApiEndpoint4 extends Tag(nameOf(Implementations5_1_0.getAtmAttributes))
object ApiEndpoint5 extends Tag(nameOf(Implementations5_1_0.getAtmAttribute))
lazy val bankId = randomBankId
lazy val atmId = createAtmAtBank(bankId).id.getOrElse("")
feature(s"Assuring that endpoint $ApiEndpoint1 works as expected - $VersionOfApi") {
scenario(s"We try to consume endpoint $ApiEndpoint1 - Anonymous access", ApiEndpoint1, VersionOfApi) {
When("We make the request")
val requestGet = (v5_1_0_Request / "banks" / bankId / "atms" / atmId / "attributes").POST
val responseGet = makePostRequest(requestGet, write(atmAttributeJsonV510))
Then("We should get a 401")
And("We should get a message: " + ErrorMessages.UserNotLoggedIn)
responseGet.code should equal(401)
responseGet.body.extract[ErrorMessage].message should equal(ErrorMessages.UserNotLoggedIn)
}
scenario(s"We try to consume endpoint $ApiEndpoint1 without proper role - Authorized access", ApiEndpoint1, VersionOfApi) {
When("We make the request")
val requestGet = (v5_1_0_Request / "banks" / bankId / "atms" / atmId / "attributes").POST <@ (user1)
val responseGet = makePostRequest(requestGet, write(atmAttributeJsonV510))
Then("We should get a 403")
And("We should get a message: " + s"$CanCreateAtmAttribute entitlement required")
responseGet.code should equal(403)
responseGet.body.extract[ErrorMessage].message should startWith(UserHasMissingRoles + CanCreateAtmAttribute)
}
scenario(s"We try to consume endpoint $ApiEndpoint1 with proper role but invalid ATM - Authorized access", ApiEndpoint1, VersionOfApi) {
When("We make the request")
val entitlement = Entitlement.entitlement.vend.addEntitlement(bankId, resourceUser1.userId, ApiRole.CanCreateAtmAttribute.toString)
val requestGet = (v5_1_0_Request / "banks" / bankId / "atms" / "atmId-invalid" / "attributes").POST <@ (user1)
val responseGet = makePostRequest(requestGet, write(atmAttributeJsonV510))
Then("We should get a 404")
And("We should get a message: " + s"$AtmNotFoundByAtmId")
responseGet.code should equal(404)
responseGet.body.extract[ErrorMessage].message should startWith(AtmNotFoundByAtmId)
Entitlement.entitlement.vend.deleteEntitlement(entitlement)
}
}
feature(s"Assuring that endpoint $ApiEndpoint2 works as expected - $VersionOfApi") {
scenario(s"We try to consume endpoint $ApiEndpoint2 - Anonymous access", ApiEndpoint2, VersionOfApi) {
When("We make the request")
val requestGet = (v5_1_0_Request / "banks" / bankId / "atms" / atmId / "attributes" / "DOES_NOT_MATTER").PUT
val responseGet = makePutRequest(requestGet, write(atmAttributeJsonV510))
Then("We should get a 401")
And("We should get a message: " + ErrorMessages.UserNotLoggedIn)
responseGet.code should equal(401)
responseGet.body.extract[ErrorMessage].message should equal(ErrorMessages.UserNotLoggedIn)
}
scenario(s"We try to consume endpoint $ApiEndpoint2 without proper role - Authorized access", ApiEndpoint2, VersionOfApi) {
When("We make the request")
val requestGet = (v5_1_0_Request / "banks" / bankId / "atms" / atmId / "attributes" / "DOES_NOT_MATTER").PUT <@ (user1)
val responseGet = makePutRequest(requestGet, write(atmAttributeJsonV510))
Then("We should get a 403")
And("We should get a message: " + s"$CanUpdateAtmAttribute entitlement required")
responseGet.code should equal(403)
responseGet.body.extract[ErrorMessage].message should startWith(UserHasMissingRoles + CanUpdateAtmAttribute)
}
scenario(s"We try to consume endpoint $ApiEndpoint2 with proper role but invalid ATM - Authorized access", ApiEndpoint2, VersionOfApi) {
When("We make the request")
val entitlement = Entitlement.entitlement.vend.addEntitlement(bankId, resourceUser1.userId, ApiRole.CanUpdateAtmAttribute.toString)
val requestGet = (v5_1_0_Request / "banks" / bankId / "atms" / "atmId-invalid" / "attributes" / "DOES_NOT_MATTER").PUT <@ (user1)
val responseGet = makePutRequest(requestGet, write(atmAttributeJsonV510))
Then("We should get a 404")
And("We should get a message: " + s"$AtmNotFoundByAtmId")
responseGet.code should equal(404)
responseGet.body.extract[ErrorMessage].message should startWith(AtmNotFoundByAtmId)
Entitlement.entitlement.vend.deleteEntitlement(entitlement)
}
}
feature(s"Assuring that endpoint $ApiEndpoint3 works as expected - $VersionOfApi") {
scenario(s"We try to consume endpoint $ApiEndpoint3 - Anonymous access", ApiEndpoint3, VersionOfApi) {
When("We make the request")
val request = (v5_1_0_Request / "banks" / bankId / "atms" / atmId / "attributes" / "DOES_NOT_MATTER").DELETE
val response = makeDeleteRequest(request)
Then("We should get a 401")
And("We should get a message: " + ErrorMessages.UserNotLoggedIn)
response.code should equal(401)
response.body.extract[ErrorMessage].message should equal(ErrorMessages.UserNotLoggedIn)
}
scenario(s"We try to consume endpoint $ApiEndpoint3 without proper role - Authorized access", ApiEndpoint3, VersionOfApi) {
When("We make the request")
val request = (v5_1_0_Request / "banks" / bankId / "atms" / atmId / "attributes" / "DOES_NOT_MATTER").DELETE <@ (user1)
val response = makeDeleteRequest(request)
Then("We should get a 403")
And("We should get a message: " + s"$CanDeleteAtmAttribute entitlement required")
response.code should equal(403)
response.body.extract[ErrorMessage].message should startWith(UserHasMissingRoles + CanDeleteAtmAttribute)
}
scenario(s"We try to consume endpoint $ApiEndpoint3 with proper role but invalid ATM - Authorized access", ApiEndpoint3, VersionOfApi) {
When("We make the request")
val entitlement = Entitlement.entitlement.vend.addEntitlement(bankId, resourceUser1.userId, ApiRole.CanDeleteAtmAttribute.toString)
val request = (v5_1_0_Request / "banks" / bankId / "atms" / "atmId-invalid" / "attributes" / "DOES_NOT_MATTER").DELETE <@ (user1)
val response = makeDeleteRequest(request)
Then("We should get a 404")
And("We should get a message: " + s"$AtmNotFoundByAtmId")
response.code should equal(404)
response.body.extract[ErrorMessage].message should startWith(AtmNotFoundByAtmId)
Entitlement.entitlement.vend.deleteEntitlement(entitlement)
}
}
feature(s"Assuring that endpoint $ApiEndpoint4 works as expected - $VersionOfApi") {
scenario(s"We try to consume endpoint $ApiEndpoint4 - Anonymous access", ApiEndpoint4, VersionOfApi) {
When("We make the request")
val request = (v5_1_0_Request / "banks" / bankId / "atms" / atmId / "attributes").GET
val response = makeGetRequest(request)
Then("We should get a 401")
And("We should get a message: " + ErrorMessages.UserNotLoggedIn)
response.code should equal(401)
response.body.extract[ErrorMessage].message should equal(ErrorMessages.UserNotLoggedIn)
}
scenario(s"We try to consume endpoint $ApiEndpoint4 without proper role - Authorized access", ApiEndpoint4, VersionOfApi) {
When("We make the request")
val request = (v5_1_0_Request / "banks" / bankId / "atms" / atmId / "attributes").GET <@ (user1)
val response = makeGetRequest(request)
Then("We should get a 403")
And("We should get a message: " + s"$CanGetAtmAttribute entitlement required")
response.code should equal(403)
response.body.extract[ErrorMessage].message should startWith(UserHasMissingRoles + CanGetAtmAttribute)
}
scenario(s"We try to consume endpoint $ApiEndpoint4 with proper role but invalid ATM - Authorized access", ApiEndpoint4, VersionOfApi) {
When("We make the request")
val entitlement = Entitlement.entitlement.vend.addEntitlement(bankId, resourceUser1.userId, ApiRole.CanGetAtmAttribute.toString)
val request = (v5_1_0_Request / "banks" / bankId / "atms" / "atmId-invalid" / "attributes").GET <@ (user1)
val response = makeGetRequest(request)
Then("We should get a 404")
And("We should get a message: " + s"$AtmNotFoundByAtmId")
response.code should equal(404)
response.body.extract[ErrorMessage].message should startWith(AtmNotFoundByAtmId)
Entitlement.entitlement.vend.deleteEntitlement(entitlement)
}
}
feature(s"Assuring that endpoint $ApiEndpoint5 works as expected - $VersionOfApi") {
scenario(s"We try to consume endpoint $ApiEndpoint4 - Anonymous access", ApiEndpoint5, VersionOfApi) {
When("We make the request")
val request = (v5_1_0_Request / "banks" / bankId / "atms" / atmId / "attributes" / "DOES_NOT_MATTER").GET
val response = makeGetRequest(request)
Then("We should get a 401")
And("We should get a message: " + ErrorMessages.UserNotLoggedIn)
response.code should equal(401)
response.body.extract[ErrorMessage].message should equal(ErrorMessages.UserNotLoggedIn)
}
scenario(s"We try to consume endpoint $ApiEndpoint5 without proper role - Authorized access", ApiEndpoint5, VersionOfApi) {
When("We make the request")
val request = (v5_1_0_Request / "banks" / bankId / "atms" / atmId / "attributes" / "DOES_NOT_MATTER").GET <@ (user1)
val response = makeGetRequest(request)
Then("We should get a 403")
And("We should get a message: " + s"$CanGetAtmAttribute entitlement required")
response.code should equal(403)
response.body.extract[ErrorMessage].message should startWith(UserHasMissingRoles + CanGetAtmAttribute)
}
scenario(s"We try to consume endpoint $ApiEndpoint5 with proper role but invalid ATM - Authorized access", ApiEndpoint5, VersionOfApi) {
When("We make the request")
val entitlement = Entitlement.entitlement.vend.addEntitlement(bankId, resourceUser1.userId, ApiRole.CanGetAtmAttribute.toString)
val request = (v5_1_0_Request / "banks" / bankId / "atms" / "atmId-invalid" / "attributes" / "DOES_NOT_MATTER").GET <@ (user1)
val response = makeGetRequest(request)
Then("We should get a 404")
And("We should get a message: " + s"$AtmNotFoundByAtmId")
response.code should equal(404)
response.body.extract[ErrorMessage].message should startWith(AtmNotFoundByAtmId)
Entitlement.entitlement.vend.deleteEntitlement(entitlement)
}
}
}

64
obp-api/src/test/scala/code/api/v5_1_0/CurrenciesTest.scala Normal file
View File

@ -0,0 +1,64 @@
package code.api.v5_1_0
import code.api.util.APIUtil.OAuth._
import code.api.util.ApiRole
import code.api.v5_1_0.OBPAPI5_1_0.Implementations5_1_0
import code.consumer.Consumers
import code.scope.Scope
import code.setup.DefaultUsers
import com.github.dwickern.macros.NameOf.nameOf
import com.openbankproject.commons.util.ApiVersion
import org.scalatest.Tag
class CurrenciesTest extends V510ServerSetup with DefaultUsers {
/**
* Test tags
* Example: To run tests with tag "getPermissions":
* mvn test -D tagsToInclude
*
* This is made possible by the scalatest maven plugin
*/
object VersionOfApi extends Tag(ApiVersion.v5_1_0.toString)
object ApiEndpoint1 extends Tag(nameOf(Implementations5_1_0.getCurrenciesAtBank))
override def beforeAll(): Unit = {
super.beforeAll()
}
override def afterAll(): Unit = {
super.afterAll()
}
feature(s"Assuring $ApiEndpoint1 works as expected - $VersionOfApi") {
scenario(s"We Call $ApiEndpoint1", VersionOfApi, ApiEndpoint1) {
setPropsValues("require_scopes_for_all_roles" -> "true")
val testBank = testBankId1
val consumerId = Consumers.consumers.vend.getConsumerByConsumerKey(user1.get._1.key).map(_.id.get.toString).getOrElse("")
Scope.scope.vend.addScope(testBank.value, consumerId, ApiRole.canReadFx.toString())
val requestGet = (v5_1_0_Request / "banks" / testBank.value / "currencies" ).GET <@ (user1)
val responseGet = makeGetRequest(requestGet)
And("We should get a 200")
responseGet.code should equal(200)
}
scenario(s"We Call $ApiEndpoint1 without a proper scope", VersionOfApi, ApiEndpoint1) {
setPropsValues("require_scopes_for_all_roles" -> "true")
val testBank = testBankId1
val requestGet = (v5_1_0_Request / "banks" / testBank.value / "currencies" ).GET <@ (user1)
val responseGet = makeGetRequest(requestGet)
And("We should get a 403")
responseGet.code should equal(403)
}
scenario(s"We Call $ApiEndpoint1 with anonymous access", VersionOfApi, ApiEndpoint1) {
setPropsValues("require_scopes_for_all_roles" -> "true")
val testBank = testBankId1
val requestGet = (v5_1_0_Request / "banks" / testBank.value / "currencies" ).GET
val responseGet = makeGetRequest(requestGet)
And("We should get a 401")
responseGet.code should equal(401)
}
}
}

6
obp-api/src/test/scala/code/api/v5_1_0/SystemIntegrityTest.scala
View File

@ -134,7 +134,7 @@ class SystemIntegrityTest extends V510ServerSetup {
feature(s"test $ApiEndpoint4 version $VersionOfApi - Unauthorized access") {
scenario("We will call the endpoint without user credentials", ApiEndpoint1, VersionOfApi) {
When("We make a request v5.1.0")
val request510 = (v5_1_0_Request / "management" / "system" / "integrity" / "account-currency-check").GET
val request510 = (v5_1_0_Request / "management" / "system" / "integrity" / "banks" / testBankId1.value / "account-currency-check").GET
val response510 = makeGetRequest(request510)
Then("We should get a 401")
response510.code should equal(401)
@ -145,7 +145,7 @@ class SystemIntegrityTest extends V510ServerSetup {
feature(s"test $ApiEndpoint4 version $VersionOfApi - Authorized access") {
scenario("We will call the endpoint with user credentials but without a proper entitlement", ApiEndpoint1, VersionOfApi) {
When("We make a request v5.1.0")
val request510 = (v5_1_0_Request / "management" / "system" / "integrity" / "account-currency-check").GET <@(user1)
val request510 = (v5_1_0_Request / "management" / "system" / "integrity" / "banks" / testBankId1.value / "account-currency-check").GET <@(user1)
val response510 = makeGetRequest(request510)
Then("error should be " + UserHasMissingRoles + CanGetSystemIntegrity)
response510.code should equal(403)
@ -157,7 +157,7 @@ class SystemIntegrityTest extends V510ServerSetup {
scenario("We will call the endpoint with user credentials and a proper entitlement", ApiEndpoint1, VersionOfApi) {
Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, CanGetSystemIntegrity.toString)
When("We make a request v5.1.0")
val request510 = (v5_1_0_Request / "management" / "system" / "integrity" / "account-currency-check").GET <@(user1)
val request510 = (v5_1_0_Request / "management" / "system" / "integrity" / "banks" / testBankId1.value / "account-currency-check").GET <@(user1)
val response510 = makeGetRequest(request510)
Then("We get successful response")
response510.code should equal(200)

18
obp-api/src/test/scala/code/api/v5_1_0/V510ServerSetup.scala
View File

@ -1,11 +1,15 @@
package code.api.v5_1_0
import code.api.ResourceDocs1_4_0.SwaggerDefinitionsJSON
import code.api.util.APIUtil.OAuth.{Consumer, Token, _}
import code.api.util.ApiRole
import code.api.v2_0_0.BasicAccountsJSON
import code.api.v4_0_0.BanksJson400
import code.api.v4_0_0.{AtmJsonV400, BanksJson400}
import code.entitlement.Entitlement
import code.setup.{APIResponse, DefaultUsers, ServerSetupWithTestData}
import com.openbankproject.commons.util.ApiShortVersions
import dispatch.Req
import net.liftweb.json.Serialization.write
import scala.util.Random.nextInt
@ -27,6 +31,18 @@ trait V510ServerSetup extends ServerSetupWithTestData with DefaultUsers {
val bank = banksJson.banks(randomPosition)
bank.id
}
def createAtmAtBank(bankId: String): AtmJsonV400 = {
val postAtmJson = SwaggerDefinitionsJSON.atmJsonV400.copy(bank_id = bankId)
val entitlement = Entitlement.entitlement.vend.addEntitlement("", resourceUser1.userId, ApiRole.CanCreateAtmAtAnyBank.toString)
val requestCreateAtm = (v4_0_0_Request / "banks" / bankId / "atms").POST <@ (user1)
val responseCreateAtm = makePostRequest(requestCreateAtm, write(postAtmJson))
val responseBodyCreateAtm = responseCreateAtm.body.extract[AtmJsonV400]
responseBodyCreateAtm should be (postAtmJson)
responseCreateAtm.code should be (201)
Entitlement.entitlement.vend.deleteEntitlement(entitlement)
responseBodyCreateAtm
}
def getPrivateAccounts(bankId : String, consumerAndToken: Option[(Consumer, Token)]) : APIResponse = {
val request = v5_1_0_Request / "banks" / bankId / "accounts" / "private" <@(consumerAndToken) //TODO, how can we know which endpoint it called? Although it is V300, but this endpoint called V200-privateAccountsAtOneBank

10
obp-commons/src/main/scala/com/openbankproject/commons/model/CommonModelTrait.scala
View File

@ -469,6 +469,16 @@ trait CustomerMessage {
def transport : Option[String] = None //TODO, introduced from V400, may set mandatory later, need to check V140.
}
trait AtmAttributeTrait {
def bankId: BankId
def atmId: AtmId
def atmAttributeId: String
def attributeType: AtmAttributeType.Value
def name: String
def value: String
def isActive: Option[Boolean]
}
trait BankAttributeTrait {
def bankId: BankId
def bankAttributeId: String

8
obp-commons/src/main/scala/com/openbankproject/commons/model/enums/Enumerations.scala
View File

@ -15,7 +15,13 @@ object UserAttributeType extends OBPEnumeration[UserAttributeType]{
object DOUBLE extends Value
object DATE_WITH_DAY extends Value
}
sealed trait AtmAttributeType extends EnumValue
object AtmAttributeType extends OBPEnumeration[AtmAttributeType]{
object STRING extends Value
object INTEGER extends Value
object DOUBLE extends Value
object DATE_WITH_DAY extends Value
}
sealed trait BankAttributeType extends EnumValue
object BankAttributeType extends OBPEnumeration[BankAttributeType]{
object STRING extends Value