[In-Progress] Feature/itbl 2762 html in app notifcation (#40)

* In Progress: Initial changes for html in-app support

* Calculates padding/offset for the in-app based upon the payload data.
Handles the full screen layout.

* Adds in additional logic for custom urls.
Opens up any web http links by default.

* Fixed up direct scheme check to avoid false positive schemes which contain http.

* Updated api parsing for in-app
Includes itbl:// custom scheme parsing
Added background alpha level

* Added in unit tests for location/padding calculation

* updates to the tests for padding

* More unit tests for padding

* code cleanup

* Updated params for get in-app to include optional platform / SDK version.

* Update constants and html check for href tag

* updated check to be case-insensitive

* Removes automatic open of http/https urls.

Author: davidtruong

Iterable-iOS-SDK.xcodeproj/project.pbxproj

@@ -33,6 +33,9 @@
 		09C0FC071A1D6D4700D5A86B /* libIterable-iOS-SDK.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 09C0FBFB1A1D6D4700D5A86B /* libIterable-iOS-SDK.a */; };
 		09CCB9301D07A7EA003EB75D /* IterableNotificationMetadata.m in Sources */ = {isa = PBXBuildFile; fileRef = 09CCB92F1D07A7EA003EB75D /* IterableNotificationMetadata.m */; };
 		09CCB9321D07BA04003EB75D /* IterableNotificationMetadataTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 09CCB9311D07BA04003EB75D /* IterableNotificationMetadataTests.m */; };
+		1608832D1F83EED500318578 /* IterableInAppNotificationTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 1608832C1F83EED500318578 /* IterableInAppNotificationTests.m */; };
+		160883301F840B5F00318578 /* IterableInAppHTMLViewController.h in Headers */ = {isa = PBXBuildFile; fileRef = 1608832E1F840B5F00318578 /* IterableInAppHTMLViewController.h */; };
+		160883311F840B5F00318578 /* IterableInAppHTMLViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = 1608832F1F840B5F00318578 /* IterableInAppHTMLViewController.m */; };
 		16513DDE1D89EECC00C205B3 /* IterableInAppManager.h in Headers */ = {isa = PBXBuildFile; fileRef = 16513DD81D89EECC00C205B3 /* IterableInAppManager.h */; };
 		16513DDF1D89EECC00C205B3 /* IterableInAppManager.m in Sources */ = {isa = PBXBuildFile; fileRef = 16513DD91D89EECC00C205B3 /* IterableInAppManager.m */; };
 		1653A80E1D88B25200690298 /* IterableConstants.h in Headers */ = {isa = PBXBuildFile; fileRef = 1653A80B1D88B25200690298 /* IterableConstants.h */; };
@@ -90,6 +93,9 @@
 		09CCB92F1D07A7EA003EB75D /* IterableNotificationMetadata.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IterableNotificationMetadata.m; sourceTree = "<group>"; };
 		09CCB9311D07BA04003EB75D /* IterableNotificationMetadataTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IterableNotificationMetadataTests.m; sourceTree = "<group>"; };
 		15E14DC3FEF5EE94DFA2424E /* libPods-Iterable-iOS-SDKTests.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = "libPods-Iterable-iOS-SDKTests.a"; sourceTree = BUILT_PRODUCTS_DIR; };
+		1608832C1F83EED500318578 /* IterableInAppNotificationTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IterableInAppNotificationTests.m; sourceTree = "<group>"; };
+		1608832E1F840B5F00318578 /* IterableInAppHTMLViewController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IterableInAppHTMLViewController.h; sourceTree = "<group>"; };
+		1608832F1F840B5F00318578 /* IterableInAppHTMLViewController.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IterableInAppHTMLViewController.m; sourceTree = "<group>"; };
 		16513DD81D89EECC00C205B3 /* IterableInAppManager.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IterableInAppManager.h; sourceTree = "<group>"; };
 		16513DD91D89EECC00C205B3 /* IterableInAppManager.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = IterableInAppManager.m; sourceTree = "<group>"; };
 		1653A80B1D88B25200690298 /* IterableConstants.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IterableConstants.h; sourceTree = "<group>"; };
@@ -180,6 +186,7 @@
 				091489E11CF6986900482D82 /* IterableAPITests.m */,
 				091489E71CF6AC1800482D82 /* CommerceItemTests.m */,
 				09CCB9311D07BA04003EB75D /* IterableNotificationMetadataTests.m */,
+				1608832C1F83EED500318578 /* IterableInAppNotificationTests.m */,
 			);
 			path = "Iterable-iOS-SDKTests";
 			sourceTree = "<group>";
@@ -195,6 +202,8 @@
 		16CE7A051DF8D5A900CADC2D /* InAppNotifications */ = {
 			isa = PBXGroup;
 			children = (
+				1608832E1F840B5F00318578 /* IterableInAppHTMLViewController.h */,
+				1608832F1F840B5F00318578 /* IterableInAppHTMLViewController.m */,
 				16513DD81D89EECC00C205B3 /* IterableInAppManager.h */,
 				16513DD91D89EECC00C205B3 /* IterableInAppManager.m */,
 				16ED2E461D90569500ADCAEC /* IterableInAppBaseViewController.h */,
@@ -247,6 +256,7 @@
 				093028D31D1B958700E7CFBE /* IterableLogging.h in Headers */,
 				16ED2E4F1D908D5500ADCAEC /* IterableAlertViewController.h in Headers */,
 				16513DDE1D89EECC00C205B3 /* IterableInAppManager.h in Headers */,
+				160883301F840B5F00318578 /* IterableInAppHTMLViewController.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -462,6 +472,7 @@
 				16ED2E501D908D5500ADCAEC /* IterableAlertViewController.m in Sources */,
 				093734271A1D701F00C950B6 /* IterableAPI.m in Sources */,
 				1653A8101D88B25200690298 /* IterableFullScreenViewController.m in Sources */,
+				160883311F840B5F00318578 /* IterableInAppHTMLViewController.m in Sources */,
 				6804B8601AC0F363000A126B /* CommerceItem.m in Sources */,
 				16E02BAD1E035EA400644C15 /* IterableConstants.m in Sources */,
 				0995DBDD1CFFF7FE00D50F19 /* IterableLogging.m in Sources */,
@@ -474,6 +485,7 @@
 			files = (
 				091489E21CF6986900482D82 /* IterableAPITests.m in Sources */,
 				09CCB9321D07BA04003EB75D /* IterableNotificationMetadataTests.m in Sources */,
+				1608832D1F83EED500318578 /* IterableInAppNotificationTests.m in Sources */,
 				091489E81CF6AC1800482D82 /* CommerceItemTests.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;

Iterable-iOS-SDK/IterableAPI.h

@@ -502,6 +502,16 @@ typedef NS_ENUM(NSInteger, PushServicePlatform) {
  */
 - (void)trackInAppClick:(NSString *)messageId buttonIndex:(NSNumber *)buttonIndex;
 
+/**
+ @method
+ 
+ @abstract Tracks a inAppClick event
+ 
+ @param messageId       The messageId of the notification
+ @param buttonURL     The url of the button that was clicked
+ */
+- (void)trackInAppClick:(NSString *)messageId buttonURL:(NSString *)buttonURL;
+
 /**
  @method
  

Iterable-iOS-SDK/IterableAPI.m

@@ -532,6 +532,26 @@ - (void)trackInAppClick:(NSString *)messageId buttonIndex:(NSNumber*)buttonIndex
     [self sendRequest:request onSuccess:[IterableAPI defaultOnSuccess:@"trackInAppClick"] onFailure:[IterableAPI defaultOnFailure:@"trackInAppClick"]];
 }
 
+// documented in IterableAPI.h
+- (void)trackInAppClick:(NSString *)messageId buttonURL:(NSString*)buttonURL {
+    NSDictionary *args;
+    if (_email != nil) {
+        args = @{
+                 ITBL_KEY_EMAIL: self.email,
+                 ITBL_KEY_MESSAGE_ID: messageId,
+                 ITERABLE_IN_APP_CLICK_URL: buttonURL
+                 };
+    } else {
+        args = @{
+                 ITBL_KEY_USER_ID: self.userId,
+                 ITBL_KEY_MESSAGE_ID: messageId,
+                 ITERABLE_IN_APP_CLICK_URL: buttonURL
+                 };
+    }
+    NSURLRequest *request = [self createRequestForAction:ENDPOINT_TRACK_INAPP_CLICK withArgs:args];
+    [self sendRequest:request onSuccess:[IterableAPI defaultOnSuccess:@"trackInAppClick"] onFailure:[IterableAPI defaultOnFailure:@"trackInAppClick"]];
+}
+
 // documented in IterableAPI.h
 - (void)registerToken:(NSData *)token appName:(NSString *)appName pushServicePlatform:(PushServicePlatform)pushServicePlatform
 {
@@ -846,23 +866,33 @@ - (void)spawnInAppNotification:(ITEActionBlock)callbackBlock
     OnSuccessHandler onSuccess = ^(NSDictionary* payload) {
         NSDictionary *dialogOptions = [IterableInAppManager getNextMessageFromPayload:payload];
         if (dialogOptions != nil) {
-            NSDictionary *message = [dialogOptions valueForKeyPath:ITERABLE_IN_APP_CONTENT];
-            NSString *messageId = [dialogOptions valueForKey:ITBL_KEY_MESSAGE_ID];
-            
-            [self trackInAppOpen:messageId];
-            [self inAppConsume:messageId];
-            IterableNotificationMetadata *notification = [IterableNotificationMetadata metadataFromInAppOptions:messageId];
-            
+            NSDictionary *message = [dialogOptions valueForKey:ITERABLE_IN_APP_CONTENT];
             if (message != nil) {
-                dispatch_sync(dispatch_get_main_queue(), ^{
-                    [IterableInAppManager showIterableNotification:message trackParams:notification callbackBlock:(ITEActionBlock)callbackBlock];
-                });
+                NSString *messageId = [dialogOptions valueForKey:ITBL_KEY_MESSAGE_ID];
+                NSString *html = [message objectForKey:ITERABLE_IN_APP_HTML];
+                
+                //uses the rangeOfString check for backwards compatability with iOS7
+                if (html != nil && !([html rangeOfString:ITERABLE_IN_APP_HREF options:NSCaseInsensitiveSearch].location == NSNotFound)) {
+                    NSDictionary *inAppDisplaySettings = [message valueForKey:ITERABLE_IN_APP_DISPLAY_SETTINGS];
+                    double backgroundAlpha = [[inAppDisplaySettings valueForKey:ITERABLE_IN_APP_BACKGROUND_ALPHA] doubleValue];
+                    UIEdgeInsets edgeInsets = [IterableInAppManager getPaddingFromPayload:inAppDisplaySettings];
+                    
+                    IterableNotificationMetadata *notification = [IterableNotificationMetadata metadataFromInAppOptions:messageId];
+                    
+                    dispatch_sync(dispatch_get_main_queue(), ^{
+                        [IterableInAppManager showIterableNotificationHTML:html trackParams:(IterableNotificationMetadata*)notification callbackBlock:(ITEActionBlock)callbackBlock backgroundAlpha:backgroundAlpha padding:edgeInsets];
+                    });
+                } else {
+                    LogWarning(@"No href tag found in the in-app html payload: %@", html);
+                }
+                
+                [self inAppConsume:messageId];
             }
         } else {
             LogDebug(@"No notifications found for inApp payload %@", payload);
         }
     };
-
+    
     [self getInAppMessages:@1 onSuccess:onSuccess onFailure:[IterableAPI defaultOnFailure:@"getInAppMessages"]];
 }
 
@@ -879,12 +909,16 @@ - (void)getInAppMessages:(NSNumber *)count onSuccess:(OnSuccessHandler)onSuccess
     if (_email != nil) {
         args = @{
                 ITBL_KEY_EMAIL: self.email,
-                ITBL_KEY_COUNT: count
+                ITBL_KEY_COUNT: count,
+                ITBL_KEY_PLATFORM: ITBL_PLATFORM_IOS,
+                ITBL_KEY_SDK_VERSION: @"0.0.0"
                 };
     } else {
         args = @{
                  ITBL_KEY_USER_ID: self.userId,
-                 ITBL_KEY_COUNT: count
+                 ITBL_KEY_COUNT: count,
+                 ITBL_KEY_PLATFORM: ITBL_PLATFORM_IOS,
+                 ITBL_KEY_SDK_VERSION: @"0.0.0"
                 };
     }
     NSURLRequest *request = [self createGetRequestForAction:ENDPOINT_GET_INAPP_MESSAGES withArgs:args];

Iterable-iOS-SDK/IterableConstants.h

@@ -24,6 +24,7 @@ extern NSString *const ITBL_KEY_MESSAGE_ID;
 extern NSString *const ITBL_KEY_NEW_EMAIL;
 extern NSString *const ITBL_KEY_PLATFORM;
 extern NSString *const ITBL_KEY_RECIPIENT_EMAIL;
+extern NSString *const ITBL_KEY_SDK_VERSION;
 extern NSString *const ITBL_KEY_SEND_AT;
 extern NSString *const ITBL_KEY_TOKEN;
 extern NSString *const ITBL_KEY_TEMPLATE_ID;
@@ -65,11 +66,15 @@ extern NSString *const ITBL_DEVICE_USER_INTERFACE;
 #define ITBL_KEY_PHONE @"Phone"
 #define ITBL_KEY_UNSPECIFIED @"Unspecified"
 
+#define ITBL_PLATFORM_IOS @"iOS"
+
 
 #define ITBL_DEEPLINK_IDENTIFIER @"/a/[a-zA-Z0-9]+"
 
 
 //In-App Constants
+#define ITERABLE_IN_APP_CLICK_URL @"urlClick"
+
 #define ITERABLE_IN_APP_TITLE @"title"
 #define ITERABLE_IN_APP_BODY @"body"
 #define ITERABLE_IN_APP_IMAGE @"mainImage"
@@ -90,5 +95,11 @@ extern NSString *const ITBL_DEVICE_USER_INTERFACE;
 #define ITERABLE_IN_APP_BUTTON_ACTION @"action"
 #define ITERABLE_IN_APP_CONTENT @"content"
 
+//In-App HTML Constants
+#define ITERABLE_IN_APP_BACKGROUND_ALPHA @"backgroundAlpha"
+#define ITERABLE_IN_APP_HTML @"html"
+#define ITERABLE_IN_APP_HREF @"href"
+#define ITERABLE_IN_APP_DISPLAY_SETTINGS @"inAppDisplaySettings"
+
 
 typedef void (^ITEActionBlock)(NSString *);

Iterable-iOS-SDK/IterableConstants.m

@@ -20,12 +20,14 @@ @implementation IterableConstants : NSObject
 NSString *const ITBL_KEY_DEVICE              = @"device";
 NSString *const ITBL_KEY_EMAIL               = @"email";
 NSString *const ITBL_KEY_EVENT_NAME          = @"eventName";
+NSString *const ITBL_KEY_INAPP_DISPLAY       = @"inAppDisplaySettings";
 NSString *const ITBL_KEY_ITEMS               = @"items";
 NSString *const ITBL_KEY_MERGE_NESTED        = @"mergeNestedObjects";
 NSString *const ITBL_KEY_MESSAGE_ID          = @"messageId";
 NSString *const ITBL_KEY_NEW_EMAIL           = @"newEmail";
 NSString *const ITBL_KEY_PLATFORM            = @"platform";
 NSString *const ITBL_KEY_RECIPIENT_EMAIL     = @"recipientEmail";
+NSString *const ITBL_KEY_SDK_VERSION         = @"SDKVersion";
 NSString *const ITBL_KEY_SEND_AT             = @"sendAt";
 NSString *const ITBL_KEY_TOKEN               = @"token";
 NSString *const ITBL_KEY_TEMPLATE_ID         = @"templateId";

Iterable-iOS-SDK/IterableInAppHTMLViewController.h

@@ -0,0 +1,83 @@
+//
+//  IterableInAppHTMLViewController.h
+//  Pods
+//
+//  Created by David Truong on 9/8/17.
+//
+//
+
+#import <UIKit/UIKit.h>
+#import "IterableConstants.h"
+#import "IterableNotificationMetadata.h"
+
+@interface IterableInAppHTMLViewController : UIViewController
+
+/**
+ @abstract Custom ITEActionBlock
+ */
+typedef void (^ITEActionBlock)(NSString *);
+
+typedef enum {
+    INAPP_FULL,
+    INAPP_TOP,
+    INAPP_CENTER,
+    INAPP_BOTTOM
+} INAPP_NOTIFICATION_TYPE;
+
+/**
+ @method
+ 
+ @abstract constructs an inapp notification with via html
+ 
+ @param htmlString the html string
+ */
+- (IterableInAppHTMLViewController*)initWithData:htmlString;
+
+/**
+ @method
+ 
+ @abstract Sets the padding
+ 
+ @param insetPadding the padding
+ 
+ @discussion defaults to 0 for left/right if left+right >100
+ */
+-(void)ITESetPadding:(UIEdgeInsets)insetPadding;
+
+/**
+ @method
+ 
+ @abstract Sets the callback
+ 
+ @param callbackBlock the payload data
+ */
+-(void)ITESetCallback:(ITEActionBlock)callbackBlock;
+
+/**
+ @method
+ 
+ @abstract Sets the track parameters
+ 
+ @param trackParams the track parameters
+ */
+-(void)ITESetTrackParams:(IterableNotificationMetadata *)trackParams;
+
+/**
+ @method
+ 
+ @abstract gets the html string
+ 
+ @return a NSString of the html
+ */
+-(NSString *)getHtml;
+
+/**
+ @method
+ 
+ @abstract gets the location from a inset data
+ 
+ @return the location as an INAPP_NOTIFICATION_TYPE
+ */
++(INAPP_NOTIFICATION_TYPE)setLocation:(UIEdgeInsets) insetPadding;
+
+@end