Merge pull request #33 from saltanovas/TS-611/fix-typo

grantas33 · web-flow · commit b7eb1b63b8af · 2022-09-08T19:47:57.000+03:00
TS-611: Fix typo. Introduce a fallback enum constant
diff --git a/src/main/kotlin/eu/kevin/api/models/ErrorCode.kt b/src/main/kotlin/eu/kevin/api/models/ErrorCode.kt
@@ -1,15 +1,17 @@
 package eu.kevin.api.models
 
+import eu.kevin.api.serializers.enums.ErrorCodeSerializer
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
-@Serializable
+@Serializable(with = ErrorCodeSerializer::class)
 enum class ErrorCode(val code: Int) {
     @SerialName("10000") SYSTEM_ERROR(10000),
     @SerialName("20017") INSUFFICIENT_FUNDS(20017),
     @SerialName("20022") CREDITOR_ACCOUNT_NUMBER_INVALID_OR_MISSING(20022),
     @SerialName("20023") THE_ACCOUNT_NUMBER_AND_THE_NAME_DO_NOT_COINCIDE(20023),
     @SerialName("20024") TRANSACTION_CURRENCY_IS_INVALID_OR_MISSING(20024),
     @SerialName("20029") REMITTANCE_INFORMATION_IS_NOT_VALID(20029),
-    @SerialName("20032") AUTHORIZATION_HEADER_IS_MISSING_OR_INVALID(20032)
+    @SerialName("20032") AUTHORIZATION_HEADER_IS_MISSING_OR_INVALID(20032),
+    UNKNOWN_VALUE(-1);
 }
diff --git a/src/main/kotlin/eu/kevin/api/models/account/balance/response/AccountBalanceType.kt b/src/main/kotlin/eu/kevin/api/models/account/balance/response/AccountBalanceType.kt
@@ -1,9 +1,10 @@
 package eu.kevin.api.models.account.balance.response
 
+import eu.kevin.api.serializers.enums.AccountBalanceTypeSerializer
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
-@Serializable
+@Serializable(with = AccountBalanceTypeSerializer::class)
 enum class AccountBalanceType {
     @SerialName("closingBooked") CLOSING_BOOKED,
     @SerialName("expected") EXPECTED,
@@ -12,5 +13,6 @@ enum class AccountBalanceType {
     @SerialName("interimAvailable") INTERIM_AVAILABLE,
     @SerialName("interimBooked") INTERIM_BOOKED,
     @SerialName("forwardAvailable") FORWARD_AVAILABLE,
-    @SerialName("nonInvoiced") NON_INVOICED
+    @SerialName("nonInvoiced") NON_INVOICED,
+    UNKNOWN_VALUE;
 }
diff --git a/src/main/kotlin/eu/kevin/api/models/general/bank/ScaApproachType.kt b/src/main/kotlin/eu/kevin/api/models/general/bank/ScaApproachType.kt
@@ -1,11 +1,13 @@
 package eu.kevin.api.models.general.bank
 
+import eu.kevin.api.serializers.enums.ScaApproachTypeSerializer
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
-@Serializable
+@Serializable(with = ScaApproachTypeSerializer::class)
 enum class ScaApproachType {
     @SerialName("REDIRECT") REDIRECT,
     @SerialName("DECOUPLED") DECOUPLED,
-    @SerialName("EMBEDDED") EMBEDDED
+    @SerialName("EMBEDDED") EMBEDDED,
+    UNKNOWN_VALUE;
 }
diff --git a/src/main/kotlin/eu/kevin/api/models/general/projectSettings/ForceRedirectToBankMode.kt b/src/main/kotlin/eu/kevin/api/models/general/projectSettings/ForceRedirectToBankMode.kt
@@ -1,11 +1,13 @@
 package eu.kevin.api.models.general.projectSettings
 
+import eu.kevin.api.serializers.enums.ForceRedirectToBankModeSerializer
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
-@Serializable
+@Serializable(with = ForceRedirectToBankModeSerializer::class)
 enum class ForceRedirectToBankMode {
     @SerialName("soft") SOFT,
     @SerialName("hard") HARD,
-    @SerialName("none") NONE
+    @SerialName("none") NONE,
+    UNKNOWN_VALUE;
 }
diff --git a/src/main/kotlin/eu/kevin/api/models/payment/BankStatus.kt b/src/main/kotlin/eu/kevin/api/models/payment/BankStatus.kt
@@ -1,9 +1,10 @@
 package eu.kevin.api.models.payment
 
+import eu.kevin.api.serializers.enums.BankStatusSerializer
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
-@Serializable
+@Serializable(with = BankStatusSerializer::class)
 enum class BankStatus(val value: String) {
     @SerialName("STRD") STARTED("STRD"),
     @SerialName("ACCC") ACCEPTED_SETTLEMENT_COMPLETED_CREDITOR("ACCC"),
@@ -19,4 +20,5 @@ enum class BankStatus(val value: String) {
     @SerialName("CANC") CANCELLED("CANC"),
     @SerialName("ACFC") ACCEPTED_FUNDS_CHECKED("ACFC"),
     @SerialName("PATC") PARTIALLY_ACCEPTED_TECHNICAL("PATC"),
+    UNKNOWN_VALUE("UNKNOWN");
 }
diff --git a/src/main/kotlin/eu/kevin/api/models/payment/CardStatus.kt b/src/main/kotlin/eu/kevin/api/models/payment/CardStatus.kt
@@ -1,17 +1,18 @@
 package eu.kevin.api.models.payment
 
+import eu.kevin.api.serializers.enums.CardStatusSerializer
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
-@Serializable
+@Serializable(with = CardStatusSerializer::class)
 enum class CardStatus {
     @SerialName("started") STARTED,
     @SerialName("issued") ISSUED,
     @SerialName("paid") PAID,
     @SerialName("payment_success") PAYMENT_SUCCESS,
     @SerialName("payment_failure") PAYMENT_FAILURE,
     @SerialName("hold") HOLD,
-    @SerialName("canceled") CANCELED,
+    @SerialName("cancelled") CANCELLED,
     @SerialName("in_progress") IN_PROGRESS,
     @SerialName("invoice_viewed") INVOICE_VIEWED,
     @SerialName("invoice_refunded") INVOICE_REFUNDED,
@@ -29,9 +30,13 @@ enum class CardStatus {
     @SerialName("chargeback") CHARGEBACK,
     @SerialName("representation") REPRESENTATION,
     @SerialName("retrieval") RETRIEVAL,
-    @SerialName("prearbitrationgood_faith") PREARBITRATIONGOOD_FAITH,
+    @SerialName("prearbitration") PREARBITRATION,
     @SerialName("good_faith") GOOD_FAITH,
     @SerialName("fraud_advice") FRAUD_ADVICE,
     @SerialName("failed") FAILED,
-    @SerialName("refund_forbidden") REFUND_FORBIDDEN
+    @SerialName("refund_forbidden") REFUND_FORBIDDEN,
+    @SerialName("completed") COMPLETED,
+    @SerialName("partially_refunded") PARTIALLY_REFUNDED,
+    @SerialName("refunded") REFUNDED,
+    UNKNOWN_VALUE;
 }
diff --git a/src/main/kotlin/eu/kevin/api/models/payment/HybridStatus.kt b/src/main/kotlin/eu/kevin/api/models/payment/HybridStatus.kt
@@ -1,11 +1,13 @@
 package eu.kevin.api.models.payment
 
+import eu.kevin.api.serializers.enums.HybridStatusSerializer
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
-@Serializable
+@Serializable(with = HybridStatusSerializer::class)
 enum class HybridStatus {
     @SerialName("created") CREATED,
-    @SerialName("canceled") CANCELED,
+    @SerialName("cancelled") CANCELLED,
     @SerialName("expired") EXPIRED,
+    UNKNOWN_VALUE;
 }
diff --git a/src/main/kotlin/eu/kevin/api/models/payment/StatusGroup.kt b/src/main/kotlin/eu/kevin/api/models/payment/StatusGroup.kt
@@ -1,12 +1,14 @@
 package eu.kevin.api.models.payment
 
+import eu.kevin.api.serializers.enums.StatusGroupSerializer
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
-@Serializable
+@Serializable(with = StatusGroupSerializer::class)
 enum class StatusGroup {
     @SerialName("started") STARTED,
     @SerialName("pending") PENDING,
     @SerialName("completed") COMPLETED,
     @SerialName("failed") FAILED,
+    UNKNOWN_VALUE;
 }
diff --git a/src/main/kotlin/eu/kevin/api/serializers/enums/AccountBalanceTypeSerializer.kt b/src/main/kotlin/eu/kevin/api/serializers/enums/AccountBalanceTypeSerializer.kt
@@ -0,0 +1,9 @@
+package eu.kevin.api.serializers.enums
+
+import eu.kevin.api.models.account.balance.response.AccountBalanceType
+
+object AccountBalanceTypeSerializer :
+    EnumIgnoreUnknownSerializer<AccountBalanceType>(
+        values = AccountBalanceType.values(),
+        defaultValue = AccountBalanceType.UNKNOWN_VALUE
+    )
diff --git a/src/main/kotlin/eu/kevin/api/serializers/enums/BankStatusSerializer.kt b/src/main/kotlin/eu/kevin/api/serializers/enums/BankStatusSerializer.kt
@@ -0,0 +1,9 @@
+package eu.kevin.api.serializers.enums
+
+import eu.kevin.api.models.payment.BankStatus
+
+object BankStatusSerializer :
+    EnumIgnoreUnknownSerializer<BankStatus>(
+        BankStatus.values(),
+        BankStatus.UNKNOWN_VALUE
+    )
diff --git a/src/main/kotlin/eu/kevin/api/serializers/enums/CardStatusSerializer.kt b/src/main/kotlin/eu/kevin/api/serializers/enums/CardStatusSerializer.kt
@@ -0,0 +1,9 @@
+package eu.kevin.api.serializers.enums
+
+import eu.kevin.api.models.payment.CardStatus
+
+object CardStatusSerializer :
+    EnumIgnoreUnknownSerializer<CardStatus>(
+        values = CardStatus.values(),
+        defaultValue = CardStatus.UNKNOWN_VALUE
+    )
diff --git a/src/main/kotlin/eu/kevin/api/serializers/enums/EnumIgnoreUnknownSerializer.kt b/src/main/kotlin/eu/kevin/api/serializers/enums/EnumIgnoreUnknownSerializer.kt
@@ -0,0 +1,38 @@
+package eu.kevin.api.serializers.enums
+
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.descriptors.PrimitiveKind
+import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
+import kotlinx.serialization.descriptors.SerialDescriptor
+import kotlinx.serialization.encoding.Decoder
+import kotlinx.serialization.encoding.Encoder
+
+/**
+ * The source code is taken from the https://gist.github.com/arberg/e20db05e018c61f37f1d274a254657c3
+ */
+abstract class EnumIgnoreUnknownSerializer<T : Enum<T>>(
+    values: Array<out T>,
+    private val defaultValue: T
+) : KSerializer<T> {
+    // Alternative to taking values in param, take clazz: Class<T>
+    // - private val values = clazz.enumConstants
+    override val descriptor: SerialDescriptor =
+        PrimitiveSerialDescriptor(values.first()::class.qualifiedName!!, PrimitiveKind.STRING)
+
+    // Build maps for faster parsing, used @SerialName annotation if present, fall back to name
+    private val lookup = values.associateBy({ it }, { it.serialName })
+    private val revLookup = values.associateBy { it.serialName }
+
+    private val Enum<T>.serialName: String
+        get() = this::class.java.getField(this.name).getAnnotation(SerialName::class.java)?.value ?: name
+
+    override fun serialize(encoder: Encoder, value: T) {
+        encoder.encodeString(lookup.getValue(value))
+    }
+
+    override fun deserialize(decoder: Decoder): T {
+        // only run 'decoder.decodeString()' once
+        return revLookup[decoder.decodeString()] ?: defaultValue // map.getOrDefault is not available < API-24
+    }
+}
diff --git a/src/main/kotlin/eu/kevin/api/serializers/enums/ErrorCodeSerializer.kt b/src/main/kotlin/eu/kevin/api/serializers/enums/ErrorCodeSerializer.kt
@@ -0,0 +1,9 @@
+package eu.kevin.api.serializers.enums
+
+import eu.kevin.api.models.ErrorCode
+
+object ErrorCodeSerializer :
+    EnumIgnoreUnknownSerializer<ErrorCode>(
+        values = ErrorCode.values(),
+        defaultValue = ErrorCode.UNKNOWN_VALUE
+    )
diff --git a/src/main/kotlin/eu/kevin/api/serializers/enums/ForceRedirectToBankModeSerializer.kt b/src/main/kotlin/eu/kevin/api/serializers/enums/ForceRedirectToBankModeSerializer.kt
@@ -0,0 +1,9 @@
+package eu.kevin.api.serializers.enums
+
+import eu.kevin.api.models.general.projectSettings.ForceRedirectToBankMode
+
+object ForceRedirectToBankModeSerializer :
+    EnumIgnoreUnknownSerializer<ForceRedirectToBankMode>(
+        values = ForceRedirectToBankMode.values(),
+        defaultValue = ForceRedirectToBankMode.UNKNOWN_VALUE
+    )
diff --git a/src/main/kotlin/eu/kevin/api/serializers/enums/HybridStatusSerializer.kt b/src/main/kotlin/eu/kevin/api/serializers/enums/HybridStatusSerializer.kt
@@ -0,0 +1,9 @@
+package eu.kevin.api.serializers.enums
+
+import eu.kevin.api.models.payment.HybridStatus
+
+object HybridStatusSerializer :
+    EnumIgnoreUnknownSerializer<HybridStatus>(
+        values = HybridStatus.values(),
+        defaultValue = HybridStatus.UNKNOWN_VALUE
+    )
diff --git a/src/main/kotlin/eu/kevin/api/serializers/enums/ScaApproachTypeSerializer.kt b/src/main/kotlin/eu/kevin/api/serializers/enums/ScaApproachTypeSerializer.kt
@@ -0,0 +1,9 @@
+package eu.kevin.api.serializers.enums
+
+import eu.kevin.api.models.general.bank.ScaApproachType
+
+object ScaApproachTypeSerializer :
+    EnumIgnoreUnknownSerializer<ScaApproachType>(
+        values = ScaApproachType.values(),
+        defaultValue = ScaApproachType.UNKNOWN_VALUE
+    )
diff --git a/src/main/kotlin/eu/kevin/api/serializers/enums/StatusGroupSerializer.kt b/src/main/kotlin/eu/kevin/api/serializers/enums/StatusGroupSerializer.kt
@@ -0,0 +1,9 @@
+package eu.kevin.api.serializers.enums
+
+import eu.kevin.api.models.payment.StatusGroup
+
+object StatusGroupSerializer :
+    EnumIgnoreUnknownSerializer<StatusGroup>(
+        values = StatusGroup.values(),
+        defaultValue = StatusGroup.UNKNOWN_VALUE
+    )
