Merge pull request #23 from chargebee/dev_v1.0.2

Dev v1.0.2- changes 1.Made customerID optional 2.SDK key changes 3.Price - decimal change 4.Improved instrumentation
chargebee · Dec 16, 2021 · 358937f · 358937f
2 parents 381a9db + a0375cd
commit 358937f
Show file tree

Hide file tree

Showing 15 changed files with 71 additions and 57 deletions.
diff --git a/Chargebee.podspec b/Chargebee.podspec
@@ -8,7 +8,7 @@
 
 Pod::Spec.new do |s|
   s.name             = 'Chargebee'
-  s.version          = '1.0.1'
+  s.version          = '1.0.2'
   s.summary          = 'Chargebee iOS SDK'
 
 # This description is used to generate tags and improve search results.

diff --git a/Chargebee/Classes/Authentication/CBAuthenticationResource.swift b/Chargebee/Classes/Authentication/CBAuthenticationResource.swift
@@ -37,7 +37,8 @@ final class CBAuthenticationResource: CBAPIResource {
             urlRequest.httpBody = bodyComponents.query?.data(using: .utf8)
             urlRequest.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")
             urlRequest.addValue(authHeader!, forHTTPHeaderField: "Authorization")
-
+            urlRequest.addValue(sdkVersion, forHTTPHeaderField: "version")
+            urlRequest.addValue(platform, forHTTPHeaderField: "platform")
             return urlRequest
         }
     }

diff --git a/Chargebee/Classes/Configuration/CBEnvironment.swift b/Chargebee/Classes/Configuration/CBEnvironment.swift
@@ -6,18 +6,18 @@ import Foundation
 
 class CBEnvironment {
     static var site: String = ""
-    static var publishableApiKey: String = ""
+    static var apiKey: String = ""
     static var encodedApiKey: String = ""
     static var baseUrl: String = ""
     static var allowErrorLogging: Bool = true
     static var sdkKey : String = ""
     static var version : CatalogVersion = .unknown
 
-    static func configure(site: String, publishableApiKey: String, allowErrorLogging: Bool, sdkKey: String? = nil) {
+    static func configure(site: String, apiKey: String, allowErrorLogging: Bool, sdkKey: String? = nil) {
         CBEnvironment.site = site
-        CBEnvironment.publishableApiKey = publishableApiKey
+        CBEnvironment.apiKey = apiKey
         CBEnvironment.allowErrorLogging = allowErrorLogging
-        CBEnvironment.encodedApiKey = CBEnvironment.publishableApiKey.data(using: .utf8)?.base64EncodedString() ?? ""
+        CBEnvironment.encodedApiKey = CBEnvironment.apiKey.data(using: .utf8)?.base64EncodedString() ?? ""
         CBEnvironment.baseUrl = "https://\(CBEnvironment.site).chargebee.com/api"
         CBEnvironment.version = .unknown
 

diff --git a/Chargebee/Classes/Configuration/Chargebee.swift b/Chargebee/Classes/Configuration/Chargebee.swift
@@ -9,7 +9,7 @@ public class Chargebee {
     public init() {
     }
 
-    public static func configure(site: String, publishableApiKey: String, sdkKey: String? = nil, allowErrorLogging: Bool = true) {
-        CBEnvironment.configure(site: site, publishableApiKey: publishableApiKey, allowErrorLogging: allowErrorLogging, sdkKey: sdkKey)
+    public static func configure(site: String, apiKey: String, sdkKey: String? = nil, allowErrorLogging: Bool = true) {
+        CBEnvironment.configure(site: site, apiKey: apiKey, allowErrorLogging: allowErrorLogging, sdkKey: sdkKey)
     }
 }
diff --git a/Chargebee/Classes/Network/CBAPIRequest.swift b/Chargebee/Classes/Network/CBAPIRequest.swift
@@ -73,6 +73,8 @@ extension CBAPIResource {
         header?.forEach({ (key, value) in
             urlRequest.addValue(value, forHTTPHeaderField: key)
         })
+        urlRequest.addValue(sdkVersion, forHTTPHeaderField: "version")
+        urlRequest.addValue(platform, forHTTPHeaderField: "platform")
         return urlRequest
     }
 }

diff --git a/Chargebee/Classes/Purchase/CBPurchaseManager.swift b/Chargebee/Classes/Purchase/CBPurchaseManager.swift
@@ -118,10 +118,10 @@ public extension CBPurchase {
 
 
     //Buy the product
-    func purchaseProduct(product: CBProduct, customerId : String ,completion handler: @escaping ((_ result: Result<(status:Bool, subscription:CBSubscriptionStatus?), Error>) -> Void)) {
+    func purchaseProduct(product: CBProduct, customerId : String? = "" ,completion handler: @escaping ((_ result: Result<(status:Bool, subscription:CBSubscriptionStatus?), Error>) -> Void)) {
         buyProductHandler = handler
         activeProduct = product.product
-        customerID = customerId
+        customerID = customerId ?? ""
         guard CBAuthenticationManager.isSDKKeyPresent() else {
             handler(.failure(CBPurchaseError.cannotMakePayments))
             return
@@ -192,11 +192,9 @@ extension CBPurchase: SKPaymentTransactionObserver {
             case .purchased:
                 SKPaymentQueue.default().finishTransaction(transaction)
                 if let productId = activeProduct?.productIdentifier,
-                   let price = activeProduct?.price,
-                   let currencyCode = activeProduct?.priceLocale.currencyCode {
-                   let priceValue : Int = Int((price.doubleValue) * Double(100))
-                   let name = activeProduct?.localizedTitle ?? productId
-                    validateReceipt(for: productId, name: name, String(priceValue), currencyCode: currencyCode, customerId:customerID,completion: buyProductHandler)
+                   let currencyCode = activeProduct?.priceLocale.currencyCode,
+                   let price = activeProduct?.price {
+                    validateReceipt(for: productId, name: activeProduct?.localizedTitle ?? productId, "\(price)", currencyCode: currencyCode, customerId:customerID,completion: buyProductHandler)
                 }
             case .restored:
                 restoredPurchasesCount += 1
@@ -247,7 +245,7 @@ public extension CBPurchase {
 //            print("Receipt String is :\(receiptString)")
             debugPrint("Apple Purchase - success")
 
-            CBReceiptValidationManager.validateReceipt(receipt: receiptString, productId: productID,name: name, price: price, currencyCode: currencyCode, customerId: customerID ) {
+            CBReceiptValidationManager.validateReceipt(receipt: receiptString, productId: productID, name: name, price: price, currencyCode: currencyCode, customerId: customerID ) {
                 (receiptResult) in DispatchQueue.main.async {
                     switch receiptResult {
                     case .success(let receipt):

diff --git a/Chargebee/Classes/ReceiptValidation/CBReceiptValidationManager.swift b/Chargebee/Classes/ReceiptValidation/CBReceiptValidationManager.swift
@@ -29,17 +29,16 @@ class CBReceiptValidationManager {
                                        name: String,
                                        price: String,
                                        currencyCode : String,
-                                       customerId : String,
+                                       customerId : String? = "",
                                        completion handler: @escaping CBValidateReceiptHandler) {
         let logger = CBLogger(name: "buy", action: "process_purchase_command")
         logger.info()
 
 
         let (onSuccess, onError) = CBResult.buildResultHandlers(handler,nil)
-
         let request = CBAPIRequest(resource: CBValidateReceiptResource(receipt: receipt, productId: productId,name: name,
                                                                      price: price, currencyCode : currencyCode,
-                                                                     customerId : customerId))
+                                                                     customerId : customerId ?? ""))
         request.create(withCompletion: { (res: CBValidateReceiptWrapper?) in
             onSuccess(res!.inAppSubscription)
         }, onError: onError)

diff --git a/Chargebee/Classes/ReceiptValidation/CBValidateReceiptResource.swift b/Chargebee/Classes/ReceiptValidation/CBValidateReceiptResource.swift
@@ -35,6 +35,8 @@ class CBValidateReceiptResource: CBAPIResource {
         header?.forEach({ (key, value) in
             urlRequest.addValue(value, forHTTPHeaderField: key)
         })
+        urlRequest.addValue(sdkVersion, forHTTPHeaderField: "version")
+        urlRequest.addValue(platform, forHTTPHeaderField: "platform")
         return urlRequest
     }
 
@@ -48,14 +50,16 @@ class CBValidateReceiptResource: CBAPIResource {
         urlRequest.httpMethod = "post"
         urlRequest.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")
         var bodyComponents = URLComponents()
-        bodyComponents.queryItems = requestBody?.toFormBody().map({ (key, value) -> URLQueryItem in
-          URLQueryItem(name: key,
-                 value: value.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed)!.replacingOccurrences(of: "+", with: "%2B"))
-        })
-
+        let bodyData = requestBody?.toFormBody().filter({!$0.value.isEmpty})
+        if let data = bodyData {
+            bodyComponents.queryItems = data.compactMap({ (key, value) -> URLQueryItem in
+                URLQueryItem(name: key,
+                             value: value.addingPercentEncoding(withAllowedCharacters: .urlQueryAllowed)!.replacingOccurrences(of: "+", with: "%2B"))
+            })
+        }
         urlRequest.httpBody = bodyComponents.query?.data(using: .utf8)
         return urlRequest
-      }
+    }
 
     init(receipt: String, productId: String, name: String,
          price: String, currencyCode : String,
@@ -75,17 +79,15 @@ struct PayloadBody: URLEncodedRequestBody {
     let price: String
     let currencyCode : String
     let customerId : String
-    let channel : String = "app_store"
 
     func toFormBody() -> [String: String] {
         [
             "receipt" : receipt,
             "product[id]" : productId,
             "product[name]": name,
-            "product[price]" :price,
+            "product[price_in_decimal]" :price,
             "product[currency_code]" :currencyCode,
-            "customer[id]" :customerId,
-            "channel": channel
+            "customer[id]" :customerId
         ]
     }
 }

diff --git a/Chargebee/Classes/Subscription/CBSubscription.swift b/Chargebee/Classes/Subscription/CBSubscription.swift
@@ -16,12 +16,18 @@ public struct CBSubscriptionData: Codable {
     public let activatedAt: Double?
     public let status: String?
     public let planAmount: Double?
-
-
+    public let id: String?
+    public let currentTermEnd: Double?
+    public let currentTermStart: Double?
+
     enum CodingKeys: String, CodingKey  {
         case activatedAt = "activated_at"
         case status
+        case id
         case planAmount = "plan_amount"
+        case currentTermEnd = "current_term_end"
+        case currentTermStart = "current_term_start"
+
     }
 }
 

diff --git a/Chargebee/Classes/Subscription/CBSubscriptionResource.swift b/Chargebee/Classes/Subscription/CBSubscriptionResource.swift
@@ -34,6 +34,8 @@ final class CBSubscriptionResource: CBAPIResource {
             urlRequest.addValue(authHeader!, forHTTPHeaderField: "Authorization")
             urlRequest.addValue("application/json; charset=utf-8", forHTTPHeaderField: "Content-Type")
             urlRequest.addValue("application/json; charset=utf-8", forHTTPHeaderField: "Accept")
+            urlRequest.addValue(sdkVersion, forHTTPHeaderField: "version")
+            urlRequest.addValue(platform, forHTTPHeaderField: "platform")
             return urlRequest
         }
     }

diff --git a/Chargebee/Classes/Token/CBPaymentConfigResource.swift b/Chargebee/Classes/Token/CBPaymentConfigResource.swift
@@ -11,7 +11,7 @@ final class CBPaymentConfigResource: CBAPIResource {
     var baseUrl: String
     var authHeader: String? {
         get {
-            "Basic \(CBEnvironment.publishableApiKey)"
+            "Basic \(CBEnvironment.apiKey)"
         }
     }
     var methodPath: String = "/internal/component/retrieve_config"

diff --git a/Example/Chargebee/AppDelegate.swift b/Example/Chargebee/AppDelegate.swift
@@ -19,7 +19,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         // Override point for customization after application
 
         Chargebee.configure(site: "Site Name",
-                            publishableApiKey: "API Key",sdkKey: "ResourceID/SDK Key")
+                            apiKey: "API Key- (full Access)",sdkKey: "ResourceID/SDK Key")
        return true
     }
 }
diff --git a/Example/Chargebee/CBSDKConfigurationViewController.swift b/Example/Chargebee/CBSDKConfigurationViewController.swift
@@ -44,7 +44,7 @@ final class CBSDKConfigurationViewController: UIViewController {
     @IBAction private func initializeClicked(_ sender: UIButton) {
 //        guard canInitialise() else { return }
         Chargebee.configure(site: siteNameTextField.unwrappedText,
-                            publishableApiKey: apiKeyTextField.unwrappedText,
+                            apiKey: apiKeyTextField.unwrappedText,
                             sdkKey: sdkKeyTextField.unwrappedText,
                             allowErrorLogging: true)
         }

diff --git a/Example/Pods/Target Support Files/Chargebee/Chargebee-Info.plist b/Example/Pods/Target Support Files/Chargebee/Chargebee-Info.plist
diff --git a/README.md b/README.md
@@ -40,19 +40,19 @@ You can initialize the SDK during your app startup by including the following in
 import Chargebee
 
 Chargebee.configure(site: "your-site",
-                    publishableApiKey: "api_key",
+                    apiKey: "api_key",
                     sdkKey: "sdk_key")
 }
 
 ```
 
 ### Configuration for using tokenization only
-If you want to use the Chargebee iOS SDK only for tokenizing credit card details, you can initialize the SDK with your Chargebee Site and Publishable API key alone. You can initialize the SDK during your app startup by including the following in your app delegate.
+If you want to use the Chargebee iOS SDK only for tokenizing credit card details, you can initialize the SDK with your Chargebee Site and  API key alone. You can initialize the SDK during your app startup by including the following in your app delegate.
 
 ```swift
 import Chargebee
 
-Chargebee.configure(site: "your-site", publishableApiKey: "api_key")
+Chargebee.configure(site: "your-site", apiKey: "api_key")
 
 ```
 
@@ -86,6 +86,7 @@ The above function will determine your product catalog version in Chargebee and
 
 You can then convert these to Apple IAP Product objects with the following function.
 
+
 ```swift
 CBPurchase.shared.retrieveProducts(withProductID : ["Product ID from Apple"],completion: { result in
     switch result {
@@ -104,6 +105,9 @@ You can present any of the above products to your users for them to purchase.
 
 When the user chooses the product to purchase, pass in the product and customer identifiers to the following function.
 
+customer id - optional Parameter
+We need the unique ID of your customer for customer_id. If your unique list of customers is maintained in your database or a 3rd party system , send us the unique ID from there. If you rely on Chargebee for the unique list of customers, then you can send us a random unique string for this ID.
+
 ```swift
 
 CBPurchase.shared.purchaseProduct(product: "CBProduct",customerId: "CustomerID") { result in