Merge pull request #549 from SourcePointUSA/DIA-3524_support_uspstrin…

…g_usnat

DIA-3524 support legacy uspstring in usnat

ConsentViewController/Classes/LocalStorage/SPUserDefaults.swift

@@ -99,7 +99,10 @@ class SPUserDefaults: SPLocalStorage {
         Self.USER_DATA_KEY: userData,
         Self.US_PRIVACY_STRING_KEY: usPrivacyString,
         Self.LOCAL_STATE_KEY: localState
-    ].merging(tcfData ?? [:]) { item, _ in item }}
+    ]
+        .merging(tcfData ?? [:]) { item, _ in item }
+        .merging(gppData ?? [:]) { item, _ in item }
+    }
 
     func clear() {
         localState = nil

ConsentViewController/Classes/SPCampaigns.swift

@@ -40,31 +40,40 @@ public typealias SPTargetingParams = [String: String]
     let GPPConfig: SPGPPConfig?
 
     /**
-     Used by usNat campaigns only. Set this flag only if your app used an SDK older than `7.6.0`, use authenticated consent
+     Used by USNat campaigns only. Set this flag only if your app used an SDK older than `7.6.0`, use authenticated consent
      and has a CCPA campaign.
      */
     let transitionCCPAAuth: Bool?
 
+    /**
+     Used by USNat campaigns. Set this flag if you want to continue having the value `IABUSPrivacy_String`
+     stored in the `UserDefaults`. Useful during the transition between CCPA and USNat campaigns.
+    */
+    let supportLegacyUSPString: Bool?
+
     @objc override public var description: String {
         """
         SPCampaign
             - targetingParams: \(targetingParams)
             - groupPmId: \(groupPmId as Any)
             - GPPConfig: \(GPPConfig as Any)
             - transitionCCPAAuth: \(transitionCCPAAuth as Any)
+            - supportLegacyUSPString: \(supportLegacyUSPString as Any)
         """
     }
 
     @nonobjc public init(
         targetingParams: SPTargetingParams = [:],
         groupPmId: String? = nil,
         gppConfig: SPGPPConfig? = nil,
-        transitionCCPAAuth: Bool? = nil
+        transitionCCPAAuth: Bool? = nil,
+        supportLegacyUSPString: Bool? = nil
     ) {
         self.targetingParams = targetingParams
         self.groupPmId = groupPmId
         self.GPPConfig = gppConfig
         self.transitionCCPAAuth = transitionCCPAAuth
+        self.supportLegacyUSPString = supportLegacyUSPString
     }
 
     @available(swift, obsoleted: 1.0)
@@ -76,19 +85,22 @@ public typealias SPTargetingParams = [String: String]
         self.groupPmId = groupPmId
         self.GPPConfig = nil
         self.transitionCCPAAuth = nil
+        self.supportLegacyUSPString = nil
     }
 
     @available(swift, obsoleted: 1.0)
     @objc public init(
         targetingParams: SPTargetingParams = [:],
         groupPmId: String? = nil,
         gppConfig: SPGPPConfig? = nil,
-        transitionCCPAAuth: SPOptinalBool = .unset
+        transitionCCPAAuth: SPOptinalBool = .unset,
+        supportLegacyUSPString: SPOptinalBool = .unset
     ) {
         self.targetingParams = targetingParams
         self.groupPmId = groupPmId
         self.GPPConfig = gppConfig
         self.transitionCCPAAuth = transitionCCPAAuth.boolValue
+        self.supportLegacyUSPString = supportLegacyUSPString.boolValue
     }
 }
 

ConsentViewController/Classes/SPGPPConfig.swift

@@ -42,6 +42,8 @@ import Foundation
     let MspaOptOutOptionMode: SPMspaTernaryFlag?
     let MspaServiceProviderMode: SPMspaTernaryFlag?
 
+    let uspString: Bool?
+
     public init(
         MspaCoveredTransaction: SPMspaBinaryFlag? = nil,
         MspaOptOutOptionMode: SPMspaTernaryFlag? = nil,
@@ -50,6 +52,7 @@ import Foundation
         self.MspaCoveredTransaction = MspaCoveredTransaction
         self.MspaOptOutOptionMode = MspaOptOutOptionMode
         self.MspaServiceProviderMode = MspaServiceProviderMode
+        uspString = nil
     }
 
     public init(
@@ -60,5 +63,13 @@ import Foundation
         self.MspaCoveredTransaction = MspaCoveredTransaction
         self.MspaOptOutOptionMode = MspaOptOutOptionMode
         self.MspaServiceProviderMode = MspaServiceProviderMode
+        uspString = nil
+    }
+
+    init(uspString: Bool?) {
+        self.uspString = uspString
+        MspaCoveredTransaction = nil
+        MspaOptOutOptionMode = nil
+        MspaServiceProviderMode = nil
     }
 }

ConsentViewController/Classes/SourcePointClient/SourcepointClientCoordinator.swift

@@ -324,7 +324,10 @@ class SourcepointClientCoordinator: SPClientCoordinator {
         self.propertyName = propertyName
         self.language = language
         self.campaigns = campaigns
-        self.includeData = IncludeData(gppConfig: campaigns.ccpa?.GPPConfig ?? SPGPPConfig())
+        self.includeData = IncludeData(
+            gppConfig: campaigns.ccpa?.GPPConfig ?? 
+                SPGPPConfig(uspString: campaigns.usnat?.supportLegacyUSPString)
+        )
         self.storage = storage
         self.spClient = spClient ?? SourcePointClient(
             accountId: accountId,

Example/ConsentViewController_ExampleTests/SPClientCoordinator/SPClientCoordinatorSpec.swift

@@ -498,6 +498,22 @@ class SPClientCoordinatorSpec: QuickSpec {
                 coordinator = coordinatorFor(campaigns: SPCampaigns(usnat: SPCampaign()))
             }
 
+            it("can support legacy uspstring") {
+                coordinator = coordinatorFor(
+                    campaigns: SPCampaigns(
+                        usnat: SPCampaign(supportLegacyUSPString: true)
+                    )
+                )
+                waitUntil { done in
+                    coordinator.loadMessages(forAuthId: nil, pubData: nil) { _ in
+                        expect(
+                            coordinator.userData.usnat?.consents?.GPPData?["IABUSPrivacy_String"]?.stringValue
+                        ).notTo(beEmpty())
+                        done()
+                    }
+                }
+            }
+
             describe("with authId") {
                 it("persists consent even after cleaning all data") {
                     waitUntil { done in

README.md

@@ -491,6 +491,17 @@ var consentManager = SPConsentManager(
 )
 ```
 
+## Support U.S. Privacy (Legacy) with U.S. Multi-State Privacy
+
+If you're transitioning from U.S. Privacy (Legacy) to U.S. Multi-State Privacy, you may want to continue supporting the legacy US privacy string (`IABUSPrivacy_String`).
+To do so, when instantiating the SDK, make sure to set the flag `.supportLegacyUSPString` to true. Example:
+```swift
+var consentManager = SPConsentManager(
+    ...
+    campaigns: SPCampaigns(usnat: SPCampaign(supportLegacyUSPString: true)), // <== here
+    delegate: self
+)
+```
 
 ## Configuring the Message/Consents timeout