Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add fragment handling to stripecardscan and update READMEs #4592

Merged
merged 4 commits into from
Feb 16, 2022
Merged

Add fragment handling to stripecardscan and update READMEs #4592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bfb6cfd
Add fragment handling to stripecardscan and update READMEs
awush-stripe Feb 15, 2022
ede293e
Update changelog
awush-stripe Feb 15, 2022
379634c
DRY the cardscan sheets
awush-stripe Feb 15, 2022
f6424a5
Update api defs
awush-stripe Feb 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
### PaymentSheet
### Identity
### Card scanning
[ADDED] [4592](https://github.com/stripe/stripe-android/pull/4592) Add support for launching card scan from fragments.

## 19.2.0 - 2022-02-14
This release includes several bug fixes and upgrades Kotlin to 1.6.
Expand Down
116 changes: 94 additions & 22 deletions stripecardscan/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ This library can be used entirely outside of a Stripe integration and with other

Note: Your app does not have to be written in kotlin to integrate this library, but must be able to depend on kotlin functionality.

# Example
See the `stripecardscan-example` directory for an example application that you can try for yourself!

# Integration
* In app/build.gradle, add these dependencies:
```gradle
Expand All @@ -23,7 +26,81 @@ Note: Your app does not have to be written in kotlin to integrate this library,
}
```

# Usage
# Credit Card OCR

Add `CardScanSheet` in your activity or fragment where you want to invoke the verification flow

Note: the `create` method must be called in your fragment or activity’s `onCreate` method in order to register the `ActivityResultListener` with your activity.

a. Initialize `CardScanSheet` with your `publishableKey` and the `id, client secret`
b. When it's time to invoke the verification flow, display the sheet with `CardScanSheet.present()`
c. When the verification flow is finished, the sheet will be dismissed and the `onFinished` block will be called with a `CardScanSheetResult`

```kotlin
class LaunchActivity : AppCompatActivity {

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_launch)

/**
* Create a [CardScanSheet] instance with [ComponentActivity].
*
* This API registers an [ActivityResultLauncher] into the
* [ComponentActivity], it must be called before the [ComponentActivity]
* is created (in the onCreate method).
*/
val cardScanSheet = CardScanSheet.create(
from = LaunchActivity.this,
stripePublishableKey = "stripe_key",
)

findViewById(R.id.scanCardButton).setOnClickListener { _ ->
cardScanSheet.present(
from = LaunchActivity.this,
) { cardScanSheetResult ->
when (cardScanSheetResult) {
is CardScanSheet.Completed -> {
/*
* The user scanned a card. The result of the scan can be found
* by querying the stripe card image verification endpoint with
* the CVI_ID, CVI_SECRET, and Stripe secret key.
*
* Details about the card itself are returned in the `scannedCard`
* field of the result.
*/
Log.i(cardScanSheetResult.scannedCard.pan)
}
is CardScanSheet.Canceled -> {
/*
* The scan was canceled. This could be because any of the
* following reasons (returned as the
* [CancellationReason] in the result):
*
* - Closed - the user pressed the X
* - Back - the user pressed the back button
* - UserCannotScan - the user is unable to scan this card
* - CameraPermissionDenied - the user did not grant permissions
*/
Log.i(cardScanSheetResult.reason)
}
is CardScanSheet.Failed -> {
/*
* The scan failed. The error that caused the failure is
* included in the [Throwable] `error` field of the verification
* result.
*/
Log.e(cardScanSheetResult.error.message)
}
}
}
}
}
}
```

# Credit Card Verification

1. Create a `CardImageVerificationIntent` (CIV Intent) on your backend

Perform the following tasks on your server:
Expand All @@ -34,13 +111,13 @@ Note: Your app does not have to be written in kotlin to integrate this library,

b. Provide the CIV intent's `id` and the `client_secret` to the SDK

2. Add `CardVerificationSheet` in your activity or fragment where you want to invoke the verification flow
2. Add `CardImageVerificationSheet` in your activity or fragment where you want to invoke the verification flow

Note: the `create` method must be called in your fragment or activity’s `onCreate` method in order to register the `ActivityResultListener` with your activity.

a. Initialize `CardVerificationSheet` with your `publishableKey` and the `id, client secret`
b. When it's time to invoke the verification flow, display the sheet with `CardVerificationSheet.present()`
c. When the verification flow is finished, the sheet will be dismissed and the `onFinished` block will be called with a `CardVerificationSheetResult`
a. Initialize `CardImageVerificationSheet` with your `publishableKey` and the `id, client secret`
b. When it's time to invoke the verification flow, display the sheet with `CardImageVerificationSheet.present()`
c. When the verification flow is finished, the sheet will be dismissed and the `onFinished` block will be called with a `CardImageVerificationSheetResult`

```kotlin
class LaunchActivity : AppCompatActivity {
Expand All @@ -50,27 +127,25 @@ Note: Your app does not have to be written in kotlin to integrate this library,
setContentView(R.layout.activity_launch)

/**
* Create a [CardVerificationSheet] instance with [ComponentActivity].
* Create a [CardImageVerificationSheet] instance with [ComponentActivity].
*
* This API registers an [ActivityResultLauncher] into the
* [ComponentActivity], it must be called before the [ComponentActivity]
* is created (in the onCreate method).
*
* see https://github.com/stripe/stripe-android/blob/3e92b79190834dc3aab1c2d9ac2dfb7bc343afd2/payments-core/src/main/java/com/stripe/android/payments/paymentlauncher/PaymentLauncher.kt#L52
*/
val cardVerificationSheet = CardVerificationSheet.create(
val cardImageVerificationSheet = CardImageVerificationSheet.create(
from = LaunchActivity.this,
stripePublishableKey = "stripe_key",
)

findViewById(R.id.scanCardButton).setOnClickListener { _ ->
cardVerificationSheet.present(
cardImageVerificationSheet.present(
from = LaunchActivity.this,
cardImageVerificationIntentId = "civ_id",
cardImageVerificationIntentSecret = "civ_client_secret",
) { cardVerificationSheetResult ->
when (cardVerificationSheetResult) {
is CardVerificationSheetResult.Completed -> {
) { cardImageVerificationSheetResult ->
when (cardImageVerificationSheetResult) {
is CardImageVerificationSheetResult.Completed -> {
/*
* The user scanned a card. The result of the scan can be found
* by querying the stripe card image verification endpoint with
Expand All @@ -79,35 +154,32 @@ Note: Your app does not have to be written in kotlin to integrate this library,
* Details about the card itself are returned in the `scannedCard`
* field of the result.
*/
Log.i(cardVerificationSheetResult.scannedCard.pan)
Log.i(cardImageVerificationSheetResult.scannedCard.pan)
}
is CardVerificationSheetResult.Canceled -> {
is CardImageVerificationSheetResult.Canceled -> {
/*
* The scan was canceled. This could be because any of the
* following reasons (returned as the
* [CardVerificationSheetCancelationReason] in the result):
* [CancellationReason] in the result):
*
* - Closed - the user pressed the X
* - Back - the user pressed the back button
* - UserCannotScan - the user is unable to scan this card
* - CameraPermissionDenied - the user did not grant permissions
*/
Log.i(cardVerificationSheetResult.reason)
Log.i(cardImageVerificationSheetResult.reason)
}
is CardVerificationSheetResult.Failed -> {
is CardImageVerificationSheetResult.Failed -> {
/*
* The scan failed. The error that caused the failure is
* included in the [Throwable] `error` field of the verification
* result.
*/
Log.e(cardVerificationSheetResult.error.message)
Log.e(cardImageVerificationSheetResult.error.message)
}
}
}
}
}
}
```

# Example
See the stripecardscan-example directory for an example application that you can try for yourself!
4 changes: 4 additions & 0 deletions stripecardscan/api/stripecardscan.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,13 @@ public final class com/stripe/android/stripecardscan/cardimageverification/CardI
public static final field Companion Lcom/stripe/android/stripecardscan/cardimageverification/CardImageVerificationSheet$Companion;
public synthetic fun <init> (Ljava/lang/String;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
public static final fun create (Landroidx/activity/ComponentActivity;Ljava/lang/String;)Lcom/stripe/android/stripecardscan/cardimageverification/CardImageVerificationSheet;
public static final fun create (Landroidx/fragment/app/Fragment;Ljava/lang/String;)Lcom/stripe/android/stripecardscan/cardimageverification/CardImageVerificationSheet;
public final fun present (Ljava/lang/String;Ljava/lang/String;Lkotlin/jvm/functions/Function1;)V
}

public final class com/stripe/android/stripecardscan/cardimageverification/CardImageVerificationSheet$Companion {
public final fun create (Landroidx/activity/ComponentActivity;Ljava/lang/String;)Lcom/stripe/android/stripecardscan/cardimageverification/CardImageVerificationSheet;
public final fun create (Landroidx/fragment/app/Fragment;Ljava/lang/String;)Lcom/stripe/android/stripecardscan/cardimageverification/CardImageVerificationSheet;
}

public abstract interface class com/stripe/android/stripecardscan/cardimageverification/CardImageVerificationSheetResult : android/os/Parcelable {
Expand Down Expand Up @@ -150,11 +152,13 @@ public final class com/stripe/android/stripecardscan/cardscan/CardScanSheet {
public synthetic fun <init> (Ljava/lang/String;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun attachCardScanFragment (Landroidx/lifecycle/LifecycleOwner;Landroidx/fragment/app/FragmentManager;ILkotlin/jvm/functions/Function1;)V
public static final fun create (Landroidx/activity/ComponentActivity;Ljava/lang/String;)Lcom/stripe/android/stripecardscan/cardscan/CardScanSheet;
public static final fun create (Landroidx/fragment/app/Fragment;Ljava/lang/String;)Lcom/stripe/android/stripecardscan/cardscan/CardScanSheet;
public final fun present (Lkotlin/jvm/functions/Function1;)V
}

public final class com/stripe/android/stripecardscan/cardscan/CardScanSheet$Companion {
public final fun create (Landroidx/activity/ComponentActivity;Ljava/lang/String;)Lcom/stripe/android/stripecardscan/cardscan/CardScanSheet;
public final fun create (Landroidx/fragment/app/Fragment;Ljava/lang/String;)Lcom/stripe/android/stripecardscan/cardscan/CardScanSheet;
public final fun removeCardScanFragment (Landroidx/fragment/app/FragmentManager;)V
}

Expand Down
48 changes: 29 additions & 19 deletions ...ava/com/stripe/android/stripecardscan/cardimageverification/CardImageVerificationSheet.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import android.os.Parcelable
import androidx.activity.ComponentActivity
import androidx.activity.result.ActivityResultLauncher
import androidx.activity.result.contract.ActivityResultContract
import androidx.fragment.app.Fragment
import com.stripe.android.stripecardscan.cardimageverification.exception.UnknownScanException
import com.stripe.android.stripecardscan.payment.card.ScannedCard
import com.stripe.android.stripecardscan.scanui.CancellationReason
Expand Down Expand Up @@ -47,29 +48,23 @@ class CardImageVerificationSheet private constructor(private val stripePublishab
* This API registers an [ActivityResultLauncher] into the
* [ComponentActivity], it must be called before the [ComponentActivity]
* is created (in the onCreate method).
*
* see https://github.com/stripe/stripe-android/blob/3e92b79190834dc3aab1c2d9ac2dfb7bc343afd2/payments-core/src/main/java/com/stripe/android/payments/paymentlauncher/PaymentLauncher.kt#L52
*/
@JvmStatic
fun create(from: ComponentActivity, stripePublishableKey: String) =
CardImageVerificationSheet(stripePublishableKey).apply {
launcher = from.registerForActivityResult(
object : ActivityResultContract<
CardImageVerificationSheetParams,
CardImageVerificationSheetResult
>() {
override fun createIntent(
context: Context,
input: CardImageVerificationSheetParams,
) = [email protected](context, input)

override fun parseResult(
resultCode: Int,
intent: Intent?,
) = [email protected](requireNotNull(intent))
},
::onResult,
)
launcher = from.registerForActivityResult(activityResultContract, ::onResult)
}

/**
* Create a [CardImageVerificationSheet] instance with [Fragment].
*
* This API registers an [ActivityResultLauncher] into the [Fragment], it must be called
* before the [Fragment] is created (in the onCreate method).
*/
@JvmStatic
fun create(from: Fragment, stripePublishableKey: String) =
CardImageVerificationSheet(stripePublishableKey).apply {
launcher = from.registerForActivityResult(activityResultContract, ::onResult)
}

private fun createIntent(context: Context, input: CardImageVerificationSheetParams) =
Expand All @@ -81,6 +76,21 @@ class CardImageVerificationSheet private constructor(private val stripePublishab
?: CardImageVerificationSheetResult.Failed(
UnknownScanException("No data in the result intent")
)

private val activityResultContract = object : ActivityResultContract<
CardImageVerificationSheetParams,
CardImageVerificationSheetResult
>() {
override fun createIntent(
context: Context,
input: CardImageVerificationSheetParams,
) = [email protected](context, input)

override fun parseResult(
resultCode: Int,
intent: Intent?,
) = [email protected](requireNotNull(intent))
}
}

/**
Expand Down
48 changes: 29 additions & 19 deletions stripecardscan/src/main/java/com/stripe/android/stripecardscan/cardscan/CardScanSheet.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import androidx.activity.result.ActivityResultLauncher
import androidx.activity.result.contract.ActivityResultContract
import androidx.annotation.IdRes
import androidx.core.os.bundleOf
import androidx.fragment.app.Fragment
import androidx.fragment.app.FragmentManager
import androidx.fragment.app.add
import androidx.fragment.app.commit
Expand Down Expand Up @@ -53,29 +54,23 @@ class CardScanSheet private constructor(private val stripePublishableKey: String
* This API registers an [ActivityResultLauncher] into the
* [ComponentActivity], it must be called before the [ComponentActivity]
* is created (in the onCreate method).
*
* see https://github.com/stripe/stripe-android/blob/3e92b79190834dc3aab1c2d9ac2dfb7bc343afd2/payments-core/src/main/java/com/stripe/android/payments/paymentlauncher/PaymentLauncher.kt#L52
*/
@JvmStatic
fun create(from: ComponentActivity, stripePublishableKey: String) =
CardScanSheet(stripePublishableKey).apply {
launcher = from.registerForActivityResult(
object : ActivityResultContract<
CardScanSheetParams,
CardScanSheetResult
>() {
override fun createIntent(
context: Context,
input: CardScanSheetParams,
) = [email protected](context, input)

override fun parseResult(
resultCode: Int,
intent: Intent?,
) = [email protected](requireNotNull(intent))
},
::onResult,
)
launcher = from.registerForActivityResult(activityResultContract, ::onResult)
}

/**
* Create a [CardScanSheet] instance with [Fragment].
*
* This API registers an [ActivityResultLauncher] into the [Fragment], it must be called
* before the [Fragment] is created (in the onCreate method).
*/
@JvmStatic
fun create(from: Fragment, stripePublishableKey: String) =
CardScanSheet(stripePublishableKey).apply {
launcher = from.registerForActivityResult(activityResultContract, ::onResult)
}

private fun createIntent(context: Context, input: CardScanSheetParams) =
Expand All @@ -99,6 +94,21 @@ class CardScanSheet private constructor(private val stripePublishableKey: String
}
}
}

private val activityResultContract = object : ActivityResultContract<
CardScanSheetParams,
CardScanSheetResult
>() {
override fun createIntent(
context: Context,
input: CardScanSheetParams,
) = [email protected](context, input)

override fun parseResult(
resultCode: Int,
intent: Intent?,
) = [email protected](requireNotNull(intent))
}
}

/**
Expand Down