Completely overhaul IDP config (#1083)

Author: SUPERCILEX

app/src/main/java/com/firebase/uidemo/auth/AuthUiActivity.java

@@ -49,7 +49,6 @@
 import butterknife.OnClick;
 
 public class AuthUiActivity extends AppCompatActivity {
-    private static final String UNCHANGED_CONFIG_VALUE = "CHANGE-ME";
     private static final String GOOGLE_TOS_URL = "https://www.google.com/policies/terms/";
     private static final String FIREBASE_TOS_URL = "https://firebase.google.com/terms/";
     private static final String GOOGLE_PRIVACY_POLICY_URL = "https://www.google.com/policies/privacy/";
@@ -204,7 +203,6 @@ public void signIn(View view) {
                         .setPrivacyPolicyUrl(getSelectedPrivacyPolicyUrl())
                         .setIsSmartLockEnabled(mEnableCredentialSelector.isChecked(),
                                 mEnableHintSelector.isChecked())
-                        .setAllowNewEmailAccounts(mAllowNewEmailAccounts.isChecked())
                         .build(),
                 RC_SIGN_IN);
     }
@@ -328,29 +326,27 @@ private List<IdpConfig> getSelectedProviders() {
 
         if (mUseGoogleProvider.isChecked()) {
             selectedProviders.add(
-                    new IdpConfig.Builder(AuthUI.GOOGLE_PROVIDER)
-                            .setPermissions(getGooglePermissions())
-                            .build());
+                    new IdpConfig.GoogleBuilder().setScopes(getGoogleScopes()).build());
         }
 
         if (mUseFacebookProvider.isChecked()) {
-            selectedProviders.add(
-                    new IdpConfig.Builder(AuthUI.FACEBOOK_PROVIDER)
-                            .setPermissions(getFacebookPermissions())
-                            .build());
+            selectedProviders.add(new IdpConfig.FacebookBuilder()
+                    .setPermissions(getFacebookPermissions())
+                    .build());
         }
 
         if (mUseTwitterProvider.isChecked()) {
-            selectedProviders.add(new IdpConfig.Builder(AuthUI.TWITTER_PROVIDER).build());
+            selectedProviders.add(new IdpConfig.TwitterBuilder().build());
         }
 
         if (mUseEmailProvider.isChecked()) {
-            selectedProviders.add(new IdpConfig.Builder(AuthUI.EMAIL_PROVIDER).build());
+            selectedProviders.add(new IdpConfig.EmailBuilder()
+                    .setAllowNewAccounts(mAllowNewEmailAccounts.isChecked())
+                    .build());
         }
 
         if (mUsePhoneProvider.isChecked()) {
-            selectedProviders.add(
-                    new IdpConfig.Builder(AuthUI.PHONE_VERIFICATION_PROVIDER).build());
+            selectedProviders.add(new IdpConfig.PhoneBuilder().build());
         }
 
         return selectedProviders;
@@ -376,12 +372,12 @@ private String getSelectedPrivacyPolicyUrl() {
 
     @MainThread
     private boolean isGoogleMisconfigured() {
-        return UNCHANGED_CONFIG_VALUE.equals(getString(R.string.default_web_client_id));
+        return AuthUI.UNCONFIGURED_CONFIG_VALUE.equals(getString(R.string.default_web_client_id));
     }
 
     @MainThread
     private boolean isFacebookMisconfigured() {
-        return UNCHANGED_CONFIG_VALUE.equals(getString(R.string.facebook_application_id));
+        return AuthUI.UNCONFIGURED_CONFIG_VALUE.equals(getString(R.string.facebook_application_id));
     }
 
     @MainThread
@@ -391,7 +387,7 @@ private boolean isTwitterMisconfigured() {
                 getString(R.string.twitter_consumer_secret)
         );
 
-        return twitterConfigs.contains(UNCHANGED_CONFIG_VALUE);
+        return twitterConfigs.contains(AuthUI.UNCONFIGURED_CONFIG_VALUE);
     }
 
     @MainThread
@@ -412,7 +408,7 @@ private List<String> getFacebookPermissions() {
     }
 
     @MainThread
-    private List<String> getGooglePermissions() {
+    private List<String> getGoogleScopes() {
         List<String> result = new ArrayList<>();
         if (mGoogleScopeYoutubeData.isChecked()) {
             result.add("https://www.googleapis.com/auth/youtube.readonly");

auth/README.md

@@ -216,16 +216,16 @@ You can enable sign-in providers like Google Sign-In or Facebook Log In by calli
 
 ```java
 startActivityForResult(
-    AuthUI.getInstance()
-        .createSignInIntentBuilder()
-        .setAvailableProviders(
-                Arrays.asList(new AuthUI.IdpConfig.Builder(AuthUI.EMAIL_PROVIDER).build(),
-                              new AuthUI.IdpConfig.Builder(AuthUI.PHONE_VERIFICATION_PROVIDER).build(),
-                              new AuthUI.IdpConfig.Builder(AuthUI.GOOGLE_PROVIDER).build(),
-                              new AuthUI.IdpConfig.Builder(AuthUI.FACEBOOK_PROVIDER).build(),
-                              new AuthUI.IdpConfig.Builder(AuthUI.TWITTER_PROVIDER).build()))
-        .build(),
-    RC_SIGN_IN);
+        AuthUI.getInstance()
+                .createSignInIntentBuilder()
+                .setAvailableProviders(Arrays.asList(
+                        new AuthUI.IdpConfig.EmailBuilder().build(),
+                        new AuthUI.IdpConfig.PhoneBuilder().build(),
+                        new AuthUI.IdpConfig.GoogleBuilder().build(),
+                        new AuthUI.IdpConfig.FacebookBuilder().build(),
+                        new AuthUI.IdpConfig.TwitterBuilder().build()))
+                .build(),
+        RC_SIGN_IN);
 ```
 
 ##### Adding a ToS and privacy policy
@@ -260,28 +260,30 @@ startActivityForResult(
     RC_SIGN_IN);
 ```
 
-It is often desirable to disable Smart Lock in development but enable it in production. To achieve
-this, you can use the `BuildConfig.DEBUG` flag to control Smart Lock:
+###### Smart Lock hints
+
+If you'd like to keep Smart Lock's "hints" but disable the saving/retrieving of credentials, then
+you can use the two-argument version of `setIsSmartLockEnabled`:
 
 ```java
 startActivityForResult(
     AuthUI.getInstance()
         .createSignInIntentBuilder()
-        .setIsSmartLockEnabled(!BuildConfig.DEBUG)
+        .setIsSmartLockEnabled(false, true)
         .build(),
     RC_SIGN_IN);
 ```
 
-###### Smart Lock hints
+###### Smart Lock in dev builds
 
-If you'd like to keep Smart Lock's "hints" but disable the saving/retrieving of credentials, then
-you can use the two-argument version of `setIsSmartLockEnabled`:
+It is often desirable to disable Smart Lock in development but enable it in production. To achieve
+this, you can use the `BuildConfig.DEBUG` flag to control Smart Lock:
 
 ```java
 startActivityForResult(
     AuthUI.getInstance()
         .createSignInIntentBuilder()
-        .setIsSmartLockEnabled(false, true)
+        .setIsSmartLockEnabled(!BuildConfig.DEBUG /* credentials */, true /* hints */)
         .build(),
     RC_SIGN_IN);
 ```
@@ -293,27 +295,27 @@ provide a default phone number (in international format) that will be used to pr
 country code and phone number input fields. The user is still able to edit the number if desired.
 
 ```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_NUMBER, "+123456789");
-IdpConfig phoneConfigWithDefaultNumber =
-        new IdpConfig.Builder(AuthUI.PHONE_VERIFICATION_PROVIDER)
-                .setParams(params)
-                .build();
+IdpConfig phoneConfigWithDefaultNumber = new IdpConfig.PhoneBuilder()
+        .setDefaultNumber("+123456789")
+        .build();
+```
+
+Alternatively, you can set only the default phone number country.
+
+```java
+IdpConfig phoneConfigWithDefaultNumber = new IdpConfig.PhoneBuilder()
+        .setDefaultCountryIso("ca")
+        .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();
+IdpConfig phoneConfigWithDefaultNumber = new IdpConfig.PhoneBuilder()
+        .setDefaultNumber("ca", "23456789")
+        .build();
 ```
 
 ### Handling the sign-in response
@@ -560,50 +562,46 @@ at a diff of the `strings.xml` file before updating FirebaseUI.
 
 ### Google
 By default, FirebaseUI requests the `email` and `profile` scopes when using Google Sign-In. If you
-would like to request additional scopes from the user, call `setPermissions` on the
-`AuthUI.IdpConfig.Builder` when initializing FirebaseUI.
+would like to request additional scopes from the user, call `setScopes` on the
+`AuthUI.IdpConfig.GoogleBuilder` when initializing FirebaseUI.
 
 
 ```java
 // For a list of all scopes, see:
 // https://developers.google.com/identity/protocols/googlescopes
-AuthUI.IdpConfig googleIdp = new AuthUI.IdpConfig.Builder(AuthUI.GOOGLE_PROVIDER)
-          .setPermissions(Arrays.asList(Scopes.GAMES))
-          .build();
+AuthUI.IdpConfig googleIdp = new AuthUI.IdpConfig.GoogleBuilder()
+        .setScopes(Arrays.asList(Scopes.GAMES))
+        .build();
 
 startActivityForResult(
-    AuthUI.getInstance()
-        .createSignInIntentBuilder()
-        .setAvailableProviders(Arrays.asList(new IdpConfig.Builder(AuthUI.EMAIL_PROVIDER).build(),
-                                             googleIdp,
-                                             new IdpConfig.Builder(AuthUI.FACEBOOK_PROVIDER).build()))
-        .build(),
-    RC_SIGN_IN);
+        AuthUI.getInstance()
+                .createSignInIntentBuilder()
+                .setAvailableProviders(Arrays.asList(googleIdp, ...))
+                .build(),
+        RC_SIGN_IN);
 ```
 
 
 ### Facebook
 
 By default, FirebaseUI requests the `email` and `public_profile` permissions when initiating
 Facebook Login. If you would like to request additional permissions from the user, call
-`setPermissions` on the `AuthUI.IdpConfig.Builder` when initializing FirebaseUI.
+`setPermissions` on the `AuthUI.IdpConfig.FacebookBuilder` when initializing FirebaseUI.
 
 ```java
 // For a list of permissions see:
-// https://developers.facebook.com/docs/facebook-login/android
 // https://developers.facebook.com/docs/facebook-login/permissions
 
-AuthUI.IdpConfig facebookIdp = new AuthUI.IdpConfig.Builder(AuthUI.FACEBOOK_PROVIDER)
-          .setPermissions(Arrays.asList("user_friends"))
-          .build();
+AuthUI.IdpConfig facebookIdp = new AuthUI.IdpConfig.FacebookBuilder()
+        .setPermissions(Arrays.asList("user_friends"))
+        .build();
 
 startActivityForResult(
-    AuthUI.getInstance()
-        .createSignInIntentBuilder()
-        .setAvailableProviders(Arrays.asList(new AuthUI.IdpConfig.Builder(AuthUI.EMAIL_PROVIDER).build(),
-                                             facebookIdp))
-        .build(),
-    RC_SIGN_IN);
+        AuthUI.getInstance()
+                .createSignInIntentBuilder()
+                .setAvailableProviders(Arrays.asList(facebookIdp, ...))
+                .build(),
+        RC_SIGN_IN);
 ```
 
 ### Twitter

auth/src/main/AndroidManifest.xml

@@ -74,6 +74,12 @@
             </intent-filter>
         </activity>
 
+        <provider
+            android:name=".data.client.AuthUiInitProvider"
+            android:authorities="${applicationId}.authuiinitprovider"
+            android:exported="false"
+            android:initOrder="90" />
+
     </application>
 
 </manifest>