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

feature/OBPV510 added new create/update/get Atms

Browse Source
This commit is contained in:
hongwei 2023-04-04 11:11:39 +02:00
parent 224224c8cc
commit eeca451f1e
9 changed files with 365 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
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.{AtmAttributeJsonV510, AtmAttributeResponseJsonV510, CertificateInfoJsonV510, CurrenciesJsonV510, CurrencyJsonV510}
import code.api.v5_1_0.{AtmsJsonV510, _}
import code.endpointMapping.EndpointMappingCommons
import scala.collection.immutable.List
@ -5284,7 +5284,46 @@ object SwaggerDefinitionsJSON {
total_duration = BigDecimal(durationExample.value),
backend_messages= List(inboundStatusMessage),
)
val atmJsonV510 = AtmJsonV510(
id = Some(atmIdExample.value),
bank_id = bankIdExample.value,
name = atmNameExample.value,
address = addressJsonV300,
location = locationJson,
meta = metaJson,
monday = openingTimesV300,
tuesday = openingTimesV300,
wednesday = openingTimesV300,
thursday = openingTimesV300,
friday = openingTimesV300,
saturday = openingTimesV300,
sunday = openingTimesV300,
is_accessible = isAccessibleExample.value,
located_at = locatedAtExample.value,
more_info = moreInfoExample.value,
has_deposit_capability = hasDepositCapabilityExample.value,
supported_languages = supportedLanguagesJson.supported_languages,
services = atmServicesJson.services,
accessibility_features = accessibilityFeaturesJson.accessibility_features,
supported_currencies = supportedCurrenciesJson.supported_currencies,
notes = atmNotesJson.notes,
location_categories = atmLocationCategoriesJsonV400.location_categories,
minimum_withdrawal = atmMinimumWithdrawalExample.value,
branch_identification = atmBranchIdentificationExample.value,
site_identification = siteIdentification.value,
site_name = atmSiteNameExample.value,
cash_withdrawal_national_fee = cashWithdrawalNationalFeeExample.value,
cash_withdrawal_international_fee = cashWithdrawalInternationalFeeExample.value,
balance_inquiry_fee = balanceInquiryFeeExample.value,
atm_type = atmTypeExample.value,
phone = phoneExample.value,
)
val atmsJsonV510 = AtmsJsonV510(
atms = List(atmJsonV510)
)
//The common error or success format.
//Just some helper format to use in Json
case class NotSupportedYet()

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

@ -897,6 +897,9 @@ object ExampleValue {
lazy val balanceInquiryFeeExample = ConnectorField(NoExampleProvided, NoDescriptionProvided)
glossaryItems += makeGlossaryItem("ATM.balance_inquiry_fee", balanceInquiryFeeExample)
lazy val atmTypeExample = ConnectorField(NoExampleProvided, NoDescriptionProvided)
glossaryItems += makeGlossaryItem("ATM.atm_type", atmTypeExample)
lazy val accessibilityFeaturesExample = ConnectorField("""["ATAC","ATAD"]""", NoDescriptionProvided)
glossaryItems += makeGlossaryItem("accessibility_features", accessibilityFeaturesExample)

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

@ -3904,6 +3904,26 @@ object NewStyle extends MdcLoggable{
Connector.connector.vend.updateCustomerAccountLinkById(customerAccountLinkId: String, relationshipType: String, callContext: Option[CallContext]) map {
i => (unboxFullOrFail(i._1, callContext, UpdateCustomerAccountLinkError), i._2)
}
def getAtmsByBankId(bankId: BankId, offset: Box[String], limit: Box[String], callContext: Option[CallContext]): OBPReturnType[List[AtmT]] =
Connector.connector.vend.getAtms(bankId, callContext) map {
case Empty =>
fullBoxOrException(Empty ?~! atmsNotFound)
case Full((List(), callContext)) =>
Full(List())
case Full((list, _)) => Full(list)
case Failure(msg, _, _) => fullBoxOrException(Empty ?~! msg)
case ParamFailure(msg, _, _, _) => fullBoxOrException(Empty ?~! msg)
} map {
unboxFull(_)
} map {
branch =>
// Before we slice we need to sort in order to keep consistent results
(branch.sortWith(_.atmId.value < _.atmId.value)
// Slice the result in next way: from=offset and until=offset + limit
.slice(offset.getOrElse("0").toInt, offset.getOrElse("0").toInt + limit.getOrElse("100").toInt)
, callContext)
}
}
}

17
obp-api/src/main/scala/code/api/v4_0_0/APIMethods400.scala
View File

@ -11686,22 +11686,7 @@ trait APIMethods400 {
case _ => true
}
}
(atms, callContext) <- Connector.connector.vend.getAtms(bankId, callContext) map {
case Empty =>
fullBoxOrException(Empty ?~! atmsNotFound)
case Full((List(), callContext)) =>
Full(List())
case Full((list, _)) =>Full(list)
case Failure(msg, _, _) => fullBoxOrException(Empty ?~! msg)
case ParamFailure(msg,_,_,_) => fullBoxOrException(Empty ?~! msg)
} map { unboxFull(_) } map {
atm =>
// Before we slice we need to sort in order to keep consistent results
(atm.sortWith(_.atmId.value < _.atmId.value)
// Slice the result in next way: from=offset and until=offset + limit
.slice(offset.getOrElse("0").toInt, offset.getOrElse("0").toInt + limit.getOrElse("100").toInt)
,callContext)
}
(atms, callContext) <- NewStyle.function.getAtmsByBankId(bankId, offset, limit, cc.callContext)
} yield {
(JSONFactory400.createAtmsJsonV400(atms), HttpCode.`200`(callContext))
}

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

@ -28,6 +28,7 @@ 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.S
import net.liftweb.http.rest.RestHelper
import scala.collection.immutable.{List, Nil}
@ -947,6 +948,131 @@ trait APIMethods510 {
}
}
staticResourceDocs += ResourceDoc(
createAtm,
implementedInApiVersion,
nameOf(createAtm),
"POST",
"/banks/BANK_ID/atms",
"Create ATM",
s"""Create ATM.""",
atmJsonV510,
atmJsonV510,
List(
$UserNotLoggedIn,
InvalidJsonFormat,
UnknownError
),
List(apiTagATM, apiTagNewStyle),
Some(List(canCreateAtm, canCreateAtmAtAnyBank))
)
lazy val createAtm: OBPEndpoint = {
case "banks" :: BankId(bankId) :: "atms" :: Nil JsonPost json -> _ => {
cc =>
for {
atmJsonV510 <- NewStyle.function.tryons(s"$InvalidJsonFormat The Json body should be the ${classOf[AtmJsonV510]}", 400, cc.callContext) {
val atm = json.extract[AtmJsonV510]
//Make sure the Create contains proper ATM ID
atm.id.get
atm
}
_ <- Helper.booleanToFuture(s"$InvalidJsonValue BANK_ID has to be the same in the URL and Body", 400, cc.callContext) {
atmJsonV510.bank_id == bankId.value
}
atm <- NewStyle.function.tryons(CouldNotTransformJsonToInternalModel + " Atm", 400, cc.callContext) {
JSONFactory510.transformToAtmFromV510(atmJsonV510)
}
(atm, callContext) <- NewStyle.function.createOrUpdateAtm(atm, cc.callContext)
} yield {
(JSONFactory510.createAtmJsonV510(atm), HttpCode.`201`(callContext))
}
}
}
staticResourceDocs += ResourceDoc(
updateAtm,
implementedInApiVersion,
nameOf(updateAtm),
"PUT",
"/banks/BANK_ID/atms/ATM_ID",
"UPDATE ATM",
s"""Update ATM.""",
atmJsonV510.copy(id = None),
atmJsonV510,
List(
$UserNotLoggedIn,
InvalidJsonFormat,
UnknownError
),
List(apiTagATM, apiTagNewStyle),
Some(List(canUpdateAtm, canUpdateAtmAtAnyBank))
)
lazy val updateAtm: OBPEndpoint = {
case "banks" :: BankId(bankId) :: "atms" :: AtmId(atmId) :: Nil JsonPut json -> _ => {
cc =>
for {
(atm, callContext) <- NewStyle.function.getAtm(bankId, atmId, cc.callContext)
atmJsonV510 <- NewStyle.function.tryons(s"$InvalidJsonFormat The Json body should be the ${classOf[AtmJsonV510]}", 400, callContext) {
json.extract[AtmJsonV510]
}
_ <- Helper.booleanToFuture(s"$InvalidJsonValue BANK_ID has to be the same in the URL and Body", 400, callContext) {
atmJsonV510.bank_id == bankId.value
}
atm <- NewStyle.function.tryons(CouldNotTransformJsonToInternalModel + " Atm", 400, callContext) {
JSONFactory510.transformToAtmFromV510(atmJsonV510.copy(id = Some(atmId.value)))
}
(atm, callContext) <- NewStyle.function.createOrUpdateAtm(atm, callContext)
} yield {
(JSONFactory510.createAtmJsonV510(atm), HttpCode.`201`(callContext))
}
}
}
staticResourceDocs += ResourceDoc(
getAtms,
implementedInApiVersion,
nameOf(getAtms),
"GET",
"/banks/BANK_ID/atms",
"Get Bank ATMS",
s"""Get Bank ATMS.""",
EmptyBody,
atmsJsonV510,
List(
$BankNotFound,
UnknownError
),
List(apiTagATM, apiTagNewStyle)
)
lazy val getAtms: OBPEndpoint = {
case "banks" :: BankId(bankId) :: "atms" :: Nil JsonGet _ => {
cc =>
val limit = S.param("limit")
val offset = S.param("offset")
for {
(_, callContext) <- getAtmsIsPublic match {
case false => authenticatedAccess(cc)
case true => anonymousAccess(cc)
}
_ <- Helper.booleanToFuture(failMsg = s"${InvalidNumber} limit:${limit.getOrElse("")}", cc = callContext) {
limit match {
case Full(i) => i.toList.forall(c => Character.isDigit(c) == true)
case _ => true
}
}
_ <- Helper.booleanToFuture(failMsg = maximumLimitExceeded, cc = callContext) {
limit match {
case Full(i) if i.toInt > 10000 => false
case _ => true
}
}
(atms, callContext) <- NewStyle.function.getAtmsByBankId(bankId, offset, limit, callContext)
} yield {
(JSONFactory510.createAtmsJsonV510(atms), HttpCode.`200`(callContext))
}
}
}
}
}

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

@ -29,12 +29,18 @@ package code.api.v5_1_0
import code.api.Constant
import code.api.util.APIUtil
import code.api.util.APIUtil.gitCommit
import code.api.v1_4_0.JSONFactory1_4_0.{LocationJsonV140, MetaJsonV140, transformToLocationFromV140, transformToMetaFromV140}
import code.api.v3_0_0.JSONFactory300.{createLocationJson, createMetaJson, transformToAddressFromV300}
import code.api.v3_0_0.{AddressJsonV300, OpeningTimesV300}
import code.api.v4_0_0.{EnergySource400, HostedAt400, HostedBy400}
import code.atmattribute.AtmAttribute
import code.atms.Atms.Atm
import code.views.system.{AccountAccess, ViewDefinition}
import com.openbankproject.commons.model.{Address, AtmId, AtmT, BankId, Location, Meta}
import com.openbankproject.commons.util.{ApiVersion, ScannedApiVersion}
import scala.collection.immutable.List
import scala.util.Try
case class APIInfoJsonV510(
@ -67,7 +73,45 @@ case class CheckSystemIntegrityJsonV510(
case class CurrencyJsonV510(alphanumeric_code: String)
case class CurrenciesJsonV510(currencies: List[CurrencyJsonV510])
case class AtmJsonV510 (
id : Option[String],
bank_id : String,
name : String,
address: AddressJsonV300,
location: LocationJsonV140,
meta: MetaJsonV140,
monday: OpeningTimesV300,
tuesday: OpeningTimesV300,
wednesday: OpeningTimesV300,
thursday: OpeningTimesV300,
friday: OpeningTimesV300,
saturday: OpeningTimesV300,
sunday: OpeningTimesV300,
is_accessible : String,
located_at : String,
more_info : String,
has_deposit_capability : String,
supported_languages: List[String],
services: List[String],
accessibility_features: List[String],
supported_currencies: List[String],
notes: List[String],
location_categories: List[String],
minimum_withdrawal: String,
branch_identification: String,
site_identification: String,
site_name: String,
cash_withdrawal_national_fee: String,
cash_withdrawal_international_fee: String,
balance_inquiry_fee: String,
atm_type: String,
phone: String
)
case class AtmsJsonV510(atms : List[AtmJsonV510])
case class ProductAttributeJsonV510(
name: String,
@ -116,6 +160,127 @@ case class AtmAttributesResponseJson(list: List[AtmAttributeBankResponseJsonV510
object JSONFactory510 {
def createAtmsJsonV510(atmList: List[AtmT]): AtmsJsonV510 = {
AtmsJsonV510(atmList.map(createAtmJsonV510))
}
def createAtmJsonV510(atm: AtmT): AtmJsonV510 = {
AtmJsonV510(
id = Some(atm.atmId.value),
bank_id = atm.bankId.value,
name = atm.name,
AddressJsonV300(atm.address.line1,
atm.address.line2,
atm.address.line3,
atm.address.city,
atm.address.county.getOrElse(""),
atm.address.state,
atm.address.postCode,
atm.address.countryCode),
createLocationJson(atm.location),
createMetaJson(atm.meta),
monday = OpeningTimesV300(
opening_time = atm.OpeningTimeOnMonday.getOrElse(""),
closing_time = atm.ClosingTimeOnMonday.getOrElse("")),
tuesday = OpeningTimesV300(
opening_time = atm.OpeningTimeOnTuesday.getOrElse(""),
closing_time = atm.ClosingTimeOnTuesday.getOrElse("")),
wednesday = OpeningTimesV300(
opening_time = atm.OpeningTimeOnWednesday.getOrElse(""),
closing_time = atm.ClosingTimeOnWednesday.getOrElse("")),
thursday = OpeningTimesV300(
opening_time = atm.OpeningTimeOnThursday.getOrElse(""),
closing_time = atm.ClosingTimeOnThursday.getOrElse("")),
friday = OpeningTimesV300(
opening_time = atm.OpeningTimeOnFriday.getOrElse(""),
closing_time = atm.ClosingTimeOnFriday.getOrElse("")),
saturday = OpeningTimesV300(
opening_time = atm.OpeningTimeOnSaturday.getOrElse(""),
closing_time = atm.ClosingTimeOnSaturday.getOrElse("")),
sunday = OpeningTimesV300(
opening_time = atm.OpeningTimeOnSunday.getOrElse(""),
closing_time = atm.ClosingTimeOnSunday.getOrElse("")),
is_accessible = atm.isAccessible.map(_.toString).getOrElse(""),
located_at = atm.locatedAt.getOrElse(""),
more_info = atm.moreInfo.getOrElse(""),
has_deposit_capability = atm.hasDepositCapability.map(_.toString).getOrElse(""),
supported_languages = atm.supportedLanguages.getOrElse(Nil),
services = atm.services.getOrElse(Nil),
accessibility_features = atm.accessibilityFeatures.getOrElse(Nil),
supported_currencies = atm.supportedCurrencies.getOrElse(Nil),
notes = atm.notes.getOrElse(Nil),
location_categories = atm.locationCategories.getOrElse(Nil),
minimum_withdrawal = atm.minimumWithdrawal.getOrElse(""),
branch_identification = atm.branchIdentification.getOrElse(""),
site_identification = atm.siteIdentification.getOrElse(""),
site_name = atm.siteName.getOrElse(""),
cash_withdrawal_national_fee = atm.cashWithdrawalNationalFee.getOrElse(""),
cash_withdrawal_international_fee = atm.cashWithdrawalInternationalFee.getOrElse(""),
balance_inquiry_fee = atm.balanceInquiryFee.getOrElse(""),
atm_type = atm.atmType.getOrElse(""),
phone = atm.phone.getOrElse(""),
)
}
def transformToAtmFromV510(atmJsonV510: AtmJsonV510): Atm = {
val address: Address = transformToAddressFromV300(atmJsonV510.address) // Note the address in V220 is V140
val location: Location = transformToLocationFromV140(atmJsonV510.location) // Note the location is V140
val meta: Meta = transformToMetaFromV140(atmJsonV510.meta) // Note the meta is V140
val isAccessible: Boolean = Try(atmJsonV510.is_accessible.toBoolean).getOrElse(false)
val hdc: Boolean = Try(atmJsonV510.has_deposit_capability.toBoolean).getOrElse(false)
Atm(
atmId = AtmId(atmJsonV510.id.getOrElse("")),
bankId = BankId(atmJsonV510.bank_id),
name = atmJsonV510.name,
address = address,
location = location,
meta = meta,
OpeningTimeOnMonday = Some(atmJsonV510.monday.opening_time),
ClosingTimeOnMonday = Some(atmJsonV510.monday.closing_time),
OpeningTimeOnTuesday = Some(atmJsonV510.tuesday.opening_time),
ClosingTimeOnTuesday = Some(atmJsonV510.tuesday.closing_time),
OpeningTimeOnWednesday = Some(atmJsonV510.wednesday.opening_time),
ClosingTimeOnWednesday = Some(atmJsonV510.wednesday.closing_time),
OpeningTimeOnThursday = Some(atmJsonV510.thursday.opening_time),
ClosingTimeOnThursday = Some(atmJsonV510.thursday.closing_time),
OpeningTimeOnFriday = Some(atmJsonV510.friday.opening_time),
ClosingTimeOnFriday = Some(atmJsonV510.friday.closing_time),
OpeningTimeOnSaturday = Some(atmJsonV510.saturday.opening_time),
ClosingTimeOnSaturday = Some(atmJsonV510.saturday.closing_time),
OpeningTimeOnSunday = Some(atmJsonV510.sunday.opening_time),
ClosingTimeOnSunday = Some(atmJsonV510.sunday.closing_time),
// Easy access for people who use wheelchairs etc. true or false ""=Unknown
isAccessible = Some(isAccessible),
locatedAt = Some(atmJsonV510.located_at),
moreInfo = Some(atmJsonV510.more_info),
hasDepositCapability = Some(hdc),
supportedLanguages = Some(atmJsonV510.supported_languages),
services = Some(atmJsonV510.services),
accessibilityFeatures = Some(atmJsonV510.accessibility_features),
supportedCurrencies = Some(atmJsonV510.supported_currencies),
notes = Some(atmJsonV510.notes),
minimumWithdrawal = Some(atmJsonV510.minimum_withdrawal),
branchIdentification = Some(atmJsonV510.branch_identification),
locationCategories = Some(atmJsonV510.location_categories),
siteIdentification = Some(atmJsonV510.site_identification),
siteName = Some(atmJsonV510.site_name),
cashWithdrawalNationalFee = Some(atmJsonV510.cash_withdrawal_national_fee),
cashWithdrawalInternationalFee = Some(atmJsonV510.cash_withdrawal_international_fee),
balanceInquiryFee = Some(atmJsonV510.balance_inquiry_fee),
atmType = Some(atmJsonV510.atm_type),
phone = Some(atmJsonV510.phone)
)
}
def getCustomViewNamesCheck(views: List[ViewDefinition]): CheckSystemIntegrityJsonV510 = {
val success = views.size == 0

4
obp-api/src/main/scala/code/atms/Atms.scala
View File

@ -60,7 +60,9 @@ object Atms extends SimpleInjector {
cashWithdrawalNationalFee: Option[String] = None,
cashWithdrawalInternationalFee: Option[String] = None,
balanceInquiryFee: Option[String] = None,
atmType: Option[String] = None,
phone: Option[String] = None,
) extends AtmT
val atmsProvider = new Inject(buildOne _) {}

5
obp-api/src/main/scala/code/atms/MappedAtmsProvider.scala
View File

@ -92,6 +92,8 @@ object MappedAtmsProvider extends AtmsProvider {
.mCashWithdrawalNationalFee(atm.cashWithdrawalNationalFee.orNull)
.mCashWithdrawalInternationalFee(atm.cashWithdrawalInternationalFee.orNull)
.mBalanceInquiryFee(atm.balanceInquiryFee.orNull)
.mAtmType(atm.atmType.orNull)
.mPhone(atm.phone.orNull)
.saveMe()
}
case _ =>
@ -149,6 +151,9 @@ object MappedAtmsProvider extends AtmsProvider {
.mCashWithdrawalNationalFee(atm.cashWithdrawalNationalFee.orNull)
.mCashWithdrawalInternationalFee(atm.cashWithdrawalInternationalFee.orNull)
.mBalanceInquiryFee(atm.balanceInquiryFee.orNull)
.mAtmType(atm.atmType.orNull)
.mPhone(atm.phone.orNull)
.saveMe()
}
}

2
obp-api/src/main/scala/code/bankconnectors/vSept2018/KafkaJsonFactory_vSept2018.scala
View File

@ -366,6 +366,8 @@ case class InboundAtmSept2018(
cashWithdrawalNationalFee: Option[String] = None,
cashWithdrawalInternationalFee: Option[String] = None,
balanceInquiryFee: Option[String] = None,
atmType: Option[String] = None,
phone: Option[String] = None,
) extends AtmT
case class InternalTransaction_vSept2018(