Rename authenticatePayment and authenticateSetup (#1782)

Rename to `Stripe#handleNextActionForPayment()` and `Stripe#handleNextActionForSetupIntent()`, respectively.
stripe · Nov 5, 2019 · 651feb7 · 651feb7
1 parent 96a741e
commit 651feb7
Show file tree

Hide file tree

Showing 3 changed files with 93 additions and 13 deletions.
diff --git a/stripe/src/main/java/com/stripe/android/Stripe.kt b/stripe/src/main/java/com/stripe/android/Stripe.kt
@@ -170,12 +170,14 @@ class Stripe internal constructor(
 
     /**
      * Authenticate a [PaymentIntent].
-     * Used for [manual confirmation](https://stripe.com/docs/payments/payment-intents/quickstart#manual-confirmation-flow) flow.
+     * Used for [manual confirmation](https://stripe.com/docs/payments/payment-intents/android-manual) flow.
      *
      * @param activity the `Activity` that is launching the payment authentication flow
      * @param clientSecret the [client_secret](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-client_secret)
      * property of a confirmed [PaymentIntent] object
      */
+    @Deprecated("Rename to better reflect behavior and match iOS naming.",
+        ReplaceWith("handleNextActionForPayment(activity, clientSecret)"))
     @UiThread
     fun authenticatePayment(activity: Activity, clientSecret: String) {
         paymentController.startAuth(
@@ -185,6 +187,25 @@ class Stripe internal constructor(
         )
     }
 
+    /**
+     * Handle the [next_action](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-next_action)
+     * for a previously confirmed [PaymentIntent].
+     *
+     * Used for [manual confirmation](https://stripe.com/docs/payments/payment-intents/quickstart#manual-confirmation-flow) flow.
+     *
+     * @param activity the `Activity` that is launching the payment authentication flow
+     * @param clientSecret the [client_secret](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-client_secret)
+     * property of a confirmed [PaymentIntent] object
+     */
+    @UiThread
+    fun handleNextActionForPayment(activity: Activity, clientSecret: String) {
+        paymentController.startAuth(
+            AuthActivityStarter.Host.create(activity),
+            clientSecret,
+            ApiRequest.Options(publishableKey, stripeAccountId)
+        )
+    }
+
     /**
      * Authenticate a [PaymentIntent].
      * Used for [manual confirmation](https://stripe.com/docs/payments/payment-intents/quickstart#manual-confirmation-flow) flow.
@@ -193,6 +214,8 @@ class Stripe internal constructor(
      * @param clientSecret the [client_secret](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-client_secret)
      * property of a confirmed [PaymentIntent] object
      */
+    @Deprecated("Rename to better reflect behavior and match iOS naming.",
+        ReplaceWith("handleNextActionForPayment(fragment, clientSecret)"))
     @UiThread
     fun authenticatePayment(fragment: Fragment, clientSecret: String) {
         paymentController.startAuth(
@@ -202,10 +225,29 @@ class Stripe internal constructor(
         )
     }
 
+    /**
+     * Handle the [next_action](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-next_action)
+     * for a previously confirmed [PaymentIntent].
+     *
+     * Used for [manual confirmation](https://stripe.com/docs/payments/payment-intents/android-manual) flow.
+     *
+     * @param fragment the `Fragment` that is launching the payment authentication flow
+     * @param clientSecret the [client_secret](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-client_secret)
+     * property of a confirmed [PaymentIntent] object
+     */
+    @UiThread
+    fun handleNextActionForPayment(fragment: Fragment, clientSecret: String) {
+        paymentController.startAuth(
+            AuthActivityStarter.Host.create(fragment),
+            clientSecret,
+            ApiRequest.Options(publishableKey, stripeAccountId)
+        )
+    }
+
     /**
      * Should be called via `Activity#onActivityResult(int, int, Intent)}}` to handle the
      * result of a PaymentIntent automatic confirmation (see [confirmPayment]) or
-     * manual confirmation (see [authenticatePayment]})
+     * manual confirmation (see [handleNextActionForPayment]})
      */
     @UiThread
     fun onPaymentResult(
@@ -314,6 +356,8 @@ class Stripe internal constructor(
      * @param clientSecret the [client_secret](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-client_secret)
      * property of a confirmed [SetupIntent] object
      */
+    @Deprecated("Rename to better reflect behavior and match iOS naming.",
+        ReplaceWith("handleNextActionForSetupIntent(activity, clientSecret)"))
     @UiThread
     fun authenticateSetup(activity: Activity, clientSecret: String) {
         paymentController.startAuth(
@@ -323,13 +367,32 @@ class Stripe internal constructor(
         )
     }
 
+    /**
+     * Handle [next_action](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-next_action)
+     * for a previously confirmed [SetupIntent]. Used for manual confirmation flow.
+     *
+     * @param activity the `Activity` that is launching the payment authentication flow
+     * @param clientSecret the [client_secret](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-client_secret)
+     * property of a confirmed [SetupIntent] object
+     */
+    @UiThread
+    fun handleNextActionForSetupIntent(activity: Activity, clientSecret: String) {
+        paymentController.startAuth(
+            AuthActivityStarter.Host.create(activity),
+            clientSecret,
+            ApiRequest.Options(publishableKey, stripeAccountId)
+        )
+    }
+
     /**
      * Authenticate a [SetupIntent]. Used for manual confirmation flow.
      *
      * @param fragment the `Fragment` launching the payment authentication flow
      * @param clientSecret the [client_secret](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-client_secret)
      * property of a confirmed [SetupIntent] object
      */
+    @Deprecated("Rename to better reflect behavior and match iOS naming.",
+        ReplaceWith("handleNextActionForSetupIntent(fragment, clientSecret)"))
     @UiThread
     fun authenticateSetup(fragment: Fragment, clientSecret: String) {
         paymentController.startAuth(
@@ -339,6 +402,23 @@ class Stripe internal constructor(
         )
     }
 
+    /**
+     * Handle [next_action](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-next_action)
+     * for a previously confirmed [SetupIntent]. Used for manual confirmation flow.
+     *
+     * @param fragment the `Fragment` launching the payment authentication flow
+     * @param clientSecret the [client_secret](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-client_secret)
+     * property of a confirmed [SetupIntent] object
+     */
+    @UiThread
+    fun handleNextActionForSetupIntent(fragment: Fragment, clientSecret: String) {
+        paymentController.startAuth(
+            AuthActivityStarter.Host.create(fragment),
+            clientSecret,
+            ApiRequest.Options(publishableKey, stripeAccountId)
+        )
+    }
+
     /**
      * Should be called via `Activity#onActivityResult(int, int, Intent)}}` to handle the
      * result of a SetupIntent confirmation (see [confirmSetupIntent]).
@@ -727,10 +807,10 @@ class Stripe internal constructor(
      * @param idempotencyKey optional, see [Idempotent Requests](https://stripe.com/docs/api/idempotent_requests)
      * @param callback a [ApiResultCallback] to receive the result or error
      */
+    @Deprecated("Deprecated, replace with Stripe#createCardToken()",
+        ReplaceWith("createCardToken(card, idempotencyKey, callback)"))
     @UiThread
     @JvmOverloads
-    @Deprecated("Deprecated, replace with Stripe#createCardToken()",
-        ReplaceWith("Stripe#createCardToken()"))
     fun createToken(
         card: Card,
         idempotencyKey: String? = null,

diff --git a/stripe/src/main/java/com/stripe/android/StripeIntentResult.kt b/stripe/src/main/java/com/stripe/android/StripeIntentResult.kt
@@ -6,7 +6,7 @@ import java.util.Objects
 
 /**
  * A model representing the result of a [StripeIntent] confirmation or authentication attempt
- * via [Stripe.confirmPayment] or [Stripe.authenticatePayment]
+ * via [Stripe.confirmPayment] or [Stripe.handleNextActionForPayment]
  *
  * [intent] is a [StripeIntent] retrieved after confirmation/authentication succeeded or failed.
  */

diff --git a/stripe/src/test/java/com/stripe/android/StripePaymentAuthTest.kt b/stripe/src/test/java/com/stripe/android/StripePaymentAuthTest.kt
@@ -7,6 +7,7 @@ import androidx.test.core.app.ApplicationProvider
 import com.nhaarman.mockitokotlin2.KArgumentCaptor
 import com.nhaarman.mockitokotlin2.argumentCaptor
 import com.nhaarman.mockitokotlin2.eq
+import com.nhaarman.mockitokotlin2.verify
 import com.stripe.android.model.ConfirmPaymentIntentParams
 import com.stripe.android.model.ConfirmSetupIntentParams
 import com.stripe.android.model.PaymentIntentFixtures
@@ -18,7 +19,6 @@ import kotlin.test.assertEquals
 import org.junit.runner.RunWith
 import org.mockito.Mock
 import org.mockito.Mockito.`when`
-import org.mockito.Mockito.verify
 import org.mockito.MockitoAnnotations
 import org.robolectric.RobolectricTestRunner
 
@@ -53,7 +53,7 @@ class StripePaymentAuthTest {
             "client_secret",
             "yourapp://post-authentication-return-url")
         stripe.confirmPayment(activity, confirmPaymentIntentParams)
-        verify<PaymentController>(paymentController).startConfirmAndAuth(
+        verify(paymentController).startConfirmAndAuth(
             hostArgumentCaptor.capture(),
             eq(confirmPaymentIntentParams),
             eq(REQUEST_OPTIONS)
@@ -69,7 +69,7 @@ class StripePaymentAuthTest {
             "client_secret",
             "yourapp://post-authentication-return-url")
         stripe.confirmSetupIntent(activity, confirmSetupIntentParams)
-        verify<PaymentController>(paymentController).startConfirmAndAuth(
+        verify(paymentController).startConfirmAndAuth(
             hostArgumentCaptor.capture(),
             eq(confirmSetupIntentParams),
             eq(REQUEST_OPTIONS)
@@ -82,8 +82,8 @@ class StripePaymentAuthTest {
         val stripe = createStripe()
         val clientSecret =
             requireNotNull(PaymentIntentFixtures.PI_REQUIRES_MASTERCARD_3DS2.clientSecret)
-        stripe.authenticatePayment(activity, clientSecret)
-        verify<PaymentController>(paymentController).startAuth(
+        stripe.handleNextActionForPayment(activity, clientSecret)
+        verify(paymentController).startAuth(
             hostArgumentCaptor.capture(),
             eq(clientSecret),
             eq(REQUEST_OPTIONS)
@@ -92,12 +92,12 @@ class StripePaymentAuthTest {
     }
 
     @Test
-    fun authenticateSetup_shouldAuth() {
+    fun handleNextActionForSetupIntent_shouldStartAuth() {
         val stripe = createStripe()
         val clientSecret =
             requireNotNull(SetupIntentFixtures.SI_NEXT_ACTION_REDIRECT.clientSecret)
-        stripe.authenticateSetup(activity, clientSecret)
-        verify<PaymentController>(paymentController).startAuth(
+        stripe.handleNextActionForSetupIntent(activity, clientSecret)
+        verify(paymentController).startAuth(
             hostArgumentCaptor.capture(),
             eq(clientSecret),
             eq(REQUEST_OPTIONS)