Instantiate BraintreeClient Within Clients (#830)

* Refactor demo app for auth fetching * Pass auth string to more fragments * Make braintreeclient internal * Fix visa checkout * Update migration guide * Add public doc strings * Fix constructor * update migration guide and CHANGELOG * Update v5_MIGRATION_GUIDE.md * Remove ClientParams * Update doc strings * Update migration guide and CHANGELOG * Remove getBraintreeClient from demo Co-authored-by: scannillo <[email protected]>
braintree · Nov 30, 2023 · 347905c · 347905c
1 parent b353681
commit 347905c
Show file tree

Hide file tree

Showing 32 changed files with 382 additions and 267 deletions.
diff --git a/AmericanExpress/src/main/java/com/braintreepayments/api/AmericanExpressClient.java b/AmericanExpress/src/main/java/com/braintreepayments/api/AmericanExpressClient.java
@@ -1,8 +1,10 @@
 package com.braintreepayments.api;
 
+import android.content.Context;
 import android.net.Uri;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.VisibleForTesting;
 
 import org.json.JSONException;
 
@@ -16,7 +18,17 @@ public class AmericanExpressClient {
 
     private final BraintreeClient braintreeClient;
 
-    public AmericanExpressClient(@NonNull BraintreeClient braintreeClient) {
+    /**
+     * Initializes a new {@link AmericanExpressClient} instance
+     *
+     * @param context an Android Context
+     * @param authorization a Tokenization Key or Client Token used to authenticate
+     */
+    public AmericanExpressClient(@NonNull Context context, @NonNull String authorization) {
+        this.braintreeClient = new BraintreeClient(context, authorization);
+    }
+
+    @VisibleForTesting AmericanExpressClient(@NonNull BraintreeClient braintreeClient) {
         this.braintreeClient = braintreeClient;
     }
 

diff --git a/BraintreeCore/src/main/java/com/braintreepayments/api/BraintreeClient.kt b/BraintreeCore/src/main/java/com/braintreepayments/api/BraintreeClient.kt
@@ -13,6 +13,7 @@ import com.braintreepayments.api.IntegrationType.Integration
  * Core Braintree class that handles network requests.
  */
 @Suppress("LargeClass", "LongParameterList", "TooManyFunctions")
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 open class BraintreeClient @VisibleForTesting internal constructor(
 
     /**
@@ -76,6 +77,7 @@ open class BraintreeClient @VisibleForTesting internal constructor(
      * @param authorization The tokenization key or client token to use. If an invalid authorization
      * is provided, a [BraintreeException] will be returned via callback.
      */
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
     constructor(context: Context, authorization: String) :
             this(BraintreeOptions(context = context, initialAuthString = authorization))
 
@@ -86,6 +88,7 @@ open class BraintreeClient @VisibleForTesting internal constructor(
      * @param clientTokenProvider An implementation of [ClientTokenProvider] that [BraintreeClient]
      * will use to fetch a client token on demand.
      */
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
     constructor(context: Context, clientTokenProvider: ClientTokenProvider) :
             this(BraintreeOptions(context = context, clientTokenProvider = clientTokenProvider))
 
@@ -104,7 +107,8 @@ open class BraintreeClient @VisibleForTesting internal constructor(
      * authorization is provided, a [BraintreeException] will be returned via callback.
      * @param returnUrlScheme A custom return url to use for browser and app switching
      */
-    constructor (context: Context, authorization: String, returnUrlScheme: String) : this(
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+    constructor (context: Context, authorization: String, returnUrlScheme: String?) : this(
         BraintreeOptions(
             context = context,
             initialAuthString = authorization,
@@ -127,6 +131,7 @@ open class BraintreeClient @VisibleForTesting internal constructor(
      * will use to fetch a client token on demand.
      * @param returnUrlScheme     A custom return url to use for browser and app switching
      */
+    @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
     constructor(
         context: Context,
         clientTokenProvider: ClientTokenProvider,

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,9 @@
   * All Modules
     * Bump `minSdkVersion` to API 23
     * Bump target Java version to Java 11
+    * Remove `BraintreeClient` public constructors
+    * Update payment method constructor parameters from `braintreeClient` to `context` and 
+      `authorization`
     * Remove `BraintreeSharedPreferencesException`
   * UnionPay
     * Remove `union-pay` module

diff --git a/Card/src/main/java/com/braintreepayments/api/CardClient.java b/Card/src/main/java/com/braintreepayments/api/CardClient.java
@@ -1,5 +1,7 @@
 package com.braintreepayments.api;
 
+import android.content.Context;
+
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
@@ -17,7 +19,18 @@ public class CardClient {
     private final BraintreeClient braintreeClient;
     private final ApiClient apiClient;
 
-    public CardClient(@NonNull BraintreeClient braintreeClient) {
+    /**
+     * Initializes a new {@link CardClient} instance
+     *
+     * @param context an Android Context
+     * @param authorization a Tokenization Key or Client Token used to authenticate
+     */
+    public CardClient(@NonNull Context context, @NonNull String authorization) {
+        this(new BraintreeClient(context, authorization));
+    }
+
+    @VisibleForTesting
+    CardClient(@NonNull BraintreeClient braintreeClient) {
         this(braintreeClient, new ApiClient(braintreeClient));
     }
 

diff --git a/DataCollector/src/main/java/com/braintreepayments/api/DataCollector.java b/DataCollector/src/main/java/com/braintreepayments/api/DataCollector.java
@@ -22,7 +22,18 @@ public class DataCollector {
     private final UUIDHelper uuidHelper;
     private final BraintreeClient braintreeClient;
 
-    public DataCollector(@NonNull BraintreeClient braintreeClient) {
+    /**
+     * Initializes a new {@link DataCollector} instance
+     *
+     * @param context an Android Context
+     * @param authorization a Tokenization Key or Client Token used to authenticate
+     */
+    public DataCollector(@NonNull Context context, @NonNull String authorization) {
+        this(new BraintreeClient(context, authorization));
+    }
+
+    @VisibleForTesting
+    DataCollector(@NonNull BraintreeClient braintreeClient) {
         this(braintreeClient, new MagnesInternalClient(), new UUIDHelper());
     }
 

diff --git a/Demo/src/main/java/com/braintreepayments/demo/BaseFragment.java b/Demo/src/main/java/com/braintreepayments/demo/BaseFragment.java
@@ -6,9 +6,10 @@
 import androidx.fragment.app.Fragment;
 import androidx.fragment.app.FragmentActivity;
 
-import com.braintreepayments.api.BraintreeClient;
 import com.braintreepayments.api.PaymentMethodNonce;
 
+import java.util.Objects;
+
 public abstract class BaseFragment extends Fragment {
 
     @CallSuper
@@ -47,11 +48,15 @@ protected void showDialog(String message) {
         }
     }
 
-    protected BraintreeClient getBraintreeClient() {
+
+    protected void fetchAuthorization(BraintreeAuthorizationCallback callback) {
         DemoActivity demoActivity = getDemoActivity();
         if (demoActivity != null) {
-            return demoActivity.getBraintreeClient();
+            demoActivity.fetchAuthorization(callback);
         }
-        return null;
+    }
+
+    String getAuthStringArg() {
+        return Objects.requireNonNull(requireArguments().getString("authString"));
     }
 }
diff --git a/Demo/src/main/java/com/braintreepayments/demo/BraintreeAuthorizationCallback.java b/Demo/src/main/java/com/braintreepayments/demo/BraintreeAuthorizationCallback.java
@@ -0,0 +1,10 @@
+package com.braintreepayments.demo;
+
+import androidx.annotation.NonNull;
+
+import com.braintreepayments.api.Authorization;
+import com.braintreepayments.api.BraintreeClient;
+
+public interface BraintreeAuthorizationCallback {
+    void onResult(@NonNull String authString);
+}
diff --git a/Demo/src/main/java/com/braintreepayments/demo/BraintreeClientCallback.java b/Demo/src/main/java/com/braintreepayments/demo/BraintreeClientCallback.java
diff --git a/Demo/src/main/java/com/braintreepayments/demo/BraintreeClientFactory.java b/Demo/src/main/java/com/braintreepayments/demo/BraintreeClientFactory.java
@@ -7,7 +7,5 @@
 // TODO: remove when AuthorizationProvider is released
 public class BraintreeClientFactory {
 
-    static public BraintreeClient createBraintreeClientWithAuthorizationProvider(Context context) {
-        return new BraintreeClient(context, new DemoClientTokenProvider(context));
-    }
+
 }
diff --git a/Demo/src/main/java/com/braintreepayments/demo/CardFragment.java b/Demo/src/main/java/com/braintreepayments/demo/CardFragment.java
@@ -17,7 +17,6 @@
 
 import com.braintreepayments.api.AmericanExpressClient;
 import com.braintreepayments.api.AmericanExpressRewardsBalance;
-import com.braintreepayments.api.BraintreeClient;
 import com.braintreepayments.api.Card;
 import com.braintreepayments.api.CardClient;
 import com.braintreepayments.api.CardNonce;
@@ -71,12 +70,11 @@ public class CardFragment extends BaseFragment implements OnCardFormSubmitListen
     public void onCreate(Bundle onSaveInstanceState) {
         super.onCreate(onSaveInstanceState);
 
-        BraintreeClient braintreeClient = getBraintreeClient();
-        americanExpressClient = new AmericanExpressClient(braintreeClient);
-        cardClient = new CardClient(braintreeClient);
-        threeDSecureClient = new ThreeDSecureClient(braintreeClient);
+        americanExpressClient = new AmericanExpressClient(requireContext(), super.getAuthStringArg());
+        cardClient = new CardClient(requireContext(), super.getAuthStringArg());
+        threeDSecureClient = new ThreeDSecureClient(requireContext(), super.getAuthStringArg());
 
-        dataCollector = new DataCollector(braintreeClient);
+        dataCollector = new DataCollector(requireContext(), super.getAuthStringArg());
 
         if (onSaveInstanceState != null) {
             threeDSecureRequested = onSaveInstanceState.getBoolean(EXTRA_THREE_D_SECURE_REQUESTED);
@@ -126,26 +124,20 @@ public void onSaveInstanceState(Bundle outState) {
 
     private void configureCardForm() {
         final AppCompatActivity activity = (AppCompatActivity) getActivity();
-        BraintreeClient braintreeClient = getBraintreeClient();
-
-        braintreeClient.getConfiguration((configuration, configError) -> {
-            if (configuration != null) {
-                cardForm.cardRequired(true)
-                        .expirationRequired(true)
-                        .cvvRequired(configuration.isCvvChallengePresent())
-                        .postalCodeRequired(configuration.isPostalCodeChallengePresent())
-                        .mobileNumberRequired(false)
-                        .actionLabel(cardFormActionLabel)
-                        .setup(activity);
-
-                if (getArguments().getBoolean(MainFragment.EXTRA_COLLECT_DEVICE_DATA, false)) {
-                    dataCollector.collectDeviceData(activity,
-                            (deviceData, e) -> this.deviceData = deviceData);
-                }
-            } else {
-                handleError(configError);
-            }
-        });
+
+        // TODO: Configure card form via settings
+        cardForm.cardRequired(true)
+                .expirationRequired(true)
+                .cvvRequired(true)
+                .postalCodeRequired(true)
+                .mobileNumberRequired(false)
+                .actionLabel(cardFormActionLabel)
+                .setup(activity);
+
+        if (getArguments().getBoolean(MainFragment.EXTRA_COLLECT_DEVICE_DATA, false)) {
+            dataCollector.collectDeviceData(activity,
+                    (deviceData, e) -> this.deviceData = deviceData);
+        }
     }
 
     @Override

diff --git a/Demo/src/main/java/com/braintreepayments/demo/DemoActivity.java b/Demo/src/main/java/com/braintreepayments/demo/DemoActivity.java
@@ -20,42 +20,33 @@
 import androidx.navigation.ui.AppBarConfiguration;
 import androidx.navigation.ui.NavigationUI;
 
-import com.braintreepayments.api.BraintreeClient;
 
 import java.util.Arrays;
 import java.util.List;
 
 public class DemoActivity extends AppCompatActivity implements ActivityCompat.OnRequestPermissionsResultCallback, ActionBar.OnNavigationListener {
 
-    private BraintreeClient braintreeClient;
     private AppBarConfiguration appBarConfiguration;
 
+    private DemoClientTokenProvider clientTokenProvider;
+
     private SharedPreferences.OnSharedPreferenceChangeListener sharedPreferenceChangeListener;
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         requestWindowFeature(Window.FEATURE_INDETERMINATE_PROGRESS);
         setContentView(R.layout.activity_demo);
+        clientTokenProvider = new DemoClientTokenProvider(this);
 
         setupActionBar();
         setProgressBarIndeterminateVisibility(true);
 
         registerSharedPreferencesListener();
     }
 
-    public BraintreeClient getBraintreeClient() {
-        // lazily instantiate braintree client in case the demo has been reset
-        if (braintreeClient == null) {
-            if (Settings.useTokenizationKey(this)) {
-                String tokenizationKey = Settings.getTokenizationKey(this);
-                braintreeClient = new BraintreeClient(this, tokenizationKey);
-            } else {
-                braintreeClient =
-                    BraintreeClientFactory.createBraintreeClientWithAuthorizationProvider(this);
-            }
-        }
-        return braintreeClient;
+    public void fetchAuthorization(BraintreeAuthorizationCallback callback) {
+        clientTokenProvider.getClientToken(callback);
     }
 
     @Override
@@ -104,7 +95,6 @@ public boolean onSupportNavigateUp() {
 
     private void performReset() {
         setProgressBarIndeterminateVisibility(true);
-        braintreeClient = null;
     }
 
     public void showDialog(String message) {

diff --git a/Demo/src/main/java/com/braintreepayments/demo/DemoClientTokenProvider.java b/Demo/src/main/java/com/braintreepayments/demo/DemoClientTokenProvider.java
@@ -11,7 +11,7 @@
 import com.braintreepayments.demo.R;
 import com.braintreepayments.demo.Settings;
 
-public class DemoClientTokenProvider implements ClientTokenProvider {
+public class DemoClientTokenProvider  {
 
     private final Merchant merchant;
     private final Context appContext;
@@ -21,15 +21,14 @@ public DemoClientTokenProvider(Context context) {
         appContext = context.getApplicationContext();
     }
 
-    @Override
-    public void getClientToken(@NonNull ClientTokenCallback callback) {
+    public void getClientToken(@NonNull BraintreeAuthorizationCallback callback) {
         String authType = Settings.getAuthorizationType(appContext);
         if (authType.equals(getString(appContext, R.string.client_token))) {
             merchant.fetchClientToken(appContext, (clientToken, error) -> {
                 if (clientToken != null) {
-                    callback.onSuccess(clientToken);
+                    callback.onResult(clientToken);
                 } else if (error != null) {
-                    callback.onFailure(error);
+                    callback.onResult(null);
                 }
             });
         }