Add feature deposit return voucher (#230)

Author: Fabtron

CHANGELOG.md

@@ -3,8 +3,15 @@ All notable changes to this project will be documented in this file.
 
 ## UNRELEASED
 ### Added
+* ui: Add UI for deposit return vouchers (APPS-1643)
+* core: Handle invalid items (APPS-2039)
+* ui/core: Integrate new states for deposit return vouchers into the checkout process and handle them
 ### Changed
+* ui: Change button message for a total price of zero and price text color for a negative total price (APPS-1939)
+* core: Handle only a set of pre defined violations (APPS-2049)
 ### Removed
+* ui/core: Remove everything related to the old deposit return voucher feature
+* core: Remove handling an empty list of payment methods in the checkout info as error (APPS-2049)
 ### Fixed
 
 ## [0.80.3]

core/src/main/java/io/snabble/sdk/Product.java

@@ -43,12 +43,7 @@ public enum Type {
          * A product that needs to be user weighed. The price from {@link Product#getListPrice()}
          * is a base price of 1000g
          */
-        UserWeighed(2),
-
-        /**
-         * A product that is used for deposit return voucher's
-         */
-        DepositReturnVoucher(3);
+        UserWeighed(2);
 
         private final int databaseValue;
 
@@ -656,4 +651,4 @@ public Product build() {
             return product;
         }
     }
-}
+}

core/src/main/java/io/snabble/sdk/ProductApi.java

@@ -58,9 +58,7 @@ private enum ApiProductType {
         @SerializedName("weighable")
         WEIGHABLE,
         @SerializedName("deposit")
-        DEPOSIT,
-        @SerializedName("depositReturnVoucher")
-        DEPOSIT_RETURN_VOUCHER
+        DEPOSIT
     }
 
     private static class ApiScannableCode {
@@ -281,8 +279,6 @@ private Product toProduct(ApiProduct apiProduct) {
                 } else {
                     builder.setType(Product.Type.PreWeighed);
                 }
-            } else if (apiProduct.productType == ApiProductType.DEPOSIT_RETURN_VOUCHER) {
-                builder.setType(Product.Type.DepositReturnVoucher);
             } else {
                 builder.setType(Product.Type.Article);
             }
@@ -306,4 +302,4 @@ private Product toProduct(ApiProduct apiProduct) {
 
         return builder.build();
     }
-}
+}

core/src/main/java/io/snabble/sdk/ProductDatabase.java

@@ -1405,7 +1405,6 @@ public Cursor searchByFoldedName(String searchString, CancellationSignal cancell
         return productQuery("JOIN searchByName ns ON ns.sku = p.sku " +
                 "WHERE ns.foldedName MATCH ? " +
                 "AND p.weighing != " + Product.Type.PreWeighed.getDatabaseValue() + " " +
-                "AND p.weighing != " + Product.Type.DepositReturnVoucher.getDatabaseValue() + " " +
                 "AND p.isDeposit = 0 " +
                 "AND availability != 2 " +
                 "LIMIT 100", new String[]{
@@ -1439,8 +1438,6 @@ public Cursor searchByCode(String searchString, CancellationSignal cancellationS
 
         sb.append(") AND p.weighing != ");
         sb.append(Product.Type.PreWeighed.getDatabaseValue());
-        sb.append(" AND p.weighing != ");
-        sb.append(Product.Type.DepositReturnVoucher.getDatabaseValue());
         sb.append(" AND p.isDeposit = 0 ");
         sb.append(" AND availability != 2");
 

core/src/main/java/io/snabble/sdk/Project.kt

@@ -9,6 +9,7 @@ import io.snabble.sdk.auth.SnabbleAuthorizationInterceptor
 import io.snabble.sdk.checkout.Checkout
 import io.snabble.sdk.codes.templates.CodeTemplate
 import io.snabble.sdk.codes.templates.PriceOverrideTemplate
+import io.snabble.sdk.codes.templates.depositReturnVoucher.DepositReturnVoucherProvider
 import io.snabble.sdk.coupons.Coupon
 import io.snabble.sdk.coupons.CouponSource
 import io.snabble.sdk.coupons.Coupons
@@ -193,6 +194,13 @@ class Project internal constructor(
     var codeTemplates = emptyList<CodeTemplate>()
         private set
 
+    /**
+     * List of providers for deposit return vouchers.
+     * Each provider contains an id and a list of code templates used for parsing return voucher specific barcodes.
+     */
+    var depositReturnVoucherProviders = emptyList<DepositReturnVoucherProvider>()
+        private set
+
     /**
      * List of code templates that are used when supplying an existing Product with a different
      * barcode which contains a reduced price
@@ -468,6 +476,13 @@ class Project internal constructor(
         }
         this.codeTemplates = codeTemplates
 
+        val dvrProvider: JsonElement? = jsonObject["depositReturnVoucherProviders"]
+
+        if (dvrProvider?.isJsonArray == true) {
+            depositReturnVoucherProviders =
+                dvrProvider.asJsonArray.mapNotNull { drv -> DepositReturnVoucherProvider.fromJsonElement(drv) }
+        }
+
         val priceOverrideTemplates = mutableListOf<PriceOverrideTemplate>()
         jsonObject["priceOverrideCodes"]?.asJsonArray?.forEach {
             val priceOverride = it.asJsonObject

core/src/main/java/io/snabble/sdk/ViolationNotification.kt

@@ -1,5 +1,7 @@
 package io.snabble.sdk
 
+import io.snabble.sdk.checkout.ViolationType
+
 /**
  * A notification that a violation occurred
  */
@@ -9,9 +11,9 @@ data class ViolationNotification(
     /** The local generated uuid of the affected item **/
     val refersTo: String?,
     /** The type of the violation **/
-    val type: String? = null,
+    val type: ViolationType? = null,
     /** Non-localized message of the backend which sould be displayed
      * if no localized message is available
      */
     val fallbackMessage: String? = null,
-)
+)

core/src/main/java/io/snabble/sdk/checkout/Checkout.kt

@@ -82,6 +82,13 @@ class Checkout @JvmOverloads constructor(
             persistentState.save()
         }
 
+    var invalidItems: List<ShoppingCart.Item>?
+        get() = persistentState.invalidItems
+        private set(value) {
+            persistentState.invalidItems = value
+            persistentState.save()
+        }
+
     /**
      * List of coupons that were redeemed during this checkout
      */
@@ -303,12 +310,13 @@ class Checkout @JvmOverloads constructor(
                     notifyStateChanged(CheckoutState.INVALID_PRODUCTS)
                 }
 
-                override fun onNoAvailablePaymentMethodFound() {
-                    notifyStateChanged(CheckoutState.NO_PAYMENT_METHOD_AVAILABLE)
+                override fun onInvalidItems(itemIds: List<String>) {
+                    invalidItems = shoppingCart.filterNotNull().filter { it.id in itemIds }
+                    notifyStateChanged(CheckoutState.INVALID_ITEMS)
                 }
 
-                override fun onInvalidDepositReturnVoucher() {
-                    notifyStateChanged(CheckoutState.CONNECTION_ERROR)
+                override fun onNoAvailablePaymentMethodFound() {
+                    notifyStateChanged(CheckoutState.NO_PAYMENT_METHOD_AVAILABLE)
                 }
 
                 override fun onUnknownError() {
@@ -445,6 +453,15 @@ class Checkout @JvmOverloads constructor(
             notifyStateChanged(CheckoutState.PAYMENT_ABORTED)
             return
         }
+        val hasAnyFailedDrvRedemptions =
+            checkoutProcess?.depositReturnVouchers
+                ?.any { it.state == DepositReturnVoucherState.REDEEMING_FAILED }
+                ?: false
+
+        if (hasAnyFailedDrvRedemptions) {
+            notifyStateChanged(CheckoutState.DEPOSIT_RETURN_REDEMPTION_FAILED)
+            return
+        }
 
         Logger.d("Polling for approval state...")
         Logger.d("RoutingTarget = $routingTarget")

core/src/main/java/io/snabble/sdk/checkout/CheckoutApi.kt

@@ -4,15 +4,14 @@ import com.google.gson.Gson
 import com.google.gson.JsonObject
 import com.google.gson.annotations.SerializedName
 import com.google.gson.reflect.TypeToken
-import io.snabble.sdk.payment.PaymentCredentials
-import io.snabble.sdk.Product
-import io.snabble.sdk.coupons.Coupon
 import io.snabble.sdk.FulfillmentState
 import io.snabble.sdk.PaymentMethod
+import io.snabble.sdk.Product
+import io.snabble.sdk.coupons.Coupon
+import io.snabble.sdk.payment.PaymentCredentials
 import io.snabble.sdk.shoppingcart.data.cart.BackendCart
 import java.io.Serializable
-import java.lang.Exception
-import java.util.*
+import java.util.Date
 
 /**
  * Interface for the snabble Checkout API
@@ -90,8 +89,8 @@ interface CheckoutInfoResult {
 
     fun onNoShopFound()
     fun onInvalidProducts(products: List<Product>)
+    fun onInvalidItems(itemIds: List<String>)
     fun onNoAvailablePaymentMethodFound()
-    fun onInvalidDepositReturnVoucher()
     fun onUnknownError()
     fun onConnectionError()
 }
@@ -111,7 +110,9 @@ enum class LineItemType {
     @SerializedName("default") DEFAULT,
     @SerializedName("deposit") DEPOSIT,
     @SerializedName("discount") DISCOUNT,
-    @SerializedName("coupon") COUPON
+    @SerializedName("coupon") COUPON,
+    @SerializedName("depositReturnVoucher") DEPOSIT_RETURN_VOUCHER,
+    @SerializedName("depositReturn") DEPOSIT_RETURN
 }
 
 enum class CheckState {
@@ -213,11 +214,28 @@ data class CheckoutInfo(
 )
 
 data class Violation(
-    val type: String? = null,
+    val type: ViolationType? = null,
     val refersTo: String? = null,
     val message: String? = null,
 )
 
+enum class ViolationType {
+    @SerializedName("deposit_return_voucher_already_redeemed")
+    DEPOSIT_RETURN_ALREADY_REDEEMED,
+
+    @SerializedName("deposit_return_voucher_duplicate")
+    DEPOSIT_RETURN_DUPLICATED,
+
+    @SerializedName("coupon_already_voided")
+    COUPON_ALREADY_VOIDED,
+
+    @SerializedName("coupon_currently_not_valid")
+    COUPON_CURRENTLY_NOT_VALID,
+
+    @SerializedName("coupon_invalid")
+    COUPON_INVALID,
+}
+
 data class LineItem(
     val id: String? = null,
     val amount: Int = 0,
@@ -317,11 +335,37 @@ data class Fulfillment(
         get() = links?.get("self")?.href
 }
 
+data class DepositReturnVoucher(
+    @SerializedName("refersTo")
+    val refersTo: String,
+    @SerializedName("state")
+    val state: DepositReturnVoucherState
+)
+
+enum class DepositReturnVoucherState {
+    @SerializedName("pending")
+    PENDING,
+
+    @SerializedName("redeemed")
+    REDEEMED,
+
+    @SerializedName("redeemingFailed")
+    REDEEMING_FAILED,
+
+    @SerializedName("rolledback")
+    ROLLED_BACK,
+
+    @SerializedName("rollbackFailed")
+    ROLLBACK_FAILED
+}
+
 data class CheckoutProcessResponse(
     val links: Map<String, Href>? = null,
     val checks: List<Check> = emptyList(),
     @SerializedName("orderID")
     val orderId: String? = null,
+    @SerializedName("depositReturnVouchers")
+    val depositReturnVouchers: List<DepositReturnVoucher>? = null,
     val aborted: Boolean = false,
     val paymentMethod: PaymentMethod? = null,
     val paymentInformation: PaymentInformation? = null,

core/src/main/java/io/snabble/sdk/checkout/CheckoutRetryer.kt

@@ -143,11 +143,11 @@ internal class CheckoutRetryer(project: Project, fallbackPaymentMethod: PaymentM
                         fail()
                     }
 
-                    override fun onNoAvailablePaymentMethodFound() {
+                    override fun onInvalidItems(itemIds: List<String>) {
                         fail()
                     }
 
-                    override fun onInvalidDepositReturnVoucher() {
+                    override fun onNoAvailablePaymentMethodFound() {
                         fail()
                     }
 

core/src/main/java/io/snabble/sdk/checkout/CheckoutState.kt

@@ -109,6 +109,11 @@ enum class CheckoutState {
      */
     INVALID_PRODUCTS,
 
+    /**
+     * Invalid items detected. For example if an item can't be found
+     */
+    INVALID_ITEMS,
+
     /**
      * No payment method available
      */
@@ -129,4 +134,9 @@ enum class CheckoutState {
      * will not be communicated
      */
     PAYMENT_TRANSFERRED,
+
+    /**
+     * One of the deposit return vouchers added couldn't be redeemed
+     */
+    DEPOSIT_RETURN_REDEMPTION_FAILED
 }