cleanUp and additional lifecycle methods available for objc requests

Author: MarcoRecchioni

BreinifyApi/api/BreinActivity.swift

@@ -74,7 +74,7 @@ open class BreinActivity: BreinBase, ISecretStrategy {
     @discardableResult
     @objc
     public func setDescription(_ description: String!) -> BreinActivity {
-        self.desc = description
+        desc = description
         return self
     }
 
@@ -93,14 +93,14 @@ open class BreinActivity: BreinBase, ISecretStrategy {
     }
 
     public func getTagsDic() -> [String: Any]? {
-        self.tagsDic
+        tagsDic
     }
 
     @discardableResult
     @objc
     public func setTag(_ key: String, _ value: AnyObject) -> BreinActivity {
-        if self.tagsDic == nil {
-            self.tagsDic = [String: Any]()
+        if tagsDic == nil {
+            tagsDic = [String: Any]()
         }
 
         tagsDic?[key] = value
@@ -114,7 +114,7 @@ open class BreinActivity: BreinBase, ISecretStrategy {
     }
 
     public func getActivityDic() -> [String: Any]? {
-        self.activityDic
+        activityDic
     }
 
     /// Sends an activity to the Breinify server.
@@ -211,12 +211,12 @@ open class BreinActivity: BreinBase, ISecretStrategy {
 
         // create a new activity object
         let clonedBreinActivity = BreinActivity()
-                .setActivityType(self.getActivityType())
-                .setCategory(self.getCategory())
-                .setDescription(self.getDescription())
+                .setActivityType(getActivityType())
+                .setCategory(getCategory())
+                .setDescription(getDescription())
 
         // clone dictionaries => simple copy is enough
-        if let clonedActivityDic = self.getActivityDic() {
+        if let clonedActivityDic = getActivityDic() {
             clonedBreinActivity.setActivityDic(clonedActivityDic)
         }
 
@@ -247,8 +247,8 @@ open class BreinActivity: BreinBase, ISecretStrategy {
     /// - Throws: BreinRuntimeError
     public override func createSignature() throws -> String! {
 
-        let breinActivityType = self.getActivityType() ?? ""
-        let unixTimestamp = self.getUnixTimestamp()
+        let breinActivityType = getActivityType() ?? ""
+        let unixTimestamp = getUnixTimestamp()
         let message = breinActivityType + String(unixTimestamp) + "1"
 
         return try BreinUtil.generateSignature(message, secret: getConfig()?.getSecret())

BreinifyApi/api/BreinIpInfo.swift

@@ -60,11 +60,11 @@ open class BreinIpInfo {
     /// provides external ipAddress
     public func getExternalIp() -> String? {
 
-        guard self.readDataMap != nil else {
+        guard readDataMap != nil else {
             return ""
         }
 
-       if let ip = self.readDataMap?[BreinIpInfo.kIpField] as? String {
+       if let ip = readDataMap?[BreinIpInfo.kIpField] as? String {
           return ip
        }
 
@@ -74,8 +74,8 @@ open class BreinIpInfo {
     /// provides timezone
     public func getTimezone() -> String? {
 
-        if self.readDataMap != nil {
-            if let timeZone = self.readDataMap?[BreinIpInfo.kTimezoneField] as? String {
+        if readDataMap != nil {
+            if let timeZone = readDataMap?[BreinIpInfo.kTimezoneField] as? String {
                 return timeZone
             }
             return ""

BreinifyApi/api/BreinLocationManager.swift

@@ -73,23 +73,23 @@ public class BreinLocationManager: NSObject, CLLocationManagerDelegate {
     ///
     public override init() {
         super.init()
-        self.ignoreLocationRequestState = false
+        ignoreLocationRequestState = false
     }
 
     // ctor with option to ignore request
     public init(ignoreLocationRequest: Bool) {
         super.init()
-        self.ignoreLocationRequestState = ignoreLocationRequest
+        ignoreLocationRequestState = ignoreLocationRequest
     }
 
     // ignore request
     public func ignoreLocationRequest() -> Bool {
-        self.ignoreLocationRequestState
+        ignoreLocationRequestState
     }
 
     // ignore request
     public func setIgnoreLocationRequest(ignoreLocationRequest: Bool) -> BreinLocationManager {
-        self.ignoreLocationRequestState = ignoreLocationRequest
+        ignoreLocationRequestState = ignoreLocationRequest
         return self
     }
 
@@ -102,28 +102,26 @@ public class BreinLocationManager: NSObject, CLLocationManagerDelegate {
     }
 
     /// location authorization status changed
-    @nonobjc
     public func locationManager(_ manager: CLLocationManager,
-                                didChangeAuthorizationStatus status: CLAuthorizationStatus) {
+                                didChangeAuthorization status: CLAuthorizationStatus) {
 
         switch status {
         case .authorizedWhenInUse,
              .authorizedAlways,
              .notDetermined:
-            self.locationManager.startUpdatingLocation()
+            locationManager.startUpdatingLocation()
 
             // it's fine to send sendLoc information
             BreinifyManager.shared.hasPermissionToSendLocationUpdates = true
 
         default:
-            completionHandler(location: dummyLocation, error: NSError(domain: self.classForCoder.description(),
+            completionHandler(location: dummyLocation, error: NSError(domain: classForCoder.description(),
                     code: BreinLocationManagerErrors.AuthorizationDenied.rawValue,
                     userInfo: nil))
         }
     }
 
     // invoked in case of a failure
-    @nonobjc
     public func locationManager(manager: CLLocationManager, didFailWithError error: NSError) {
         completionHandler(location: dummyLocation, error: error)
     }
@@ -151,7 +149,7 @@ public class BreinLocationManager: NSObject, CLLocationManagerDelegate {
         didComplete = completion
 
         // check if location request should be ignored
-        if self.ignoreLocationRequest() == true {
+        if ignoreLocationRequest() == true {
             completionHandler(location: dummyLocation, error: NSError(domain: "BreinLocationManager", code: 103, userInfo: nil))
         }
 

BreinifyApi/api/BreinNotificationServiceExtension.swift

@@ -15,12 +15,12 @@ open class BreinNotificationServiceExtension: UNNotificationServiceExtension {
 
     open override func didReceive(_ request: UNNotificationRequest, withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void) {
         self.contentHandler = contentHandler
-        self.receivedRequest = request
+        receivedRequest = request
         bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)
 
         if let bestAttemptContent = bestAttemptContent {
             // Modify the notification content here...
-            Breinify.didReceiveNotificationExtensionRequest(self.receivedRequest as Any, bestAttemptContent: bestAttemptContent)
+            Breinify.didReceiveNotificationExtensionRequest(receivedRequest as Any, bestAttemptContent: bestAttemptContent)
             contentHandler(bestAttemptContent)
         }
     }

BreinifyApi/api/Breinify.swift

@@ -11,7 +11,7 @@ open class Breinify: NSObject {
     typealias apiFailure = (_ error: NSDictionary) -> Void
 
     ///  contains the current version of the library
-    static let version: String! = "2.0.19"
+    static let version: String! = "2.0.20"
 
     /// contains the configuration
     static var config: BreinConfig?
@@ -71,6 +71,19 @@ open class Breinify: NSObject {
         BreinifyManager.shared.handleDidReceiveNotification(notification)
     }
 
+    @available(iOS 10, *)
+    @objc
+    public static func didReceiveNotificationResponse(_ response: UNNotificationResponse) {
+        BreinLogger.shared.log("Breinify didReceiveNNotificationResponse invoked")
+        BreinifyManager.shared.handleDidReceiveNotificationResponse(response)
+    }
+
+    @objc
+    public static func didReceive(_ notification: [AnyHashable : Any]) {
+        BreinLogger.shared.log("Breinify didReceive invoked")
+        BreinifyManager.shared.handleDidReceiveNotification(notification)
+    }
+
     @objc
     public static func willPresentNotification(_ notification: [AnyHashable : Any]) {
         BreinLogger.shared.log("Breinify willPresentNotification invoked")
@@ -79,7 +92,7 @@ open class Breinify: NSObject {
 
     @objc
     public static func isBreinifyNotification(_ userInfo: [AnyHashable : Any]) -> Bool {
-        return userInfo.keys.contains("breinify")
+        userInfo.keys.contains("breinify")
     }
 
     @objc
@@ -626,7 +639,7 @@ open class Breinify: NSObject {
         - Parameter activityType:  The type of the activity collected, i.e., one of search, login, logout, addToCart,
                                    removeFromCart, checkOut, selectProduct, or other. if not specified, the default other will
                                    be used
-        - Parameter categoryType:  The category of the platform/service/products, i.e., one of apparel, home, education, family,
+        - Parameter category:      The category of the platform/service/products, i.e., one of apparel, home, education, family,
                                    food, health, job, services, or other
         - Parameter description:   A string with further information about the activity performed
         - Parameter success:       A callback function that is invoked in case of success.
@@ -789,7 +802,7 @@ open class Breinify: NSObject {
 
        Furthermore it uses the internal instance of BreinTemporalData.
 
-       - parameter ipAddress: Contains an ipAddress to resolve.
+       - Parameter ipAddress: Contains an ipAddress to resolve.
        - Parameter success:   A callback function that is invoked in case of success.
        - Parameter failure:   A callback function that is invoked in case of an error.
 
@@ -828,7 +841,7 @@ open class Breinify: NSObject {
 
         Furthermore it uses the internal instance of BreinTemporalData.
 
-        - parameter breinTemporalData: Contains a breinTemporalData object.
+        - Parameter breinTemporalData: Contains a breinTemporalData object.
         - Parameter success:           A callback function that is invoked in case of success.
         - Parameter failure:           A callback function that is invoked in case of an error.
 
@@ -870,8 +883,8 @@ open class Breinify: NSObject {
       Retrieves a lookup result from the engine. The function needs a valid API-key to be configured to succeed.
       This request is synchronous.
 
-        - parameter user:       A plain object specifying information about the user to retrieve data for.
-        - parameter dimension:  An object (with an array) containing the names of the dimensions to lookup.
+        - Parameter user:       A plain object specifying information about the user to retrieve data for.
+        - Parameter dimension:  An object (with an array) containing the names of the dimensions to lookup.
         - Parameter success:    A callback function that is invoked in case of success.
         - Parameter failure:    A callback function that is invoked in case of an error.
 
@@ -899,9 +912,9 @@ open class Breinify: NSObject {
        Retrieves a lookup result from the engine. The function needs a valid API-key to be configured to succeed.
        This request is synchronous.
 
-         - parameter breinLookup: An instance of BreinLookup.
-         - parameter user:        A plain object specifying information about the user to retrieve data for.
-         - parameter dimension:   An object (with an array) containing the names of the dimensions to lookup.
+         - Parameter breinLookup: An instance of BreinLookup.
+         - Parameter user:        A plain object specifying information about the user to retrieve data for.
+         - Parameter dimension:   An object (with an array) containing the names of the dimensions to lookup.
          - Parameter success:     A callback function that is invoked in case of success.
          - Parameter failure:     A callback function that is invoked in case of an error.
 

BreinifyApi/api/BreinifyManager.swift

@@ -60,11 +60,11 @@ open class BreinifyManager: NSObject, UNUserNotificationCenterDelegate {
     }()
 
     public func willRegisterPushNotification(_ shouldRegister: Bool) {
-        self.shouldRegisterPushNotification = shouldRegister
+        shouldRegisterPushNotification = shouldRegister
     }
 
     public func hasRegisteredPushNotification() -> Bool {
-        self.shouldRegisterPushNotification
+        shouldRegisterPushNotification
     }
 
     // Can't init the singleton
@@ -300,6 +300,7 @@ open class BreinifyManager: NSObject, UNUserNotificationCenterDelegate {
     public func userNotificationCenter(_ center: UNUserNotificationCenter,
                                        didReceive response: UNNotificationResponse,
                                        withCompletionHandler completionHandler: @escaping () -> Void) {
+
         BreinLogger.shared.log("Breinify UserNotification didReceive invoked with response: \(response)")
 
         let campaignNotificationDic = getCampaignContent(response.notification.request.content.userInfo)
@@ -318,9 +319,15 @@ open class BreinifyManager: NSObject, UNUserNotificationCenterDelegate {
         let campaignNotificationDic = getCampaignContent(userInfo)
         sendActivity(BreinActivityType.OPEN_PUSH_NOTIFICATION.rawValue, additionalActivityTagContent: campaignNotificationDic)
 
+        BreinLogger.shared.log("Breinify invoking handleIncomingNotificationContent from handleDidReceiveNotification method")
         handleIncomingNotificationContent(userInfo)
     }
 
+    @available(iOS 10, *)
+    public func handleDidReceiveNotificationResponse(_ response: UNNotificationResponse) {
+        BreinLogger.shared.log("Breinify handleDidReceiveNotificationResponse invoked with response: \(response)")
+    }
+
     public func handleWillPresentNotification(_ userInfo: [AnyHashable: Any]) {
 
         BreinLogger.shared.log("Breinify handleWillPresentNotification invoked with notification: \(userInfo)")
@@ -462,7 +469,7 @@ open class BreinifyManager: NSObject, UNUserNotificationCenterDelegate {
 
     }
 
-    func registerPushNotifications() {
+    public func registerPushNotifications() {
         BreinLogger.shared.log("Breinify registerPushNotifications invoked")
 
         guard let application = UIApplication.value(forKeyPath: #keyPath(UIApplication.shared)) as? UIApplication else {