Add new delegate methods, add screenName and ruleName, fix bug with user_id, add error to restore purchases method (#13)

what's new in 0.8.5:
* Added new ApphudUIDelegate method `func apphudShouldPerformRule(rule: ApphudRule) -> Bool`. See Apphud.swift for method explanation.
* (Attention!) Renamed ApphudUIDelegate method to `func apphudShouldShowScreen(screenName: String) -> Bool`. Don't forget to update this method parameter, if you were using it.
* Added Adjust support.
* Renamed `func restoreSubscriptions(callback: @escaping ([ApphudSubscription]?, Error?) -> Void)`. Added `Error?` parameter.
* Improved logic for `func migrateSubscriptionsIfNeeded` method.
* Pretty printed logs.
* Fixed bug with user id being changed sometimes.
* User ID is now saved to Keychain, so after re-install it is restored.
* Fixed bug with push opened event not being sent in some cases.
* Add rule name and screen name to delegate methods.
* Add more logs.

Author: ren6

ApphudSDK.podspec

@@ -1,8 +1,7 @@
 Pod::Spec.new do |s|
   s.name             = 'ApphudSDK'
-  s.version          = '0.8'
-  s.summary          = 'Track and control iOS auto-renewable subscriptions.'
- 
+  s.version          = '0.8.5'
+  s.summary          = 'Track and control iOS auto-renewable subscriptions.' 
   s.description      = 'Track, control and analyze iOS auto-renewable subscriptions with Apphud.'
   s.homepage         = 'https://github.com/apphud/ApphudSDK'
   s.license          = { :type => 'MIT', :file => 'LICENSE' }

README.md

@@ -144,7 +144,7 @@ Apphud.subscription()
 If your app doesn't have a login system, which identifies a premium user by his credentials, then you need a restore mechanism. If you already have a restore purchases mechanism by calling `SKPaymentQueue.default().restoreCompletedTransactions()`, then you have nothing to worry about – Apphud SDK will automatically intercept and send latest App Store Receipt to Apphud servers when your restoration is completed. However, better to call our restore method from SDK:
 
 ```swift
-Apphud.restoreSubscriptions{ subscriptions in 
+Apphud.restoreSubscriptions{ subscriptions, error in 
    // handle here
 }
 ```

Sources/ApphudSDK/Apphud.swift

@@ -54,11 +54,16 @@ public typealias ApphudBoolCallback = ((Bool) -> Void)
 @objc public protocol ApphudUIDelegate {
 
     /**
-        You can return `false` to this delegate method if you don't want Apphud Screen to be displayed at this time.
+        You can return `false` to ignore this rule. You should only do this if you want to handle your rules by yourself. Default implementation is `true`.
+     */
+    @objc optional func apphudShouldPerformRule(rule: ApphudRule) -> Bool
+    
+    /**
+        You can return `false` to this delegate method if you don't want to delay Apphud Screen presentation.
 
-        If you returned `false`, this controller will be accessible in `Apphud.pendingScreen()` method. You will be able to present it manually later.
+        Controller will be kept in memory until you present it via `Apphud.showPendingScreen()` method. If you don't want to show screen at all, you should check `apphudShouldPerformRule` delegate method.
      */
-    @objc optional func apphudShouldShowScreen(controller: UIViewController) -> Bool
+    @objc optional func apphudShouldShowScreen(screenName: String) -> Bool
 
     /**
         Return `UIViewController` instance from which you want to present given Apphud controller. If you don't implement this method, then top visible viewcontroller from key window will be used.
@@ -100,7 +105,7 @@ public typealias ApphudBoolCallback = ((Bool) -> Void)
 /// List of available attribution providers
 @objc public enum ApphudAttributionProvider : Int {
     case appsFlyer
-    
+    case adjust
     /**
      Branch is implemented and doesn't require any additional code from Apphud SDK 
      More details: https://docs.apphud.com/integrations/attribution/branch
@@ -266,7 +271,7 @@ final public class Apphud: NSObject {
         * To migrate existing subsribers to Apphud. If you want your current subscribers to be tracked in Apphud, call this method once at the first launch.   
      - parameter callback: Required. Returns array of subscription (or subscriptions in case you more than one subscription group). Returns nil if user never purchased a subscription.
      */     
-    @objc public static func restoreSubscriptions(callback: @escaping ([ApphudSubscription]?) -> Void) {
+    @objc public static func restoreSubscriptions(callback: @escaping ([ApphudSubscription]?, Error?) -> Void) {
         ApphudInternal.shared.restoreSubscriptions(callback: callback)
     }
 
@@ -286,8 +291,10 @@ final public class Apphud: NSObject {
      */
     @objc public static func migrateSubscriptionsIfNeeded(callback: @escaping ([ApphudSubscription]?) -> Void) {
         if apphudShouldMigrate() {
-            ApphudInternal.shared.restoreSubscriptions { subscriptions in
-                apphudDidMigrate()
+            ApphudInternal.shared.restoreSubscriptions { (subscriptions, error) in
+                if error == nil {
+                    apphudDidMigrate()
+                }
                 callback(subscriptions)
             }
         } 

Sources/ApphudSDK/ApphudHttpClient.swift

@@ -165,15 +165,17 @@ public class ApphudHttpClient {
 
                     let code = httpResponse.statusCode
                     if code >= 200 && code < 300 {
-                        
-                        if data != nil {
-                            let stringResponse = String(data: data!, encoding: .utf8)
-                            apphudLog("Request \(method) \(request.url?.absoluteString ?? "") success with response: \n\(stringResponse ?? "")")
+                          
+                        if let dictionary = dictionary, 
+                            let json = try? JSONSerialization.data(withJSONObject: dictionary, options: .prettyPrinted),
+                            let string = String(data: json, encoding: .utf8){
+                            apphudLog("Request \(method) \(request.url?.absoluteString ?? "") success with response: \n\(string)")
                         }
+                        
                         callback?(true, dictionary, nil)
                         return
                     }
-                    apphudLog("Request \(method) \(request.url?.absoluteString ?? "") failed with code \(code), error: \(error?.localizedDescription ?? "") response: \(dictionary ?? [:])")
+                    apphudLog("Request \(method) \(request.url?.absoluteString ?? "") failed with code \(code), error: \(error?.localizedDescription ?? "") response: \(dictionary ?? [:])", forceDisplay: true)
                 }
 
                 callback?(false, nil, error)

Sources/ApphudSDK/ApphudInternal.swift

@@ -10,7 +10,7 @@ import Foundation
 import AdSupport
 import StoreKit
 
-let sdk_version = "0.8"
+let sdk_version = "0.8.5"
 
 @available(iOS 11.2, *)
 final class ApphudInternal {
@@ -41,7 +41,7 @@ final class ApphudInternal {
 
     private var submitReceiptCallback : ((Error?) -> Void)?
 
-    private var restoreSubscriptionCallback : (([ApphudSubscription]?) -> Void)?
+    private var restoreSubscriptionCallback : (([ApphudSubscription]?, Error?) -> Void)?
 
     private var allowInitialize = true
 
@@ -71,15 +71,22 @@ final class ApphudInternal {
         self.httpClient.apiKey = apiKey
 
         self.currentUser = ApphudUser.fromCache()
+        let userIDFromKeychain = ApphudKeychain.loadUserID()
 
         if userID != nil {
             self.currentUserID = userID!
         } else if let existingUserID = self.currentUser?.user_id {
             self.currentUserID = existingUserID
+        } else if userIDFromKeychain != nil{
+            self.currentUserID = userIDFromKeychain!
         } else {
             self.currentUserID = ApphudKeychain.generateUUID()
         }
 
+        if self.currentUserID != userIDFromKeychain {
+            ApphudKeychain.saveUserID(userID: self.currentUserID)
+        }
+        
         self.productsGroupsMap = fromUserDefaultsCache(key: "productsGroupsMap")
 
         continueToRegisteringUser()
@@ -147,6 +154,8 @@ final class ApphudInternal {
 
         let minCheckInterval :Double = 30
 
+        ApphudRulesManager.shared.handlePendingAPSInfo()
+        
         if Date().timeIntervalSince(lastCheckDate) >  minCheckInterval{
             self.checkForUnreadNotifications()
             self.refreshCurrentUser()
@@ -186,6 +195,7 @@ final class ApphudInternal {
         guard let userID = self.currentUser?.user_id else {return}        
         if self.currentUserID != userID {
             self.currentUserID = userID
+            ApphudKeychain.saveUserID(userID: self.currentUserID)
             if tellDelegate {
                 self.delegate?.apphudDidChangeUserID?(userID)
             }
@@ -349,7 +359,7 @@ final class ApphudInternal {
 
     //MARK:- Main Purchase and Submit Receipt methods
 
-    internal func restoreSubscriptions(callback: @escaping ([ApphudSubscription]?) -> Void) {
+    internal func restoreSubscriptions(callback: @escaping ([ApphudSubscription]?, Error?) -> Void) {
         self.restoreSubscriptionCallback = callback
         self.submitReceiptRestore(allowsReceiptRefresh: true)
     }
@@ -371,15 +381,15 @@ final class ApphudInternal {
                 ApphudStoreKitWrapper.shared.refreshReceipt()
             } else {
                 apphudLog("App Store receipt is missing on device and couldn't be refreshed.", forceDisplay: true)
-                self.restoreSubscriptionCallback?(nil)
+                self.restoreSubscriptionCallback?(nil, nil)
                 self.restoreSubscriptionCallback = nil
             }
             return 
         }
 
         let exist = performWhenUserRegistered { 
             self.submitReceipt(receiptString: receiptString, notifyDelegate: true) { error in
-                self.restoreSubscriptionCallback?(self.currentUser?.subscriptions)
+                self.restoreSubscriptionCallback?(self.currentUser?.subscriptions, error)
                 self.restoreSubscriptionCallback = nil
             }
         }
@@ -748,7 +758,9 @@ final class ApphudInternal {
             let params = ["device_id": self.currentDeviceID] as [String : String]
             self.httpClient.startRequest(path: "notifications", apiVersion: .v2, params: params, method: .get, callback: { (result, response, error) in
 
-                if result, let dataDict = response?["data"] as? [String : Any], let notifArray = dataDict["results"] as? [[String : Any]], let notifDict = notifArray.first, let ruleDict = notifDict["rule"] as? [String : Any] {
+                if result, let dataDict = response?["data"] as? [String : Any], let notifArray = dataDict["results"] as? [[String : Any]], let notifDict = notifArray.first, var ruleDict = notifDict["rule"] as? [String : Any] {
+                    let properties = notifDict["properties"] as? [String : Any]
+                    ruleDict = ruleDict.merging(properties ?? [:], uniquingKeysWith: {old, new in new})
                     let rule = ApphudRule(dictionary: ruleDict)
                     ApphudRulesManager.shared.handleRule(rule: rule)
                 }
@@ -777,6 +789,8 @@ final class ApphudInternal {
                 }   
                 params["appsflyer_id"] = identifer
                 params["appsflyer_data"] = data
+            } else if provider == .adjust {
+                params["adjust_data"] = data
             }
 
             self.httpClient.startRequest(path: "customers/attribution", params: params, method: .post) { (result, response, error) in

Sources/ApphudSDK/ApphudKeychain.swift

@@ -13,6 +13,7 @@ import Security
 let userAccount = "ApphudUser"
 let accessGroup = "SecuritySerivice"
 let deviceIdKey : NSString = "ApphudDeviceID"
+let userIdKey : NSString = "ApphudUserID"
 
 // Arguments for the keychain queries
 let kSecClassValue = NSString(format: kSecClass)
@@ -39,6 +40,14 @@ internal class ApphudKeychain: NSObject {
         self.save(deviceIdKey, data: deviceID)
     }
 
+    internal class func loadUserID() -> String? {
+        return self.load(userIdKey)
+    }
+    
+    internal class func saveUserID(userID : String) {
+        self.save(userIdKey, data: userID)
+    }    
+    
     private class func save(_ service: NSString, data: String) {
         if let dataFromString = data.data(using: .utf8, allowLossyConversion: false) {
 

Sources/ApphudSDK/ApphudRule.swift

@@ -8,11 +8,27 @@
 
 import UIKit
 
-struct ApphudRule {    
-    var id: String
-    var screen_id: String
-    init(dictionary: [String : Any]) {
+public class ApphudRule: NSObject {    
+        
+    /**
+     Rule name that is visible in Apphud Rules dashboard
+     */
+    @objc public let rule_name: String 
+    /**
+     Screen name that is visible in Apphud Screens dashboard
+     */
+    @objc public let screen_name: String
+    
+    internal let id: String
+    internal let screen_id: String
+
+    // MARK:- Private methods
+    
+    /// Subscription private initializer
+    init(dictionary : [String : Any]) {
         id = dictionary["id"] as? String ?? ""
         screen_id = dictionary["screen_id"] as? String ?? ""
+        rule_name = dictionary["rule_name"] as? String ?? ""
+        screen_name = dictionary["screen_name"] as? String ?? ""
     }
 }

Sources/ApphudSDK/ApphudUI/ApphudRulesManager.swift

@@ -18,6 +18,8 @@ internal class ApphudRulesManager {
 
     private var handledRules = [String]()
 
+    private var apsInfo : [AnyHashable : Any]?
+    
     @discardableResult internal func handleNotification(_ apsInfo: [AnyHashable : Any]) -> Bool{
 
         guard let rule_id = apsInfo["rule_id"] as? String else {
@@ -28,25 +30,42 @@ internal class ApphudRulesManager {
             return true
         }
 
-        apphudLog("handle APS: \(apsInfo as AnyObject)")
+        self.apsInfo = apsInfo
+        self.handledRules.append(rule_id)
+        
+        if UIApplication.shared.applicationState == .active {
+            self.handlePendingAPSInfo()
+        } else {
+            // do nothing, because ApphudInternal will call once app is active
+            apphudLog("Got APS info, but app is not yet active, waiting for app to be active, then will handle push notification.")
+        }
+        
+        return true    
+    }
+
+    @objc internal func handlePendingAPSInfo(){
+        
+        guard let rule_id = apsInfo?["rule_id"] as? String else {
+            return
+        }
+        
+        apphudLog("handle push notification: \(apsInfo as AnyObject)")
 
         ApphudInternal.shared.trackEvent(params: ["rule_id" : rule_id, "name" : "$push_opened"]) {}
 
-        if let screen_id = apsInfo["screen_id"] as? String {
-            handleRule(ruleID: rule_id, screenID: screen_id)            
+        if apsInfo?["screen_id"] != nil {
+            handleRule(ruleID: rule_id, data: apsInfo as? [String : Any])            
         }
 
-        handledRules.append(rule_id)
+        self.apsInfo = nil
         // allow handling the same push notification rule after 5 seconds. This is needed for testing rules from Apphud dashboard
         DispatchQueue.main.asyncAfter(deadline: .now() + 5) { 
             self.handledRules.removeAll()
         }
-        
-        return true    
     }
 
-    internal func handleRule(ruleID: String, screenID: String){
-        let dict = ["id" : ruleID, "screen_id" : screenID]
+    internal func handleRule(ruleID: String, data: [String : Any]?){
+        let dict = ["id" : ruleID].merging(data ?? [:], uniquingKeysWith: {old, new in new})
         let rule = ApphudRule(dictionary: dict)
         self.handleRule(rule: rule)
     }
@@ -55,6 +74,10 @@ internal class ApphudRulesManager {
 
         guard self.pendingController == nil else { return }
         guard rule.screen_id.count > 0 else { return }
+        guard ApphudInternal.shared.uiDelegate?.apphudShouldPerformRule?(rule: rule) ?? true else { 
+            apphudLog("apphudShouldPerformRule returned false for rule \(rule.rule_name), exiting")
+            return 
+        }
 
         let controller = ApphudScreenController(rule: rule, screenID: rule.screen_id) {_ in}
         controller.loadScreenPage()
@@ -63,8 +86,10 @@ internal class ApphudRulesManager {
         nc.setNavigationBarHidden(true, animated: false)
         self.pendingController = nc
 
-        if ApphudInternal.shared.uiDelegate?.apphudShouldShowScreen?(controller: nc) ?? true {
+        if ApphudInternal.shared.uiDelegate?.apphudShouldShowScreen?(screenName: rule.screen_name) ?? true {
              showPendingScreen()
+        } else {
+            apphudLog("apphudShouldShowScreen returned false for screen \(rule.screen_name), exiting")
         }
     }
 

Sources/ApphudSDK/ApphudUI/ApphudScreenController.swift

@@ -374,7 +374,7 @@ class ApphudScreenController: UIViewController{
                 isPurchasing = true
                 self.startLoading()
 
-                ApphudInternal.shared.uiDelegate?.apphudWillPurchase?(product: product, offerID: offerID!, screenName: self.screen?.name ?? "unknown")
+                ApphudInternal.shared.uiDelegate?.apphudWillPurchase?(product: product, offerID: offerID!, screenName: self.rule.screen_name)
 
                 ApphudInternal.shared.purchasePromo(product: product, discountID: offerID!) { (subscription, transaction, error) in
                     self.handlePurchaseResult(product: product, offerID: offerID!, subscription: subscription, transaction: transaction, error: error)                    
@@ -390,7 +390,7 @@ class ApphudScreenController: UIViewController{
             isPurchasing = true
             self.startLoading()
 
-            ApphudInternal.shared.uiDelegate?.apphudWillPurchase?(product: product, offerID: nil, screenName: self.screen?.name ?? "unknown")
+            ApphudInternal.shared.uiDelegate?.apphudWillPurchase?(product: product, offerID: nil, screenName: self.rule.screen_name)
 
             ApphudInternal.shared.purchase(product: product) { (subscription, transaction, error) in
                 self.handlePurchaseResult(product: product, subscription: subscription, transaction: transaction, error: error)
@@ -425,7 +425,7 @@ class ApphudScreenController: UIViewController{
 
     private func restoreTapped(){
         self.startLoading()
-        Apphud.restoreSubscriptions { subscriptions in
+        Apphud.restoreSubscriptions { subscriptions, error in
             self.stopLoading()
             if subscriptions?.first?.isActive() ?? false {
                 self.dismiss()
@@ -642,7 +642,7 @@ extension ApphudScreenController {
 
             ApphudInternal.shared.trackEvent(params: params) {}
 
-            ApphudInternal.shared.uiDelegate?.apphudDidPurchase?(product: product, offerID: offerID, screenName: self.screen?.name ?? "unknown")
+            ApphudInternal.shared.uiDelegate?.apphudDidPurchase?(product: product, offerID: offerID, screenName: self.rule.screen_name)
 
             dismiss() // dismiss only when purchase is successful
 
@@ -653,10 +653,10 @@ extension ApphudScreenController {
             // if error occurred, restore subscriptions
             if !(errorCode == .paymentCancelled) {
                 // maybe remove?
-                Apphud.restoreSubscriptions { subscriptions in }
+                Apphud.restoreSubscriptions { subscriptions, error  in }
             }
 
-            ApphudInternal.shared.uiDelegate?.apphudDidFailPurchase?(product: product, offerID: offerID, errorCode: errorCode, screenName: self.screen?.name ?? "unknown")
+            ApphudInternal.shared.uiDelegate?.apphudDidFailPurchase?(product: product, offerID: offerID, errorCode: errorCode, screenName: self.rule.screen_name)
         }
     }