Feature/itbl 1883 deeplink track redirect (#31)

* Tracks and returns an iterable redirected URL

* Adds format check for /a/ in the url before trying to call the url to track a click on deeplinked links.

* Updated getAndTrackDeeplink to pass back original url if it isn't an app link.
Added unit tests for getAndTrackDeeplink.

* Updating deeplink link check with a more robust regex.

Author: davidtruong

Iterable-iOS-SDK/IterableAPI.h

@@ -514,6 +514,16 @@ typedef NS_ENUM(NSInteger, PushServicePlatform) {
  */
 -(void) showSystemNotification:(NSString *)title body:(NSString *)body buttonLeft:(NSString *)buttonLeft buttonRight:(NSString *)buttonRight callbackBlock:(ITEActionBlock)callbackBlock;
 
+/*!
+ @method
+ 
+ @abstract tracks a link click and passes the redirected URL to the callback
+ 
+ @param webpageURL      the URL that was clicked
+ @param callbackBlock   the callback to send after the webpageURL is called
+ 
+ @discussion            passes the string of the redirected URL to the callback
+ */+(void) getAndTrackDeeplink:(NSURL *)webpageURL callbackBlock:(ITEActionBlock)callbackBlock;
 
 @end
 

Iterable-iOS-SDK/IterableAPI.m

@@ -345,6 +345,55 @@ - (instancetype)createSession:(NSDictionary *)launchOptions useCustomLaunchOptio
 /// @name Implementations of things documents in IterableAPI.h
 //////////////////////////////////////////////////////////////
 
+// documented in IterableAPI.h
++ (IterableAPI *)sharedInstance
+{
+    if (sharedInstance == nil) {
+        LogError(@"[sharedInstance called before sharedInstanceWithApiKey");
+    }
+    return sharedInstance;
+}
+
+// documented in IterableAPI.h
++ (IterableAPI *)sharedInstanceWithApiKey:(NSString *)apiKey andEmail:(NSString *)email launchOptions:(NSDictionary *)launchOptions
+{
+    // threadsafe way to create a static singleton https://stackoverflow.com/questions/5720029/create-singleton-using-gcds-dispatch-once-in-objective-c
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        sharedInstance = [[IterableAPI alloc] initWithApiKey:apiKey andEmail:email launchOptions:launchOptions];
+    });
+    return sharedInstance;
+}
+
+// documented in IterableAPI.h
++ (IterableAPI *)sharedInstanceWithApiKey:(NSString *)apiKey andUserId:(NSString *)userId launchOptions:(NSDictionary *)launchOptions
+{
+    // threadsafe way to create a static singleton https://stackoverflow.com/questions/5720029/create-singleton-using-gcds-dispatch-once-in-objective-c
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        sharedInstance = [[IterableAPI alloc] initWithApiKey:apiKey andUserId:userId launchOptions:launchOptions];
+    });
+    return sharedInstance;
+}
+
+// documented in IterableAPI.h
++(void) getAndTrackDeeplink:(NSURL *)webpageURL callbackBlock:(ITEActionBlock)callbackBlock
+{
+    NSRegularExpression *regex = [NSRegularExpression regularExpressionWithPattern:ITBL_DEEPLINK_IDENTIFIER options:0 error:NULL];
+    NSString *urlString = webpageURL.absoluteString;
+    NSTextCheckingResult *match = [regex firstMatchInString:urlString options:0 range:NSMakeRange(0, [urlString length])];
+    
+    if (match == NULL) {
+        callbackBlock(webpageURL.absoluteString);
+    } else {
+        NSURLSessionDataTask *trackAndRedirectTask = [[NSURLSession sharedSession]
+                                                      dataTaskWithURL:webpageURL completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
+                                                          callbackBlock(response.URL.absoluteString);
+                                                      }];
+        [trackAndRedirectTask resume];
+    }
+}
+
 // documented in IterableAPI.h
 - (instancetype)initWithApiKey:(NSString *)apiKey andEmail:(NSString *)email
 {
@@ -437,41 +486,6 @@ - (void)trackInAppClick:(NSNumber*)campaignId templateId:(NSNumber*)templateId m
     [self sendRequest:request onSuccess:[IterableAPI defaultOnSuccess:@"trackInAppClick"] onFailure:[IterableAPI defaultOnFailure:@"trackInAppClick"]];
 }
 
-//////////////////////////////////////////////////////////////
-/// @name Implementations of things documents in IterableAPI.h
-//////////////////////////////////////////////////////////////
-
-// documented in IterableAPI.h
-+ (IterableAPI *)sharedInstance
-{
-    if (sharedInstance == nil) {
-        LogError(@"[sharedInstance called before sharedInstanceWithApiKey");
-    }
-    return sharedInstance;
-}
-
-// documented in IterableAPI.h
-+ (IterableAPI *)sharedInstanceWithApiKey:(NSString *)apiKey andEmail:(NSString *)email launchOptions:(NSDictionary *)launchOptions
-{
-    // threadsafe way to create a static singleton https://stackoverflow.com/questions/5720029/create-singleton-using-gcds-dispatch-once-in-objective-c
-    static dispatch_once_t onceToken;
-    dispatch_once(&onceToken, ^{
-        sharedInstance = [[IterableAPI alloc] initWithApiKey:apiKey andEmail:email launchOptions:launchOptions];
-    });
-    return sharedInstance;
-}
-
-// documented in IterableAPI.h
-+ (IterableAPI *)sharedInstanceWithApiKey:(NSString *)apiKey andUserId:(NSString *)userId launchOptions:(NSDictionary *)launchOptions
-{
-    // threadsafe way to create a static singleton https://stackoverflow.com/questions/5720029/create-singleton-using-gcds-dispatch-once-in-objective-c
-    static dispatch_once_t onceToken;
-    dispatch_once(&onceToken, ^{
-        sharedInstance = [[IterableAPI alloc] initWithApiKey:apiKey andUserId:userId launchOptions:launchOptions];
-    });
-    return sharedInstance;
-}
-
 // documented in IterableAPI.h
 - (void)registerToken:(NSData *)token appName:(NSString *)appName pushServicePlatform:(PushServicePlatform)pushServicePlatform
 {
@@ -807,11 +821,13 @@ - (void)getInAppMessages:(NSNumber *)count onSuccess:(OnSuccessHandler)onSuccess
     [self sendRequest:request onSuccess:onSuccess onFailure:onFailure];
 }
 
+// documented in IterableAPI.h
 -(void) showSystemNotification:(NSString *)title body:(NSString *)body button:(NSString *)button callbackBlock:(ITEActionBlock)callbackBlock
 {
     [IterableInAppManager showSystemNotification:title body:body buttonLeft:button buttonRight:nil callbackBlock:callbackBlock];
 }
 
+// documented in IterableAPI.h
 -(void) showSystemNotification:(NSString *)title body:(NSString *)body buttonLeft:(NSString *)buttonLeft buttonRight:(NSString *)buttonRight callbackBlock:(ITEActionBlock)callbackBlock
 {
     [IterableInAppManager showSystemNotification:title body:body buttonLeft:buttonLeft buttonRight:buttonRight  callbackBlock:callbackBlock];

Iterable-iOS-SDK/IterableConstants.h

@@ -67,6 +67,9 @@ extern NSString *const ITBL_DEVICE_USER_INTERFACE;
 #define ITBL_KEY_UNSPECIFIED @"Unspecified"
 
 
+#define ITBL_DEEPLINK_IDENTIFIER @"/a/[a-zA-Z0-9]+"
+
+
 //In-App Constants
 #define ITERABLE_IN_APP_TITLE @"title"
 #define ITERABLE_IN_APP_BODY @"body"

Iterable-iOS-SDKTests/IterableAPITests.m

@@ -82,4 +82,31 @@ - (void)testUserInterfaceIdionEnumToString {
     XCTAssertEqualObjects(@"Unspecified", [IterableAPI userInterfaceIdiomEnumToString:192387]);
 }
 
+- (void)testUniversalDeepLinkRewriting {
+    NSURL *iterableLink = [NSURL URLWithString:@"http://links.iterable.com/a/60402396fbd5433eb35397b47ab2fb83?_e=joneng%40iterable.com&_m=93125f33ba814b13a882358f8e0852e0"];
+    
+    XCTestExpectation *expectation =
+    [self expectationWithDescription:@"High Expectations"];
+    ITEActionBlock aBlock = ^(NSString* redirectUrl) {
+        [expectation fulfill];
+        XCTAssertEqualObjects(@"https://links.iterable.com/api/docs#!/email", redirectUrl);
+        
+    };
+    [IterableAPI getAndTrackDeeplink:iterableLink callbackBlock:aBlock];
+
+    NSURL *normalLink = [NSURL URLWithString:@"http://links.iterable.com/u/60402396fbd5433eb35397b47ab2fb83?_e=joneng%40iterable.com&_m=93125f33ba814b13a882358f8e0852e0"];
+    
+    ITEActionBlock uBlock = ^(NSString* redirectUrl) {
+        XCTAssertEqualObjects(@"http://links.iterable.com/u/60402396fbd5433eb35397b47ab2fb83?_e=joneng%40iterable.com&_m=93125f33ba814b13a882358f8e0852e0", redirectUrl);
+        
+    };
+    [IterableAPI getAndTrackDeeplink:normalLink callbackBlock:uBlock];
+    
+    [self waitForExpectationsWithTimeout:1.0 handler:^(NSError *error) {
+        if (error) {
+            NSLog(@"Timeout Error: %@", error);
+        }
+    }];
+}
+
 @end