support terminal handover + product resolver key listener

Author: ajungg

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog  
 All notable changes to this project will be documented in this file.
 
+## [0.17.3]
+
+### Added
+- Added support for terminal handover
+- Added support for adding payment origins over terminal payments
+- Added OnKeyListener to PaymentResolver
+
 ## [0.17.2]
 
 ### Changed

build.gradle

@@ -23,7 +23,7 @@ allprojects {
     }
 
     project.ext {
-        sdkVersion='0.17.2'
+        sdkVersion='0.17.3'
         versionCode=1
 
         compileSdkVersion=29

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

@@ -43,6 +43,12 @@ public enum State {
          * Payment was approved and is currently processing.
          */
         PAYMENT_PROCESSING,
+        /**
+         * Happens when a user want to save his transaction details when paying over a terminal.
+         *
+         * To continue call {@link #continuePaymentProcess()}.
+         */
+        REQUEST_ADD_PAYMENT_ORIGIN,
         /**
          * The payment was approved. We are done.
          */
@@ -81,6 +87,16 @@ public enum State {
         NO_SHOP,
     }
 
+    public class PaymentOrigin {
+        public final String name;
+        public final String iban;
+
+        PaymentOrigin(String name, String iban) {
+            this.name = name;
+            this.iban = iban;
+        }
+    }
+
     private Project project;
     private CheckoutApi checkoutApi;
     private ShoppingCart shoppingCart;
@@ -102,6 +118,8 @@ public enum State {
     private PaymentMethod[] clientAcceptedPaymentMethods;
     private Shop shop;
     private List<Product> invalidProducts;
+    private CheckoutApi.PaymentResult paymentResult;
+    private boolean paymentResultHandled;
 
     private Runnable pollRunnable = new Runnable() {
         @Override
@@ -408,6 +426,7 @@ public void success(CheckoutApi.CheckoutProcessResponse checkoutProcessResponse)
                     checkoutProcess = checkoutProcessResponse;
 
                     if (handleProcessResponse()) {
+                        Logger.d("stop polling");
                         handler.removeCallbacks(pollRunnable);
                     }
                 }
@@ -419,7 +438,9 @@ public void error() {
             }
         });
 
-        if (state == State.WAIT_FOR_APPROVAL || state == State.PAYMENT_APPROVED) {
+        if (state == State.WAIT_FOR_APPROVAL
+                || state == State.PAYMENT_APPROVED
+                || state == State.REQUEST_ADD_PAYMENT_ORIGIN) {
             scheduleNextPoll();
         }
     }
@@ -431,6 +452,21 @@ private boolean handleProcessResponse() {
             return true;
         }
 
+        if (checkoutProcess.paymentResult != null
+         && checkoutProcess.paymentResult.ehiTechDaysName != null
+         && checkoutProcess.paymentResult.ehiTechDaysIban != null) {
+            if (!paymentResultHandled) {
+                if (paymentResult == null) {
+                    Logger.d("Request adding payment origin");
+                    paymentResult = checkoutProcess.paymentResult;
+                    paymentResultHandled = false;
+                    notifyStateChanged(State.REQUEST_ADD_PAYMENT_ORIGIN);
+                }
+
+                return false;
+            }
+        }
+
         if (checkoutProcess.paymentState == CheckoutApi.PaymentState.SUCCESSFUL) {
             approve();
             return true;
@@ -469,6 +505,14 @@ public void approveOfflineMethod() {
         }
     }
 
+    /** Continues the payment process after it stopped when requiring user interaction,
+     *  for example after REQUEST_ADD_PAYMENT_ORIGIN **/
+    public void continuePaymentProcess() {
+        Logger.d("Continue payment process");
+        paymentResultHandled = true;
+        paymentResult = null;
+    }
+
     public String getOrderId() {
         return checkoutProcess != null ? checkoutProcess.orderId : null;
     }
@@ -516,6 +560,14 @@ public PaymentMethod getSelectedPaymentMethod() {
         return paymentMethod;
     }
 
+    public PaymentMethod getPaymentMethodForPayment() {
+        if (checkoutProcess != null) {
+            return checkoutProcess.paymentMethod;
+        }
+
+        return null;
+    }
+
     public int getPriceToPay() {
         return priceToPay;
     }
@@ -524,6 +576,17 @@ public List<Product> getInvalidProducts() {
         return invalidProducts;
     }
 
+    public PaymentOrigin getPaymentOrigin() {
+        if (paymentResult != null
+                && paymentResult.ehiTechDaysIban != null
+                && paymentResult.ehiTechDaysName != null) {
+            return new PaymentOrigin(paymentResult.ehiTechDaysName,
+                    paymentResult.ehiTechDaysIban);
+        }
+
+        return null;
+    }
+
     /**
      * Gets all available payment methods, callable after {@link Checkout.State#REQUEST_PAYMENT_METHOD}.
      */

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

@@ -143,6 +143,11 @@ public enum PaymentState {
         FAILED,
     }
 
+    public static class PaymentResult {
+        public String ehiTechDaysIban;
+        public String ehiTechDaysName;
+    }
+
     public static class CheckoutProcessResponse {
         public Map<String, Href> links;
         public Boolean supervisorApproval;
@@ -155,6 +160,7 @@ public static class CheckoutProcessResponse {
         public boolean modified;
         public PaymentInformation paymentInformation;
         public PaymentState paymentState;
+        public PaymentResult paymentResult;
 
         public String getSelfLink() {
             Href link = links.get("self");

core/src/main/java/io/snabble/sdk/payment/PaymentCredentials.java

@@ -121,6 +121,35 @@ public static PaymentCredentials fromSEPA(String name, String iban) {
         return pc;
     }
 
+    public static PaymentCredentials fromEncryptedSEPA(String name, String obfuscatedId, String encryptedData) {
+        PaymentCredentials pc = new PaymentCredentials();
+        pc.type = Type.SEPA;
+
+        List<X509Certificate> certificates = Snabble.getInstance().getPaymentSigningCertificates();
+        if (certificates.size() == 0) {
+            return null;
+        }
+
+        if (name == null || name.length() == 0) {
+            throw new IllegalArgumentException("Invalid Name");
+        }
+
+        pc.obfuscatedId = obfuscatedId;
+
+        X509Certificate certificate = certificates.get(0);
+        pc.encryptedData = encryptedData;
+        pc.encrypt();
+        pc.signature = pc.sha256Signature(certificate);
+        pc.brand = Brand.UNKNOWN;
+        pc.appId = Snabble.getInstance().getConfig().appId;
+
+        if (pc.encryptedData == null) {
+            return null;
+        }
+
+        return pc;
+    }
+
     public static PaymentCredentials fromCreditCardData(String name, Brand brand, String obfuscatedId,
                                                         String expirationMonth, String expirationYear,
                                                         String hostedDataId, String storeId) {

ui/src/main/java/io/snabble/sdk/ui/checkout/CheckoutGatekeeperView.java

@@ -93,7 +93,7 @@ public void onStateChanged(Checkout.State state) {
                 checkoutIdCode.setVisibility(View.VISIBLE);
                 String id = checkout.getId();
                 if (id != null) {
-                    checkoutIdCode.setText("snabble:checkoutInfo:" + id);
+                    checkoutIdCode.setText("snabble:checkoutProcess:" + id);
                 }
                 break;
             case PAYMENT_PROCESSING:

ui/src/main/java/io/snabble/sdk/ui/checkout/CheckoutView.java

@@ -13,9 +13,13 @@
 import android.view.View;
 import android.view.ViewGroup;
 import android.widget.FrameLayout;
+import android.widget.Toast;
 import android.widget.ViewAnimator;
 
 import io.snabble.sdk.Checkout;
+import io.snabble.sdk.Snabble;
+import io.snabble.sdk.payment.PaymentCredentials;
+import io.snabble.sdk.ui.KeyguardHandler;
 import io.snabble.sdk.ui.R;
 import io.snabble.sdk.ui.SnabbleUI;
 import io.snabble.sdk.ui.SnabbleUICallback;
@@ -126,6 +130,24 @@ public void onClick(DialogInterface dialog, int which) {
                         .create()
                         .show();
                 break;
+            case REQUEST_ADD_PAYMENT_ORIGIN:
+                new AlertDialog.Builder(getContext())
+                        .setMessage(R.string.Snabble_Payment_addPaymentOrigin)
+                        .setPositiveButton(R.string.Snabble_Yes, new DialogInterface.OnClickListener() {
+                            @Override
+                            public void onClick(DialogInterface dialog, int which) {
+                                addPaymentOrigin();
+                            }
+                        })
+                        .setNegativeButton(R.string.Snabble_No, new DialogInterface.OnClickListener() {
+                            @Override
+                            public void onClick(DialogInterface dialog, int which) {
+                                checkout.continuePaymentProcess();
+                            }
+                        })
+                        .create()
+                        .show();
+                break;
             case PAYMENT_ABORTED:
             case DENIED_BY_PAYMENT_PROVIDER:
             case DENIED_BY_SUPERVISOR:
@@ -146,6 +168,43 @@ public void onClick(DialogInterface dialog, int which) {
         currentState = state;
     }
 
+    private void addPaymentOrigin() {
+        if (Snabble.getInstance().getUserPreferences().isRequiringKeyguardAuthenticationForPayment()) {
+            SnabbleUI.getUiCallback().requestKeyguard(new KeyguardHandler() {
+                @Override
+                public void onKeyguardResult(int resultCode) {
+                    if (resultCode == Activity.RESULT_OK) {
+                        addPaymentCredentials();
+                        checkout.continuePaymentProcess();
+                    }
+                }
+            });
+        } else {
+            addPaymentCredentials();
+            checkout.continuePaymentProcess();
+        }
+    }
+
+    public void addPaymentCredentials() {
+        Checkout.PaymentOrigin paymentOrigin = checkout.getPaymentOrigin();
+
+        if (paymentOrigin != null) {
+            final PaymentCredentials pc = PaymentCredentials.fromSEPA(
+                    paymentOrigin.name,
+                    paymentOrigin.iban);
+
+            if (pc == null) {
+                Toast.makeText(getContext(), "Could not verify payment credentials", Toast.LENGTH_LONG)
+                        .show();
+            } else {
+                Snabble.getInstance().getPaymentCredentialsStore().add(pc);
+                Telemetry.event(Telemetry.Event.PaymentMethodAdded, pc.getType().name());
+
+                checkout.continuePaymentProcess();
+            }
+        }
+    }
+
     private void displayPaymentView() {
         switch (checkout.getSelectedPaymentMethod()) {
             case TEGUT_EMPLOYEE_CARD:

ui/src/main/java/io/snabble/sdk/ui/checkout/PaymentMethodView.java

@@ -58,7 +58,7 @@ class PaymentMethodView extends FrameLayout implements PaymentCredentialsStore.C
         icons.put(PaymentMethod.QRCODE_POS, R.drawable.snabble_ic_pm_checkstand);
         icons.put(PaymentMethod.QRCODE_OFFLINE, R.drawable.snabble_ic_pm_checkstand);
         icons.put(PaymentMethod.TEGUT_EMPLOYEE_CARD, R.drawable.snabble_ic_pm_tegut);
-        icons.put(PaymentMethod.GATEKEEPER_TERMINAL, R.drawable.snabble_ic_pm_checkstand);
+        icons.put(PaymentMethod.GATEKEEPER_TERMINAL, R.drawable.snabble_ic_pm_sco);
     }
 
     private Checkout checkout;
@@ -419,6 +419,8 @@ public void onBindViewHolder(final PaymentMethodView.ViewHolder holder, final in
                 matrix.setSaturation(0);
                 ColorMatrixColorFilter filter = new ColorMatrixColorFilter(matrix);
                 imageView.setColorFilter(filter);
+            } else {
+                imageView.clearColorFilter();
             }
 
             TextView textView = holder.text;

ui/src/main/java/io/snabble/sdk/ui/scanner/ProductConfirmationDialog.java

@@ -63,7 +63,7 @@ class ProductConfirmationDialog {
 
     private DialogInterface.OnDismissListener onDismissListener;
     private DialogInterface.OnShowListener onShowListener;
-
+    private DialogInterface.OnKeyListener onKeyListener;
 
     public ProductConfirmationDialog(Context context,
                                      Project project) {
@@ -84,6 +84,7 @@ public void show(Product product, ScannedCode scannedCode) {
 
         alertDialog.setOnShowListener(onShowListener);
         alertDialog.setOnDismissListener(onDismissListener);
+        alertDialog.setOnKeyListener(onKeyListener);
 
         quantity = view.findViewById(R.id.quantity);
         subtitle = view.findViewById(R.id.subtitle);
@@ -285,7 +286,7 @@ private void updatePrice() {
         }
     }
 
-    private void addToCart() {
+    public void addToCart() {
         // its possible that the onClickListener gets called before a dismiss is dispatched
         // and when that happens the product is already null
         if (cartItem == null) {
@@ -395,4 +396,8 @@ public void setOnDismissListener(DialogInterface.OnDismissListener onDismissList
     public void setOnShowListener(DialogInterface.OnShowListener onShowListener) {
         this.onShowListener = onShowListener;
     }
+
+    public void setOnKeyListener(DialogInterface.OnKeyListener onKeyListener) {
+        this.onKeyListener = onKeyListener;
+    }
 }