Merge pull request #580 from SourcePointUSA/DIA-4457_mobile-core_meta…

…data DIA-4457 use mobile-core metadata
SourcePointUSA · Sep 10, 2024 · 38fcfaf · 38fcfaf
2 parents 7ef2577 + 96de1f7
commit 38fcfaf
Show file tree

Hide file tree

Showing 194 changed files with 25,109 additions and 5,583 deletions.
diff --git a/ConsentViewController.podspec b/ConsentViewController.podspec
@@ -8,6 +8,7 @@ Pod::Spec.new do |s|
   s.source = { :git => 'https://github.com/SourcePointUSA/ios-cmp-app.git', :tag => s.version.to_s }
   s.swift_version = '5.1'
   s.source_files = 'ConsentViewController/Classes/**/*'
+  s.dependency 'SPMobileCore', '0.0.3'
   s.ios.deployment_target = '10.0'
   s.ios.exclude_files = 'ConsentViewController/Classes/Views/tvOS'
   s.tvos.deployment_target = '12.0'

diff --git a/ConsentViewController/Classes/SPConsentManager.swift b/ConsentViewController/Classes/SPConsentManager.swift
@@ -71,6 +71,7 @@ import UIKit
         let client = SourcePointClient(
             accountId: accountId,
             propertyName: propertyName,
+            propertyId: propertyId,
             campaignEnv: campaigns.environment,
             timeout: Self.DefaultTimeout
         )

diff --git a/ConsentViewController/Classes/SPDate.swift b/ConsentViewController/Classes/SPDate.swift
@@ -26,7 +26,7 @@ public struct SPDate: Codable, Equatable {
     public init(from decoder: Decoder) throws {
         let container = try decoder.singleValueContainer()
         originalDateString = try container.decode(String.self)
-        date = Self.format.date(from: originalDateString) ?? Date()
+        date = Self.format.date(from: originalDateString) ?? Date() // TODO: potentially throw an error here...
     }
 
     static func now() -> SPDate {

diff --git a/ConsentViewController/Classes/SourcePointClient/Adapters.swift b/ConsentViewController/Classes/SourcePointClient/Adapters.swift
@@ -0,0 +1,56 @@
+//
+//  Adapters.swift
+//  Pods
+//
+//  Created by Andre Herculano on 10/9/24.
+//
+
+import Foundation
+import SPMobileCore
+
+// swiftlint:disable force_unwrapping
+
+extension SPDate {
+    init(string: String) {
+        originalDateString = string
+        date = Self.format.date(from: originalDateString) ?? Date()
+    }
+}
+
+extension MetaDataQueryParam {
+    func toCore() -> MetaDataRequest.Campaigns {
+        .init(
+            gdpr: gdpr != nil ? .init(groupPmId: gdpr?.groupPmId) : nil,
+            usnat: usnat != nil ? .init(groupPmId: usnat?.groupPmId) : nil,
+            ccpa: ccpa != nil ? .init(groupPmId: ccpa?.groupPmId) : nil
+        )
+    }
+}
+
+extension SPMobileCore.MetaDataResponse {
+    func toNative() -> MetaDataResponse {
+        .init(
+            ccpa: ccpa != nil ? .init(
+                applies: ccpa!.applies,
+                sampleRate: ccpa!.sampleRate
+            ) : nil,
+            gdpr: gdpr != nil ? .init(
+                additionsChangeDate: SPDate(string: gdpr!.additionsChangeDate),
+                legalBasisChangeDate: SPDate(string: gdpr!.legalBasisChangeDate),
+                vendorListId: gdpr!.vendorListId,
+                childPmId: gdpr!.childPmId,
+                applies: gdpr!.applies,
+                sampleRate: gdpr!.sampleRate
+            ) : nil,
+            usnat: usnat != nil ? .init(
+                vendorListId: usnat!.vendorListId,
+                additionsChangeDate: SPDate(string: usnat!.additionsChangeDate),
+                applies: usnat!.applies,
+                sampleRate: usnat!.sampleRate,
+                applicableSections: usnat!.applicableSections.map { Int(truncating: $0) }
+            ) : nil
+        )
+    }
+}
+
+// swiftlint:enable force_unwrapping
diff --git a/ConsentViewController/Classes/SourcePointClient/SourcePointClient.swift b/ConsentViewController/Classes/SourcePointClient/SourcePointClient.swift
@@ -7,6 +7,9 @@
 
 // swiftlint:disable function_parameter_count file_length
 import Foundation
+import SPMobileCore
+
+typealias CoreClient = SPMobileCore.SourcepointClient
 
 extension Result where Success == Data? {
     func decoded<T: Decodable>(
@@ -49,7 +52,13 @@ typealias MetaDataHandler = (Result<MetaDataResponse, SPError>) -> Void
 typealias ChoiceHandler = (Result<ChoiceAllResponse, SPError>) -> Void
 
 protocol SourcePointProtocol {
-    init(accountId: Int, propertyName: SPPropertyName, campaignEnv: SPCampaignEnv, timeout: TimeInterval)
+    init(
+        accountId: Int,
+        propertyName: SPPropertyName,
+        propertyId: Int,
+        campaignEnv: SPCampaignEnv,
+        timeout: TimeInterval
+    )
 
     func getMessages(_ params: MessagesRequest, handler: @escaping MessagesHandler)
 
@@ -170,23 +179,44 @@ A Http client for SourcePoint's endpoints
  */
 class SourcePointClient: SourcePointProtocol {
     let accountId: Int
+    let propertyId: Int
     let propertyName: SPPropertyName
     let campaignEnv: SPCampaignEnv
     var client: HttpClient
+    let coreClient: CoreClient
 
     let requestUUID = UUID()
 
-    init(accountId: Int, propertyName: SPPropertyName, campaignEnv: SPCampaignEnv, client: HttpClient) {
+    init(
+        accountId: Int,
+        propertyName: SPPropertyName,
+        propertyId: Int,
+        campaignEnv: SPCampaignEnv,
+        client: HttpClient
+    ) {
         self.accountId = accountId
         self.propertyName = propertyName
+        self.propertyId = propertyId
         self.campaignEnv = campaignEnv
         self.client = client
+        self.coreClient = CoreClient(
+            accountId: Int32(accountId),
+            propertyId: Int32(propertyId),
+            propertyName: propertyName.rawValue
+        )
     }
 
-    required convenience init(accountId: Int, propertyName: SPPropertyName, campaignEnv: SPCampaignEnv, timeout: TimeInterval) {
+    required convenience init(
+        accountId: Int,
+        propertyName: SPPropertyName,
+        propertyId: Int,
+        campaignEnv: SPCampaignEnv,
+        timeout: TimeInterval
+    ) {
         self.init(
             accountId: accountId,
             propertyName: propertyName,
+            propertyId: propertyId,
             campaignEnv: campaignEnv,
             client: SimpleClient(timeoutAfter: timeout))
     }
@@ -445,7 +475,7 @@ extension SourcePointClient {
         return url
     }
 
-    func metaData(
+    func fallbackMetaData(
         accountId: Int,
         propertyId: Int,
         metadata: MetaDataQueryParam,
@@ -465,6 +495,26 @@ extension SourcePointClient {
         }
     }
 
+    func metaData(
+        accountId: Int,
+        propertyId: Int,
+        metadata: MetaDataQueryParam,
+        handler: @escaping MetaDataHandler
+    ) {
+        coreClient.getMetaData(campaigns: metadata.toCore()) { response, error in
+            if error != nil || response == nil {
+                self.fallbackMetaData(
+                    accountId: accountId,
+                    propertyId: propertyId,
+                    metadata: metadata,
+                    handler: handler
+                )
+            } else {
+                handler(Result.success(response!.toNative())) // swiftlint:disable:this force_unwrapping
+            }
+        }
+    }
+
     func getMessages(_ params: MessagesRequest, handler: @escaping MessagesHandler) {
         guard let url = Constants.Urls.GET_MESSAGES_URL.appendQueryItems(params.stringifiedParams())
         else {

diff --git a/ConsentViewController/Classes/SourcePointClient/SourcepointClientCoordinator.swift b/ConsentViewController/Classes/SourcePointClient/SourcepointClientCoordinator.swift
@@ -333,6 +333,7 @@ class SourcepointClientCoordinator: SPClientCoordinator {
         self.spClient = spClient ?? SourcePointClient(
             accountId: accountId,
             propertyName: propertyName,
+            propertyId: propertyId,
             campaignEnv: campaigns.environment,
             timeout: SPConsentManager.DefaultTimeout
         )

diff --git a/Example/ConsentViewController.xcodeproj/project.pbxproj b/Example/ConsentViewController.xcodeproj/project.pbxproj
@@ -668,6 +668,7 @@
 		80A5A481B97C11AC27421C73 /* Pods_ObjC_ExampleApp.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_ObjC_ExampleApp.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		815ACB69209144D8CA0F5833 /* Pods-SourcepointFirebaseDemo.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-SourcepointFirebaseDemo.debug.xcconfig"; path = "Target Support Files/Pods-SourcepointFirebaseDemo/Pods-SourcepointFirebaseDemo.debug.xcconfig"; sourceTree = "<group>"; };
 		816F9B5ABCD689D81DDBAC41 /* Pods-SourcepointFirebaseDemoUITests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-SourcepointFirebaseDemoUITests.release.xcconfig"; path = "Target Support Files/Pods-SourcepointFirebaseDemoUITests/Pods-SourcepointFirebaseDemoUITests.release.xcconfig"; sourceTree = "<group>"; };
+		8203A3BE2C904C3E00BACFE7 /* SPMobileCore.xcframework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.xcframework; name = SPMobileCore.xcframework; path = "../../mobile-core/SPMobileCore.xcframework"; sourceTree = "<group>"; };
 		820B08AD2B602177004E77E8 /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = Platforms/MacOSX.platform/Developer/SDKs/MacOSX14.2.sdk/System/Library/Frameworks/Foundation.framework; sourceTree = DEVELOPER_DIR; };
 		820B08AF2B60217E004E77E8 /* UIKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = UIKit.framework; path = Platforms/MacOSX.platform/Developer/SDKs/MacOSX14.2.sdk/System/iOSSupport/System/Library/Frameworks/UIKit.framework; sourceTree = DEVELOPER_DIR; };
 		820B08B12B6021A6004E77E8 /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = Platforms/AppleTVOS.platform/Developer/SDKs/AppleTVOS17.2.sdk/System/Library/Frameworks/Foundation.framework; sourceTree = DEVELOPER_DIR; };
@@ -2210,6 +2211,7 @@
 		EEE3CDAB8AFE80647B1E565B /* Frameworks */ = {
 			isa = PBXGroup;
 			children = (
+				8203A3BE2C904C3E00BACFE7 /* SPMobileCore.xcframework */,
 				8216E2632BB32B74006FEF11 /* ConsentViewController.framework */,
 				820B08B12B6021A6004E77E8 /* Foundation.framework */,
 				820B08AF2B60217E004E77E8 /* UIKit.framework */,

diff --git a/Example/ConsentViewController_ExampleTests/Helpers/SourcePointClientMock.swift b/Example/ConsentViewController_ExampleTests/Helpers/SourcePointClientMock.swift
@@ -28,18 +28,25 @@ class SourcePointClientMock: SourcePointProtocol {
         nonKeyedLocalState: SPJson()
     )
 
-    required init(accountId: Int, propertyName: SPPropertyName, campaignEnv: SPCampaignEnv, timeout: TimeInterval) {
-    }
+    required init(
+        accountId: Int,
+        propertyName: SPPropertyName,
+        propertyId: Int,
+        campaignEnv: SPCampaignEnv,
+        timeout: TimeInterval
+    ) {}
 
     convenience init(
         accountId: Int = 0,
         propertyName: SPPropertyName = try! SPPropertyName(""),
+        propertyId: Int = 0,
         campaignEnv: SPCampaignEnv = .Public,
         timout: TimeInterval = 1.0
     ) {
         self.init(
             accountId: accountId,
             propertyName: propertyName,
+            propertyId: propertyId,
             campaignEnv: campaignEnv,
             timeout: timout
         )

diff --git a/Example/ConsentViewController_ExampleTests/SPClientCoordinator/SPClientCoordinatorSpec.swift b/Example/ConsentViewController_ExampleTests/SPClientCoordinator/SPClientCoordinatorSpec.swift
@@ -107,6 +107,7 @@ class SPClientCoordinatorSpec: QuickSpec {
                     spClientMock = SourcePointClientMock(
                         accountId: accountId,
                         propertyName: propertyName,
+                        propertyId: propertyId,
                         campaignEnv: .Public,
                         timeout: 999
                     )
@@ -174,6 +175,7 @@ class SPClientCoordinatorSpec: QuickSpec {
                     spClientMock = SourcePointClientMock(
                         accountId: accountId,
                         propertyName: propertyName,
+                        propertyId: propertyId,
                         campaignEnv: .Public,
                         timeout: 999
                     )
@@ -765,6 +767,7 @@ class SPClientCoordinatorSpec: QuickSpec {
                 spClientMock = SourcePointClientMock(
                     accountId: accountId,
                     propertyName: propertyName,
+                    propertyId: propertyId,
                     campaignEnv: .Public,
                     timeout: 999
                 )

diff --git a/...Controller_ExampleTests/SPClientCoordinator/SourcePointClient/SourcePointClientSpec.swift b/...Controller_ExampleTests/SPClientCoordinator/SourcePointClient/SourcePointClientSpec.swift
@@ -31,6 +31,7 @@ class SourcePointClientSpec: QuickSpec {
     func getClient(_ client: MockHttp) -> SourcePointClient { SourcePointClient(
         accountId: accountId,
         propertyName: propertyName,
+        propertyId: propertyId,
         campaignEnv: .Public,
         client: client
     )}

diff --git a/...er_ExampleTests/SPClientCoordinator/SourcePointClient/UnmockedSourcepointClientSpec.swift b/...er_ExampleTests/SPClientCoordinator/SourcePointClient/UnmockedSourcepointClientSpec.swift
@@ -29,6 +29,7 @@ class UnmockedSourcepointClientSpec: QuickSpec {
             client = SourcePointClient(
                 accountId: accountId,
                 propertyName: propertyName,
+                propertyId: propertyId,
                 campaignEnv: .Public,
                 client: SimpleClient(timeoutAfter: TimeInterval(10))
             )
@@ -235,16 +236,22 @@ class UnmockedSourcepointClientSpec: QuickSpec {
             describe("for a property belonging to a property group") {
                 describe("and with a valid groupPmId") {
                     it("meta-data returns a childPmId") {
-                        let propertyIdBelongingToAPropertyGroup = 24188
                         let groupPmId = "613056"
                         let childPmId = "613057"
+                        client = SourcePointClient(
+                            accountId: accountId,
+                            propertyName: propertyName,
+                            propertyId: 24188,
+                            campaignEnv: .Public,
+                            client: SimpleClient(timeoutAfter: TimeInterval(10))
+                        )
                         waitUntil { done in
                             client.metaData(
-                                accountId: accountId,
-                                propertyId: propertyIdBelongingToAPropertyGroup,
+                                accountId: 99,
+                                propertyId: 99,
                                 metadata: MetaDataQueryParam(
                                     gdpr: .init(groupPmId: groupPmId),
-                                    ccpa: .init(groupPmId: nil),
+                                    ccpa: nil,
                                     usnat: nil
                                 )
                             ) {

diff --git a/...e/ConsentViewController_ExampleTests/SPClientCoordinator/SourcepointCoordinatorMock.swift b/...e/ConsentViewController_ExampleTests/SPClientCoordinator/SourcepointCoordinatorMock.swift
@@ -19,6 +19,7 @@ class CoordinatorMock: SPClientCoordinator {
     var spClient: SourcePointProtocol = SourcePointClientMock(
         accountId: 0,
         propertyName: try! SPPropertyName(""),
+        propertyId: 0,
         campaignEnv: .Public,
         timeout: 10
     )

diff --git a/Example/ConsentViewController_ExampleTests/SPConsentManagerSpec.swift b/Example/ConsentViewController_ExampleTests/SPConsentManagerSpec.swift
@@ -137,6 +137,7 @@ class SPConsentManagerSpec: QuickSpec {
                     spClient: SourcePointClientMock(
                         accountId: accountId,
                         propertyName: propertyName,
+                        propertyId: propertyId,
                         campaignEnv: .Public,
                         timeout: 999
                     ),

diff --git a/Example/Podfile.lock b/Example/Podfile.lock
@@ -1,6 +1,7 @@
 PODS:
   - ConsentViewController (7.7.1):
     - Down (~> 0.11.0)
+    - SPMobileCore (= 0.0.3)
   - Down (0.11.0)
   - FirebaseAnalytics (10.23.0):
     - FirebaseAnalytics/AdIdSupport (= 10.23.0)
@@ -89,6 +90,7 @@ PODS:
   - Nimble (10.0.0)
   - PromisesObjC (2.4.0)
   - Quick (5.0.1)
+  - SPMobileCore (0.0.3)
   - SwiftLint (0.51.0)
   - Wormholy (1.6.6)
 
@@ -117,6 +119,7 @@ SPEC REPOS:
     - Nimble
     - PromisesObjC
     - Quick
+    - SPMobileCore
     - SwiftLint
     - Wormholy
 
@@ -125,7 +128,7 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  ConsentViewController: 43068f943fe21d8990a44dabfd4da41170ec7c8b
+  ConsentViewController: 13d8ce7370f1af6708e49f7e5f1b5aac01f21f6e
   Down: b6ba1bc985c9d2f4e15e3b293d2207766fa12612
   FirebaseAnalytics: 45f6e2e5ef8ccbb90be73ae983c3b20fa78837f7
   FirebaseCore: 63efb128decaebb04c4033ed4e05fb0bb1cccef1
@@ -139,6 +142,7 @@ SPEC CHECKSUMS:
   Nimble: 5316ef81a170ce87baf72dd961f22f89a602ff84
   PromisesObjC: f5707f49cb48b9636751c5b2e7d227e43fba9f47
   Quick: 749aa754fd1e7d984f2000fe051e18a3a9809179
+  SPMobileCore: 47632f68a87b5df421750db6ba987768c5c36011
   SwiftLint: 1b7561918a19e23bfed960e40759086e70f4dba5
   Wormholy: 09da0b876f9276031fd47383627cb75e194fc068
 

diff --git a/Example/Pods/Local Podspecs/ConsentViewController.podspec.json b/Example/Pods/Local Podspecs/ConsentViewController.podspec.json