Merge pull request #30 from Iterable/feature/mob-1-future

[MOB-1] - Use Future Internally

Author: tapashmajumder

Tests/swift-sdk-swift-tests/PromiseTests.swift

@@ -28,7 +28,7 @@ class PromiseTests: XCTestCase {
         f2.onSuccess { (value) in
             XCTAssertEqual(value, "zeeString".count)
             expectation1.fulfill()
-        } .onFailure { _ in
+        } .onError { _ in
             expectation2.fulfill()
         }
 
@@ -46,7 +46,7 @@ class PromiseTests: XCTestCase {
 
         f2.onSuccess { (value) in
             expectation1.fulfill()
-        }.onFailure { error in
+        }.onError { error in
             if let myError = error as? MyError {
                 XCTAssertEqual(myError.message, "zeeErrorMessage")
                 expectation2.fulfill()
@@ -72,7 +72,7 @@ class PromiseTests: XCTestCase {
         f2.onSuccess { (secondValue) in
             XCTAssertEqual(secondValue, "zeeStringzeeString")
             expectation1.fulfill()
-        } .onFailure { _ in
+        } .onError { _ in
             expectation2.fulfill()
         }
 
@@ -94,7 +94,7 @@ class PromiseTests: XCTestCase {
 
         f2.onSuccess { (secondValue) in
             expectation1.fulfill()
-        } .onFailure {(error) in
+        } .onError {(error) in
             if let myError = error as? MyError {
                 XCTAssertEqual(myError.message, "zeeErrorMessage")
                 expectation2.fulfill()
@@ -119,7 +119,7 @@ class PromiseTests: XCTestCase {
 
         f2.onSuccess { (secondValue) in
             expectation1.fulfill()
-        }.onFailure {(error) in
+        }.onError {(error) in
             if let myError = error as? MyError {
                 XCTAssertEqual(myError.message, "zeeErrorMessage")
                 expectation2.fulfill()
@@ -140,7 +140,7 @@ class PromiseTests: XCTestCase {
         f1.onSuccess { (value) in
             XCTAssertEqual(value, "zeeValue")
             expectation1.fulfill()
-        }.onFailure { _ in
+        }.onError { _ in
             expectation2.fulfill()
         }
 
@@ -157,7 +157,7 @@ class PromiseTests: XCTestCase {
 
         f1.onSuccess { (value) in
             expectation1.fulfill()
-        }.onFailure { error in
+        }.onError { error in
             if let myError = error as? MyError {
                 XCTAssertEqual(myError.message, "zeeErrorMessage")
                 expectation2.fulfill()

swift-sdk/Internal/IterableAPIInternal.swift

@@ -116,9 +116,9 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
                 return self.register(token: token, appName: appName, pushServicePlatform: self.config.pushPlatform)
             }).onSuccess { (json) in
                 onSuccess?(json)
-            }.onFailure { (error) in
+            }.onError { (error) in
                 if let sendError = error as? SendRequestError {
-                    onFailure?(sendError.errorMessage, sendError.data)
+                    onFailure?(sendError.reason, sendError.data)
                 } else {
                     onFailure?("failed to create user", nil)
                 }
@@ -132,7 +132,7 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
         guard email != nil || userId != nil else {
             ITBError("Both email and userId are nil")
             onFailure?("Both email and userId are nil", nil)
-            return SendRequestError.createFailedFuture(reason: "Both email and userId are nil")
+            return SendRequestError.createErroredFuture(reason: "Both email and userId are nil")
         }
 
         hexToken = (token as NSData).iteHexadecimalString()
@@ -178,7 +178,7 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
         ITBInfo("sending registerToken request with args \(args)")
         return
             createPostRequest(forPath: .ITBL_PATH_REGISTER_DEVICE_TOKEN, withBody: args)
-                .map {sendRequest($0, onSuccess: onSuccess, onFailure: onFailure)} ?? SendRequestError.createFailedFuture(reason: "Couldn't create register request")
+                .map {sendRequest($0, onSuccess: onSuccess, onFailure: onFailure)} ?? SendRequestError.createErroredFuture(reason: "Couldn't create register request")
     }
 
     func disableDeviceForCurrentUser() {
@@ -242,7 +242,7 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
 
         return createPostRequest(forPath: .ITBL_PATH_CREATE_USER, withBody: args).map {
             sendRequest($0)
-        } ?? SendRequestError.createFailedFuture(reason: "Could not create createUser Reqeust")
+        } ?? SendRequestError.createErroredFuture(reason: "Could not create createUser Reqeust")
     }
 
     func trackPurchase(_ total: NSNumber, items: [CommerceItem]) {
@@ -399,56 +399,34 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
         }
     }
 
-    func spawn(inAppNotification callbackBlock:ITEActionBlock?) {
-        let onSuccess: OnSuccessHandler = { payload in
-            guard let payload = payload else {
-                return
-            }
-            guard let dialogOptions = IterableInAppManager.getNextMessageFromPayload(payload) else {
-                ITBError("No notifications found for inApp payload \(payload)")
-                return
-            }
-            guard let message = dialogOptions[.ITBL_IN_APP_CONTENT] as? [AnyHashable : Any] else {
-                return
-            }
-            guard let messageId = dialogOptions[.ITBL_KEY_MESSAGE_ID] as? String else {
-                return
-            }
-            guard let html = message[.ITBL_IN_APP_HTML] as? String else {
-                return
-            }
-            guard html.range(of: AnyHashable.ITBL_IN_APP_HREF, options: [.caseInsensitive]) != nil else {
-                ITBError("No href tag found in in-app html payload \(html)")
-                self.inAppConsume(messageId)
-                return
-            }
-
-            let inAppDisplaySettings = message[.ITBL_IN_APP_DISPLAY_SETTINGS] as? [AnyHashable : Any]
-            let backgroundAlpha = IterableInAppManager.getBackgroundAlpha(fromInAppSettings: inAppDisplaySettings)
-            let edgeInsets = IterableInAppManager.getPaddingFromPayload(inAppDisplaySettings)
-
-            let notificationMetadata = IterableNotificationMetadata.metadata(fromInAppOptions: messageId)
-            
-            DispatchQueue.main.async {
-                let opened = IterableInAppManager.showIterableNotificationHTML(html, trackParams: notificationMetadata, backgroundAlpha: backgroundAlpha, padding: edgeInsets, callbackBlock: callbackBlock)
-                if opened {
-                    self.inAppConsume(messageId)
+    @discardableResult func spawn(inAppNotification callbackBlock:ITEActionBlock?) -> Future<IterableInAppManager.ShowInAppResult> {
+        return getInAppMessages(1)
+            .map { IterableInAppManager.parseInApp(fromPayload: $0)}
+            .flatMap { IterableInAppManager.showInApp(parseResult: $0, callbackBlock: callbackBlock)}
+            .onSuccess {
+                switch $0 {
+                case .success(opened: let opened, messageId: let messageId):
+                    if opened {
+                        self.inAppConsume(messageId)
+                    }
+                case .failure(reason: let reason, messageId: let messageId):
+                    if let messageId = messageId {
+                        self.inAppConsume(messageId)
+                    }
+                    ITBError(reason)
                 }
             }
-        }
-        
-        getInAppMessages(1, onSuccess: onSuccess, onFailure: IterableAPIInternal.defaultOnFailure(identifier: "getInAppMessages"))
     }
 
-    func getInAppMessages(_ count: NSNumber) {
-        getInAppMessages(count, onSuccess: IterableAPIInternal.defaultOnSucess(identifier: "getMessages"), onFailure: IterableAPIInternal.defaultOnFailure(identifier: "getMessages"))
+    @discardableResult func getInAppMessages(_ count: NSNumber) -> Future<SendRequestValue> {
+        return getInAppMessages(count, onSuccess: IterableAPIInternal.defaultOnSucess(identifier: "getMessages"), onFailure: IterableAPIInternal.defaultOnFailure(identifier: "getMessages"))
     }
 
-    func getInAppMessages(_ count: NSNumber, onSuccess: OnSuccessHandler?, onFailure: OnFailureHandler?) {
+    @discardableResult func getInAppMessages(_ count: NSNumber, onSuccess: OnSuccessHandler?, onFailure: OnFailureHandler?) -> Future<SendRequestValue> {
         guard email != nil || userId != nil else {
             ITBError("Both email and userId are nil")
             onFailure?("Both email and userId are nil", nil)
-            return
+            return SendRequestError.createErroredFuture(reason: "Both email and userId are nil")
         }
 
         var args : [AnyHashable : Any] = [
@@ -459,9 +437,9 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
 
         addEmailOrUserId(args: &args)
 
-        if let request = createGetRequest(forPath: .ITBL_PATH_GET_INAPP_MESSAGES, withArgs: args as! [String : String]) {
-            sendRequest(request, onSuccess: onSuccess, onFailure: onFailure)
-        }
+        return createGetRequest(forPath: .ITBL_PATH_GET_INAPP_MESSAGES, withArgs: args as! [String : String]).map {
+            sendRequest($0, onSuccess: onSuccess, onFailure: onFailure)
+        } ?? SendRequestError.createErroredFuture(reason: "Could not create get request for getInApp")
     }
 
     func trackInAppOpen(_ messageId: String) {
@@ -533,9 +511,9 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
     @discardableResult func sendRequest(_ request: URLRequest, onSuccess: OnSuccessHandler? = nil, onFailure: OnFailureHandler? = nil) -> Future<SendRequestValue> {
         return NetworkHelper.sendRequest(request, usingSession: networkSession).onSuccess { (json) in
             onSuccess?(json)
-        }.onFailure { (failureInfo) in
-            if let sendError = failureInfo as? SendRequestError {
-                onFailure?(sendError.errorMessage, sendError.data)
+        }.onError { (error) in
+            if let sendError = error as? SendRequestError {
+                onFailure?(sendError.reason, sendError.data)
             } else {
                 onFailure?("send request failed", nil)
             }
@@ -796,9 +774,9 @@ final class IterableAPIInternal : NSObject, PushTrackerProtocol {
 
         NetworkHelper.sendRequest(request, usingSession: networkSession).onSuccess { (json) in
             self.handleDDL(json: json)
-        }.onFailure { (failureInfo) in
-            if let sendError = failureInfo as? SendRequestError, let errorMessage = sendError.errorMessage {
-                ITBError(errorMessage)
+        }.onError { (error) in
+            if let sendError = error as? SendRequestError, let reason = sendError.reason {
+                ITBError(reason)
             } else {
                 ITBError("failed to send handleDDl request")
             }

swift-sdk/Internal/IterableInAppManager.swift

@@ -133,10 +133,8 @@ class IterableInAppManager: NSObject {
         return padding
     }
 
-    /*!
-     @method
-     
-     @abstract Gets the int value of the padding from the payload
+    /**
+     Gets the int value of the padding from the payload
 
      @param value          the value
 
@@ -172,6 +170,32 @@ class IterableInAppManager: NSObject {
         }
     }
 
+    enum ShowInAppResult {
+        case success(opened: Bool, messageId: String)
+        case failure(reason: String, messageId: String?)
+    }
+    
+    static func showInApp(parseResult: InAppParseResult, callbackBlock:ITEActionBlock?) -> Future<ShowInAppResult> {
+        switch parseResult {
+        case .success(let inAppDetails):
+            let result = Promise<ShowInAppResult>()
+            let notificationMetadata = IterableNotificationMetadata.metadata(fromInAppOptions: inAppDetails.messageId)
+            
+            DispatchQueue.main.async {
+                let opened = IterableInAppManager.showIterableNotificationHTML(inAppDetails.html,
+                                                                               trackParams: notificationMetadata,
+                                                                               backgroundAlpha: inAppDetails.backgroundAlpha,
+                                                                               padding: inAppDetails.edgeInsets,
+                                                                               callbackBlock: callbackBlock)
+                result.resolve(with: .success(opened: opened, messageId: inAppDetails.messageId))
+            }
+            return result
+        case .failure(let reason, let messageId):
+            return Promise<ShowInAppResult>(value: .failure(reason: reason, messageId: messageId))
+        }
+    }
+
+    
     private static func getTopViewController() -> UIViewController? {
         guard let rootViewController = IterableUtil.rootViewController else {
             return nil
@@ -183,6 +207,44 @@ class IterableInAppManager: NSObject {
         return topViewController
     }
 
+    enum InAppParseResult {
+        case success(InAppDetails)
+        case failure(reason: String, messageId: String?)
+    }
+    
+    struct InAppDetails {
+        let edgeInsets: UIEdgeInsets
+        let backgroundAlpha: Double
+        let messageId: String
+        let html: String
+    }
+    
+    // Payload is what comes from Api
+    // If successful you get InAppDetails
+    static func parseInApp(fromPayload payload: [AnyHashable : Any]) -> InAppParseResult {
+        guard let dialogOptions = IterableInAppManager.getNextMessageFromPayload(payload) else {
+            return .failure(reason: "No notifications found for inApp payload \(payload)", messageId: nil)
+        }
+        guard let message = dialogOptions[.ITBL_IN_APP_CONTENT] as? [AnyHashable : Any] else {
+            return .failure(reason: "no message", messageId: nil)
+        }
+        guard let messageId = dialogOptions[.ITBL_KEY_MESSAGE_ID] as? String else {
+            return .failure(reason: "no message id", messageId: nil)
+        }
+        guard let html = message[.ITBL_IN_APP_HTML] as? String else {
+            return .failure(reason: "no html", messageId: nil)
+        }
+        guard html.range(of: AnyHashable.ITBL_IN_APP_HREF, options: [.caseInsensitive]) != nil else {
+            return .failure(reason: "No href tag found in in-app html payload \(html)", messageId: messageId)
+        }
+        
+        let inAppDisplaySettings = message[.ITBL_IN_APP_DISPLAY_SETTINGS] as? [AnyHashable : Any]
+        let backgroundAlpha = IterableInAppManager.getBackgroundAlpha(fromInAppSettings: inAppDisplaySettings)
+        let edgeInsets = IterableInAppManager.getPaddingFromPayload(inAppDisplaySettings)
+        
+        return .success(InAppDetails(edgeInsets: edgeInsets, backgroundAlpha: backgroundAlpha, messageId: messageId, html: html))
+    }
+
     /**
      Creates and adds an alert action button to an alertController
 

swift-sdk/Internal/NetworkHelper.swift

@@ -9,22 +9,22 @@ import Foundation
 typealias SendRequestValue = [AnyHashable : Any]
 
 struct SendRequestError : Error {
-    let errorMessage: String?
+    let reason: String?
     let data: Data?
 
-    init(errorMessage: String? = nil, data: Data? = nil) {
-        self.errorMessage = errorMessage
+    init(reason: String? = nil, data: Data? = nil) {
+        self.reason = reason
         self.data = data
     }
 
-    static func createFailedFuture(reason: String? = nil) -> Future<SendRequestValue> {
-        return Promise<SendRequestValue>(error: SendRequestError(errorMessage: reason))
+    static func createErroredFuture(reason: String? = nil) -> Future<SendRequestValue> {
+        return Promise<SendRequestValue>(error: SendRequestError(reason: reason))
     }
 }
 
 extension SendRequestError : LocalizedError {
     var localizedDescription: String {
-        return errorMessage ?? ""
+        return reason ?? ""
     }
 }
 
@@ -61,10 +61,10 @@ struct NetworkHelper {
 
     static func createResultFromNetworkResponse(data: Data?, response: URLResponse?, error: Error?) -> Result<SendRequestValue> {
         if let error = error {
-            return .error(SendRequestError(errorMessage: "\(error.localizedDescription)", data: data))
+            return .error(SendRequestError(reason: "\(error.localizedDescription)", data: data))
         }
         guard let response = response as? HTTPURLResponse else {
-            return .error(SendRequestError(errorMessage: "No response", data: nil))
+            return .error(SendRequestError(reason: "No response", data: nil))
         }
 
         let responseCode = response.statusCode
@@ -84,33 +84,33 @@ struct NetworkHelper {
         }
 
         if responseCode == 401 {
-            return .error(SendRequestError(errorMessage: "Invalid API Key", data: data))
+            return .error(SendRequestError(reason: "Invalid API Key", data: data))
         } else if responseCode >= 400 {
-            var errorMessage = "Invalid Request"
+            var reason = "Invalid Request"
             if let jsonDict = json as? [AnyHashable : Any], let msgFromDict = jsonDict["msg"] as? String {
-                errorMessage = msgFromDict
+                reason = msgFromDict
             } else if responseCode >= 500 {
-                errorMessage = "Internal Server Error"
+                reason = "Internal Server Error"
             }
-            return .error(SendRequestError(errorMessage: errorMessage, data: data))
+            return .error(SendRequestError(reason: reason, data: data))
         } else if responseCode == 200 {
             if let data = data, data.count > 0 {
                 if let jsonError = jsonError {
                     var reason = "Could not parse json, error: \(jsonError.localizedDescription)"
                     if let stringValue = String(data: data, encoding: .utf8) {
                         reason = "Could not parse json: \(stringValue), error: \(jsonError.localizedDescription)"
                     }
-                    return .error(SendRequestError(errorMessage: reason, data: data))
+                    return .error(SendRequestError(reason: reason, data: data))
                 } else if let json = json as? [AnyHashable : Any] {
                     return .value(json)
                 } else {
-                    return .error(SendRequestError(errorMessage: "Response is not a dictionary", data: data))
+                    return .error(SendRequestError(reason: "Response is not a dictionary", data: data))
                 }
             } else {
-                return .error(SendRequestError(errorMessage: "No data received", data: data))
+                return .error(SendRequestError(reason: "No data received", data: data))
             }
         } else {
-            return .error(SendRequestError(errorMessage: "Received non-200 response: \(responseCode)", data: data))
+            return .error(SendRequestError(reason: "Received non-200 response: \(responseCode)", data: data))
         }
     }
 }