feat: Course Upgrade Option with IAP

Core/Core/Analytics/CoreAnalytics.swift

@@ -18,6 +18,72 @@ public protocol CoreAnalytics {
         value: String,
         oldValue: String
     )
+
+    func trackCourseUpgradePaymentError(
+        _ event: AnalyticsEvent,
+        biValue: EventBIValue,
+        courseID: String,
+        blockID: String?,
+        pacing: String,
+        coursePrice: String,
+        screen: CourseUpgradeScreen,
+        error: String
+    )
+
+    func trackCourseUpgradeError(
+        courseID: String,
+        blockID: String?,
+        pacing: String,
+        coursePrice: String?,
+        screen: CourseUpgradeScreen,
+        error: String,
+        flowType: UpgradeMode
+    )
+
+    func trackCourseUpgradeErrorAction(
+        courseID: String,
+        blockID: String?,
+        pacing: String,
+        coursePrice: String?,
+        screen: CourseUpgradeScreen,
+        alertType: UpgradeAlertType,
+        errorAction: String,
+        error: String,
+        flowType: UpgradeMode
+    )
+
+    func trackCourseUpgradeSuccess(
+        courseID: String,
+        blockID: String?,
+        pacing: String,
+        coursePrice: String,
+        screen: CourseUpgradeScreen,
+        flowType: UpgradeMode
+    )
+
+    func trackUpgradeNow(
+        courseID: String,
+        blockID: String?,
+        pacing: String,
+        screen: CourseUpgradeScreen,
+        coursePrice: String
+    )
+
+    func trackCourseUpgradeLoadError(
+        courseID: String,
+        blockID: String?,
+        pacing: String,
+        screen: CourseUpgradeScreen
+    )
+
+    func trackCourseUnfulfilledPurchaseInitiated(
+        courseID: String,
+        pacing: String,
+        screen: CourseUpgradeScreen,
+        flowType: UpgradeMode
+    )
+
+    func trackRestorePurchaseClicked()
 }
 
 public extension CoreAnalytics {
@@ -42,6 +108,71 @@ public class CoreAnalyticsMock: CoreAnalytics {
         value: String,
         oldValue: String
     ) {}
+
+    public func trackCourseUpgradePaymentError(
+        _ event: AnalyticsEvent,
+        biValue: EventBIValue,
+        courseID: String,
+        blockID: String? = nil,
+        pacing: String,
+        coursePrice: String,
+        screen: CourseUpgradeScreen,
+        error: String
+    ) {}
+
+    public func trackCourseUpgradeError(
+        courseID: String,
+        blockID: String? = nil,
+        pacing: String,
+        coursePrice: String? = nil,
+        screen: CourseUpgradeScreen,
+        error: String,
+        flowType: UpgradeMode
+    ) {}
+
+    public func trackCourseUpgradeErrorAction(
+        courseID: String,
+        blockID: String? = nil,
+        pacing: String,
+        coursePrice: String? = nil,
+        screen: CourseUpgradeScreen,
+        alertType: UpgradeAlertType,
+        errorAction: String,
+        error: String,
+        flowType: UpgradeMode
+    ) {}
+
+    public func trackCourseUpgradeSuccess(
+        courseID: String,
+        blockID: String? = nil,
+        pacing: String,
+        coursePrice: String,
+        screen: CourseUpgradeScreen,
+        flowType: UpgradeMode) {}
+
+    public func trackUpgradeNow(
+        courseID: String,
+        blockID: String? = nil,
+        pacing: String,
+        screen: CourseUpgradeScreen,
+        coursePrice: String
+    ) {}
+
+    public func trackCourseUpgradeLoadError(
+        courseID: String,
+        blockID: String? = nil,
+        pacing: String,
+        screen: CourseUpgradeScreen
+    ) {}
+
+    public func trackCourseUnfulfilledPurchaseInitiated(
+        courseID: String,
+        pacing: String,
+        screen: CourseUpgradeScreen,
+        flowType: UpgradeMode
+    ) {}
+
+    public func trackRestorePurchaseClicked() {}
 }
 #endif
 
@@ -124,6 +255,16 @@ public enum AnalyticsEvent: String {
     case whatnewPopup = "WhatsNew:Pop up Viewed"
     case whatnewDone = "WhatsNew:Done"
     case whatnewClose = "WhatsNew:Close"
+    case upgradeNowClicked = "Payments: Upgrade Now Clicked"
+    case courseUpgradePriceLoadError = "Payments: Price Load Error"
+    case courseUpgradePaymentError = "Payments: Payment Error"
+    case courseUpgradePaymentCancelError = "Payments: Canceled by User"
+    case courseUpgradeError = "Payments: Course Upgrade Error"
+    case courseUpgradeErrorAction = "Payments: Error Alert Action"
+    case courseUpgradeSuccess = "Payments: Course Upgrade Success"
+    case courseUpgradeUnfulfilledPurchaseInitiated = "Payments: Unfulfilled Purchase Initiated"
+    case courseUpgradeRestorePurchaseClicked = "Payments: Restore Purchases Clicked"
+
 }
 
 public enum EventBIValue: String {
@@ -205,6 +346,15 @@ public enum EventBIValue: String {
     case whatnewPopup = "edx.bi.app.whats_new.popup.viewed"
     case whatnewDone = "edx.bi.app.whats_new.done"
     case whatnewClose = "edx.bi.app.whats_new.close"
+    case upgradeNowClicked = "edx.bi.app.payments.upgrade_now.clicked"
+    case courseUpgradePriceLoadError = "edx.bi.app.payments.price_load_error"
+    case courseUpgradePaymentError = "edx.bi.app.payments.payment_error"
+    case courseUpgradePaymentCancelError = "edx.bi.app.payments.canceled_by_user"
+    case courseUpgradeError = "edx.bi.app.payments.course_upgrade_error"
+    case courseUpgradeErrorAction = "edx.bi.app.payments.error_alert_action"
+    case courseUpgradeSuccess = "edx.bi.app.payments.course_upgrade_success"
+    case courseUpgradeUnfulfilledPurchaseInitiated = "edx.bi.app.payments.unfulfilled_purchase.initiated"
+    case courseUpgradeRestorePurchaseClicked = "edx.bi.app.payments.restore_purchases.clicked"
 }
 
 public struct EventParamKey {
@@ -241,6 +391,11 @@ public struct EventParamKey {
     public static let pacing = "pacing"
     public static let dialog = "dialog"
     public static let snackbar = "snackbar"
+    public static let price = "price"
+    public static let error = "error"
+    public static let errorAction = "error_action"
+    public static let flowType = "flow_type"
+    public static let alertType = "alert_type"
 }
 
 public struct EventCategory {
@@ -251,4 +406,5 @@ public struct EventCategory {
     public static let profile = "profile"
     public static let video = "video"
     public static let course = "course"
+    public static let inAppPurchases = "in_app_purchases"
 }

Core/Core/Assets.xcassets/UpgradeAccess/Contents.json

@@ -0,0 +1,6 @@
+{
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

Core/Core/Assets.xcassets/UpgradeAccess/UpgradeArrowImage.imageset/Contents.json

@@ -0,0 +1,15 @@
+{
+  "images" : [
+    {
+      "filename" : "arrow.pdf",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  },
+  "properties" : {
+    "preserves-vector-representation" : true
+  }
+}

Core/Core/Assets.xcassets/UpgradeAccess/UpgradeCalendarImage.imageset/Contents.json

@@ -0,0 +1,15 @@
+{
+  "images" : [
+    {
+      "filename" : "calendar.svg",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  },
+  "properties" : {
+    "preserves-vector-representation" : true
+  }
+}

Core/Core/Assets.xcassets/UpgradeAccess/UpgradeCheckmarkImage.imageset/Contents.json

@@ -0,0 +1,15 @@
+{
+  "images" : [
+    {
+      "filename" : "checkmark.svg",
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  },
+  "properties" : {
+    "preserves-vector-representation" : true
+  }
+}

Core/Core/Configuration/BaseRouter.swift

@@ -58,7 +58,26 @@ public protocol BaseRouter {
     func presentView(transitionStyle: UIModalTransitionStyle, view: any View, completion: (() -> Void)?)
 
     func presentView(transitionStyle: UIModalTransitionStyle, animated: Bool, content: () -> any View)
-
+    func presentNativeAlert(title: String?, message: String?, actions: [UIAlertAction])
+    @MainActor
+    func showUpgradeInfo(
+        productName: String,
+        message: String,
+        sku: String,
+        courseID: String,
+        screen: CourseUpgradeScreen,
+        pacing: String
+    ) async
+    @MainActor
+    func hideUpgradeInfo(animated: Bool) async
+    @MainActor
+    func showUpgradeLoaderView(animated: Bool) async
+    @MainActor
+    func hideUpgradeLoaderView(animated: Bool) async
+    @MainActor
+    func showRestoreProgressView()
+    @MainActor
+    func hideRestoreProgressView()
 }
 
 extension BaseRouter {
@@ -125,5 +144,25 @@ open class BaseRouterMock: BaseRouter {
 
     public func presentView(transitionStyle: UIModalTransitionStyle, animated: Bool, content: () -> any View) {}
 
+    public func presentNativeAlert(title: String?, message: String?, actions: [UIAlertAction]) {}
+    @MainActor
+    public func showUpgradeInfo(
+        productName: String,
+        message: String,
+        sku: String,
+        courseID: String,
+        screen: CourseUpgradeScreen,
+        pacing: String
+    ) async {}
+    @MainActor
+    public func hideUpgradeInfo(animated: Bool) async {}
+    @MainActor
+    public func showUpgradeLoaderView(animated: Bool) async {}
+    @MainActor
+    public func hideUpgradeLoaderView(animated: Bool) async {}
+    @MainActor
+    public func showRestoreProgressView() {}
+    @MainActor
+    public func hideRestoreProgressView() {}
 }
 #endif

Core/Core/Configuration/Config/Config.swift

@@ -31,6 +31,7 @@ public protocol ConfigProtocol {
     var segment: SegmentConfig { get }
     var program: DiscoveryConfig { get }
     var URIScheme: String { get }
+    var ecommerceURL: String? { get }
 }
 
 public enum TokenType: String {
@@ -49,6 +50,7 @@ private enum ConfigKeys: String {
     case appstoreID = "APP_STORE_ID"
     case faq = "FAQ_URL"
     case URIScheme = "URI_SCHEME"
+    case ecommerceURL = "ECOMMERCE_URL"
 }
 
 public class Config {
@@ -160,6 +162,10 @@ extension Config: ConfigProtocol {
     public var URIScheme: String {
         return string(for: ConfigKeys.URIScheme.rawValue) ?? ""
     }
+
+    public var ecommerceURL: String? {
+        return string(for: ConfigKeys.ecommerceURL.rawValue)
+    }
 }
 
 // Mark - For testing and SwiftUI preview

Core/Core/Configuration/ServerConfig/IAPConfig.swift

@@ -0,0 +1,41 @@
+//
+//  IAPConfig.swift
+//  Core
+//
+//  Created by Saeed Bashir on 4/29/24.
+//
+
+import Foundation
+
+public class IAPConfig: NSObject {
+
+    enum Keys: String, RawStringExtractable {
+        case enabled = "enabled"
+        case disabledVersions = "ios_disabled_versions"
+        case restoreEnabled = "restore_enabled"
+    }
+
+    public var enabled: Bool = false
+    private var disabledVersions: [String] = []
+    public var restoreEnabled: Bool = false
+
+    init(dictionary: [String: Any]) {
+        enabled = dictionary[Keys.enabled] as? Bool ?? false
+        disabledVersions = dictionary[Keys.disabledVersions] as? [String] ?? []
+        restoreEnabled = dictionary[Keys.restoreEnabled] as? Bool ?? false
+
+        if let info = Bundle.main.infoDictionary,
+           let currentVersion = info["CFBundleShortVersionString"] as? String,
+           disabledVersions.contains(currentVersion) {
+            enabled = false
+        }
+    }
+}
+
+private let Key = "iap_config"
+
+extension ServerConfig {
+    public var iapConfig: IAPConfig {
+        return IAPConfig(dictionary: config[Key] as? [String: AnyObject] ?? [:])
+    }
+}