Merge pull request #3 from socure-inc/2420-v2-v3

sample app - v2

Author: amar-w

README.md

@@ -1,92 +1,82 @@
-# Document Verification Android SDK
+# Predictive DocV Android SDK v3
 
-The Document Verification Android SDK provides a framework to add image capture and upload services to your native Android applications. The SDK supports image capture for both Android and iOS. This guide covers only Android.
+The Predictive Document Verification (Predictive DocV) Android SDK v3 provides a framework to add image capture and upload services to your mobile application. 
 
 ## Minimum Requirements
 
-| Feature                          | Minimum Requirements |
-|----------------------------------|----------------------|
-| Android SDK                      | `minSdkVersion 22`   |
-| Document and Selfie Auto Capture | Android 8 and above  |
+- Android SDK Version 22 (OS Version 5.1) and later
+- Android SDK is compiled with `compileSdkVersion 32` and Java 11
 
-### OkHttp3 and Retrofit dependencies
-
-| Feature  | Version |
-|----------|---------|
-| okHttp   | 4.9.3   |
-| retrofit | 2.9.0   |
+## Configuration and integration
 
+The Predictive DocV Android SDK v3 allows integration as simple as writing a single line of code:
 ```
-def retrofitVersion = '2.9.0'
-implementation "com.squareup.retrofit2:retrofit:$retrofitVersion"
-implementation "com.squareup.retrofit2:converter-gson:$retrofitVersion"
-
-def okHttpVersion = '4.9.3'
-implementation "com.squareup.okhttp3:okhttp:$okHttpVersion"
-implementation "com.squareup.okhttp3:logging-interceptor:$okHttpVersion"
+SocureDocVHelper.getIntent(context, socure-api-key, config)
 ```
 
-## Installation
+| Argument           | Description                                                                                                                                                                                                                                                                                                       |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `SocureDocVHelper` | A framework helper class.                                                                                                                                                                                                                                                                                         |
+| `socure-api-key`   | The unique SDK key obtained from Admin Dashboard. For more information on SDK keys, see the Admin Dashboard User Guide.                                                                                                                          |
+| `context`          | Activity context                                                                                                                                                                                                                                                                                                  |
+| `config`           | An optional JSON string or null value that specifies a custom flow. The `flow_1` value specifies the name of the flow (created in Admin Dashboard) that the Predictive DocV SDK should use.  <br /> <br />`{"flow": {"name": "flow_1"}}` <br /> <br />If the value is `null`, the Predictive DocV SDK will fetch Socure's default flow. |
 
-To install the DocV Android SDK, you must perform the following steps:
- - [Add Socure to the build.gradle](#add-socure-to-the-buildgradle)
- - [Update permissions](#update-permissions)
- - [Add API keys](#add-api-keys)
+Before you can use the Predictive DocV Android SDK v3, you must perform the following steps:
 
-### Add Socure to the build.gradle
+- [Add SDK dependencies](#add-sdk-dependencies)
+- [Camera permissions](#camera-permissions)
+- [Launch Socure DocV SDK](#launch-socure-docv-sdk)
 
-You must add the following to your `build.gradle`:
+### Add SDK dependencies
 
-- Add the maven URL in the root/project level `build.gradle`:
+In your root `build.gradle` file, at the end of the `allprojects` > `repositories` section, add the Socure DocV SDK Maven repository. 
 
+```kotlin {4}
+allprojects {
+        repositories {
+            ...
+            maven { url 'https://jitpack.io' }
+        }
+    }
 ```
-(NOT IN THE `buildscript` code block above. allprojects is a sibling to build script)
 
+In your module level `build.gradle` file, add the following Socure DocV SDK dependency:
 
-allprojects {
-  	  	repositories {
-      	 		 .......
-
-       			 maven {
-           				 url "https://jitpack.io"
-     		 	 }
-    		}
-}
-```
+```kotlin {2}
+ dependencies {
+      implementation 'com.github.socure-inc:socure-docv:x.y.z'
+ }
+ ```
 
-- Add the following to the `build.gradle` of the module/library that uses the framework:
+### Camera permissions
 
-```
-dependencies {
-   		 implementation 'com.github.socure-inc:android-sdk:2.0.13'
-}
-```
+The Predictive DocV Android SDK requires camera permission to capture identity documents. Upon the first invocation of the SDK, your app will request camera permission from the user.
 
-### Update permissions
+**Note**: We recommend you check for camera permissions before calling the Socure DocV SDK’s launch API. 
 
-Make the following permission updates for Android in the Android.manifest:
+#### Required permissions
+
+Ensure that your app manifest has been set up properly to request the following required permissions:
 
 ```
-<uses-permission android:name="android.permission.CAMERA"></uses-permission>
-<uses-permission android:name="android.permission.INTERNET"></uses-permission>
-<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"></uses-permission>
-<uses-feature android:name="android.hardware.camera.autofocus" />
-<uses-feature android:name="android.hardware.camera.flash" android:required="false" />
 <uses-feature android:name="android.hardware.camera" />
-<uses-permission android:name="android.permission.VIBRATE" />
-```
 
-### Add API keys
+<!-- Declare permissions -->
+<uses-permission android:name="android.permission.CAMERA" />
+<uses-permission android:name="android.permission.INTERNET" />
+<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
+
+```
 
-Use the Admin Dashboard to find the Socure public key.
+### Launch Socure DocV SDK
 
-- Add the key to your application:
+To launch the Socure DocV SDK, call the launch function using `ActivityResultLauncher`. 
 
 ```
-<string name="socurePublicKey" translatable="false">YOUR_KEY_HERE</string>
-```
-- Add the API key to `string.xml` as a resource.
+val startForResult: ActivityResultLauncher<Intent> = registerForActivityResult(...)
+...
+startForResult.launch(SocureDocVHelper.getIntent(context, socure-api-key, config))
 
-### Configuration and usage
+```
 
-For instructions on how to configure the SDK, see the [Android SDK documentation](https://developer.socure.com/docs/sdks/docv/android-sdk).
+Once the Socure DocV SDK is successfully launched, you will be able to set up a listener for Callback Events and customize the most aspect of the interface. For more information, see the [Android SDK documentation](https://developer.socure.com/docs/sdks/docv/android-sdk/android-sdk-v3/) on DevHub. 

License.txt renamed to licence/License.txt

@@ -1 +1,16 @@
-keystore/
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties
+.idea

sample-app/.gitignore

@@ -1,34 +1 @@
-/build
-build/
-.gradle/
-.idea/
-.DS_Store
-
-# Built application files
-*.apk
-*.ap_
-*.aab
-
-# Files for the ART/Dalvik VM
-*.dex
-
-# Java class files
-*.class
-
-
-bin/
-gen/
-out/
-
-local.properties
-
-proguard/
-
-*.log
-.navigation/
-
-captures/
-
-.externalNativeBuild
-
-output.json
+/build

sample-app/app/.gitignore

@@ -1,81 +1,47 @@
-apply plugin: 'com.android.application'
-apply plugin: 'kotlin-android'
-apply plugin: 'kotlin-android-extensions'
-apply plugin: 'kotlin-kapt'
+plugins {
+    id 'com.android.application'
+    id 'org.jetbrains.kotlin.android'
+}
 
 android {
-    useLibrary 'org.apache.http.legacy'
-    compileSdkVersion 32
+    compileSdk 32
 
     defaultConfig {
-        applicationId "com.socure.demo.demosk"
-        minSdkVersion 22
-        targetSdkVersion 32
-        versionCode 2014
-        versionName "2.0.14"
-    }
-
-    def localProperties = new Properties()
-    localProperties.load(new FileInputStream(rootProject.file("local.properties")))
+        applicationId "com.socure.docv.sdk.sample"
+        minSdk 22
+        targetSdk 32
+        versionCode 1
+        versionName "1.0"
 
-    signingConfigs {
-        release {
-            storeFile file(localProperties['keystore.release.filepath'])
-            storePassword localProperties['keystore.release.password']
-            keyAlias localProperties['key.release.alias']
-            keyPassword localProperties['key.release.password']
-        }
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
 
     buildTypes {
-        debug {
-            debuggable true
-        }
-
         release {
-            debuggable false
-            minifyEnabled true
+            minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
-            signingConfig signingConfigs.release
         }
     }
-
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_11
         targetCompatibility JavaVersion.VERSION_11
     }
-
     kotlinOptions {
-        jvmTarget = JavaVersion.VERSION_11
-    }
-
-    viewBinding {
-        enabled = true
-    }
-
-    applicationVariants.all { variant ->
-        variant.outputs.all {
-            outputFileName = "${variant.name}-${variant.versionName}.apk"
-        }
-    }
-}
-
-allprojects {
-    repositories {
-        maven { url 'https://jitpack.io'}
+        jvmTarget = '1.8'
     }
 }
 
 dependencies {
-    implementation 'androidx.core:core-ktx:1.7.0'
-    implementation 'androidx.appcompat:appcompat:1.4.1'
-    implementation 'com.google.android.material:material:1.5.0'
-    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
-    implementation 'com.karumi:dexter:6.2.1'
-    implementation 'com.google.code.gson:gson:2.9.0'
 
-    // socure document verification sdk dependency
-    implementation 'com.github.socure-inc:android-sdk:2.0.14'
-}
+    implementation 'androidx.core:core-ktx:1.8.0'
+    implementation 'androidx.appcompat:appcompat:1.4.2'
+    implementation 'com.google.android.material:material:1.6.1'
+    implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
 
+    def docV_version = "3.0.0"
+    implementation "com.github.socure-inc:socure-docv:$docV_version"
 
+    testImplementation 'junit:junit:4.13.2'
+    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
+}

sample-app/app/build.gradle

@@ -1,25 +1,21 @@
--keepnames class com.socure.idplus.*
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
 
--assumenosideeffects class android.util.Log {
-    public static boolean isLoggable(java.lang.String, int);
-    public static int v(...);
-    public static int i(...);
-    public static int w(...);
-    public static int d(...);
-    public static int e(...);
-}
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
 
--keepnames class * implements java.io.Serializable
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
 
--keepclassmembers class * implements java.io.Serializable {
-    static final long serialVersionUID;
-    static final java.io.ObjectStreamField[] serialPersistentFields;
-    !static !transient <fields>;
-    private void writeObject(java.io.ObjectOutputStream);
-    private void readObject(java.io.ObjectInputStream);
-    java.lang.Object writeReplace();
-    java.lang.Object readResolve();
-}
-
--dontwarn okhttp3.**
--dontwarn retrofit2.**
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

sample-app/app/proguard-rules.pro

@@ -0,0 +1,24 @@
+package com.socure.docv.sdk.sample
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.ext.junit.runners.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+    @Test
+    fun useAppContext() {
+        // Context of the app under test.
+        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+        assertEquals("com.socure.docv.sdk.sample", appContext.packageName)
+    }
+}