Merge pull request #16 from snabble/routing_targets

Activity API + RoutingTargets

Author: ajungg

CHANGELOG.md

@@ -1,6 +1,28 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.60.0-alpha02]
+
+### Changes
+- Add support for new Routing Targets API
+
+## [0.60.0-alpha01]
+
+### Breaking Changes
+- Removed 'ui-integration' module and integrated it into 'ui'
+    - All Fragments have its package name changed due to this.
+- Now supporting Activities for all screens. For example 'SelfScanningActivity' for the Scanner.
+  Refer to the Documentation for a list of all Activites/Fragments and View's
+- Removed SnabbleUI.registerUiCallbacks in favor of SnabbleUI.setUiAction
+    - UI Callback are now entirely optional, and Activites will be launched if a UI Event is not implemented
+      by the hosting application
+    - Upgrading from 0.52.x requires the callbacks to be changed, but the general flow is the same if you were using Fragments
+    - Cleanup is done automatically, no SnabbleUI.unregisterUiCallbacks is necessary anymore!
+- Checkout is now done in it's own Activity and can be started by using CheckoutActivity.startCheckoutFlow
+
+### Notes
+- Toolbar can be enabled in Activities by setting **snabbleToolbarStyle** in your Application theme
+
 ## [0.53.0]
 
 ### Changed

README.md

@@ -37,10 +37,6 @@ dependencies {
     
     // user interface library
     implementation 'io.snabble.sdk:ui:{currentVersion}'
-    
-    // user interface integration library, entirely optional,
-    // for more seamless and easier integration in apps
-    implementation 'io.snabble.sdk:ui-integration:{currentVersion}'
 }
 ```
 

build.gradle

@@ -31,14 +31,13 @@ allprojects {
     }
 
     project.ext {
-        sdkVersion='0.53.0'
+        sdkVersion='0.60.0-alpha02'
         versionCode=1
 
         compileSdkVersion=31
         minSdkVersion=21
         targetSdkVersion=31
 
-        buildToolsVersion='30.0.2'
         okhttpVersion='4.9.1'
         desugarVersion='1.1.5'
 

core/build.gradle

@@ -6,7 +6,6 @@ apply plugin: 'org.jetbrains.dokka'
 
 android {
     compileSdkVersion project.compileSdkVersion
-    buildToolsVersion project.buildToolsVersion
 
     defaultConfig {
         minSdkVersion project.minSdkVersion

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

@@ -55,7 +55,15 @@ public enum State {
          */
         REQUEST_PAYMENT_AUTHORIZATION_TOKEN,
         /**
-         * Payment was received by the backend and we are waiting for confirmation of the payment provider
+         * Checkout was received and we wait for confirmation by the supervisor
+         */
+        WAIT_FOR_SUPERVISOR,
+        /**
+         * Checkout was received and we wait for confirmation by the gatekeeper
+         */
+        WAIT_FOR_GATEKEEPER,
+        /**
+         * Payment was received by the backend and we are waiting for confirmation by the payment provider
          */
         WAIT_FOR_APPROVAL,
         /**
@@ -158,15 +166,15 @@ public void abort() {
      * was cancelled
      */
     public void abort(boolean error) {
-        cancelOutstandingCalls();
-
         if (state != Checkout.State.PAYMENT_APPROVED
                 && state != Checkout.State.DENIED_BY_PAYMENT_PROVIDER
                 && state != Checkout.State.DENIED_BY_SUPERVISOR
                 && checkoutProcess != null) {
             checkoutApi.abort(checkoutProcess, new CheckoutApi.PaymentAbortResult() {
                 @Override
                 public void success() {
+                    cancelOutstandingCalls();
+
                     synchronized (Checkout.this) {
                         if (error) {
                             notifyStateChanged(Checkout.State.PAYMENT_PROCESSING_ERROR);
@@ -236,13 +244,6 @@ public void reset() {
         shop = null;
     }
 
-    public void resume() {
-        if (lastState == Checkout.State.WAIT_FOR_APPROVAL || lastState == State.REQUEST_PAYMENT_AUTHORIZATION_TOKEN) {
-            notifyStateChanged(Checkout.State.WAIT_FOR_APPROVAL);
-            pollForResult();
-        }
-    }
-
     public boolean isAvailable() {
         return project.getCheckoutUrl() != null && project.isCheckoutAvailable();
     }
@@ -397,22 +398,6 @@ public void success(CheckoutApi.CheckoutProcessResponse checkoutProcessResponse,
                         rawCheckoutProcess = rawResponse;
 
                         if (!handleProcessResponse()) {
-                            boolean allChecksOk = areAllChecksSucceeded(checkoutProcessResponse);
-
-                            if (allChecksOk) {
-                                if (checkoutProcessResponse.paymentState == CheckoutApi.State.PROCESSING) {
-                                    Logger.d("Processing payment...");
-                                    notifyStateChanged(Checkout.State.PAYMENT_PROCESSING);
-                                } else {
-                                    Logger.d("Waiting for approval...");
-                                    if (paymentMethod != PaymentMethod.GOOGLE_PAY) {
-                                        notifyStateChanged(Checkout.State.WAIT_FOR_APPROVAL);
-                                    }
-                                }
-                            } else {
-                                notifyStateChanged(Checkout.State.WAIT_FOR_APPROVAL);
-                            }
-
                             if (!paymentMethod.isOfflineMethod()) {
                                 scheduleNextPoll();
                             }
@@ -457,7 +442,7 @@ private boolean areAllChecksSucceeded(CheckoutApi.CheckoutProcessResponse checko
 
         if (checkoutProcessResponse.checks != null) {
             for (CheckoutApi.Check check : checkoutProcessResponse.checks) {
-                if (check.state == CheckoutApi.State.FAILED) {
+                if (check.state != CheckoutApi.State.SUCCESSFUL) {
                     return false;
                 }
 
@@ -493,6 +478,30 @@ private boolean areAllChecksSucceeded(CheckoutApi.CheckoutProcessResponse checko
         return allChecksOk;
     }
 
+    private boolean hasAnyCheckFailed(CheckoutApi.CheckoutProcessResponse checkoutProcessResponse) {
+        if (checkoutProcessResponse.checks != null) {
+            for (CheckoutApi.Check check : checkoutProcessResponse.checks) {
+                if (check.state == CheckoutApi.State.FAILED) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
+    private boolean hasAnyFulfillmentAllocationFailed() {
+        if (checkoutProcess.fulfillments != null) {
+            for (CheckoutApi.Fulfillment fulfillment : checkoutProcess.fulfillments) {
+                if (fulfillment.state == FulfillmentState.ALLOCATION_FAILED || fulfillment.state == FulfillmentState.ALLOCATION_TIMED_OUT) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
     private boolean hasStillPendingChecks(CheckoutApi.CheckoutProcessResponse checkoutProcessResponse) {
         if (checkoutProcessResponse.checks != null) {
             for (CheckoutApi.Check check : checkoutProcessResponse.checks) {
@@ -569,6 +578,8 @@ private void pollForResult() {
 
         Logger.d("Polling for approval state...");
 
+        Logger.d("RoutingTarget = " + getRoutingTarget());
+
         checkoutApi.updatePaymentProcess(checkoutProcess, new CheckoutApi.PaymentProcessResult() {
             @Override
             public void success(CheckoutApi.CheckoutProcessResponse checkoutProcessResponse, String rawResponse) {
@@ -589,6 +600,8 @@ public void error() {
         });
 
         if (state == Checkout.State.WAIT_FOR_APPROVAL
+                || state == State.WAIT_FOR_GATEKEEPER
+                || state == State.WAIT_FOR_SUPERVISOR
                 || state == State.VERIFYING_PAYMENT_METHOD
                 || state == State.REQUEST_PAYMENT_AUTHORIZATION_TOKEN
                 || state == Checkout.State.PAYMENT_PROCESSING
@@ -608,6 +621,18 @@ private boolean handleProcessResponse() {
             return true;
         }
 
+        if (state == State.VERIFYING_PAYMENT_METHOD) {
+            if (checkoutProcess.routingTarget == CheckoutApi.RoutingTarget.SUPERVISOR) {
+                notifyStateChanged(State.WAIT_FOR_SUPERVISOR);
+            } else if (checkoutProcess.routingTarget == CheckoutApi.RoutingTarget.GATEKEEPER) {
+                notifyStateChanged(State.WAIT_FOR_GATEKEEPER);
+            } else {
+                notifyStateChanged(State.WAIT_FOR_APPROVAL);
+            }
+
+            return false;
+        }
+
         String authorizePaymentUrl = checkoutProcess.getAuthorizePaymentLink();
         if (authorizePaymentUrl != null) {
             if (authorizePaymentRequestFailed) {
@@ -651,11 +676,12 @@ private boolean handleProcessResponse() {
                 return false;
             }
 
-            if (hasStillPendingChecks(checkoutProcess)) {
-                notifyStateChanged(State.WAIT_FOR_APPROVAL);
+            if (hasAnyFulfillmentAllocationFailed()) {
+                notifyStateChanged(State.PAYMENT_ABORTED);
+                return true;
             }
 
-            if (!areAllChecksSucceeded(checkoutProcess)) {
+            if (hasAnyCheckFailed(checkoutProcess)) {
                 Logger.d("Payment denied by supervisor");
                 shoppingCart.generateNewUUID();
                 notifyStateChanged(Checkout.State.DENIED_BY_SUPERVISOR);
@@ -708,6 +734,7 @@ public List<Coupon> getRedeemedCoupons() {
     public void approveOfflineMethod() {
         if (paymentMethod != null && paymentMethod.isOfflineMethod()
          || paymentMethod == PaymentMethod.CUSTOMERCARD_POS) {
+            shoppingCart.generateNewUUID();
             approve();
         }
     }
@@ -787,6 +814,14 @@ public int getVerifiedOnlinePrice() {
         return -1;
     }
 
+    public CheckoutApi.RoutingTarget getRoutingTarget() {
+        if (checkoutProcess != null && checkoutProcess.routingTarget != null) {
+            return checkoutProcess.routingTarget;
+        }
+
+        return CheckoutApi.RoutingTarget.NONE;
+    }
+
     public List<Product> getInvalidProducts() {
         return invalidProducts;
     }

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

@@ -193,6 +193,7 @@ public static class PaymentInformation {
         public String deviceName;
         public String deviceFingerprint;
         public String deviceIPAddress;
+        public String handoverInformation;
     }
 
     public static class CheckoutProcessRequest {
@@ -285,6 +286,15 @@ public String getSelfLink() {
         }
     }
 
+    public enum RoutingTarget {
+        @SerializedName("gatekeeper")
+        GATEKEEPER,
+        @SerializedName("supervisor")
+        SUPERVISOR,
+        @SerializedName("none")
+        NONE,
+    }
+
     public static class CheckoutProcessResponse {
         public Map<String, Href> links;
         public Check[] checks;
@@ -298,6 +308,7 @@ public static class CheckoutProcessResponse {
         public ExitToken exitToken;
         public State paymentState;
         public Pricing pricing;
+        public RoutingTarget routingTarget;
         public PaymentResult paymentResult;
         public Fulfillment[] fulfillments;
 

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

@@ -448,6 +448,10 @@ public List<Project> getProjects() {
     }
 
     public Project getProjectById(String projectId) {
+        if (projects == null) {
+            return null;
+        }
+
         for (Project project : projects) {
             if (project.getId().equals(projectId)) {
                 return project;
@@ -563,20 +567,6 @@ public interface OnMetadataUpdateListener {
         void onMetaDataUpdated();
     }
 
-    /**
-     * Sets the current activity context.
-     *
-     * This is an internal method and should not be called.
-     */
-    public void _setCurrentActivity(Activity activity) {
-        if (currentActivity != null) {
-            currentActivity.clear();
-            currentActivity = null;
-        }
-
-        currentActivity = new WeakReference<>(activity);
-    }
-
     private final Application.ActivityLifecycleCallbacks activityLifecycleCallbacks = new SimpleActivityLifecycleCallbacks() {
 
         @Override
@@ -690,7 +680,7 @@ public Error getError() {
             return error;
         }
 
-        @NonNull 
+        @NonNull
         @Override
         public String toString() {
             return "SnabbleException{" +

docs/docs/android-api.md

@@ -5,8 +5,7 @@
 minSdkVersion = 21  
 compileSdkVersion = 29  
 java 8
-
-androidx and a material 3 theme for ui components
+androidx
 
 ### Using the snabble GitHub Repository
 
@@ -29,10 +28,6 @@ dependencies {
     
     // user interface library
     implementation 'io.snabble.sdk:ui:{{ extra.sdk_version }}'
-    
-    // user interface integration library, entirely optional,
-    // for more seamless and easier integration in apps
-    implementation 'io.snabble.sdk:ui-integration:{{ extra.sdk_version }}'
 }
 ```
 
@@ -83,7 +78,7 @@ snabble.setup(this, config, new Snabble.SetupCompletionListener() {
         project = snabble.getProjects().get(0);
 
         // registers this project globally for use with ui components
-        SnabbleUI.useProject(project);
+        SnabbleUI.setProject(project);
 
         // select the first shop for demo purposes, ideally this should be done with
         // geofencing or a manual user selection