Make IAM able to re display multiple times

  * Changes on OSInAppMessage class, add two new params delay and limit
  * Make OSInAppMessageController handle the multiple re displays
  * Save on local database quantity of displays and last display time per IAM
  * Add unit test for new functionality

Author: Jeasmine

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessage.java

@@ -8,10 +8,18 @@
 
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.Iterator;
+import java.util.Set;
 
 class OSInAppMessage {
 
+    private static final String IAM_ID = "id";
+    private static final String IAM_VARIANTS = "variants";
+    private static final String IAM_TRIGGERS = "triggers";
+    private static final String IAM_RE_DISPLAY = "redisplay";
+    private static final String DISPLAY_DURATION = "display_duration";
+
     /**
      * The unique identifier for this in-app message
      */
@@ -34,24 +42,47 @@ class OSInAppMessage {
     @NonNull
     public ArrayList<ArrayList<OSTrigger>> triggers;
 
-    private double displayDuration;
+    /**
+     * IAM clicks associated to this IAM
+     */
+    @NonNull
+    private Set<String> clickedClickIds;
 
+    /**
+     * Reference to redisplay properties
+     */
+    private OSInAppMessageDisplayStats displayStats = new OSInAppMessageDisplayStats();
+
+    private double displayDuration;
+    private boolean triggerChanged = false;
     private boolean actionTaken;
     boolean isPreview;
 
     OSInAppMessage(boolean isPreview) {
         this.isPreview = isPreview;
     }
 
+    OSInAppMessage(@NonNull String messageId, @NonNull Set<String> clickIds, OSInAppMessageDisplayStats displayStats) {
+        this.messageId = messageId;
+        this.clickedClickIds = clickIds;
+
+        this.displayStats = displayStats;
+    }
+
     OSInAppMessage(JSONObject json) throws JSONException {
 
         // initialize simple root properties
-        this.messageId = json.getString("id");
-        this.variants = parseVariants(json.getJSONObject("variants"));
-        this.triggers = parseTriggerJson(json.getJSONArray("triggers"));
+        this.messageId = json.getString(IAM_ID);
+        this.variants = parseVariants(json.getJSONObject(IAM_VARIANTS));
+        this.triggers = parseTriggerJson(json.getJSONArray(IAM_TRIGGERS));
+        this.clickedClickIds = new HashSet<>();
+
+        if (json.has(IAM_RE_DISPLAY)) {
+            this.displayStats = new OSInAppMessageDisplayStats(json.getJSONObject(IAM_RE_DISPLAY));
+        }
     }
 
-    private static HashMap<String, HashMap<String, String>> parseVariants(JSONObject json) throws JSONException {
+    private HashMap<String, HashMap<String, String>> parseVariants(JSONObject json) throws JSONException {
         HashMap<String, HashMap<String, String>> variantTypes = new HashMap<>();
 
         Iterator<String> keyIterator = json.keys();
@@ -72,16 +103,17 @@ private static HashMap<String, HashMap<String, String>> parseVariants(JSONObject
         return variantTypes;
     }
 
-    ArrayList<ArrayList<OSTrigger>> parseTriggerJson(JSONArray triggersJson) throws JSONException {
+    protected ArrayList<ArrayList<OSTrigger>> parseTriggerJson(JSONArray triggersJson) throws JSONException {
         // initialize triggers
         ArrayList<ArrayList<OSTrigger>> parsedTriggers = new ArrayList<>();
 
         for (int i = 0; i < triggersJson.length(); i++) {
             JSONArray ands = triggersJson.getJSONArray(i);
             ArrayList<OSTrigger> converted = new ArrayList<>();
-            for (int j = 0; j < ands.length(); j++)
-                converted.add(new OSTrigger(ands.getJSONObject(j)));
-
+            for (int j = 0; j < ands.length(); j++) {
+                OSTrigger trigger = new OSTrigger(ands.getJSONObject(j));
+                converted.add(trigger);
+            }
             parsedTriggers.add(converted);
         }
 
@@ -92,7 +124,7 @@ JSONObject toJSONObject() {
         JSONObject json = new JSONObject();
 
         try {
-            json.put("id", this.messageId);
+            json.put(IAM_ID, this.messageId);
 
             JSONObject variants = new JSONObject();
             for (String key : this.variants.keySet()) {
@@ -105,8 +137,11 @@ JSONObject toJSONObject() {
                 variants.put(key, converted);
             }
 
-            json.put("variants", variants);
-            json.put("display_duration", this.displayDuration);
+            json.put(IAM_VARIANTS, variants);
+            json.put(DISPLAY_DURATION, this.displayDuration);
+
+            if (displayStats.isRedisplayEnabled())
+                json.put(IAM_RE_DISPLAY, displayStats.toJSONObject());
 
             JSONArray orConditions = new JSONArray();
             for (ArrayList<OSTrigger> andArray : this.triggers) {
@@ -118,7 +153,7 @@ JSONObject toJSONObject() {
                 orConditions.put(andConditions);
             }
 
-            json.put("triggers", orConditions);
+            json.put(IAM_TRIGGERS, orConditions);
 
         } catch (JSONException exception) {
             exception.printStackTrace();
@@ -129,6 +164,7 @@ JSONObject toJSONObject() {
 
     /**
      * Called when an action is taken to track uniqueness
+     *
      * @return true if action taken was unique
      */
     boolean takeActionAsUnique() {
@@ -137,22 +173,66 @@ boolean takeActionAsUnique() {
         return actionTaken = true;
     }
 
-    public double getDisplayDuration() {
+    double getDisplayDuration() {
         return displayDuration;
     }
 
-    public void setDisplayDuration(double displayDuration) {
+    void setDisplayDuration(double displayDuration) {
         this.displayDuration = displayDuration;
     }
 
+    boolean isTriggerChanged() {
+        return triggerChanged;
+    }
+
+    void setTriggerChanged(boolean triggerChanged) {
+        this.triggerChanged = triggerChanged;
+    }
+
+    @NonNull
+    Set<String> getClickedClickIds() {
+        return clickedClickIds;
+    }
+
+    boolean isClickAvailable(String clickId) {
+        return !clickedClickIds.contains(clickId);
+    }
+
+    void clearClickIds() {
+        clickedClickIds.clear();
+    }
+
+    void addClickId(String clickId) {
+        clickedClickIds.add(clickId);
+    }
+
+    OSInAppMessageDisplayStats getDisplayStats() {
+        return displayStats;
+    }
+
     @Override
     public String toString() {
         return "OSInAppMessage{" +
                 "messageId='" + messageId + '\'' +
-                ", variants=" + variants +
                 ", triggers=" + triggers +
-                ", displayDuration=" + displayDuration +
+                ", clickedClickIds=" + clickedClickIds +
+                ", displayStats=" + displayStats +
                 ", actionTaken=" + actionTaken +
+                ", isPreview=" + isPreview +
                 '}';
     }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        OSInAppMessage that = (OSInAppMessage) o;
+        return messageId.equals(that.messageId);
+    }
+
+    @Override
+    public int hashCode() {
+        int result = messageId.hashCode();
+        return result;
+    }
 }