release/7.4.5 (#737)

SourcePointUSA · Nov 8, 2023 · 0942e4f · 0942e4f
1 parent 1834327
commit 0942e4f
Show file tree

Hide file tree

Showing 36 changed files with 697 additions and 196 deletions.
diff --git a/README.md b/README.md
@@ -248,30 +248,62 @@ Java
 
 ## Loading a Privacy Manager on demand
 
-Call `spConsentLib.loadPrivacyManager` to surface the Privacy Manager
+Call `spConsentLib.loadPrivacyManager` to surface the Privacy Manager. There are three Privacy Manager types:
+
+```kotlin
+    enum class MessageType {
+        MOBILE,
+        OTT,
+        LEGACY_OTT
+    }
+```
+
+- MOBILE: it is used for mobile devices,
+- OTT: it presents a new layout and operates on TV devices,
+- LEGACY_OTT: it presents the legacy layout and operates on TV devices.
+
+As a default behavior, the type is determined based on the nature of the device on which your application is executed. 
+For example, if your application is running on a television, the selected type will be 'OTT,' whereas the 'MOBILE' 
+type will be assigned in all other cases.
 
 Kotlin
 
 ```kotlin
-    //...
+    //... IMPLICIT message type selection
     spConsentLib.loadPrivacyManager(
       "<PM_ID>",
       PMTab.PURPOSES,
       CampaignType.GDPR
     )
     //...
+    //... EXPLICIT message type selection
+    spConsentLib.loadPrivacyManager(
+      "<PM_ID>",
+      PMTab.PURPOSES,
+      CampaignType.GDPR,
+      MOBILE
+    )
+    //...
 ```
 
 Java
 
 ```java
-    //...
+    //... IMPLICIT message type selection
     spConsentLib.loadPrivacyManager(
             "<PM_ID>",
             PMTab.PURPOSES,
             CampaignType.GDPR
             ));
     //...
+    //... EXPLICIT message type selection
+            spConsentLib.loadPrivacyManager(
+            "<PM_ID>",
+            PMTab.PURPOSES,
+            CampaignType.GDPR,
+            MOBILE
+            ));
+    //...
 ```
 
 ## Loading the OTT First Layer Message
@@ -306,13 +338,13 @@ An OTT privacy manager can be **resurfaced** for your project (_e.g. via a butto
 Kotlin
 
 ```kotlin
-    spConsentLib.loadPrivacyManager("<PM_ID>", CampaignType.GDPR) // For a GDPR campaign
+spConsentLib.loadPrivacyManager("<PM_ID>", CampaignType.GDPR, MessageType.OTT) // For a GDPR campaign
 ```
 
 Java
 
 ```java
-    spConsentLib.loadPrivacyManager("<PM_ID>", CampaignType.CCPA); // For a CCPA campaign
+    spConsentLib.loadPrivacyManager("<PM_ID>", CampaignType.CCPA, MessageType.OTT); // For a CCPA campaign
 ```
 
 > In case a property was created from the web builder as OTT/CTV, the Privacy Manager is the first layer message itself, this means that as pmId you should use the message id of your first layer message.
@@ -353,12 +385,15 @@ SpConsent
     |   |-- grants: Map<String, GDPRPurposeGrants>
     |   |-- euconsent: String
     |   |-- acceptedCategories: List<String>
+    |   |-- apply: Boolean
+    |   |-- consentStatus: ConsentStatus
     |-- ccpa?
         |-- uuid: String?
         |-- rejectedCategories: List<String>
         |-- rejectedVendors: List<String>
         |-- status: String?
         |-- uspstring: String
+        |-- apply: Boolean
 ```
 
 ### The grants parameter and the GDPRPurposeGrants object

diff --git a/cmplibrary/gradle.properties b/cmplibrary/gradle.properties
@@ -1,4 +1,4 @@
-VERSION_NAME = 7.4.4
+VERSION_NAME = 7.4.5
 
 POM_NAME = cmplibrary
 POM_REPO = sourcepoint

diff --git a/cmplibrary/release_note.txt b/cmplibrary/release_note.txt
@@ -1,2 +1,4 @@
-* [DIA-2896](https://sourcepoint.atlassian.net/browse/DIA-2896) Implement consent expiration (#731)
-* [DIA-2654](https://sourcepoint.atlassian.net/browse/DIA-2654) Flush data if authId or propertyId changes (#711)
+* [DIA-2940](https://sourcepoint.atlassian.net/browse/DIA-2940) Fix for the applies parameter after saving partial GDPR consent (#734)
+* [DIA-2786](https://sourcepoint.atlassian.net/browse/DIA-2786) Added support fo the new CCPA OTT PM  (#735)
+* [HCD-452](https://sourcepoint.atlassian.net/browse/DIA-452) Add full structure to SpConsent (#733)
+
diff --git a/...ibrary/src/androidTest/java/com/sourcepoint/cmplibrary/util/UserConsentsRegressionTest.kt b/...ibrary/src/androidTest/java/com/sourcepoint/cmplibrary/util/UserConsentsRegressionTest.kt
@@ -0,0 +1,48 @@
+package com.sourcepoint.cmplibrary.util
+
+import androidx.test.internal.runner.junit4.AndroidJUnit4ClassRunner
+import androidx.test.platform.app.InstrumentationRegistry
+import com.example.uitestutil.assertEquals
+import com.example.uitestutil.toList
+import com.sourcepoint.cmplibrary.Utils.Companion.storeTestDataObj
+import org.json.JSONObject
+import org.junit.Test
+import org.junit.runner.RunWith
+
+@RunWith(AndroidJUnit4ClassRunner::class)
+class UserConsentsRegressionTest {
+
+    private val appContext by lazy { InstrumentationRegistry.getInstrumentation().targetContext }
+
+    /**
+     * Test case that tests when the user has both campaigns applies value as TRUE then should return
+     * sane from the userConsents() method
+     */
+    @Test
+    fun given_stored_consent_with_save_and_exit_choices_and_applies_true_then_user_consents_should_return_true_for_both_applies() {
+
+        val v7Consent = JSONObject("v7/stored_consent_with_save_and_exit_choices_and_applies_true.json".file2String())
+        appContext.storeTestDataObj(v7Consent.toList())
+
+        val gdprAppliesFromUserConsents = userConsents(appContext).gdpr?.consent?.applies
+        gdprAppliesFromUserConsents.assertEquals(true)
+        val ccpaAppliesFromUserConsents = userConsents(appContext).ccpa?.consent?.applies
+        ccpaAppliesFromUserConsents.assertEquals(true)
+    }
+
+    /**
+     * Test case that tests when the user has both campaigns applies value as FALSE then should return
+     * sane from the userConsents() method
+     */
+    @Test
+    fun given_stored_consent_with_save_and_exit_choices_and_applies_false_then_user_consents_should_return_false_for_both_applies() {
+
+        val v7Consent = JSONObject("v7/stored_consent_with_save_and_exit_choices_and_applies_false.json".file2String())
+        appContext.storeTestDataObj(v7Consent.toList())
+
+        val gdprAppliesFromUserConsents = userConsents(appContext).gdpr?.consent?.applies
+        gdprAppliesFromUserConsents.assertEquals(false)
+        val ccpaAppliesFromUserConsents = userConsents(appContext).ccpa?.consent?.applies
+        ccpaAppliesFromUserConsents.assertEquals(false)
+    }
+}
diff --git a/cmplibrary/src/main/java/com/sourcepoint/cmplibrary/SpConsentLib.kt b/cmplibrary/src/main/java/com/sourcepoint/cmplibrary/SpConsentLib.kt
@@ -4,6 +4,7 @@ import android.view.View
 import com.sourcepoint.cmplibrary.consent.CustomConsentClient
 import com.sourcepoint.cmplibrary.exception.CampaignType
 import com.sourcepoint.cmplibrary.model.PMTab
+import com.sourcepoint.cmplibrary.model.exposed.MessageType
 import com.sourcepoint.cmplibrary.model.exposed.SPConsents
 import org.json.JSONObject
 
@@ -63,6 +64,10 @@ interface SpConsentLib {
     fun loadPrivacyManager(pmId: String, pmTab: PMTab, campaignType: CampaignType)
     fun loadPrivacyManager(pmId: String, pmTab: PMTab, campaignType: CampaignType, useGroupPmIfAvailable: Boolean)
 
+    fun loadPrivacyManager(pmId: String, campaignType: CampaignType, messageType: MessageType)
+    fun loadPrivacyManager(pmId: String, pmTab: PMTab, campaignType: CampaignType, messageType: MessageType)
+    fun loadPrivacyManager(pmId: String, pmTab: PMTab, campaignType: CampaignType, useGroupPmIfAvailable: Boolean, messageType: MessageType)
+
     fun showView(view: View)
     fun removeView(view: View)