feat: added commerce events to android

Author: ethanneff

src/android/io/branch/BranchSDK.java

@@ -20,7 +20,12 @@
 import io.branch.indexing.BranchUniversalObject;
 import io.branch.referral.Branch;
 import io.branch.referral.BranchError;
+import io.branch.referral.BranchViewHandler;
 import io.branch.referral.SharingHelper;
+import io.branch.referral.util.CommerceEvent;
+import io.branch.referral.util.CurrencyType;
+import io.branch.referral.util.Product;
+import io.branch.referral.util.ProductCategory;
 import io.branch.referral.util.ShareSheetStyle;
 
 public class BranchSDK extends CordovaPlugin {
@@ -107,6 +112,13 @@ public boolean execute(String action, JSONArray args, CallbackContext callbackCo
                     }
                     cordova.getThreadPool().execute(r);
                     return true;
+                } else if (action.equals("sendCommerceEvent")) {
+                    if (args.length() < 1 && args.length() > 2) {
+                        callbackContext.error(String.format("Parameter mismatched. 1-2 is required but %d is given", args.length()));
+                        return false;
+                    }
+                    cordova.getThreadPool().execute(r);
+                    return true;
                 } else if (action.equals("getFirstReferringParams")) {
                     cordova.getThreadPool().execute(r);
                     return true;
@@ -602,6 +614,91 @@ private void userCompletedAction(String action, JSONObject metaData, CallbackCon
 
     }
 
+    /**
+     * <p>A void call to indicate that the user has performed a specific commerce event and for that to be
+     * reported to the Branch API.</p>
+     *
+     * @param action          A {@link String} value to be passed as an commerce event that the user has
+     *                        carried out.
+     * @param metaData        A {@link JSONObject} containing app-defined meta-data to be attached to a
+     *                        user action that has just been completed.
+     * @param callbackContext A callback to execute at the end of this method
+     */
+    private void sendCommerceEvent(JSONObject action, JSONObject metaData, CallbackContext callbackContext) throws JSONException {
+
+        CommerceEvent commerce = new CommerceEvent();
+        Iterator<String> keys = action.keys();
+        while(keys.hasNext()){
+            String key = keys.next();
+            String val;
+            try {
+                val = action.getString(key);
+            } catch (JSONException e) {
+                e.printStackTrace();
+                callbackContext.error("Invalid key-value for " + key);
+                return;
+            }
+            if (key.equals("revenue")) {
+                commerce.setRevenue(Double.parseDouble(val));
+            } else if (key.equals("currency")) {
+                commerce.setCurrencyType(CurrencyType.values()[Integer.parseInt(val)]);
+            } else if (key.equals("transactionID")) {
+                commerce.setTransactionID(val);
+            } else if (key.equals("coupon")) {
+                commerce.setCoupon(val);
+            } else if (key.equals("shipping")) {
+                commerce.setShipping(Double.parseDouble(val));
+            } else if (key.equals("tax")) {
+                commerce.setTax(Double.parseDouble(val));
+            } else if (key.equals("affiliation")) {
+                commerce.setAffiliation(val);
+            } else if (key.equals("products")) {
+                JSONArray products = new JSONArray();
+                try {
+                    products = action.getJSONArray(key);
+                } catch (JSONException e) {
+                    e.printStackTrace();
+                    callbackContext.error("Invalid key-value for " + key);
+                    return;
+                }
+                for (int i = 0; i < products.length(); ++i) {
+                    Product product = new Product();
+                    JSONObject item = products.getJSONObject(i);
+                    keys = item.keys();
+                    while(keys.hasNext()) {
+                        key = keys.next();
+                        try {
+                            val = item.getString(key);
+                        } catch (JSONException e) {
+                            e.printStackTrace();
+                            callbackContext.error("Invalid key-value for product for " + key);
+                            return;
+                        }
+                        if (key.equals("sku")) {
+                            product.setSku(val);
+                        } else if (key.equals("name")) {
+                            product.setName(val);
+                        } else if (key.equals("price")) {
+                            product.setPrice(Double.parseDouble(val));
+                        } else if (key.equals("quantity")) {
+                            product.setQuantity(Integer.parseInt(val));
+                        } else if (key.equals("brand")) {
+                            product.setBrand(val);
+                        } else if (key.equals("category")) {
+                            product.setCategory(ProductCategory.values()[Integer.parseInt(val)]);
+                        } else if (key.equals("variant")) {
+                            product.setVariant(val);
+                        }
+                    }
+                    commerce.addProduct(product);
+                }
+            }
+        }
+
+        this.instance.sendCommerceEvent(commerce, metaData, new BranchViewEventsListener(callbackContext));
+
+    }
+
     /**
      * <p>Gets the credit history of the specified bucket and triggers a callback to handle the
      * response.</p>
@@ -645,6 +742,35 @@ public BranchUniversalObjectWrapper(BranchUniversalObject branchUniversalObj) {
     //----------- INNER CLASS LISTENERS ------------//
     //////////////////////////////////////////////////
 
+    protected class BranchViewEventsListener implements BranchViewHandler.IBranchViewEvents {
+
+        private CallbackContext _callbackContext;
+
+        public BranchViewEventsListener(CallbackContext callbackContext) {
+            callbackContext.success("Success");
+        }
+
+        @Override
+        public void onBranchViewVisible(String action, String branchViewID) {
+
+        }
+
+        @Override
+        public void onBranchViewAccepted(String action, String branchViewID) {
+
+        }
+
+        @Override
+        public void onBranchViewCancelled(String action, String branchViewID) {
+
+        }
+
+        @Override
+        public void onBranchViewError(int errorCode, String errorMsg, String action) {
+
+        }
+    }
+
     protected class SessionListener implements Branch.BranchReferralInitListener {
         private CallbackContext _callbackContext;
 
@@ -1104,6 +1230,8 @@ public void run() {
                         } else if (this.args.length() == 1) {
                             userCompletedAction(this.args.getString(0), this.callbackContext);
                         }
+                    } else if (this.action.equals("sendCommerceEvent")) {
+                        sendCommerceEvent(this.args.getJSONObject(0), this.args.getJSONObject(1), this.callbackContext);
                     } else if (this.action.equals("getFirstReferringParams")) {
                         getFirstReferringParams(this.callbackContext);
                     } else if (this.action.equals("getLatestReferringParams")) {