Add an example page for cardscan

CHANGELOG.md

@@ -7,6 +7,7 @@
 ### Identity
 ### Card scanning
 * [FIXED] [4548](https://github.com/stripe/stripe-android/pull/4548) Potential work leak when canceling a card scan in StripeCardScan
+* [ADDED] [4562](https://github.com/stripe/stripe-android/pull/4562) Add an example page for cardscan
 
 ## 19.1.1 - 2022-01-31
 ### PaymentSheet

stripecardscan-example/build.gradle

@@ -50,6 +50,8 @@ dependencies {
     implementation "androidx.lifecycle:lifecycle-viewmodel-compose:2.4.0"
     // Integration with observables
     implementation "androidx.compose.runtime:runtime-livedata:$composeVersion"
+    implementation 'androidx.appcompat:appcompat:1.3.0'
+    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
 
     debugImplementation 'com.squareup.leakcanary:leakcanary-android:2.8.1'
 

stripecardscan-example/src/main/AndroidManifest.xml

@@ -21,14 +21,22 @@
 
         <activity
             android:name=".MainActivity"
-            android:label="@string/app_name"
-            android:theme="@style/AppTheme.NoActionBar"
-            android:exported="true">
+            android:exported="true"
+            android:theme="@style/AppTheme.NoActionBar">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
+
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
+
+        <activity
+            android:name=".CardImageVerificationDemoActivity"
+            android:exported="false" />
+
+        <activity
+            android:name=".CardScanDemoActivity"
+            android:exported="false" />
     </application>
 
 </manifest>

stripecardscan-example/src/main/java/com/stripe/android/stripecardscan/example/CardImageVerificationDemoActivity.kt

@@ -0,0 +1,148 @@
+package com.stripe.android.stripecardscan.example
+
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+import androidx.core.widget.addTextChangedListener
+import com.github.kittinunf.fuel.Fuel
+import com.github.kittinunf.result.Result
+import com.stripe.android.stripecardscan.cardimageverification.CardImageVerificationSheet
+import com.stripe.android.stripecardscan.cardimageverification.CardImageVerificationSheetResult
+import com.stripe.android.stripecardscan.example.databinding.ActivityCardImageVerificationDemoBinding
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.json.Json
+
+class CardImageVerificationDemoActivity : AppCompatActivity() {
+    private val viewBinding by lazy {
+        ActivityCardImageVerificationDemoBinding.inflate(layoutInflater)
+    }
+
+    private val snackbarController: SnackbarController by lazy {
+        SnackbarController(viewBinding.coordinator)
+    }
+
+    private val json by lazy {
+        Json {
+            ignoreUnknownKeys = true
+            isLenient = true
+            encodeDefaults = true
+        }
+    }
+
+    private val settings by lazy { Settings(this) }
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(viewBinding.root)
+
+        val cardImageVerificationSheet =
+            CardImageVerificationSheet.create(this, settings.publishableKey)
+
+        viewBinding.generateCivIntent.setOnClickListener {
+            Fuel.post("${settings.backendUrl}/card-set/checkout")
+                .header("content-type", "application/json")
+                .body(
+                    json.encodeToString(
+                        CivCreationRequest.serializer(),
+                        CivCreationRequest(
+                            iin = viewBinding.requiredIinText.text.toString(),
+                            lastFour = viewBinding.requiredLast4Text.text.toString(),
+                        ),
+                    )
+                )
+                .responseString { _, _, result ->
+                    when (result) {
+                        is Result.Failure -> snackbarController
+                            .show("Error generating CIV: ${result.getException().message}")
+                        is Result.Success -> runOnUiThread {
+                            try {
+                                json.decodeFromString(
+                                    CivCreationResponse.serializer(),
+                                    result.get()
+                                )
+                                    .let {
+                                        viewBinding.scanResultText.setText("")
+                                        viewBinding.civIdText.setText(it.civId)
+                                        viewBinding.civSecretText.setText(it.civClientSecret)
+                                        viewBinding.launchScanButton.isEnabled = true
+                                    }
+                            } catch (t: Throwable) {
+                                viewBinding.scanResultText.text = result.value
+                                viewBinding.civIdText.setText("")
+                                viewBinding.civSecretText.setText("")
+                            }
+                        }
+                    }
+                }
+        }
+
+        viewBinding.civIdText.addTextChangedListener(
+            { _, _, _, _ -> /* before change */ },
+            { _, _, _, _ -> /* on change */ },
+            { s ->
+                viewBinding.launchScanButton.isEnabled =
+                    !s.isNullOrEmpty() && !viewBinding.civSecretText.text.isNullOrEmpty()
+            }
+        )
+
+        viewBinding.civSecretText.addTextChangedListener(
+            { _, _, _, _ -> /* before change */ },
+            { _, _, _, _ -> /* on change */ },
+            { s ->
+                viewBinding.launchScanButton.isEnabled =
+                    !s.isNullOrEmpty() && !viewBinding.civIdText.text.isNullOrEmpty()
+            }
+        )
+
+        viewBinding.launchScanButton.setOnClickListener {
+            cardImageVerificationSheet.present(
+                viewBinding.civIdText.text.toString(),
+                viewBinding.civSecretText.text.toString(),
+                this::onScanFinished,
+            )
+        }
+    }
+
+    private fun onScanFinished(result: CardImageVerificationSheetResult) {
+        snackbarController.show(result.toString())
+
+        Fuel.post("${settings.backendUrl}/verify")
+            .header("content-type", "application/json")
+            .body(
+                json.encodeToString(
+                    VerifyRequest.serializer(),
+                    VerifyRequest(
+                        civId = viewBinding.civIdText.text.toString()
+                    )
+                )
+            )
+            .responseString { _, _, result ->
+                when (result) {
+                    is Result.Failure -> snackbarController
+                        .show("Error getting validation payload: ${result.getException().message}")
+                    is Result.Success -> runOnUiThread {
+                        viewBinding.scanResultText.text = result.value
+                        viewBinding.civIdText.setText("")
+                        viewBinding.civSecretText.setText("")
+                    }
+                }
+            }
+    }
+
+    @Serializable
+    data class CivCreationRequest(
+        @SerialName("expected_card[iin]") val iin: String,
+        @SerialName("expected_card[last4]") val lastFour: String,
+    )
+
+    @Serializable
+    data class CivCreationResponse(
+        @SerialName("id") val civId: String,
+        @SerialName("client_secret") val civClientSecret: String,
+    )
+
+    @Serializable
+    data class VerifyRequest(
+        @SerialName("civ_id") val civId: String,
+    )
+}

stripecardscan-example/src/main/java/com/stripe/android/stripecardscan/example/CardScanDemoActivity.kt

@@ -0,0 +1,37 @@
+package com.stripe.android.stripecardscan.example
+
+import androidx.appcompat.app.AppCompatActivity
+import android.os.Bundle
+import com.stripe.android.stripecardscan.cardscan.CardScanSheet
+import com.stripe.android.stripecardscan.cardscan.CardScanSheetResult
+import com.stripe.android.stripecardscan.example.databinding.ActivityCardScanDemoBinding
+
+class CardScanDemoActivity : AppCompatActivity() {
+    private val viewBinding by lazy {
+        ActivityCardScanDemoBinding.inflate(layoutInflater)
+    }
+
+    private val settings by lazy { Settings(this) }
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(viewBinding.root)
+
+        val cardScanSheet = CardScanSheet.create(this, settings.publishableKey)
+
+        viewBinding.launchScanButton.setOnClickListener {
+            cardScanSheet.present(this::onScanFinished)
+        }
+    }
+
+    private fun onScanFinished(result: CardScanSheetResult) {
+        when (result) {
+            is CardScanSheetResult.Completed ->
+                viewBinding.scanResultText.text = result.scannedCard.pan
+            is CardScanSheetResult.Canceled ->
+                viewBinding.scanResultText.text = result.reason.toString()
+            is CardScanSheetResult.Failed ->
+                viewBinding.scanResultText.text = result.error.message
+        }
+    }
+}

stripecardscan-example/src/main/java/com/stripe/android/stripecardscan/example/MainActivity.kt

@@ -1,148 +1,25 @@
 package com.stripe.android.stripecardscan.example
 
-import android.os.Bundle
+import android.content.Intent
 import androidx.appcompat.app.AppCompatActivity
-import androidx.core.widget.addTextChangedListener
-import com.github.kittinunf.fuel.Fuel
-import com.github.kittinunf.result.Result
-import com.stripe.android.stripecardscan.cardimageverification.CardImageVerificationSheet
-import com.stripe.android.stripecardscan.cardimageverification.CardImageVerificationSheetResult
+import android.os.Bundle
 import com.stripe.android.stripecardscan.example.databinding.ActivityMainBinding
-import kotlinx.serialization.SerialName
-import kotlinx.serialization.Serializable
-import kotlinx.serialization.json.Json
 
 class MainActivity : AppCompatActivity() {
     private val viewBinding by lazy {
         ActivityMainBinding.inflate(layoutInflater)
     }
 
-    private val snackbarController: SnackbarController by lazy {
-        SnackbarController(viewBinding.coordinator)
-    }
-
-    private val json by lazy {
-        Json {
-            ignoreUnknownKeys = true
-            isLenient = true
-            encodeDefaults = true
-        }
-    }
-
-    private val settings by lazy { Settings(this) }
-
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
         setContentView(viewBinding.root)
 
-        val cardImageVerificationSheet =
-            CardImageVerificationSheet.create(this, settings.publishableKey)
-
-        viewBinding.generateCivIntent.setOnClickListener {
-            Fuel.post("${settings.backendUrl}/card-set/checkout")
-                .header("content-type", "application/json")
-                .body(
-                    json.encodeToString(
-                        CivCreationRequest.serializer(),
-                        CivCreationRequest(
-                            iin = viewBinding.requiredIinText.text.toString(),
-                            lastFour = viewBinding.requiredLast4Text.text.toString(),
-                        ),
-                    )
-                )
-                .responseString { _, _, result ->
-                    when (result) {
-                        is Result.Failure -> snackbarController
-                            .show("Error generating CIV: ${result.getException().message}")
-                        is Result.Success -> runOnUiThread {
-                            try {
-                                json.decodeFromString(
-                                    CivCreationResponse.serializer(),
-                                    result.get()
-                                )
-                                    .let {
-                                        viewBinding.scanResultText.setText("")
-                                        viewBinding.civIdText.setText(it.civId)
-                                        viewBinding.civSecretText.setText(it.civClientSecret)
-                                        viewBinding.launchScanButton.isEnabled = true
-                                    }
-                            } catch (t: Throwable) {
-                                viewBinding.scanResultText.text = result.value
-                                viewBinding.civIdText.setText("")
-                                viewBinding.civSecretText.setText("")
-                            }
-                        }
-                    }
-                }
+        viewBinding.buttonCardImageVerification.setOnClickListener {
+            startActivity(Intent(this, CardImageVerificationDemoActivity::class.java))
         }
 
-        viewBinding.civIdText.addTextChangedListener(
-            { _, _, _, _ -> /* before change */ },
-            { _, _, _, _ -> /* on change */ },
-            { s ->
-                viewBinding.launchScanButton.isEnabled =
-                    !s.isNullOrEmpty() && !viewBinding.civSecretText.text.isNullOrEmpty()
-            }
-        )
-
-        viewBinding.civSecretText.addTextChangedListener(
-            { _, _, _, _ -> /* before change */ },
-            { _, _, _, _ -> /* on change */ },
-            { s ->
-                viewBinding.launchScanButton.isEnabled =
-                    !s.isNullOrEmpty() && !viewBinding.civIdText.text.isNullOrEmpty()
-            }
-        )
-
-        viewBinding.launchScanButton.setOnClickListener {
-            cardImageVerificationSheet.present(
-                viewBinding.civIdText.text.toString(),
-                viewBinding.civSecretText.text.toString(),
-                this::onScanFinished,
-            )
+        viewBinding.buttonCardScan.setOnClickListener {
+            startActivity(Intent(this, CardScanDemoActivity::class.java))
         }
     }
-
-    private fun onScanFinished(result: CardImageVerificationSheetResult) {
-        snackbarController.show(result.toString())
-
-        Fuel.post("${settings.backendUrl}/verify")
-            .header("content-type", "application/json")
-            .body(
-                json.encodeToString(
-                    VerifyRequest.serializer(),
-                    VerifyRequest(
-                        civId = viewBinding.civIdText.text.toString()
-                    )
-                )
-            )
-            .responseString { _, _, result ->
-                when (result) {
-                    is Result.Failure -> snackbarController
-                        .show("Error getting validation payload: ${result.getException().message}")
-                    is Result.Success -> runOnUiThread {
-                        viewBinding.scanResultText.text = result.value
-                        viewBinding.civIdText.setText("")
-                        viewBinding.civSecretText.setText("")
-                    }
-                }
-            }
-    }
-
-    @Serializable
-    data class CivCreationRequest(
-        @SerialName("expected_card[iin]") val iin: String,
-        @SerialName("expected_card[last4]") val lastFour: String,
-    )
-
-    @Serializable
-    data class CivCreationResponse(
-        @SerialName("id") val civId: String,
-        @SerialName("client_secret") val civClientSecret: String,
-    )
-
-    @Serializable
-    data class VerifyRequest(
-        @SerialName("civ_id") val civId: String,
-    )
 }