Add method for downloading inbox messages (#434)

* Add method for downloading inbox messages

* Simplify implementation

* Move public methods to LeanplumInbox

Author: hborisoff

AndroidSDKCore/src/main/java/com/leanplum/Leanplum.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016, Leanplum, Inc. All rights reserved.
+ * Copyright 2020, Leanplum, Inc. All rights reserved.
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file

AndroidSDKCore/src/main/java/com/leanplum/LeanplumInbox.java

@@ -24,6 +24,7 @@
 import android.content.Context;
 import android.content.SharedPreferences;
 
+import androidx.annotation.Nullable;
 import com.leanplum.callbacks.InboxChangedCallback;
 import com.leanplum.callbacks.InboxSyncedCallback;
 import com.leanplum.callbacks.VariablesChangedCallback;
@@ -284,6 +285,19 @@ void triggerInboxSyncedWithStatus(boolean success) {
     }
   }
 
+  private void triggerInboxSyncedWithStatus(
+      boolean success,
+      @Nullable InboxSyncedCallback oneTimeCallback) {
+
+    if (oneTimeCallback != null) {
+      addSyncedHandler(oneTimeCallback);
+      triggerInboxSyncedWithStatus(success);
+      removeSyncedHandler(oneTimeCallback);
+    } else {
+      triggerInboxSyncedWithStatus(success);
+    }
+  }
+
   void load() {
     if (Constants.isNoop()) {
       return;
@@ -346,7 +360,21 @@ void save() {
     SharedPreferencesUtil.commitChanges(editor);
   }
 
-  void downloadMessages() {
+  /**
+   * Forces downloading of inbox messages from the server. After messages are downloaded the
+   * appropriate callbacks will fire.
+   */
+  public void downloadMessages() {
+    downloadMessages(null);
+  }
+
+  /**
+   * Forces downloading of inbox messages from the server. After messages are downloaded the
+   * appropriate callbacks will fire.
+   *
+   * @param callback The callback to invoke when messages are downloaded.
+   */
+  public void downloadMessages(@Nullable InboxSyncedCallback callback) {
     if (Constants.isNoop()) {
       return;
     }
@@ -399,7 +427,7 @@ public void response(JSONObject response) {
 
           if (!willDownladImages) {
             update(messages, unreadCount, true);
-            triggerInboxSyncedWithStatus(true);
+            triggerInboxSyncedWithStatus(true, callback);
             return;
           }
 
@@ -409,19 +437,19 @@ public void response(JSONObject response) {
                 @Override
                 public void variablesChanged() {
                   update(messages, totalUnreadCount, true);
-                  triggerInboxSyncedWithStatus(true);
+                  triggerInboxSyncedWithStatus(true, callback);
                 }
               });
         } catch (Throwable t) {
-          triggerInboxSyncedWithStatus(false);
+          triggerInboxSyncedWithStatus(false, callback);
           Log.exception(t);
         }
       }
     });
     req.onError(new Request.ErrorCallback() {
       @Override
       public void error(Exception e) {
-        triggerInboxSyncedWithStatus(false);
+        triggerInboxSyncedWithStatus(false, callback);
       }
     });
     RequestSender.getInstance().send(req);

AndroidSDKCore/src/main/java/com/leanplum/callbacks/InboxSyncedCallback.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2017, Leanplum, Inc. All rights reserved.
+ * Copyright 2020, Leanplum, Inc. All rights reserved.
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -22,7 +22,7 @@
 package com.leanplum.callbacks;
 
 /**
- * Callback that gets run when forceContentUpdate was called.
+ * Callback that gets run when inbox finishes syncing of messages.
  *
  * @author Anna Orlova
  */
@@ -38,7 +38,7 @@ public void run() {
   }
 
   /**
-   * Call when forceContentUpdate was called.
+   * Called when inbox finishes syncing of messages.
    * @param success True if syncing was successful.
    */
   public abstract void onForceContentUpdate(boolean success);

AndroidSDKTests/src/test/java/com/leanplum/LeanplumInboxTest.java

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2020, Leanplum, Inc. All rights reserved.
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.leanplum;
+
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
+
+import com.leanplum.__setup.AbstractTest;
+import com.leanplum._whitebox.utilities.ResponseHelper;
+import com.leanplum.callbacks.InboxSyncedCallback;
+import org.junit.Test;
+
+/**
+ * Unit tests for {@link LeanplumInbox}.
+ */
+public class LeanplumInboxTest extends AbstractTest {
+
+  /**
+   * Test for {@link LeanplumInbox#downloadMessages()}.
+   */
+  @Test
+  public void testDownloadMessages() {
+    setupSDK(mContext, "/responses/simple_start_response.json");
+
+    ResponseHelper.seedResponse("/responses/newsfeed_response.json");
+    Boolean[] inboxSyncResult = new Boolean[1]; // boolean holder
+
+    LeanplumInbox.getInstance().addSyncedHandler(new InboxSyncedCallback() {
+      @Override
+      public void onForceContentUpdate(boolean success) {
+        inboxSyncResult[0] = success;
+      }
+    });
+    LeanplumInbox.getInstance().downloadMessages();
+
+    assertNotNull(inboxSyncResult[0]);
+    assertTrue(inboxSyncResult[0]);
+  }
+
+  /**
+   * Test for {@link LeanplumInbox#downloadMessages(InboxSyncedCallback)}.
+   */
+  @Test
+  public void testDownloadMessagesWithCallback() {
+    setupSDK(mContext, "/responses/simple_start_response.json");
+
+    ResponseHelper.seedResponse("/responses/newsfeed_response.json");
+    Boolean[] inboxSyncResult = new Boolean[1]; // boolean holder
+
+    LeanplumInbox.getInstance().downloadMessages(new InboxSyncedCallback() {
+      @Override
+      public void onForceContentUpdate(boolean success) {
+        inboxSyncResult[0] = success;
+      }
+    });
+    assertNotNull(inboxSyncResult[0]);
+    assertTrue(inboxSyncResult[0]);
+  }
+
+}