let the user accept/cancel the terms before signing up

auth0 · Aug 8, 2016 · d7a6b06 · d7a6b06
1 parent 070177c
commit d7a6b06
Show file tree

Hide file tree

Showing 7 changed files with 161 additions and 133 deletions.
diff --git a/lib/src/main/java/com/auth0/android/lock/Configuration.java b/lib/src/main/java/com/auth0/android/lock/Configuration.java
@@ -71,6 +71,7 @@ public class Configuration {
     private boolean allowSignUp;
     private boolean allowForgotPassword;
     private boolean usernameRequired;
+    private boolean mustAcceptTerms;
     @PasswordStrength
     private int passwordPolicy;
     private final boolean classicLockAvailable;
@@ -249,6 +250,7 @@ private void parseLocalOptions(Options options) {
         usernameStyle = options.usernameStyle();
         socialButtonStyle = options.socialButtonStyle();
         loginAfterSignUp = options.loginAfterSignUp();
+        mustAcceptTerms = options.mustAcceptTerms();
 
         final boolean socialAvailable = !getSocialStrategies().isEmpty();
         final boolean dbAvailable = getDefaultDatabaseConnection() != null;
@@ -413,4 +415,8 @@ public String getTermsURL() {
     public String getPrivacyURL() {
         return privacyURL;
     }
+
+    public boolean mustAcceptTerms() {
+        return mustAcceptTerms;
+    }
 }
diff --git a/lib/src/main/java/com/auth0/android/lock/Lock.java b/lib/src/main/java/com/auth0/android/lock/Lock.java
@@ -430,6 +430,18 @@ public Builder setTermsURL(@NonNull String url) {
             return this;
         }
 
+        /**
+         * Prompts the user to accept the Privacy Policy and Terms of Service before signing up.
+         * The default value is false.
+         *
+         * @param mustAcceptTerms whether the user needs to accept the terms before sign up or not.
+         * @return the current builder instance
+         */
+        public Builder setMustAcceptTerms(boolean mustAcceptTerms) {
+            options.setMustAcceptTerms(mustAcceptTerms);
+            return this;
+        }
+
         private List<CustomField> removeDuplicatedKeys(List<CustomField> customFields) {
             int originalSize = customFields.size();
             final List<CustomField> withoutDuplicates = new ArrayList<>();

diff --git a/lib/src/main/java/com/auth0/android/lock/Options.java b/lib/src/main/java/com/auth0/android/lock/Options.java
@@ -60,6 +60,7 @@ class Options implements Parcelable {
     private boolean allowSignUp;
     private boolean allowForgotPassword;
     private boolean loginAfterSignUp;
+    private boolean mustAcceptTerms;
     private String defaultDatabaseConnection;
     private List<String> connections;
     private List<String> enterpriseConnectionsUsingWebForm;
@@ -94,6 +95,7 @@ protected Options(Parcel in) {
         allowSignUp = in.readByte() != WITHOUT_DATA;
         allowForgotPassword = in.readByte() != WITHOUT_DATA;
         loginAfterSignUp = in.readByte() != WITHOUT_DATA;
+        mustAcceptTerms = in.readByte() != WITHOUT_DATA;
         useCodePasswordless = in.readByte() != WITHOUT_DATA;
         defaultDatabaseConnection = in.readString();
         usernameStyle = in.readInt();
@@ -144,6 +146,7 @@ public void writeToParcel(Parcel dest, int flags) {
         dest.writeByte((byte) (allowSignUp ? HAS_DATA : WITHOUT_DATA));
         dest.writeByte((byte) (allowForgotPassword ? HAS_DATA : WITHOUT_DATA));
         dest.writeByte((byte) (loginAfterSignUp ? HAS_DATA : WITHOUT_DATA));
+        dest.writeByte((byte) (mustAcceptTerms ? HAS_DATA : WITHOUT_DATA));
         dest.writeByte((byte) (useCodePasswordless ? HAS_DATA : WITHOUT_DATA));
         dest.writeString(defaultDatabaseConnection);
         dest.writeInt(usernameStyle);
@@ -372,4 +375,12 @@ public void setTermsURL(@NonNull String url) {
     public String getTermsURL() {
         return termsURL;
     }
+
+    public void setMustAcceptTerms(boolean mustAcceptTerms) {
+        this.mustAcceptTerms = mustAcceptTerms;
+    }
+
+    public boolean mustAcceptTerms() {
+        return mustAcceptTerms;
+    }
 }
diff --git a/lib/src/main/java/com/auth0/android/lock/views/ClassicLockView.java b/lib/src/main/java/com/auth0/android/lock/views/ClassicLockView.java
@@ -25,6 +25,7 @@
 package com.auth0.android.lock.views;
 
 import android.content.Context;
+import android.content.DialogInterface;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
 import android.support.annotation.StringRes;
@@ -51,7 +52,7 @@
 import com.auth0.android.lock.views.interfaces.LockWidgetForm;
 import com.squareup.otto.Bus;
 
-public class ClassicLockView extends LinearLayout implements View.OnClickListener, LockWidgetForm {
+public class ClassicLockView extends LinearLayout implements LockWidgetForm {
 
     private static final String TAG = ClassicLockView.class.getSimpleName();
     private static final int FORM_INDEX = 2;
@@ -114,14 +115,32 @@ private void showContentLayout() {
         bottomBanner.setOnClickListener(new OnClickListener() {
             @Override
             public void onClick(View v) {
-                showSignUpTermsDialog();
+                showSignUpTermsDialog(null);
             }
         });
         bottomBanner.setVisibility(GONE);
         addView(bottomBanner, wrapHeightParams);
 
         actionButton = new ActionButton(getContext(), lockTheme);
-        actionButton.setOnClickListener(this);
+        actionButton.setOnClickListener(new OnClickListener() {
+            @Override
+            public void onClick(View v) {
+                final Object event = subForm != null ? subForm.submitForm() : formLayout.onActionPressed();
+                if (event == null) {
+                    return;
+                }
+                if (!configuration.mustAcceptTerms() || !(event instanceof DatabaseSignUpEvent)) {
+                    bus.post(event);
+                    return;
+                }
+                showSignUpTermsDialog(new DialogInterface.OnClickListener() {
+                    @Override
+                    public void onClick(DialogInterface dialog, int which) {
+                        bus.post(event);
+                    }
+                });
+            }
+        });
         addView(actionButton, wrapHeightParams);
 
         boolean showDatabase = configuration.getDefaultDatabaseConnection() != null;
@@ -254,15 +273,26 @@ private void showSignUpTerms(boolean show) {
         bottomBanner.setVisibility(show ? VISIBLE : GONE);
     }
 
-    private void showSignUpTermsDialog() {
+    /**
+     * Create a dialog to show the Privacy Policy and Terms of Service text.
+     * If the provided callback it's not null, it will ask for acceptance.
+     *
+     * @param acceptCallback the callback to receive the acceptance. Can be null.
+     */
+    private void showSignUpTermsDialog(@Nullable DialogInterface.OnClickListener acceptCallback) {
         final String content = String.format(getResources().getString(R.string.com_auth0_lock_sign_up_terms_dialog_message), configuration.getTermsURL(), configuration.getPrivacyURL());
-        final AlertDialog dialog = new AlertDialog.Builder(getContext())
+        final AlertDialog.Builder builder = new AlertDialog.Builder(getContext())
                 .setTitle(getResources().getString(R.string.com_auth0_lock_sign_up_terms_dialog_title))
-                .setPositiveButton(android.R.string.ok, null)
-                .setMessage(Html.fromHtml(content))
-                .show();
+                .setPositiveButton(R.string.com_auth0_lock_action_ok, null)
+                .setMessage(Html.fromHtml(content));
+        if (acceptCallback != null) {
+            builder.setNegativeButton(R.string.com_auth0_lock_action_cancel, null)
+                    .setPositiveButton(R.string.com_auth0_lock_action_accept, acceptCallback)
+                    .setCancelable(false);
+        }
 
-        final TextView message = (TextView) dialog.findViewById(android.R.id.message);
+        //the dialog needs to be shown before we can get it's view.
+        final TextView message = (TextView) builder.show().findViewById(android.R.id.message);
         if (message != null) {
             message.setMovementMethod(LinkMovementMethod.getInstance());
         }
@@ -278,14 +308,6 @@ public void onFormSubmit() {
         actionButton.callOnClick();
     }
 
-    @Override
-    public void onClick(View v) {
-        Object event = subForm != null ? subForm.submitForm() : formLayout.onActionPressed();
-        if (event != null) {
-            bus.post(event);
-        }
-    }
-
     @Override
     public void showCustomFieldsForm(DatabaseSignUpEvent event) {
         addSubForm(new CustomFieldsFormView(this, event.getEmail(), event.getPassword(), event.getUsername()));

diff --git a/lib/src/main/res/values/strings.xml b/lib/src/main/res/values/strings.xml
@@ -91,6 +91,9 @@
     <string name="com_auth0_lock_action_forgot_password">Don\'t remember your password?</string>
     <string name="com_auth0_lock_action_login_with_corporate">Please enter your corporate credentials at %s</string>
     <string name="com_auth0_lock_action_retry">Retry</string>
+    <string name="com_auth0_lock_action_accept">Accept</string>
+    <string name="com_auth0_lock_action_cancel">Cancel</string>
+    <string name="com_auth0_lock_action_ok">OK</string>
     <string name="com_auth0_lock_single_sign_on_enabled">Single Sign On Enabled</string>
     <string name="com_auth0_lock_forms_separator">OR</string>
     <string name="com_auth0_lock_passwordless_sms_forms_separator">Otherwise, enter your phone to sign in or create an account</string>
@@ -112,7 +115,7 @@
     <string name="com_auth0_lock_sign_up_terms_dialog_message" formatted="false"><![CDATA[
     By signing up, you agree to our <a href=\'%s\'>terms of service</a> and <a href=\'%s\'>privacy policy</a>
     ]]></string>
-    
+
     <!-- Custom Error Messages -->
     <string name="com_auth0_lock_missing_connections_message">There isn\'t any connection configured for this Application. Check your dashboard configuration on http://auth0.com</string>
     <string name="com_auth0_lock_configuration_retrieving_error">Error retrieving the Dashboard configuration</string>

diff --git a/lib/src/test/java/com/auth0/android/lock/ConfigurationTest.java b/lib/src/test/java/com/auth0/android/lock/ConfigurationTest.java
@@ -115,6 +115,7 @@ public void shouldKeepApplicationDefaultsIfOptionsAreNotModified() throws Except
         assertThat(configuration.getSocialButtonStyle(), is(equalTo(SocialButtonStyle.UNSPECIFIED)));
         assertThat(configuration.hasExtraFields(), is(false));
         assertThat(configuration.getPasswordPolicy(), is(PasswordStrength.NONE));
+        assertThat(configuration.mustAcceptTerms(), is(false));
     }
 
     @Test
@@ -574,6 +575,13 @@ public void shouldHaveCustomTermsOfServiceURL() throws Exception {
         assertThat(configuration.getTermsURL(), is(equalTo("https://google.com/terms")));
     }
 
+    @Test
+    public void shouldHaveMustAcceptTermsEnabled() throws Exception {
+        options.setMustAcceptTerms(true);
+        configuration = new Configuration(application, options);
+        assertThat(configuration.mustAcceptTerms(), is(true));
+    }
+
     private Configuration unfilteredConfig() {
         return new Configuration(application, options);
     }