Improve MessageTemplates public methods (#426)

* Improve MessageTemplates public methods

* Add waitFilesAndVariables method to interface

* Fix CloseButton for external usage

* Fix method accessibility

Author: hborisoff

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

@@ -22,6 +22,7 @@
 package com.leanplum;
 
 import com.leanplum.internal.ActionArg;
+import com.leanplum.internal.Constants;
 import com.leanplum.internal.Log;
 
 import java.util.ArrayList;
@@ -118,4 +119,16 @@ public ActionArgs withAction(String name, String defaultValue) {
   List<ActionArg<?>> getValue() {
     return args;
   }
+
+  /**
+   * Checks if there is at least one file argument.
+   */
+  public boolean containsFile() {
+    for (ActionArg<?> arg : args) {
+      if (Constants.Kinds.FILE.equals(arg.kind())) {
+        return true;
+      }
+    }
+    return false;
+  }
 }

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/MessageTemplate.java

@@ -0,0 +1,66 @@
+/*
+ * 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.messagetemplates;
+
+import android.content.Context;
+import androidx.annotation.NonNull;
+import com.leanplum.ActionArgs;
+import com.leanplum.ActionContext;
+
+/**
+ * Wraps action name, arguments and handler.
+ */
+public interface MessageTemplate {
+
+  /**
+   * Returns the name of the action to register.
+   */
+  @NonNull
+  String getName();
+
+  /**
+   * Creates the user-customizable options for the action.
+   *
+   * @param context Android context
+   */
+  @NonNull
+  ActionArgs createActionArgs(Context context);
+
+  /**
+   * Called in response to the registered action.
+   * Use it to show your message to the user.
+   *
+   * @param context The context in which an action or message is executed.
+   */
+  void handleAction(ActionContext context);
+
+  /**
+   * If your custom template depends on files or variables, that will be downloaded, override and
+   * return true.
+   *
+   * @return true to wait for files and variables to finish downloading before calling
+   * {@link #handleAction(ActionContext)}.
+   */
+  default boolean waitFilesAndVariables() {
+    return false;
+  }
+}

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/MessageTemplates.java

@@ -22,6 +22,7 @@
 package com.leanplum.messagetemplates;
 
 import android.content.Context;
+import androidx.annotation.NonNull;
 import com.leanplum.ActionArgs;
 import com.leanplum.ActionContext;
 import com.leanplum.Leanplum;
@@ -43,43 +44,26 @@
  * @author Andrew First
  */
 public class MessageTemplates {
-  private static final String ALERT = "Alert";
-  private static final String CENTER_POPUP = "Center Popup";
-  private static final String CONFIRM = "Confirm";
-  private static final String HTML = "HTML";
-  private static final String INTERSTITIAL = "Interstitial";
-  private static final String OPEN_URL = "Open URL";
-  private static final String WEB_INTERSTITIAL = "Web Interstitial";
 
   private static boolean registered = false;
 
-  @FunctionalInterface
-  private interface MessageFactory {
-    void showMessage(ActionContext context);
-  }
-
-  @FunctionalInterface
-  private interface ActionArgsFactory {
-    ActionArgs createActionArgs(Context context);
-  }
-
-  private static ActionCallback createCallback(MessageFactory messageFactory) {
+  private static ActionCallback createCallback(@NonNull MessageTemplate template) {
     return new ActionCallback() {
       @Override
       public boolean onResponse(ActionContext actionContext) {
         LeanplumActivityHelper.queueActionUponActive(
             new PostponableAction() {
               @Override
               public void run() {
-                messageFactory.showMessage(actionContext);
+                template.handleAction(actionContext);
               }
             });
         return true;
       }
     };
   }
 
-  private static ActionCallback createCallbackWaitVarsAndFiles(MessageFactory messageFactory) {
+  private static ActionCallback createCallbackWaitVarsAndFiles(@NonNull MessageTemplate template) {
     return new ActionCallback() {
       @Override
       public boolean onResponse(ActionContext actionContext) {
@@ -91,7 +75,7 @@ public void variablesChanged() {
                     new PostponableAction() {
                       @Override
                       public void run() {
-                        messageFactory.showMessage(actionContext);
+                        template.handleAction(actionContext);
                       }
                     });
               }
@@ -101,32 +85,26 @@ public void run() {
     };
   }
 
-  private static void defineAction(
-      String name,
-      ActionArgsFactory argsFactory,
-      MessageFactory messageFactory,
-      Context context) {
-
+  /**
+   * Registers a message template to respond to a given action.
+   *
+   * @param template Wrapper for action name, action arguments and handler.
+   * @param context Android context
+   */
+  public static void registerTemplate(
+      @NonNull MessageTemplate template,
+      @NonNull Context context) {
+
+    String name = template.getName();
     int kind = Leanplum.ACTION_KIND_MESSAGE | Leanplum.ACTION_KIND_ACTION;
+    ActionArgs args = template.createActionArgs(context);
 
-    ActionArgs args = argsFactory.createActionArgs(context);
-
-    ActionCallback callback = createCallback(messageFactory);
-
-    Leanplum.defineAction(name, kind, args, callback);
-  }
-
-  private static void defineActionWaitVarsAndFiles(
-      String name,
-      ActionArgsFactory argsFactory,
-      MessageFactory messageFactory,
-      Context context) {
-
-    int kind = Leanplum.ACTION_KIND_MESSAGE | Leanplum.ACTION_KIND_ACTION;
-
-    ActionArgs args = argsFactory.createActionArgs(context);
-
-    ActionCallback callback = createCallbackWaitVarsAndFiles(messageFactory);
+    ActionCallback callback;
+    if (template.waitFilesAndVariables() || args.containsFile()) { // checks args just in case
+      callback = createCallbackWaitVarsAndFiles(template);
+    } else {
+      callback = createCallback(template);
+    }
 
     Leanplum.defineAction(name, kind, args, callback);
   }
@@ -137,46 +115,12 @@ public synchronized static void register(Context context) {
     }
     registered = true;
 
-    defineAction(
-        OPEN_URL,
-        OpenUrlAction::createActionArgs,
-        OpenUrlAction::onActionTriggered,
-        context);
-
-    defineAction(
-        ALERT,
-        AlertMessage::createActionArgs,
-        AlertMessage::showMessage,
-        context);
-
-    defineAction(
-        CONFIRM,
-        ConfirmMessage::createActionArgs,
-        ConfirmMessage::showMessage,
-        context);
-
-    defineActionWaitVarsAndFiles(
-        CENTER_POPUP,
-        CenterPopupMessage::createActionArgs,
-        CenterPopupMessage::showMessage,
-        context);
-
-    defineActionWaitVarsAndFiles(
-        INTERSTITIAL,
-        InterstitialMessage::createActionArgs,
-        InterstitialMessage::showMessage,
-        context);
-
-    defineAction(
-        WEB_INTERSTITIAL,
-        WebInterstitialMessage::createActionArgs,
-        WebInterstitialMessage::showMessage,
-        context);
-
-    defineActionWaitVarsAndFiles(
-        HTML,
-        RichHtmlMessage::createActionArgs,
-        RichHtmlMessage::showMessage,
-        context);
+    registerTemplate(new OpenUrlAction(), context);
+    registerTemplate(new AlertMessage(), context);
+    registerTemplate(new ConfirmMessage(), context);
+    registerTemplate(new CenterPopupMessage(), context);
+    registerTemplate(new InterstitialMessage(), context);
+    registerTemplate(new WebInterstitialMessage(), context);
+    registerTemplate(new RichHtmlMessage(), context);
   }
 }

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/actions/AlertMessage.java

@@ -25,10 +25,12 @@
 import android.app.AlertDialog;
 import android.content.Context;
 
+import androidx.annotation.NonNull;
 import com.leanplum.ActionArgs;
 import com.leanplum.ActionContext;
 import com.leanplum.LeanplumActivityHelper;
 import com.leanplum.internal.Util;
+import com.leanplum.messagetemplates.MessageTemplate;
 import com.leanplum.messagetemplates.MessageTemplateConstants.Args;
 import com.leanplum.messagetemplates.MessageTemplateConstants.Values;
 
@@ -37,17 +39,27 @@
  *
  * @author Andrew First
  */
-public class AlertMessage {
+public class AlertMessage implements MessageTemplate {
+  private static final String ALERT = "Alert";
 
-  public static ActionArgs createActionArgs(Context context) {
+  @NonNull
+  @Override
+  public String getName() {
+    return ALERT;
+  }
+
+  @NonNull
+  @Override
+  public ActionArgs createActionArgs(Context context) {
     return new ActionArgs()
         .with(Args.TITLE, Util.getApplicationName(context))
         .with(Args.MESSAGE, Values.ALERT_MESSAGE)
         .with(Args.DISMISS_TEXT, Values.OK_TEXT)
         .withAction(Args.DISMISS_ACTION, null);
   }
 
-  public static void showMessage(ActionContext context) {
+  @Override
+  public void handleAction(ActionContext context) {
     Activity activity = LeanplumActivityHelper.getCurrentActivity();
     if (activity == null || activity.isFinishing()) {
       return;

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/actions/CenterPopupMessage.java

@@ -23,18 +23,31 @@
 
 import android.app.Activity;
 import android.content.Context;
+import androidx.annotation.NonNull;
 import com.leanplum.ActionArgs;
 import com.leanplum.ActionContext;
 import com.leanplum.LeanplumActivityHelper;
+import com.leanplum.messagetemplates.MessageTemplate;
 import com.leanplum.messagetemplates.controllers.CenterPopupController;
 import com.leanplum.messagetemplates.options.CenterPopupOptions;
 
-public class CenterPopupMessage {
-  public static ActionArgs createActionArgs(Context context) {
+public class CenterPopupMessage implements MessageTemplate {
+  private static final String CENTER_POPUP = "Center Popup";
+
+  @NonNull
+  @Override
+  public String getName() {
+    return CENTER_POPUP;
+  }
+
+  @NonNull
+  @Override
+  public ActionArgs createActionArgs(Context context) {
     return CenterPopupOptions.toArgs(context);
   }
 
-  public static void showMessage(ActionContext context) {
+  @Override
+  public void handleAction(ActionContext context) {
     Activity activity = LeanplumActivityHelper.getCurrentActivity();
     if (activity == null || activity.isFinishing()) {
       return;
@@ -44,4 +57,9 @@ public static void showMessage(ActionContext context) {
     CenterPopupController popup = new CenterPopupController(activity, options);
     popup.show();
   }
+
+  @Override
+  public boolean waitFilesAndVariables() {
+    return true;
+  }
 }

AndroidSDKCore/src/main/java/com/leanplum/messagetemplates/actions/ConfirmMessage.java

@@ -25,10 +25,12 @@
 import android.app.AlertDialog;
 import android.content.Context;
 
+import androidx.annotation.NonNull;
 import com.leanplum.ActionArgs;
 import com.leanplum.ActionContext;
 import com.leanplum.LeanplumActivityHelper;
 import com.leanplum.internal.Util;
+import com.leanplum.messagetemplates.MessageTemplate;
 import com.leanplum.messagetemplates.MessageTemplateConstants.Args;
 import com.leanplum.messagetemplates.MessageTemplateConstants.Values;
 
@@ -37,9 +39,18 @@
  *
  * @author Andrew First
  */
-public class ConfirmMessage {
+public class ConfirmMessage implements MessageTemplate {
+  private static final String CONFIRM = "Confirm";
 
-  public static ActionArgs createActionArgs(Context context) {
+  @NonNull
+  @Override
+  public String getName() {
+    return CONFIRM;
+  }
+
+  @NonNull
+  @Override
+  public ActionArgs createActionArgs(Context context) {
     return new ActionArgs()
         .with(Args.TITLE, Util.getApplicationName(context))
         .with(Args.MESSAGE, Values.CONFIRM_MESSAGE)
@@ -49,7 +60,8 @@ public static ActionArgs createActionArgs(Context context) {
         .withAction(Args.CANCEL_ACTION, null);
   }
 
-  public static void showMessage(ActionContext context) {
+  @Override
+  public void handleAction(ActionContext context) {
     Activity activity = LeanplumActivityHelper.getCurrentActivity();
     if (activity == null || activity.isFinishing())
       return;