Allowing default country code and national phone number (#919)

Jacob Stimes · samtstern · commit 6a32081e3093 · 2017-09-27T12:37:26.000-07:00
diff --git a/auth/README.md b/auth/README.md
@@ -263,13 +263,27 @@ country code and phone number input fields. The user is still able to edit the n
 ```java
 // Use a Bundle to hold the default number, and pass it to the Builder via setParams:
 Bundle params = new Bundle();
-params.putString(AuthUI.EXTRA_DEFAULT_PHONE, "+12345678901");
+params.putString(AuthUI.EXTRA_DEFAULT_PHONE_NUMBER, "+123456789");
 IdpConfig phoneConfigWithDefaultNumber =
         new IdpConfig.Builder(AuthUI.PHONE_VERIFICATION_PROVIDER)
                 .setParams(params)
                 .build();
 ```
 
+It is also possible to set a default country code along with a national number if a specific country
+is your app's target audience. This will take precedence over the full default phone number if both
+are provided.
+
+```java
+Bundle params = new Bundle();
+params.putString(AuthUI.EXTRA_DEFAULT_COUNTRY_CODE, "ca");
+params.putString(AuthUI.EXTRA_DEFAULT_NATIONAL_NUMBER, "23456789");
+IdpConfig phoneConfigWithDefaultCountryAndNationalNumber =
+        new IdpConfig.Builder(AuthUI.PHONE_VERIFICATION_PROVIDER)
+                .setParams(params)
+                .build();
+```
+
 #### Handling the sign-in response
 
 ##### Response codes
diff --git a/auth/src/main/java/com/firebase/ui/auth/AuthUI.java b/auth/src/main/java/com/firebase/ui/auth/AuthUI.java
@@ -107,9 +107,19 @@ public class AuthUI {
     public static final String PHONE_VERIFICATION_PROVIDER = PhoneAuthProvider.PROVIDER_ID;
 
     /**
-     * Bundle key for the default phone number parameter
+     * Bundle key for the default full phone number parameter.
      */
-    public static final String EXTRA_DEFAULT_PHONE = ExtraConstants.EXTRA_PHONE;
+    public static final String EXTRA_DEFAULT_PHONE_NUMBER = ExtraConstants.EXTRA_PHONE;
+
+    /**
+     * Bundle key for the default phone country code parameter.
+     */
+    public static final String EXTRA_DEFAULT_COUNTRY_CODE = ExtraConstants.EXTRA_COUNTRY_CODE;
+
+    /**
+     * Bundle key for the default national phone number parameter.
+     */
+    public static final String EXTRA_DEFAULT_NATIONAL_NUMBER = ExtraConstants.EXTRA_NATIONAL_NUMBER;
 
     /**
      * Default value for logo resource, omits the logo from the {@link AuthMethodPickerActivity}.
diff --git a/auth/src/main/java/com/firebase/ui/auth/provider/PhoneProvider.java b/auth/src/main/java/com/firebase/ui/auth/provider/PhoneProvider.java
@@ -3,6 +3,7 @@
 import android.app.Activity;
 import android.content.Context;
 import android.content.Intent;
+import android.os.Bundle;
 import android.support.annotation.LayoutRes;
 
 import com.firebase.ui.auth.AuthUI;
@@ -36,15 +37,15 @@ public int getButtonLayout() {
     @Override
     public void startLogin(Activity activity) {
 
-        String phone = null;
+        Bundle params = null;
         for (AuthUI.IdpConfig idpConfig : mFlowParameters.providerInfo) {
             if (idpConfig.getProviderId().equals(AuthUI.PHONE_VERIFICATION_PROVIDER)) {
-                phone = idpConfig.getParams().getString(AuthUI.EXTRA_DEFAULT_PHONE);
+                params = idpConfig.getParams();
             }
         }
 
         activity.startActivityForResult(
-                PhoneVerificationActivity.createIntent(activity, mFlowParameters, phone),
+                PhoneVerificationActivity.createIntent(activity, mFlowParameters, params),
                 RC_PHONE_FLOW);
     }
 
diff --git a/auth/src/main/java/com/firebase/ui/auth/ui/ExtraConstants.java b/auth/src/main/java/com/firebase/ui/auth/ui/ExtraConstants.java
@@ -26,5 +26,8 @@ public class ExtraConstants {
     public static final String EXTRA_USER = "extra_user";
     public static final String EXTRA_EMAIL = "extra_email";
     public static final String EXTRA_PHONE = "extra_phone_number";
+    public static final String EXTRA_COUNTRY_CODE = "extra_country_code";
+    public static final String EXTRA_NATIONAL_NUMBER = "extra_national_number";
     public static final String HAS_EXISTING_INSTANCE = "has_existing_instance";
+    public static final String EXTRA_PARAMS = "extra_params";
 }
diff --git a/auth/src/main/java/com/firebase/ui/auth/ui/phone/PhoneNumberUtils.java b/auth/src/main/java/com/firebase/ui/auth/ui/phone/PhoneNumberUtils.java
@@ -138,6 +138,22 @@ protected static PhoneNumber getPhoneNumber(@NonNull String providedPhoneNumber)
         return new PhoneNumber(phoneNumber, countryIso, countryCode);
     }
 
+    static PhoneNumber getPhoneNumber(
+            @NonNull String providedCountryIso, @NonNull String providedNationalNumber) {
+        Integer countryCode = getCountryCode(providedCountryIso);
+        if (countryCode == null) {
+            // Invalid ISO supplied:
+            countryCode = DEFAULT_COUNTRY_CODE_INT;
+            providedCountryIso = DEFAULT_COUNTRY_CODE;
+        }
+
+        // National number shouldn't include '+', but just in case:
+        providedNationalNumber = stripPlusSign(providedNationalNumber);
+
+        return new PhoneNumber(
+                providedNationalNumber, providedCountryIso, String.valueOf(countryCode));
+    }
+
     private static String countryIsoForCountryCode(String countryCode) {
         final List<String> countries = CountryCodeToRegionCodeMap.get(Integer.valueOf(countryCode));
         if (countries != null) {
@@ -1337,6 +1353,10 @@ private static String stripCountryCode(String phoneNumber, String countryCode) {
         return phoneNumber.replaceFirst("^\\+?" + countryCode, "");
     }
 
+    private static String stripPlusSign(String phoneNumber) {
+        return phoneNumber.replaceFirst("^\\+?", "");
+    }
+
     private static Locale getSimBasedLocale(@NonNull Context context) {
         final TelephonyManager tm =
                 (TelephonyManager) context.getSystemService(Context.TELEPHONY_SERVICE);
diff --git a/auth/src/main/java/com/firebase/ui/auth/ui/phone/PhoneVerificationActivity.java b/auth/src/main/java/com/firebase/ui/auth/ui/phone/PhoneVerificationActivity.java
@@ -74,9 +74,10 @@ private enum VerificationState {
     private PhoneAuthProvider.ForceResendingToken mForceResendingToken;
     private VerificationState mVerificationState;
 
-    public static Intent createIntent(Context context, FlowParameters flowParams, String phone) {
-        return HelperActivityBase.createBaseIntent(context, PhoneVerificationActivity.class, flowParams)
-                .putExtra(ExtraConstants.EXTRA_PHONE, phone);
+    public static Intent createIntent(Context context, FlowParameters flowParams, Bundle params) {
+        return HelperActivityBase.createBaseIntent(
+                context, PhoneVerificationActivity.class, flowParams)
+                .putExtra(ExtraConstants.EXTRA_PARAMS, params);
     }
 
     @Override
@@ -94,9 +95,9 @@ protected void onCreate(final Bundle savedInstance) {
             return;
         }
 
-        String phone = getIntent().getExtras().getString(ExtraConstants.EXTRA_PHONE);
+        Bundle params = getIntent().getExtras().getBundle(ExtraConstants.EXTRA_PARAMS);
         VerifyPhoneNumberFragment fragment = VerifyPhoneNumberFragment.newInstance
-                (getFlowParams(), phone);
+                (getFlowParams(), params);
         getSupportFragmentManager().beginTransaction()
                 .replace(R.id.fragment_verify_phone, fragment, VerifyPhoneNumberFragment.TAG)
                 .disallowAddToBackStack()
diff --git a/auth/src/main/java/com/firebase/ui/auth/ui/phone/VerifyPhoneNumberFragment.java b/auth/src/main/java/com/firebase/ui/auth/ui/phone/VerifyPhoneNumberFragment.java
@@ -32,6 +32,7 @@
 import android.widget.EditText;
 import android.widget.TextView;
 
+import com.firebase.ui.auth.AuthUI;
 import com.firebase.ui.auth.R;
 import com.firebase.ui.auth.ui.ExtraConstants;
 import com.firebase.ui.auth.ui.FlowParameters;
@@ -64,13 +65,13 @@ public class VerifyPhoneNumberFragment extends FragmentBase implements View.OnCl
     private PhoneVerificationActivity mVerifier;
     private TextView mSmsTermsText;
 
-    public static VerifyPhoneNumberFragment newInstance(FlowParameters flowParameters,
-                                                        String phone) {
+    public static VerifyPhoneNumberFragment newInstance(
+            FlowParameters flowParameters, Bundle params) {
         VerifyPhoneNumberFragment fragment = new VerifyPhoneNumberFragment();
 
         Bundle args = new Bundle();
         args.putParcelable(ExtraConstants.EXTRA_FLOW_PARAMS, flowParameters);
-        args.putString(ExtraConstants.EXTRA_PHONE, phone);
+        args.putBundle(ExtraConstants.EXTRA_PARAMS, params);
 
         fragment.setArguments(args);
         return fragment;
@@ -133,9 +134,22 @@ public void onActivityCreated(@Nullable Bundle savedInstanceState) {
         // Check for phone
         // It is assumed that the phone number that are being wired in via Credential Selector
         // are e164 since we store it.
-        String phone = getArguments().getString(ExtraConstants.EXTRA_PHONE);
-        if (!TextUtils.isEmpty(phone)) {
-            // Use phone passed in
+        Bundle params = getArguments().getBundle(ExtraConstants.EXTRA_PARAMS);
+        String phone = null;
+        String countryCode = null;
+        String nationalNumber = null;
+        if (params != null) {
+            phone = params.getString(AuthUI.EXTRA_DEFAULT_PHONE_NUMBER);
+            countryCode = params.getString(AuthUI.EXTRA_DEFAULT_COUNTRY_CODE);
+            nationalNumber = params.getString(AuthUI.EXTRA_DEFAULT_NATIONAL_NUMBER);
+        }
+        if (!TextUtils.isEmpty(countryCode) && !TextUtils.isEmpty(nationalNumber)) {
+            // User supplied country code & national number
+            PhoneNumber phoneNumber = PhoneNumberUtils.getPhoneNumber(countryCode, nationalNumber);
+            setPhoneNumber(phoneNumber);
+            setCountryCode(phoneNumber);
+        } else if (!TextUtils.isEmpty(phone)) {
+            // User supplied full phone number
             PhoneNumber phoneNumber = PhoneNumberUtils.getPhoneNumber(phone);
             setPhoneNumber(phoneNumber);
             setCountryCode(phoneNumber);
diff --git a/auth/src/main/java/com/firebase/ui/auth/util/signincontainer/SignInDelegate.java b/auth/src/main/java/com/firebase/ui/auth/util/signincontainer/SignInDelegate.java
@@ -249,9 +249,11 @@ private void startAuthMethodChoice() {
                     break;
                 case PhoneAuthProvider.PROVIDER_ID:
                     // Go directly to phone flow
-                    String phone = firstIdpConfig.getParams().getString(AuthUI.EXTRA_DEFAULT_PHONE);
+                    Bundle params = firstIdpConfig.getParams();
+                    Intent phoneActivityIntent = PhoneVerificationActivity
+                            .createIntent(getContext(), flowParams, params);
                     startActivityForResult(
-                            PhoneVerificationActivity.createIntent(getContext(), flowParams, phone),
+                            phoneActivityIntent,
                             RC_PHONE_FLOW);
                     break;
                 default:
diff --git a/auth/src/test/java/com/firebase/ui/auth/ui/phone/PhoneTestConstants.java b/auth/src/test/java/com/firebase/ui/auth/ui/phone/PhoneTestConstants.java
@@ -24,6 +24,8 @@ public class PhoneTestConstants {
     public static final String PHONE_NO_COUNTRY_CODE = "23456789";
     public static final String US_COUNTRY_CODE = "1";
     public static final String US_ISO2 = "US";
+    public static final String CA_ISO2 = "CA";
+    public static final String CA_COUNTRY_CODE = "1";
     public static final String YE_COUNTRY_CODE = "967";
     public static final String YE_ISO2 = "YE";
 }
diff --git a/auth/src/test/java/com/firebase/ui/auth/ui/phone/PhoneVerificationActivityTest.java b/auth/src/test/java/com/firebase/ui/auth/ui/phone/PhoneVerificationActivityTest.java
@@ -49,11 +49,14 @@
 import org.robolectric.shadows.ShadowLooper;
 
 import java.util.Collections;
+import java.util.Locale;
 import java.util.concurrent.TimeUnit;
 
+import static com.firebase.ui.auth.ui.phone.PhoneTestConstants.CA_COUNTRY_CODE;
 import static com.firebase.ui.auth.ui.phone.PhoneTestConstants.PHONE;
 import static com.firebase.ui.auth.ui.phone.PhoneTestConstants.PHONE_NO_COUNTRY_CODE;
 import static com.firebase.ui.auth.ui.phone.PhoneTestConstants.YE_COUNTRY_CODE;
+import static com.firebase.ui.auth.ui.phone.PhoneTestConstants.CA_ISO2;
 import static com.firebase.ui.auth.ui.phone.PhoneTestConstants.YE_RAW_PHONE;
 import static com.firebase.ui.auth.ui.phone.PhoneVerificationActivity.AUTO_RETRIEVAL_TIMEOUT_MILLIS;
 import static junit.framework.Assert.assertEquals;
@@ -107,12 +110,14 @@ public void setUp() {
     }
 
     @Test
-    public void testPhoneNumberFromSmartlock_prePopulatesPhoneNumberInBundle() {
+    public void testDefaultFullPhoneNumber_prePopulatesPhoneNumberInBundle() {
+        Bundle fullPhoneParams = new Bundle();
+        fullPhoneParams.putString(AuthUI.EXTRA_DEFAULT_PHONE_NUMBER, YE_RAW_PHONE);
         Intent startIntent = PhoneVerificationActivity.createIntent(
                 RuntimeEnvironment.application,
                 TestHelper.getFlowParameters(
                         Collections.singletonList(AuthUI.PHONE_VERIFICATION_PROVIDER)),
-                YE_RAW_PHONE);
+                fullPhoneParams);
 
         mActivity = Robolectric.buildActivity(PhoneVerificationActivity.class, startIntent)
                 .create(new Bundle()).start().visible().get();
@@ -129,6 +134,34 @@ public void testPhoneNumberFromSmartlock_prePopulatesPhoneNumberInBundle() {
                      String.valueOf(((CountryInfo) mCountryListSpinner.getTag()).countryCode));
     }
 
+    @Test
+    public void testDefaultCountryCodeAndNationalNumber_prePopulatesPhoneNumberInBundle() {
+        Bundle phoneParams = new Bundle();
+        phoneParams.putString(AuthUI.EXTRA_DEFAULT_COUNTRY_CODE, CA_ISO2);
+        phoneParams.putString(AuthUI.EXTRA_DEFAULT_NATIONAL_NUMBER, PHONE_NO_COUNTRY_CODE);
+        Intent startIntent = PhoneVerificationActivity.createIntent(
+                RuntimeEnvironment.application,
+                TestHelper.getFlowParameters(
+                        Collections.singletonList(AuthUI.PHONE_VERIFICATION_PROVIDER)),
+                phoneParams);
+
+        mActivity = Robolectric.buildActivity(PhoneVerificationActivity.class, startIntent)
+                .create(new Bundle()).start().visible().get();
+
+        VerifyPhoneNumberFragment verifyPhoneNumberFragment = (VerifyPhoneNumberFragment)
+                mActivity.getSupportFragmentManager()
+                        .findFragmentByTag(VerifyPhoneNumberFragment.TAG);
+        assertNotNull(verifyPhoneNumberFragment);
+        mPhoneEditText = mActivity.findViewById(R.id.phone_number);
+        mCountryListSpinner = mActivity.findViewById(R.id.country_list);
+
+        assertEquals(PHONE_NO_COUNTRY_CODE, mPhoneEditText.getText().toString());
+        assertEquals(CA_COUNTRY_CODE,
+                String.valueOf(((CountryInfo) mCountryListSpinner.getTag()).countryCode));
+        assertEquals(new Locale("", CA_ISO2),
+                ((CountryInfo) mCountryListSpinner.getTag()).locale);
+    }
+
     @Test
     public void testBadPhoneNumber_showsInlineError() {
         VerifyPhoneNumberFragment verifyPhoneNumberFragment = (VerifyPhoneNumberFragment)

Original file line number	Diff line number	Diff line change
`@@ -26,5 +26,8 @@ public class ExtraConstants {`
`26`	`26`	`public static final String EXTRA_USER = "extra_user";`
`27`	`27`	`public static final String EXTRA_EMAIL = "extra_email";`
`28`	`28`	`public static final String EXTRA_PHONE = "extra_phone_number";`
	`29`	`+ public static final String EXTRA_COUNTRY_CODE = "extra_country_code";`
	`30`	`+ public static final String EXTRA_NATIONAL_NUMBER = "extra_national_number";`
`29`	`31`	`public static final String HAS_EXISTING_INSTANCE = "has_existing_instance";`
	`32`	`+ public static final String EXTRA_PARAMS = "extra_params";`
`30`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,8 @@ public class PhoneTestConstants {`
`24`	`24`	`public static final String PHONE_NO_COUNTRY_CODE = "23456789";`
`25`	`25`	`public static final String US_COUNTRY_CODE = "1";`
`26`	`26`	`public static final String US_ISO2 = "US";`
	`27`	`+ public static final String CA_ISO2 = "CA";`
	`28`	`+ public static final String CA_COUNTRY_CODE = "1";`
`27`	`29`	`public static final String YE_COUNTRY_CODE = "967";`
`28`	`30`	`public static final String YE_ISO2 = "YE";`
`29`	`31`	`}`