[ITBL-5309] Add handleUniversalLink: method (#59)

vbabenkoru · web-flow · commit 8dbf1dbba82d · 2018-06-28T13:40:03.000-07:00
* Add resolveAppLinkURL:callback: method with a URL callback in addition to getAndTrackDeeplink

* Make sure we call getAndTrackDeeplink: and resolveApplinkURL: on the main queue

* Add tests for resolveApplinkURL: method, check that the callback is run on the main thread

* Replace resolveApplinkURL: with handleUniversalLink: that creates a new IterableAction and executes it with IterableActionRunner
Add IterableActionContext specifying the context the action is executing in (including the source – push or universal link)

* Fix warnings

* Fix a typo

* Fix another typo
diff --git a/Iterable-iOS-SDK.xcodeproj/project.pbxproj b/Iterable-iOS-SDK.xcodeproj/project.pbxproj
@@ -48,6 +48,7 @@
 		68E32EF61AC21D37000CEBE1 /* CommerceItem.h in Headers */ = {isa = PBXBuildFile; fileRef = 6804B8651AC10426000A126B /* CommerceItem.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		921AE47A20AA2E94009CFC9F /* IterableNotificationResponseTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 921AE47920AA2E94009CFC9F /* IterableNotificationResponseTests.m */; };
 		921AE47C20AA43D5009CFC9F /* IterableActionRunnerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 921AE47B20AA43D5009CFC9F /* IterableActionRunnerTests.m */; };
+		924E781D20E43C2F003CEC14 /* IterableActionContext.m in Sources */ = {isa = PBXBuildFile; fileRef = E95160EFC943628C8A6BC430 /* IterableActionContext.m */; };
 		9267AA1820992F9C006AF394 /* IterableAppExtensions.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 9267AA0F20992F9C006AF394 /* IterableAppExtensions.framework */; };
 		9267AA1D20992F9C006AF394 /* IterableAppExtensionsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 9267AA1C20992F9C006AF394 /* IterableAppExtensionsTests.m */; };
 		9267AA1F20992F9C006AF394 /* IterableAppExtensions.h in Headers */ = {isa = PBXBuildFile; fileRef = 9267AA1120992F9C006AF394 /* IterableAppExtensions.h */; settings = {ATTRIBUTES = (Public, ); }; };
@@ -76,6 +77,7 @@
 		AC60AB4B20BDDD5100BF6BEC /* IterableUtilTests.m in Sources */ = {isa = PBXBuildFile; fileRef = AC60AB4A20BDDD5100BF6BEC /* IterableUtilTests.m */; };
 		E95160B3683E5A47EC313472 /* IterableAppIntegration+Private.h in Headers */ = {isa = PBXBuildFile; fileRef = E9516F6B446F6E9AB537C83F /* IterableAppIntegration+Private.h */; };
 		E951624B2D970B91EE110E56 /* IterableAPI+Internal.h in Headers */ = {isa = PBXBuildFile; fileRef = E95162E0F83DDB6177F24360 /* IterableAPI+Internal.h */; };
+		E951656A49CFFB4BED48AF3B /* IterableActionContext.h in Headers */ = {isa = PBXBuildFile; fileRef = E9516F2F4291E19DC6625187 /* IterableActionContext.h */; };
 		E9516B4E1A6D7B8CB1314D1F /* IterableAPI+Deprecated.h in Headers */ = {isa = PBXBuildFile; fileRef = E9516BD2E9DDA6AE024F6A63 /* IterableAPI+Deprecated.h */; };
 		E9516D3401091CA4D87B10B9 /* IterableAPI+Deprecated.m in Sources */ = {isa = PBXBuildFile; fileRef = E9516D87A090ED58BED61C6B /* IterableAPI+Deprecated.m */; };
 /* End PBXBuildFile section */
@@ -190,10 +192,12 @@
 		AC60AB4A20BDDD5100BF6BEC /* IterableUtilTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = IterableUtilTests.m; sourceTree = "<group>"; };
 		BE5CCE23DD4BB53759B5D427 /* Pods-Iterable-iOS-SDK.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Iterable-iOS-SDK.debug.xcconfig"; path = "Pods/Target Support Files/Pods-Iterable-iOS-SDK/Pods-Iterable-iOS-SDK.debug.xcconfig"; sourceTree = "<group>"; };
 		DAB696718A4F07CC09FB5CB1 /* Pods-Iterable-iOS-SDKTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Iterable-iOS-SDKTests.release.xcconfig"; path = "Pods/Target Support Files/Pods-Iterable-iOS-SDKTests/Pods-Iterable-iOS-SDKTests.release.xcconfig"; sourceTree = "<group>"; };
+		E95160EFC943628C8A6BC430 /* IterableActionContext.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IterableActionContext.m; sourceTree = "<group>"; };
 		E95162E0F83DDB6177F24360 /* IterableAPI+Internal.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "IterableAPI+Internal.h"; sourceTree = "<group>"; };
 		E95162E4972E90805BB61534 /* .travis.yml */ = {isa = PBXFileReference; lastKnownFileType = file.yml; path = .travis.yml; sourceTree = "<group>"; };
 		E9516BD2E9DDA6AE024F6A63 /* IterableAPI+Deprecated.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "IterableAPI+Deprecated.h"; sourceTree = "<group>"; };
 		E9516D87A090ED58BED61C6B /* IterableAPI+Deprecated.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "IterableAPI+Deprecated.m"; sourceTree = "<group>"; };
+		E9516F2F4291E19DC6625187 /* IterableActionContext.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IterableActionContext.h; sourceTree = "<group>"; };
 		E9516F6B446F6E9AB537C83F /* IterableAppIntegration+Private.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "IterableAppIntegration+Private.h"; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
@@ -301,6 +305,8 @@
 				AC60AB4720BDD4DC00BF6BEC /* IterableUtil.m */,
 				92F03EEA20D899CE00C3BFCA /* IterableConfig.h */,
 				92F03EEB20D899CE00C3BFCA /* IterableConfig.m */,
+				E95160EFC943628C8A6BC430 /* IterableActionContext.m */,
+				E9516F2F4291E19DC6625187 /* IterableActionContext.h */,
 			);
 			path = "Iterable-iOS-SDK";
 			sourceTree = "<group>";
@@ -431,6 +437,7 @@
 				AC60AB4820BDD4DC00BF6BEC /* IterableUtil.h in Headers */,
 				E9516B4E1A6D7B8CB1314D1F /* IterableAPI+Deprecated.h in Headers */,
 				E951624B2D970B91EE110E56 /* IterableAPI+Internal.h in Headers */,
+				E951656A49CFFB4BED48AF3B /* IterableActionContext.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -719,6 +726,7 @@
 				0995DBDD1CFFF7FE00D50F19 /* IterableLogging.m in Sources */,
 				926B33E520B7A091004DD7CE /* IterableAttributionInfo.m in Sources */,
 				E9516D3401091CA4D87B10B9 /* IterableAPI+Deprecated.m in Sources */,
+				924E781D20E43C2F003CEC14 /* IterableActionContext.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
diff --git a/Iterable-iOS-SDK/IterableAPI.h b/Iterable-iOS-SDK/IterableAPI.h
@@ -513,7 +513,18 @@ typedef void (^OnFailureHandler)(NSString *reason, NSData *_Nullable data);
  
  @discussion            passes the string of the redirected URL to the callback, returns the original webpageURL if not an iterable link
  */
-+(void) getAndTrackDeeplink:(NSURL *)webpageURL callbackBlock:(ITEActionBlock)callbackBlock;
++ (void)getAndTrackDeeplink:(NSURL *)webpageURL callbackBlock:(ITEActionBlock)callbackBlock;
+
+/**
+ * Handles a Universal Link
+ * For Iterable links, it will track the click and retrieve the original URL,
+ * pass it to `IterableURLDelegate` for handling
+ * If it's not an Iterable link, it just passes the same URL to `IterableURLDelegate`
+ *
+ * @param url  the URL obtained from `[NSUserActivity webpageURL]`
+ * @return YES if it is an Iterable link, or the value returned from `IterableURLDelegate` otherwise
+ */
++ (BOOL)handleUniversalLink:(NSURL *)url;
 
 @end
 
diff --git a/Iterable-iOS-SDK/IterableAPI.m b/Iterable-iOS-SDK/IterableAPI.m
@@ -29,6 +29,7 @@
 #import "IterableConstants.h"
 #import "IterableDeeplinkManager.h"
 #import "IterableAppIntegration+Private.h"
+#import "IterableActionRunner.h"
 
 @interface IterableAPI ()
 
@@ -457,12 +458,27 @@ + (IterableAPI *)sharedInstanceWithApiKey:(NSString *)apiKey andUserId:(NSString
 }
 
 // documented in IterableAPI.h
-+(void) getAndTrackDeeplink:(NSURL *)webpageURL callbackBlock:(ITEActionBlock)callbackBlock
++ (void)getAndTrackDeeplink:(NSURL *)webpageURL callbackBlock:(ITEActionBlock)callbackBlock
 {
     IterableDeeplinkManager *deeplinkManager = [IterableDeeplinkManager instance];
     [deeplinkManager getAndTrackDeeplink:webpageURL callbackBlock:callbackBlock];
 }
 
+// documented in IterableAPI.h
++ (BOOL)handleUniversalLink:(NSURL *)url {
+    IterableDeeplinkManager *deeplinkManager = [IterableDeeplinkManager instance];
+    if ([deeplinkManager isIterableDeeplink:url]) {
+        [deeplinkManager getAndTrackDeeplink:url callbackBlock:^(NSString *originalUrlString) {
+            IterableAction *action = [IterableAction actionOpenUrl:originalUrlString];
+            [IterableActionRunner executeAction:action from:IterableActionSourceUniversalLink];
+        }];
+        return YES;
+    } else {
+        IterableAction *action = [IterableAction actionOpenUrl:url.absoluteString];
+        return [IterableActionRunner executeAction:action from:IterableActionSourceUniversalLink];
+    }
+}
+
 // documented in IterableAPI.h
 - (instancetype)initWithApiKey:(NSString *)apiKey andEmail:(NSString *)email
 {
diff --git a/Iterable-iOS-SDK/IterableAction.h b/Iterable-iOS-SDK/IterableAction.h
@@ -56,6 +56,14 @@ extern NSString *const IterableActionTypeOpenUrl;
  */
 + (instancetype)actionFromDictionary:(NSDictionary *)dictionary;
 
+/**
+ * Creates a new `IterableAction` with type `IterableActionTypeOpenUrl`
+ * and the specified URL
+ * @param url URL to open
+ * @return `IterableAction` instance
+ */
++ (instancetype)actionOpenUrl:(NSString *)url;
+
 ////////////////////
 /// @name Methods
 ////////////////////
diff --git a/Iterable-iOS-SDK/IterableAction.m b/Iterable-iOS-SDK/IterableAction.m
@@ -19,10 +19,19 @@ @interface IterableAction ()
 @implementation IterableAction
 
 + (instancetype)actionFromDictionary:(NSDictionary *)dictionary {
-    if (dictionary != nil)
+    if (dictionary != nil) {
         return [[self alloc] initWithDictionary:dictionary];
-    else
+    } else {
         return nil;
+    }
+}
+
++ (instancetype)actionOpenUrl:(NSString *)url {
+    if (url != nil) {
+        return [self actionFromDictionary:@{@"type": IterableActionTypeOpenUrl, @"data": url}];
+    } else {
+        return nil;
+    }
 }
 
 - (instancetype)initWithDictionary:(NSDictionary *)dictionary {
diff --git a/Iterable-iOS-SDK/IterableActionContext.h b/Iterable-iOS-SDK/IterableActionContext.h
@@ -0,0 +1,44 @@
+//
+// Created by Victor Babenko on 6/27/18.
+// Copyright (c) 2018 Iterable. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "IterableAction.h"
+
+/**
+ * Enum representing the source of the action: push notification, universal link, etc.
+ */
+typedef NS_ENUM(NSInteger, IterableActionSource) {
+    /** Push Notification */
+    IterableActionSourcePush,
+
+    /** Universal Link */
+    IterableActionSourceUniversalLink
+};
+
+/**
+ * An object representing the action to execute and the context it is executing in
+ *
+ */
+@interface IterableActionContext : NSObject
+
+/**
+ * Action to execute
+ */
+@property (nonatomic, readonly) IterableAction *action;
+
+/**
+ * Source of the action: push notification, universal link, etc.
+ */
+@property (nonatomic, readonly) IterableActionSource source;
+
+/**
+ * Create an `IterableActionContext` object with the given action and source
+ * @param action Action to execute
+ * @param source Source of the action
+ * @return `IterableActionContext` instance
+ */
++ (instancetype)contextWithAction:(IterableAction *)action source:(IterableActionSource)source;
+
+@end
diff --git a/Iterable-iOS-SDK/IterableActionContext.m b/Iterable-iOS-SDK/IterableActionContext.m
@@ -0,0 +1,24 @@
+//
+// Created by Victor Babenko on 6/27/18.
+// Copyright (c) 2018 Iterable. All rights reserved.
+//
+
+#import "IterableActionContext.h"
+
+
+@implementation IterableActionContext
+
+- (instancetype)initWithAction:(IterableAction *)action source:(IterableActionSource)source {
+    self = [super init];
+    if (self) {
+        _action = action;
+        _source = source;
+    }
+    return self;
+}
+
++ (instancetype)contextWithAction:(IterableAction *)action source:(IterableActionSource)source {
+    return [[IterableActionContext alloc] initWithAction:action source:source];
+}
+
+@end
diff --git a/Iterable-iOS-SDK/IterableActionRunner.h b/Iterable-iOS-SDK/IterableActionRunner.h
@@ -8,9 +8,10 @@
 
 #import <Foundation/Foundation.h>
 #import "IterableAction.h"
+#import "IterableActionContext.h"
 
 @interface IterableActionRunner : NSObject
 
-+ (void)executeAction:(IterableAction *)action;
++ (BOOL)executeAction:(IterableAction *)action from:(IterableActionSource)source;
 
 @end
diff --git a/Iterable-iOS-SDK/IterableActionRunner.m b/Iterable-iOS-SDK/IterableActionRunner.m
@@ -10,56 +10,63 @@
 #import "IterableAPI.h"
 #import "IterableAPI+Internal.h"
 #import "IterableLogging.h"
+#import "IterableActionContext.h"
 
 @implementation IterableActionRunner
 
-+ (void)executeAction:(IterableAction *)action {
++ (BOOL)executeAction:(IterableAction *)action from:(IterableActionSource)source {
     // Do not handle actions and try to open Safari for URLs unless the SDK is initialized with a new init method
     if ([IterableAPI sharedInstance].sdkCompatEnabled) {
-        return;
+        return NO;
     }
 
+    IterableActionContext *context = [IterableActionContext contextWithAction:action source:source];
+
     if ([action isOfType:IterableActionTypeOpenUrl]) {
         // Open deeplink, use delegate handler
-        [self openURL:[NSURL URLWithString:action.data] action:action];
+        return [self openURL:[NSURL URLWithString:action.data] context:context];
     }
     else {
         // Call a custom action if available
-        [self callCustomActionIfSpecified:action];
+        return [self callCustomActionIfSpecified:action context:context];
     }
 }
 
-+ (void)openURL:(NSURL *)url action:(IterableAction *)action {
++ (BOOL)openURL:(NSURL *)url context:(IterableActionContext *)context {
     if (url == nil) {
-        return;
+        return NO;
     }
     
-    if ([[IterableAPI sharedInstance].config.urlDelegate handleIterableURL:url fromAction:action]) {
-        return;
+    if ([[IterableAPI sharedInstance].config.urlDelegate handleIterableURL:url context:context]) {
+        return YES;
     }
 
-    // Open http/https links in the browser
-    NSString *scheme = url.scheme;
-    if ([scheme isEqualToString:@"http"] || [scheme isEqualToString:@"https"]) {
-        if (@available(iOS 10.0, *)) {
-            [[UIApplication sharedApplication] openURL:url
-                                               options:@{}
-                                               completionHandler:^(BOOL success) {
-                                                   if (!success) {
-                                                       LogError(@"Could not open the URL: %@", url.absoluteString);
-                                                   }
-                                               }];
-        }
-        else {
-            [[UIApplication sharedApplication] openURL:url];
+    if (context.source == IterableActionSourcePush) {
+        // Open http/https links in the browser
+        NSString *scheme = url.scheme;
+        if ([scheme isEqualToString:@"http"] || [scheme isEqualToString:@"https"]) {
+            if (@available(iOS 10.0, *)) {
+                [[UIApplication sharedApplication] openURL:url
+                                                   options:@{}
+                                         completionHandler:^(BOOL success) {
+                                             if (!success) {
+                                                 LogError(@"Could not open the URL: %@", url.absoluteString);
+                                             }
+                                         }];
+            } else {
+                [[UIApplication sharedApplication] openURL:url];
+            }
+            return YES;
         }
     }
+    return NO;
 }
 
-+ (void)callCustomActionIfSpecified:(IterableAction *)action {
++ (BOOL)callCustomActionIfSpecified:(IterableAction *)action context:(IterableActionContext *)context {
     if (action.type.length > 0) {
-        [[IterableAPI sharedInstance].config.customActionDelegate handleIterableCustomAction:action];
+        return [[IterableAPI sharedInstance].config.customActionDelegate handleIterableCustomAction:action context:context];
     }
+    return NO;
 }
 
 @end
diff --git a/Iterable-iOS-SDK/IterableAppIntegration.m b/Iterable-iOS-SDK/IterableAppIntegration.m
@@ -64,7 +64,7 @@ + (void)performDefaultNotificationAction:(NSDictionary *)userInfo api:(IterableA
     [api trackPushOpen:userInfo dataFields:dataFields];
 
     //Execute the action
-    [IterableActionRunner executeAction:action];
+    [IterableActionRunner executeAction:action from:IterableActionSourcePush];
 }
 
 + (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler
@@ -122,7 +122,7 @@ + (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNoti
     }
     
     //Execute the action
-    [IterableActionRunner executeAction:action];
+    [IterableActionRunner executeAction:action from:IterableActionSourcePush];
     
     if (completionHandler) {
         completionHandler();
@@ -131,7 +131,7 @@ + (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNoti
 
 + (IterableAction *)legacyDefaultActionFromPayload:(NSDictionary *)userInfo {
     if (userInfo[ITBL_PAYLOAD_DEEP_LINK_URL] != nil) {
-        return [IterableAction actionFromDictionary:@{@"type": IterableActionTypeOpenUrl, @"data": userInfo[ITBL_PAYLOAD_DEEP_LINK_URL]}];
+        return [IterableAction actionOpenUrl:userInfo[ITBL_PAYLOAD_DEEP_LINK_URL]];
     } else {
         return nil;
     }
diff --git a/Iterable-iOS-SDK/IterableConfig.h b/Iterable-iOS-SDK/IterableConfig.h
@@ -7,8 +7,8 @@
 //
 
 #import <Foundation/Foundation.h>
-
-@class IterableAction;
+#include "IterableAction.h"
+#include "IterableActionContext.h"
 
 /**
  * Custom URL handling delegate
@@ -18,10 +18,10 @@
 /**
  * Callback called for a deeplink action. Return YES to override default behavior
  * @param url     Deeplink URL
- * @param action  Original openUrl Action object
+ * @param context  Metadata containing the original action and the source: push or universal link
  * @return Boolean value. Return YES if the URL was handled to override default behavior.
  */
-- (BOOL)handleIterableURL:(NSURL *)url fromAction:(IterableAction *)action;
+- (BOOL)handleIterableURL:(NSURL *)url context:(IterableActionContext *)context;
 
 @end
 
@@ -35,7 +35,7 @@
  * @param action  `IterableAction` object containing action payload
  * @return Boolean value. Reserved for future use.
  */
-- (BOOL)handleIterableCustomAction:(IterableAction *)action;
+- (BOOL)handleIterableCustomAction:(IterableAction *)action context:(IterableActionContext *)context;
 
 @end
 
diff --git a/Iterable-iOS-SDK/IterableConfig.m b/Iterable-iOS-SDK/IterableConfig.m
@@ -7,7 +7,6 @@
 //
 
 #import "IterableConfig.h"
-#import "IterableAction.h"
 
 @implementation IterableConfig
 
diff --git a/Iterable-iOS-SDK/IterableConstants.h b/Iterable-iOS-SDK/IterableConstants.h
@@ -141,3 +141,4 @@ extern NSString *const ITBL_DEVICE_USER_INTERFACE;
 #define ITERABLE_IN_APP_DISPLAY_SETTINGS @"inAppDisplaySettings"
 
 typedef void (^ITEActionBlock)(NSString *);
+typedef void (^ITBURLCallback)(NSURL *);
diff --git a/Iterable-iOS-SDK/IterableDeeplinkManager.h b/Iterable-iOS-SDK/IterableDeeplinkManager.h
diff --git a/Iterable-iOS-SDK/IterableDeeplinkManager.m b/Iterable-iOS-SDK/IterableDeeplinkManager.m
diff --git a/Iterable-iOS-SDKTests/IterableAPIResponseTests.m b/Iterable-iOS-SDKTests/IterableAPIResponseTests.m
diff --git a/Iterable-iOS-SDKTests/IterableAPITests.m b/Iterable-iOS-SDKTests/IterableAPITests.m
diff --git a/Iterable-iOS-SDKTests/IterableActionRunnerTests.m b/Iterable-iOS-SDKTests/IterableActionRunnerTests.m
diff --git a/Iterable-iOS-SDKTests/IterableNotificationResponseTests.m b/Iterable-iOS-SDKTests/IterableNotificationResponseTests.m
