Non renewing purchases support (#14)

* Support for consumable, non-consumable and non-renewing subscription in-app purchases.
* Apple Search Ads attribution support
* Added many new methods to SDK.
* Added new class `ApphudNonRenewingPurchase` which contains product identifier, purchase date and and optional cancellation date.
* Apphud SDK now tries to re-register user and re-fetch products when application becomes active if there were errors on app launch; for example, if there was no Internet connection.

Author: ren6

.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata

@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'ApphudSDK'
-  s.version          = '0.8.5'
+  s.version          = '0.9.0'
   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'

ApphudSDK.podspec

@@ -20,12 +20,15 @@ public typealias ApphudBoolCallback = ((Bool) -> Void)
     /**
         Returns array of subscriptions that user ever purchased. Empty array means user never purchased a subscription. If you have just one subscription group in your app, you will always receive just one subscription in an array.
 
-        This method is called when any subscription in an array has been changed (for example, status changed from `trial` to `expired`).
-     
-        In most cases you don't need this method because you already have completion blocks in `purchase`, `purchasePromo` and `submitReceipt` methods. However this method may be useful to detect whether subscription was purchased in Apphud's puchase screen.
+        This method is called when subscription is purchased or updated (for example, status changed from `trial` to `expired` or `isAutorenewEnabled` changed to `false`). SDK also checks for subscription updates when app becomes active.
      */
     @objc optional func apphudSubscriptionsUpdated(_ subscriptions: [ApphudSubscription])
 
+    /**
+        Called when any of non renewing purchases changes. Called when purchase is made or has been refunded.
+     */
+    @objc optional func apphudNonRenewingPurchasesUpdated(_ purchases: [ApphudNonRenewingPurchase])
+    
     /**
         Called when user ID has been changed. Use this if you implement integrations with Analytics services.
 
@@ -46,7 +49,7 @@ public typealias ApphudBoolCallback = ((Bool) -> Void)
     /**
         Returns array of `SKProduct` objects after they are fetched from StoreKit. Note that you have to add all product identifiers in Apphud.
 
-        You can use this delegate method or observe for `Apphud.didFetchProductsNotification()` notification. 
+        You can use `productsDidFetchCallback` callback or observe for `didFetchProductsNotification()` or implement `apphudDidFetchStoreKitProducts` delegate method. Use whatever you like most. 
      */
     @objc optional func apphudDidFetchStoreKitProducts(_ products: [SKProduct])
 }
@@ -106,6 +109,7 @@ public typealias ApphudBoolCallback = ((Bool) -> Void)
 @objc public enum ApphudAttributionProvider : Int {
     case appsFlyer
     case adjust
+    case appleSearchAds
     /**
      Branch is implemented and doesn't require any additional code from Apphud SDK 
      More details: https://docs.apphud.com/integrations/attribution/branch
@@ -167,16 +171,34 @@ final public class Apphud: NSObject {
     /**
      This notification is sent when SKProducts are fetched from StoreKit. Note that you have to add all product identifiers in Apphud.
 
-     You can observe for this notification or implement `apphudDidFetchStoreKitProducts` delegate method.
+     You can use `productsDidFetchCallback` callback or observe for `didFetchProductsNotification()` or implement `apphudDidFetchStoreKitProducts` delegate method. Use whatever you like most.
      */
     @objc public static func didFetchProductsNotification() -> Notification.Name {
         return Notification.Name("ApphudDidFetchProductsNotification")
     }
 
+    /**
+    This callback is called when SKProducts are fetched from StoreKit. Note that you have to add all product identifiers in Apphud.
+    
+    You can use `productsDidFetchCallback` callback or observe for `didFetchProductsNotification()` or implement `apphudDidFetchStoreKitProducts` delegate method. Use whatever you like most.
+    */
+    @objc public static func productsDidFetchCallback(_ callback: @escaping ([SKProduct]) -> Void) {
+        ApphudStoreKitWrapper.shared.customProductsFetchedBlock = callback
+    }
+    
+    /**
+    Refreshes SKProducts from the App Store. You have to add all product identifiers in Apphud. 
+     
+     __Note__: You shouldn't call this method at app launch, because Apphud SDK automatically fetches products during initialization. Only use this method as a fallback.
+     */
+    @objc public static func refreshStoreKitProducts(_ callback: (([SKProduct]) -> Void)?) {
+        ApphudInternal.shared.refreshStoreKitProductsWithCallback(callback: callback)
+    }
+    
     /**
      Returns array of `SKProduct` objects that you added in Apphud. 
 
-     Note that this method will return `nil` if products are not yet fetched. You should observe for `Apphud.didFetchProductsNotification()` notification or implement  `apphudDidFetchStoreKitProducts` delegate method.
+     Note that this method will return `nil` if products are not yet fetched. You should observe for `Apphud.didFetchProductsNotification()` notification or implement  `apphudDidFetchStoreKitProducts` delegate method or set `productsDidFetchCallback` block.
      */
     @objc public static func products() -> [SKProduct]? {
         guard ApphudStoreKitWrapper.shared.products.count > 0 else {
@@ -188,7 +210,7 @@ final public class Apphud: NSObject {
     /**
      Returns `SKProduct` object by product identifier. Note that you have to add this product identifier in Apphud.
 
-     Will retun `nil` if product is not yet fetched from StoreKit.
+     Will return `nil` if product is not yet fetched from StoreKit.
      */
     @objc public static func product(productIdentifier : String) -> SKProduct? {
         return ApphudStoreKitWrapper.shared.products.first(where: {$0.productIdentifier == productIdentifier})
@@ -197,38 +219,42 @@ final public class Apphud: NSObject {
     /**
      Purchases product and automatically submits App Store Receipt to Apphud.
 
-     __Note__: This method automatically sends in-app purchase receipt to Apphud, so you don't need to call `submitReceipt` method.    
+     __Note__:  You are not required to purchase product using Apphud SDK methods. You can purchase subscription or any in-app purchase using your own code. App Store receipt will be sent to Apphud anyway.
 
-     - parameter product: Required. This is an `SKProduct` object that user wants to purchase.
-     - parameter callback: Optional. Returns `ApphudSubscription` object if succeeded and an optional error otherwise.
+     - parameter product: Required. This is an `SKProduct` object that user wants to purchase. 
+     - parameter callback: Optional. Returns `ApphudPurchaseResult` object.
      */
-    @objc public static func purchase(_ product: SKProduct, callback: ((ApphudSubscription?, Error?) -> Void)?){
+    @objc public static func purchase(_ product: SKProduct, callback: ((ApphudPurchaseResult) -> Void)?){
         ApphudInternal.shared.purchase(product: product, callback: callback)
     }
 
+    /**
+    Purchases product and automatically submits App Store Receipt to Apphud. This method doesn't wait until Apphud validates receipt from Apple and immediately returns transaction object. This method may be useful if you don't care about receipt validation in callback. 
+    
+     __Note__:  You are not required to purchase product using Apphud SDK methods. You can purchase subscription or any in-app purchase using your own code. App Store receipt will be sent to Apphud anyway.
+     
+    - parameter product: Required. This is an `SKProduct` object that user wants to purchase.
+    - parameter callback: Optional. Returns optional `SKPaymentTransaction` object and an optional error.
+    */
+    @objc public static func purchaseWithoutValidation(_ product: SKProduct,  callback: ((SKPaymentTransaction, Error?) -> Void)?){
+        ApphudInternal.shared.purchaseWithoutValidation(product: product, callback: callback)
+    }
+    
     /**
         Purchases subscription (promotional) offer and automatically submits App Store Receipt to Apphud. 
 
         __Note__: This method automatically sends in-app purchase receipt to Apphud, so you don't need to call `submitReceipt` method.    
 
         - parameter product: Required. This is an `SKProduct` object that user wants to purchase.
         - parameter discountID: Required. This is a `SKProductDiscount` Identifier String object that you would like to apply.
-        - parameter callback: Optional. Returns `ApphudSubscription` object if succeeded and an optional error otherwise.
+        - parameter callback: Optional. Returns `ApphudPurchaseResult` object.
      */
     @available(iOS 12.2, *)
-    @objc public static func purchasePromo(_ product: SKProduct, discountID: String, _ callback: ((ApphudSubscription?, Error?) -> Void)?){
+    @objc public static func purchasePromo(_ product: SKProduct, discountID: String, _ callback: ((ApphudPurchaseResult) -> Void)?){
         ApphudInternal.shared.purchasePromo(product: product, discountID: discountID, callback: callback)
     }
 
-    /**
-         __Deprecated__. Starting now Apphud SDK automatically tracks all your in-app purchases and submits App Store receipt to Apphud. You can safely remove this method from your code. If you were using callback, you can use `apphudSubscriptionsUpdated` delegate method instead.
-     */
-    @available(*, deprecated, message: "Starting now Apphud SDK automatically tracks all your in-app purchases and submits App Store receipt to Apphud. You can safely remove this method from your code. If you were using callback, you can use `apphudSubscriptionsUpdated` delegate method instead.")
-    @objc public static func submitReceipt(_ productIdentifier : String, _ callback : ((ApphudSubscription?, Error?) -> Void)?) {
-        ApphudInternal.shared.submitReceipt(productId: productIdentifier, callback: callback)        
-    }
-    
-    //MARK:- Handle Subscriptions
+    //MARK:- Handle Purchases
 
     /**
         Returns true if user has active subscription.
@@ -261,6 +287,22 @@ final public class Apphud: NSObject {
         return ApphudInternal.shared.currentUser?.subscriptions
     }
 
+    /**
+     Returns an array of all standard in-app purchases (consumables, nonconsumables or nonrenewing subscriptions) that this user has ever purchased. Purchases are cached on device. This array is sorted by purchase date. Apphud only tracks consumables if they were purchased after integrating Apphud SDK.
+     */
+    @objc public static func nonRenewingPurchases() -> [ApphudNonRenewingPurchase]? {
+        return ApphudInternal.shared.currentUser?.purchases
+    }
+    
+    /**
+     Returns `true` if current user has purchased standard in-app purchase with given product identifier. Returns `false` if this product is refunded or never purchased. Includes consumables, nonconsumables or non-renewing subscriptions. Apphud only tracks consumables if they were purchased after integrating Apphud SDK.
+     
+     __Note__: Purchases are sorted by purchase date, so it returns Bool value for the most recent purchase by given product identifier.
+     */
+    @objc public static func isNonRenewingPurchaseActive(productIdentifier : String) -> Bool {
+        return ApphudInternal.shared.currentUser?.purchases.first(where: {$0.productId == productIdentifier})?.isActive() ?? false
+    }
+    
     /**
      Implements `Restore Purchases` mechanism. Basically it just sends current App Store Receipt to Apphud and returns subscriptions info.
 
@@ -269,33 +311,33 @@ final public class Apphud: NSObject {
      You should use this method in 2 cases:
         * Upon tap on `Restore Purchases` button in your UI.
         * 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.
+     - parameter callback: Required. Returns array of subscription (or subscriptions in case you have more than one subscription group), array of standard in-app purchases and an error. All of three parameters are optional.
      */     
-    @objc public static func restoreSubscriptions(callback: @escaping ([ApphudSubscription]?, Error?) -> Void) {
-        ApphudInternal.shared.restoreSubscriptions(callback: callback)
+    @objc public static func restorePurchases(callback: @escaping ([ApphudSubscription]?, [ApphudNonRenewingPurchase]?, Error?) -> Void) {
+        ApphudInternal.shared.restorePurchases(callback: callback)
     }
 
     /**
-     If you already have a live app with paying users and you want Apphud to track their subscriptions, you should import their App Store receipts into Apphud. Call this method at launch of your app for your paying users. This method should be used only to migrate existing paying users that are not yet tracked by Apphud.
+     If you already have a live app with paying users and you want Apphud to track their purchases, you should import their App Store receipts into Apphud. Call this method at launch of your app for your paying users. This method should be used only to migrate existing paying users that are not yet tracked by Apphud.
 
      Example:
 
         ````
         // hasPurchases - is your own boolean value indicating that current user is paying user.
         if hasPurchases {
-            Apphud.migrateSubscriptionsIfNeeded {_ in}
+            Apphud.migratePurchasesIfNeeded { _, _, _ in}
         }
         ````
 
     __Note__: You can remove this method after a some period of time, i.e. when you are sure that all paying users are already synced with Apphud.
      */
-    @objc public static func migrateSubscriptionsIfNeeded(callback: @escaping ([ApphudSubscription]?) -> Void) {
+    @objc public static func migratePurchasesIfNeeded(callback: @escaping ([ApphudSubscription]?, [ApphudNonRenewingPurchase]?, Error?) -> Void) {
         if apphudShouldMigrate() {
-            ApphudInternal.shared.restoreSubscriptions { (subscriptions, error) in
+            ApphudInternal.shared.restorePurchases { (subscriptions, purchases, error) in
                 if error == nil {
                     apphudDidMigrate()
                 }
-                callback(subscriptions)
+                callback(subscriptions, purchases, error)
             }
         } 
     }
@@ -409,6 +451,20 @@ final public class Apphud: NSObject {
         ApphudUtils.enableDebugLogs()
     }
 
+    /**
+     Automatically finishes all pending transactions. By default, Apphud SDK only finishes transactions, that were started by Apphud SDK, i.e. by calling  any of `Apphud.purchase..()` methods.
+    
+     However, when you debug in-app purchases and/or change Apple ID too often, some transactions may stay in the queue (for example, if you broke execution until transaction is finished). And these transactions will try to finish at every next app launch. In this case you may see a system alert prompting to enter your Apple ID password. To fix this annoying issue, you can add this method.
+     
+     You may also use this method in production if you don't care about handling pending transactions, for example, downloading Apple hosted content.
+     For more information read "Finish the transaction" paragraph here: https://developer.apple.com/library/archive/technotes/tn2387/_index.html
+     
+     __Note__: Only use this method if you know what you are doing. Must be called before Apphud SDK initialization.
+     */
+    @objc public static func setFinishAllTransactions(){
+        ApphudUtils.shared.finishTransactions = true
+    }
+    
     /**
         This method must be called before SDK initialization. Apphud will send all subscription events of current user to your test analytics, if test api keys are set in integrations dashboard.
      */

Sources/ApphudSDK/Apphud.swift

@@ -8,7 +8,7 @@
 
 import Foundation
 
-typealias ApphudBoolDictionaryCallback = (Bool, [String : Any]?, Error?) -> Void
+typealias ApphudHTTPResponseCallback = (Bool, [String : Any]?, Error?, Int) -> Void
 typealias ApphudStringCallback = (String?, Error?) -> Void
 /**
  This is Apphud's internal class.
@@ -44,7 +44,7 @@ public class ApphudHttpClient {
         return URLSession.init(configuration: config)
     }()
 
-    internal func startRequest(path: String, apiVersion: ApphudApiVersion = .v1, params: [String : Any]?, method: ApphudHttpMethod, callback: ApphudBoolDictionaryCallback?) {
+    internal func startRequest(path: String, apiVersion: ApphudApiVersion = .v1, params: [String : Any]?, method: ApphudHttpMethod, callback: ApphudHTTPResponseCallback?) {
         if let request = makeRequest(path: path, apiVersion: apiVersion, params: params, method: method) {
             start(request: request, callback: callback)
         }
@@ -145,7 +145,7 @@ public class ApphudHttpClient {
         task.resume()
     }
 
-    private func start(request: URLRequest, callback: ApphudBoolDictionaryCallback?){
+    private func start(request: URLRequest, callback: ApphudHTTPResponseCallback?){
         let task = session.dataTask(with: request) { (data, response, error) in
 
             var dictionary: [String : Any]?
@@ -172,15 +172,15 @@ public class ApphudHttpClient {
                             apphudLog("Request \(method) \(request.url?.absoluteString ?? "") success with response: \n\(string)")
                         }
 
-                        callback?(true, dictionary, nil)
+                        callback?(true, dictionary, nil, code)
                         return
                     }
                     apphudLog("Request \(method) \(request.url?.absoluteString ?? "") failed with code \(code), error: \(error?.localizedDescription ?? "") response: \(dictionary ?? [:])", forceDisplay: true)
+                    callback?(false, nil, error, code)
+                } else {
+                    callback?(false, nil, error, 0)
                 }
-                
-                callback?(false, nil, error)
-            }
-            
+            }            
         }
         task.resume()
     }