Card-scanning in PaymentSheet

CHANGELOG.md

@@ -25,6 +25,7 @@ This release patches on a crash on PaymentLauncher, updates the package name of
 changes the public API for CardImageVerificationSheet and releases Identity SDK.
 
 ### Payments (`com.stripe:stripe-android`)
+* [ADDED] [4804](https://github.com/stripe/stripe-android/pull/4804) Added card-scanning feature to PaymentSheet
 * [FIXED] [4776](https://github.com/stripe/stripe-android/pull/4776) fix issue with PaymentLauncher configuration change
 * [CHANGED] [4358](https://github.com/stripe/stripe-android/pull/4358) Updated the card element on
   PaymentSheet to use Compose.

payments-ui-core/api/payments-ui-core.api

@@ -19,6 +19,15 @@ public final class com/stripe/android/ui/core/address/AddressFieldElementReposit
 	public static fun newInstance (Landroid/content/res/Resources;)Lcom/stripe/android/ui/core/address/AddressFieldElementRepository;
 }
 
+public final class com/stripe/android/ui/core/databinding/ActivityCardScanBinding : androidx/viewbinding/ViewBinding {
+	public final field fragmentContainer Landroidx/fragment/app/FragmentContainerView;
+	public static fun bind (Landroid/view/View;)Lcom/stripe/android/ui/core/databinding/ActivityCardScanBinding;
+	public synthetic fun getRoot ()Landroid/view/View;
+	public fun getRoot ()Landroidx/constraintlayout/widget/ConstraintLayout;
+	public static fun inflate (Landroid/view/LayoutInflater;)Lcom/stripe/android/ui/core/databinding/ActivityCardScanBinding;
+	public static fun inflate (Landroid/view/LayoutInflater;Landroid/view/ViewGroup;Z)Lcom/stripe/android/ui/core/databinding/ActivityCardScanBinding;
+}
+
 public final class com/stripe/android/ui/core/elements/AffirmElementUIKt {
 }
 
@@ -42,6 +51,15 @@ public final class com/stripe/android/ui/core/elements/BankRepository_Factory :
 public final class com/stripe/android/ui/core/elements/BsbElementUIKt {
 }
 
+public final class com/stripe/android/ui/core/elements/CardDetailsSectionController : com/stripe/android/ui/core/elements/SectionFieldErrorController {
+	public static final field $stable I
+	public fun <init> (Landroid/content/Context;)V
+	public fun getError ()Lkotlinx/coroutines/flow/Flow;
+}
+
+public final class com/stripe/android/ui/core/elements/CardDetailsSectionElementUIKt {
+}
+
 public final class com/stripe/android/ui/core/elements/ComposableSingletons$AfterpayClearpayElementUIKt {
 	public static final field INSTANCE Lcom/stripe/android/ui/core/elements/ComposableSingletons$AfterpayClearpayElementUIKt;
 	public static field lambda-1 Lkotlin/jvm/functions/Function3;

payments-ui-core/build.gradle

@@ -21,6 +21,7 @@ if (System.getenv("JITPACK")) {
 dependencies {
     implementation project(":stripe-core")
     implementation project(":payments-core")
+    compileOnly project(":stripecardscan")
 
     implementation 'androidx.constraintlayout:constraintlayout-compose:1.0.0'
     implementation "androidx.core:core-ktx:$androidxCoreVersion"
@@ -63,6 +64,7 @@ dependencies {
     testImplementation "androidx.test.ext:junit-ktx:$androidTestJunitVersion"
     testImplementation "androidx.arch.core:core-testing:$androidxArchCoreVersion"
     testImplementation "androidx.fragment:fragment-testing:$androidxFragmentVersion"
+    testImplementation project(':stripecardscan')
 
     ktlint "com.pinterest:ktlint:$ktlintVersion"
 }
@@ -102,6 +104,7 @@ android {
 
     buildFeatures {
         compose = true
+        viewBinding = true
     }
 
     testOptions {

payments-ui-core/res/drawable/ic_photo_camera.xml

@@ -0,0 +1,13 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24"
+    android:tint="?attr/colorControlNormal">
+    <path
+        android:fillColor="@android:color/black"
+        android:pathData="M12,12m-3.2,0a3.2,3.2 0,1 1,6.4 0a3.2,3.2 0,1 1,-6.4 0"/>
+    <path
+        android:fillColor="@android:color/black"
+        android:pathData="M9,2L7.17,4L4,4c-1.1,0 -2,0.9 -2,2v12c0,1.1 0.9,2 2,2h16c1.1,0 2,-0.9 2,-2L22,6c0,-1.1 -0.9,-2 -2,-2h-3.17L15,2L9,2zM12,17c-2.76,0 -5,-2.24 -5,-5s2.24,-5 5,-5 5,2.24 5,5 -2.24,5 -5,5z"/>
+</vector>

payments-ui-core/res/layout/activity_card_scan.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.constraintlayout.widget.ConstraintLayout
+    xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent">
+
+    <androidx.fragment.app.FragmentContainerView
+        android:id="@+id/fragment_container"
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        app:layout_constraintEnd_toEndOf="parent"
+        app:layout_constraintStart_toStartOf="parent"
+        app:layout_constraintTop_toTopOf="parent"
+        app:layout_constraintBottom_toBottomOf="parent"/>
+
+</androidx.constraintlayout.widget.ConstraintLayout>

payments-ui-core/res/values/totranslate.xml

@@ -5,4 +5,7 @@
     -->
     <!-- Card details section title for card form entry -->
     <string name="card_information" tools:ignore="ExtraTranslation">Card information</string>
+
+    <!-- Scan card button -->
+    <string name="scan_card" tools:ignore="ExtraTranslation">Scan card</string>
 </resources>

payments-ui-core/src/main/AndroidManifest.xml

@@ -2,4 +2,11 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="com.stripe.android.ui.core">
 
+    <application>
+        <activity
+            android:name=".cardscan.CardScanActivity"
+            android:theme="@style/StripePaymentSheetDefaultTheme"
+            android:exported="false" />
+    </application>
+
 </manifest>

payments-ui-core/src/main/java/com/stripe/android/ui/core/IsStripeCardScanAvailable.kt

@@ -0,0 +1,16 @@
+package com.stripe.android.ui.core
+
+internal interface IsStripeCardScanAvailable {
+    operator fun invoke(): Boolean
+}
+
+internal class DefaultIsStripeCardScanAvailable : IsStripeCardScanAvailable {
+    override fun invoke(): Boolean {
+        return try {
+            Class.forName("com.stripe.android.stripecardscan.cardscan.CardScanSheet")
+            true
+        } catch (_: Exception) {
+            false
+        }
+    }
+}

payments-ui-core/src/main/java/com/stripe/android/ui/core/StripeCardScanProxy.kt

@@ -0,0 +1,108 @@
+package com.stripe.android.ui.core
+
+import androidx.annotation.IdRes
+import androidx.appcompat.app.AppCompatActivity
+import androidx.fragment.app.Fragment
+import androidx.fragment.app.FragmentManager
+import androidx.lifecycle.LifecycleOwner
+import com.stripe.android.BuildConfig
+import com.stripe.android.stripecardscan.cardscan.CardScanSheet
+import com.stripe.android.stripecardscan.cardscan.CardScanSheetResult
+
+/**
+ * Proxy to access stripecardscan code safely
+ *
+ */
+internal interface StripeCardScanProxy {
+    fun present()
+
+    fun attachCardScanFragment(
+        lifecycleOwner: LifecycleOwner,
+        supportFragmentManager: FragmentManager,
+        @IdRes fragmentContainer: Int,
+        onFinished: (cardScanSheetResult: CardScanSheetResult) -> Unit
+    )
+
+    companion object {
+        fun create(
+            fragment: Fragment,
+            stripePublishableKey: String,
+            onFinished: (cardScanSheetResult: CardScanSheetResult) -> Unit,
+            provider: () -> StripeCardScanProxy = {
+                DefaultStripeCardScanProxy(CardScanSheet.create(fragment, stripePublishableKey, onFinished))
+            },
+            isStripeCardScanAvailable: IsStripeCardScanAvailable = DefaultIsStripeCardScanAvailable()
+        ): StripeCardScanProxy {
+            return if (isStripeCardScanAvailable()) {
+                provider()
+            } else {
+                UnsupportedStripeCardScanProxy()
+            }
+        }
+
+        fun create(
+            activity: AppCompatActivity,
+            stripePublishableKey: String,
+            onFinished: (cardScanSheetResult: CardScanSheetResult) -> Unit,
+            provider: () -> StripeCardScanProxy = {
+                DefaultStripeCardScanProxy(CardScanSheet.create(activity, stripePublishableKey, onFinished))
+            },
+            isStripeCardScanAvailable: IsStripeCardScanAvailable = DefaultIsStripeCardScanAvailable()
+        ): StripeCardScanProxy {
+            return if (isStripeCardScanAvailable()) {
+                provider()
+            } else {
+                UnsupportedStripeCardScanProxy()
+            }
+        }
+
+        fun removeCardScanFragment(
+            supportFragmentManager: FragmentManager,
+            isStripeCardScanAvailable: IsStripeCardScanAvailable = DefaultIsStripeCardScanAvailable()
+        ) {
+            if (isStripeCardScanAvailable()) {
+                CardScanSheet.removeCardScanFragment(supportFragmentManager)
+            }
+        }
+    }
+}
+
+internal class DefaultStripeCardScanProxy(
+    private val cardScanSheet: CardScanSheet
+) : StripeCardScanProxy {
+    override fun present() {
+        cardScanSheet.present()
+    }
+
+    override fun attachCardScanFragment(
+        lifecycleOwner: LifecycleOwner,
+        supportFragmentManager: FragmentManager,
+        fragmentContainer: Int,
+        onFinished: (cardScanSheetResult: CardScanSheetResult) -> Unit
+    ) {
+        cardScanSheet.attachCardScanFragment(lifecycleOwner, supportFragmentManager, fragmentContainer, onFinished)
+    }
+}
+
+internal class UnsupportedStripeCardScanProxy : StripeCardScanProxy {
+    override fun present() {
+        if (BuildConfig.DEBUG) {
+            throw IllegalStateException(
+                "Missing stripecardscan dependency, please add it to your apps build.gradle"
+            )
+        }
+    }
+
+    override fun attachCardScanFragment(
+        lifecycleOwner: LifecycleOwner,
+        supportFragmentManager: FragmentManager,
+        fragmentContainer: Int,
+        onFinished: (cardScanSheetResult: CardScanSheetResult) -> Unit
+    ) {
+        if (BuildConfig.DEBUG) {
+            throw IllegalStateException(
+                "Missing stripecardscan dependency, please add it to your apps build.gradle"
+            )
+        }
+    }
+}

payments-ui-core/src/main/java/com/stripe/android/ui/core/cardscan/CardScanActivity.kt

@@ -0,0 +1,53 @@
+package com.stripe.android.ui.core.cardscan
+
+import android.content.Intent
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+import com.stripe.android.PaymentConfiguration
+import com.stripe.android.stripecardscan.cardscan.CardScanSheetResult
+import com.stripe.android.ui.core.R
+import com.stripe.android.ui.core.StripeCardScanProxy
+import com.stripe.android.ui.core.databinding.ActivityCardScanBinding
+
+internal class CardScanActivity : AppCompatActivity() {
+    private val viewBinding by lazy {
+        ActivityCardScanBinding.inflate(layoutInflater)
+    }
+
+    private lateinit var stripeCardScanProxy: StripeCardScanProxy
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(viewBinding.root)
+
+        stripeCardScanProxy = StripeCardScanProxy.create(
+            this, PaymentConfiguration.getInstance(this).publishableKey, this::onScanFinished
+        )
+    }
+
+    override fun onStart() {
+        super.onStart()
+        stripeCardScanProxy.attachCardScanFragment(
+            this, supportFragmentManager, R.id.fragment_container, this::onScanFinished
+        )
+    }
+
+    private fun onScanFinished(result: CardScanSheetResult) {
+        val intent = Intent()
+            .putExtra(
+                CARD_SCAN_PARCELABLE_NAME,
+                result
+            )
+        setResult(RESULT_OK, intent)
+        finish()
+    }
+
+    override fun onStop() {
+        StripeCardScanProxy.removeCardScanFragment(supportFragmentManager)
+        super.onStop()
+    }
+
+    companion object {
+        const val CARD_SCAN_PARCELABLE_NAME = "CardScanActivityResult"
+    }
+}

payments-ui-core/src/main/java/com/stripe/android/ui/core/elements/CardDetailsSectionController.kt

@@ -0,0 +1,15 @@
+package com.stripe.android.ui.core.elements
+
+import android.content.Context
+import com.stripe.android.ui.core.DefaultIsStripeCardScanAvailable
+
+class CardDetailsSectionController(context: Context) : SectionFieldErrorController {
+
+    internal val cardDetailsElement = CardDetailsElement(
+        IdentifierSpec.Generic("card_detail"), context
+    )
+
+    internal val isStripeCardScanAvailable = DefaultIsStripeCardScanAvailable()
+
+    override val error = cardDetailsElement.controller.error
+}

payments-ui-core/src/main/java/com/stripe/android/ui/core/elements/CardDetailsSectionElement.kt

@@ -0,0 +1,19 @@
+package com.stripe.android.ui.core.elements
+
+import android.content.Context
+import androidx.annotation.RestrictTo
+import com.stripe.android.ui.core.forms.FormFieldEntry
+import kotlinx.coroutines.flow.Flow
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+data class CardDetailsSectionElement(
+    val context: Context,
+    override val identifier: IdentifierSpec,
+    override val controller: CardDetailsSectionController = CardDetailsSectionController(context),
+) : FormElement() {
+    override fun getFormFieldValueFlow(): Flow<List<Pair<IdentifierSpec, FormFieldEntry>>> =
+        controller.cardDetailsElement.getFormFieldValueFlow()
+
+    override fun getTextFieldIdentifiers(): Flow<List<IdentifierSpec>> =
+        controller.cardDetailsElement.getTextFieldIdentifiers()
+}

payments-ui-core/src/main/java/com/stripe/android/ui/core/elements/CardDetailsSectionElementUI.kt

@@ -0,0 +1,60 @@
+package com.stripe.android.ui.core.elements
+
+import androidx.annotation.RestrictTo
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.semantics.heading
+import androidx.compose.ui.semantics.semantics
+import com.stripe.android.stripecardscan.cardscan.CardScanSheetResult
+import com.stripe.android.stripecardscan.cardscan.exception.UnknownScanException
+import com.stripe.android.ui.core.R
+import com.stripe.android.ui.core.cardscan.CardScanActivity
+
+@Composable
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+fun CardDetailsSectionElementUI(
+    enabled: Boolean,
+    controller: CardDetailsSectionController,
+    hiddenIdentifiers: List<IdentifierSpec>?
+) {
+
+    Row(
+        horizontalArrangement = Arrangement.SpaceBetween,
+        verticalAlignment = Alignment.CenterVertically,
+        modifier = Modifier
+            .fillMaxWidth()
+    ) {
+        H6Text(
+            text = stringResource(R.string.card_information),
+            modifier = Modifier
+                .semantics(mergeDescendants = true) { // Need to prevent form as focusable accessibility
+                    heading()
+                }
+        )
+        if (controller.isStripeCardScanAvailable()) {
+            ScanCardButtonUI {
+                controller.cardDetailsElement.controller.numberElement.controller.onCardScanResult(
+                    it.getParcelableExtra(CardScanActivity.CARD_SCAN_PARCELABLE_NAME)
+                        ?: CardScanSheetResult.Failed(
+                            UnknownScanException("No data in the result intent")
+                        )
+                )
+            }
+        }
+    }
+    SectionElementUI(
+        enabled,
+        SectionElement(
+            IdentifierSpec.Generic("credit_details"),
+            listOf(controller.cardDetailsElement),
+            SectionController(null, listOf(controller.cardDetailsElement.sectionFieldErrorController()))
+        ),
+        hiddenIdentifiers ?: emptyList(),
+        IdentifierSpec.Generic("card_details")
+    )
+}