Merge pull request #1 from getyoti/ED-553

eduardoyoti · web-flow · commit 0acc4a0e6e64 · 2018-07-25T11:16:55.000+01:00
[TASK] [ED-553] Adding YotiCalled callback
diff --git a/README.md b/README.md
@@ -179,6 +179,19 @@ yotiSDKButton.setOnYotiButtonListener(new YotiSDKButton.OnYotiButtonClickListene
     });
 ```
 
+There is also a listener that you can set to be notified when the intent has been sent to the Yoti app.
+When this happens you would probably want to restore your state.
+
+
+```java
+        yotiSDKButton.setOnYotiCalledListener(new YotiSDKButton.OnYotiCalledListener() {
+            @Override
+            public void onYotiCalled() {
+                // Restore the original state
+            }
+        }); 
+```
+[See this code in one of our sample apps](./sample-app/src/main/java/com/yoti/mobile/android/sdk/sampleapp/MainActivity.java)
 
 You can activate a verbose mode for the SDK by using this method :
 ```java
diff --git a/build.gradle b/build.gradle
@@ -33,6 +33,6 @@ allprojects {
 
         // Testing
         libJunit = "junit:junit:${libJunitVersion}"
-        libMockito = "org.mockito:mockito-all:${libMockitoVersion}"
+        libMockito = "org.mockito:mockito-core:${libMockitoVersion}"
     }
 }
diff --git a/sample-app/src/main/java/com/yoti/mobile/android/sdk/sampleapp/MainActivity.java b/sample-app/src/main/java/com/yoti/mobile/android/sdk/sampleapp/MainActivity.java
@@ -47,6 +47,15 @@ public void onYotiAppNotInstalledError(YotiSDKNoYotiAppException cause) {
             }
         });
 
+        yotiSDKButton.setOnYotiCalledListener(new YotiSDKButton.OnYotiCalledListener() {
+            @Override
+            public void onYotiCalled() {
+                // Restore the original state
+                yotiSDKButton.setVisibility(View.VISIBLE);
+                progress.setVisibility(View.GONE);
+            }
+        });
+
         if (getIntent().hasExtra(ShareAttributesResultBroadcastReceiver.EXTRA_CANCELLED_BY_USER)) {
             yotiSDKButton.setVisibility(View.VISIBLE);
             progress.setVisibility(View.GONE);
diff --git a/yoti-sdk/src/main/java/com/yoti/mobile/android/sdk/YotiSDK.java b/yoti-sdk/src/main/java/com/yoti/mobile/android/sdk/YotiSDK.java
@@ -3,6 +3,7 @@
 import android.content.Context;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
+import android.os.ResultReceiver;
 import android.support.annotation.Nullable;
 
 import com.yoti.mobile.android.sdk.exceptions.YotiSDKException;
@@ -92,7 +93,9 @@ public static Scenario getScenario(String useCaseId) {
      * @throws YotiSDKException
      */
     /*package*/
-    static void startScenario(final Context context, final String useCaseId, final boolean handleNoYotiAppError) throws YotiSDKException {
+    static void startScenario(final Context context, final String useCaseId,
+                              final boolean handleNoYotiAppError,
+                              final ResultReceiver onYotiCalledResultReceiver) throws YotiSDKException {
 
         YotiSDKLogger.debug("Starting scenario " + useCaseId);
 
@@ -127,7 +130,7 @@ static void startScenario(final Context context, final String useCaseId, final b
         }
 
         YotiSDKLogger.debug("Started scenario " + useCaseId);
-        KernelSDKIntentService.startActionStartScenario(context, useCaseId);
+        KernelSDKIntentService.startActionStartScenario(context, useCaseId, onYotiCalledResultReceiver);
     }
 
     /**
diff --git a/yoti-sdk/src/main/java/com/yoti/mobile/android/sdk/YotiSDKButton.java b/yoti-sdk/src/main/java/com/yoti/mobile/android/sdk/YotiSDKButton.java
@@ -2,6 +2,10 @@
 
 import android.content.Context;
 import android.content.res.TypedArray;
+import android.os.Bundle;
+import android.os.Handler;
+import android.os.ResultReceiver;
+import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
 import android.support.v7.widget.AppCompatButton;
 import android.util.AttributeSet;
@@ -19,6 +23,17 @@ public class YotiSDKButton extends YotiButton implements View.OnClickListener {
     private String mUseCaseId;
     private OnYotiButtonClickListener mOnYotiButtonClickListener;
     private OnYotiAppNotInstalledListener mOnYotiAppNotInstalledListener;
+    private OnYotiCalledListener mOnYotiCalledListener;
+
+    private ResultReceiver mYotiCallResultReceiver = new ResultReceiver(new Handler()) {
+        @Override
+        protected void onReceiveResult(int resultCode, Bundle resultData) {
+            super.onReceiveResult(resultCode, resultData);
+            if (mOnYotiCalledListener != null) {
+                mOnYotiCalledListener.onYotiCalled();
+            }
+        }
+    };
 
     public YotiSDKButton(Context context) {
         super(context);
@@ -72,6 +87,10 @@ public void setOnYotiAppNotInstalledListener(@Nullable OnYotiAppNotInstalledList
         mOnYotiAppNotInstalledListener = listener;
     }
 
+    public void setOnYotiCalledListener(@Nullable OnYotiCalledListener listener) {
+        mOnYotiCalledListener = listener;
+    }
+
     @Override
     public void onClick(View v) {
 
@@ -80,7 +99,7 @@ public void onClick(View v) {
         }
 
         try {
-            YotiSDK.startScenario(getContext(), mUseCaseId, mOnYotiAppNotInstalledListener == null);
+            YotiSDK.startScenario(getContext(), mUseCaseId, mOnYotiAppNotInstalledListener == null, mYotiCallResultReceiver);
         } catch (YotiSDKException cause) {
 
             YotiSDKLogger.error(cause.getMessage(), cause);
@@ -104,4 +123,8 @@ public interface OnYotiButtonClickListener {
     public interface OnYotiAppNotInstalledListener {
         void onYotiAppNotInstalledError(YotiSDKNoYotiAppException cause);
     }
+
+    public interface OnYotiCalledListener {
+        void onYotiCalled();
+    }
 }
diff --git a/yoti-sdk/src/main/java/com/yoti/mobile/android/sdk/kernelSDK/KernelSDKIntentService.java b/yoti-sdk/src/main/java/com/yoti/mobile/android/sdk/kernelSDK/KernelSDKIntentService.java
@@ -5,6 +5,7 @@
 import android.content.Intent;
 import android.content.pm.ApplicationInfo;
 import android.net.Uri;
+import android.os.ResultReceiver;
 import android.text.TextUtils;
 
 import com.yoti.mobile.android.sdk.YotiSDK;
@@ -35,6 +36,7 @@ public class KernelSDKIntentService extends IntentService {
 
     private static final String ACTION_BACKEND_CALL = "com.yoti.mobile.android.sdk.network.action.BACKEND_CALL";
     private static final String ACTION_START_SCENARIO = "com.yoti.mobile.android.sdk.network.action.START_SCENARIO";
+    private static final String YOTI_CALLED_RESULT_RECEIVER = "com.yoti.mobile.android.sdk.network.action.YOTI_CALLED_RESULT_RECEIVER";
 
     private static final String EXTRA_USE_CASE_ID = "com.yoti.mobile.android.sdk.network.extra.USE_CASE_ID";
     private KernelSDK mKernelSDK;
@@ -67,10 +69,11 @@ public static void startActionBackendCall(Context context, String useCaseId) {
      *
      * @see IntentService
      */
-    public static void startActionStartScenario(Context context, String useCaseId) {
+    public static void startActionStartScenario(Context context, String useCaseId, ResultReceiver resultReceiver) {
         Intent intent = new Intent(context, KernelSDKIntentService.class);
         intent.setAction(ACTION_START_SCENARIO);
         intent.putExtra(EXTRA_USE_CASE_ID, useCaseId);
+        intent.putExtra(YOTI_CALLED_RESULT_RECEIVER, resultReceiver);
         context.startService(intent);
     }
 
@@ -82,12 +85,13 @@ protected void onHandleIntent(Intent intent) {
             if (ACTION_BACKEND_CALL.equals(action)) {
                 handleActionBackendCall(useCaseId);
             } else if (ACTION_START_SCENARIO.equals(action)) {
-                handleActionStartScenario(useCaseId);
+                ResultReceiver resultReceiver = intent.getParcelableExtra(YOTI_CALLED_RESULT_RECEIVER);
+                handleActionStartScenario(useCaseId, resultReceiver);
             }
         }
     }
 
-    private void handleActionStartScenario(String useCaseId) {
+    private void handleActionStartScenario(String useCaseId, ResultReceiver resultReceiver) {
 
         Scenario currentScenario = YotiSDK.getScenario(useCaseId);
 
@@ -123,6 +127,8 @@ private void handleActionStartScenario(String useCaseId) {
                 .appendQueryParameter(APP_NAME_PARAM, appName)
                 .build();
 
+        resultReceiver.send(0, null);
+
         Intent intent = new Intent(Intent.ACTION_VIEW, uri);
         intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
         startActivity(intent);
diff --git a/yoti-sdk/src/test/java/com/yoti/mobile/android/sdk/YotiSDKTest.java b/yoti-sdk/src/test/java/com/yoti/mobile/android/sdk/YotiSDKTest.java
@@ -59,7 +59,7 @@ public void testStartScenario_withNotInitiatedSDK() throws Throwable {
         exception.expect(YotiSDKException.class);
         exception.expectMessage("SDK not initialised");
 
-        YotiSDK.startScenario(mMockContext, "a_scenario", true);
+        YotiSDK.startScenario(mMockContext, "a_scenario", true, null);
     }
 
     @Test
@@ -76,7 +76,7 @@ public void testStartScenario_withNotScenariosSDK() throws Throwable {
                 .create();
 
         YotiSDK.addScenario(scenario);
-        YotiSDK.startScenario(mMockContext, "a_scenario", true);
+        YotiSDK.startScenario(mMockContext, "a_scenario", true, null);
     }
 
     @Test
@@ -93,7 +93,7 @@ public void testStartScenario_withWrongScenario() throws Throwable {
                 .create();
 
         YotiSDK.addScenario(scenario);
-        YotiSDK.startScenario(mMockContext, "a_scenario", true);
+        YotiSDK.startScenario(mMockContext, "a_scenario", true, null);
     }
 
     @Test
@@ -106,7 +106,7 @@ public void testStartScenario_withNotValidScenario() throws Throwable {
                 .create();
 
         YotiSDK.addScenario(scenario);
-        YotiSDK.startScenario(mMockContext, "b_scenario", true);
+        YotiSDK.startScenario(mMockContext, "b_scenario", true, null);
     }
 
     @Test
@@ -126,7 +126,7 @@ public void testStartScenario_withWrongYotiAppVersion() throws Throwable {
 
 
         YotiSDK.addScenario(scenario);
-        YotiSDK.startScenario(mMockContext, "a_scenario", true);
+        YotiSDK.startScenario(mMockContext, "a_scenario", true, null);
     }
 
     @Test
@@ -148,7 +148,7 @@ public void testStartScenario_withNoYotiApp() throws Throwable {
 
 
         YotiSDK.addScenario(scenario);
-        YotiSDK.startScenario(mMockContext, "a_scenario", false);
+        YotiSDK.startScenario(mMockContext, "a_scenario", false, null);
     }
 
     @Test
@@ -168,7 +168,7 @@ public void testStartScenario_whenHandlingNoYotiApp() throws Throwable {
 
 
         YotiSDK.addScenario(scenario);
-        YotiSDK.startScenario(mMockContext, "a_scenario", true);
+        YotiSDK.startScenario(mMockContext, "a_scenario", true, null);
     }
 
     @Test
@@ -190,6 +190,6 @@ public void testStartScenario_withoutHandlingNoYotiApp() throws Throwable {
 
 
         YotiSDK.addScenario(scenario);
-        YotiSDK.startScenario(mMockContext, "a_scenario", false);
+        YotiSDK.startScenario(mMockContext, "a_scenario", false, null);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,6 @@ allprojects {`
`33`	`33`
`34`	`34`	`// Testing`
`35`	`35`	`libJunit = "junit:junit:${libJunitVersion}"`
`36`		`- libMockito = "org.mockito:mockito-all:${libMockitoVersion}"`
	`36`	`+ libMockito = "org.mockito:mockito-core:${libMockitoVersion}"`
`37`	`37`	`}`
`38`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public void testStartScenario_withNotInitiatedSDK() throws Throwable {`
`59`	`59`	`exception.expect(YotiSDKException.class);`
`60`	`60`	`exception.expectMessage("SDK not initialised");`
`61`	`61`
`62`		`- YotiSDK.startScenario(mMockContext, "a_scenario", true);`
	`62`	`+ YotiSDK.startScenario(mMockContext, "a_scenario", true, null);`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`@Test`
`@@ -76,7 +76,7 @@ public void testStartScenario_withNotScenariosSDK() throws Throwable {`
`76`	`76`	`.create();`
`77`	`77`
`78`	`78`	`YotiSDK.addScenario(scenario);`
`79`		`- YotiSDK.startScenario(mMockContext, "a_scenario", true);`
	`79`	`+ YotiSDK.startScenario(mMockContext, "a_scenario", true, null);`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`@Test`
`@@ -93,7 +93,7 @@ public void testStartScenario_withWrongScenario() throws Throwable {`
`93`	`93`	`.create();`
`94`	`94`
`95`	`95`	`YotiSDK.addScenario(scenario);`
`96`		`- YotiSDK.startScenario(mMockContext, "a_scenario", true);`
	`96`	`+ YotiSDK.startScenario(mMockContext, "a_scenario", true, null);`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`@Test`
`@@ -106,7 +106,7 @@ public void testStartScenario_withNotValidScenario() throws Throwable {`
`106`	`106`	`.create();`
`107`	`107`
`108`	`108`	`YotiSDK.addScenario(scenario);`
`109`		`- YotiSDK.startScenario(mMockContext, "b_scenario", true);`
	`109`	`+ YotiSDK.startScenario(mMockContext, "b_scenario", true, null);`
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`@Test`
`@@ -126,7 +126,7 @@ public void testStartScenario_withWrongYotiAppVersion() throws Throwable {`
`126`	`126`
`127`	`127`
`128`	`128`	`YotiSDK.addScenario(scenario);`
`129`		`- YotiSDK.startScenario(mMockContext, "a_scenario", true);`
	`129`	`+ YotiSDK.startScenario(mMockContext, "a_scenario", true, null);`
`130`	`130`	`}`
`131`	`131`
`132`	`132`	`@Test`
`@@ -148,7 +148,7 @@ public void testStartScenario_withNoYotiApp() throws Throwable {`
`148`	`148`
`149`	`149`
`150`	`150`	`YotiSDK.addScenario(scenario);`
`151`		`- YotiSDK.startScenario(mMockContext, "a_scenario", false);`
	`151`	`+ YotiSDK.startScenario(mMockContext, "a_scenario", false, null);`
`152`	`152`	`}`
`153`	`153`
`154`	`154`	`@Test`
`@@ -168,7 +168,7 @@ public void testStartScenario_whenHandlingNoYotiApp() throws Throwable {`
`168`	`168`
`169`	`169`
`170`	`170`	`YotiSDK.addScenario(scenario);`
`171`		`- YotiSDK.startScenario(mMockContext, "a_scenario", true);`
	`171`	`+ YotiSDK.startScenario(mMockContext, "a_scenario", true, null);`
`172`	`172`	`}`
`173`	`173`
`174`	`174`	`@Test`
`@@ -190,6 +190,6 @@ public void testStartScenario_withoutHandlingNoYotiApp() throws Throwable {`
`190`	`190`
`191`	`191`
`192`	`192`	`YotiSDK.addScenario(scenario);`
`193`		`- YotiSDK.startScenario(mMockContext, "a_scenario", false);`
	`193`	`+ YotiSDK.startScenario(mMockContext, "a_scenario", false, null);`
`194`	`194`	`}`
`195`	`195`	`}`