feat: recriculation source and cmp status (#32)

Author: marcmrf

CompassSDK/Info.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
 	<key>CFBundleShortVersionString</key>
-	<string>2.15.0</string>
+	<string>2.16.0</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 </dict>

CompassSDK/Storage/CompassStorage.swift

@@ -26,7 +26,7 @@ protocol CompassStorage {
     func removeUserSegment(_ name: String)
     func clearUserSegments()
     func setConsent(_ hasConsent: Bool)
-    func setLandingPage(_ landingPage: String)
+    func setLandingPage(_ landingPage: String?)
 }
 
 enum Store: String {
@@ -226,7 +226,7 @@ extension PListCompassStorage: CompassStorage {
         return model?.landingPage
     }
 
-    func setLandingPage(_ landingPage: String) {
+    func setLandingPage(_ landingPage: String?) {
         model?.landingPage = landingPage
     }
 }

CompassSDK/Tracker/Core/CompassTracker.swift

@@ -61,10 +61,10 @@ public protocol CompassTracking: AnyObject {
     func startPageView(url: URL)
     @available(*, deprecated, renamed: "trackNewPage")
     func startPageView(url: URL, scrollView: UIScrollView?)
-    func trackNewPage(url: URL)
-    func trackNewPage(url: URL, scrollView: UIScrollView?)
-    func trackScreen(_ name: String)
-    func trackScreen(name: String, scrollView: UIScrollView?)
+    func trackNewPage(url: URL, rs: String?)
+    func trackNewPage(url: URL, scrollView: UIScrollView?, rs: String?)
+    func trackScreen(_ name: String, rs: String?)
+    func trackScreen(name: String, scrollView: UIScrollView?, rs: String?)
     func stopTracking()
     func getRFV(_ completion: @escaping (Rfv?) -> ())
     @available(*, deprecated, renamed: "setSiteUserId")
@@ -83,7 +83,7 @@ public protocol CompassTracking: AnyObject {
     func clearUserSegments()
     func setConsent(_ hasConsent: Bool)
     func getUserId() -> String
-    func setLandingPage(_ landingPage: String)
+    func setLandingPage(_ landingPage: String?)
     func setLandingPage(_ landingPage: URL)
 }
 
@@ -196,7 +196,7 @@ extension CompassTracker: ScrollPercentProvider {
 }
 
 extension CompassTracker: CompassTracking {
-    public func setLandingPage(_ landingPage: String) {
+    public func setLandingPage(_ landingPage: String?) {
         storage.setLandingPage(landingPage)
     }
 
@@ -237,30 +237,30 @@ extension CompassTracker: CompassTracking {
         trackNewPage(url: url)
     }
 
-    public func trackNewPage(url: URL, scrollView: UIScrollView?) {
+    public func trackNewPage(url: URL, scrollView: UIScrollView?, rs: String? = nil) {
         self.scrollView = scrollView
-        self.trackNewPage(url: url)
+        self.trackNewPage(url: url, rs: rs)
     }
 
-    public func trackNewPage(url: URL) {
-        restart(pageName: url.absoluteString)
+    public func trackNewPage(url: URL, rs: String? = nil) {
+        restart(pageName: url.absoluteString, rs: rs)
         doTik()
     }
 
-    public func trackScreen(_ name: String) {
+    public func trackScreen(_ name: String, rs: String? = nil) {
         guard let url = screenUrl(name) else {
             return
         }
 
-        trackNewPage(url: url)
+        trackNewPage(url: url, rs: rs)
     }
 
-    public func trackScreen(name: String, scrollView: UIScrollView?) {
+    public func trackScreen(name: String, scrollView: UIScrollView?, rs: String? = nil) {
         guard let url = screenUrl(name) else {
             return
         }
 
-        trackNewPage(url: url, scrollView: scrollView)
+        trackNewPage(url: url, scrollView: scrollView, rs: rs)
     }
 
     public func stopTracking() {
@@ -403,10 +403,11 @@ private extension CompassTracker {
         operationQueue.addOperation(operation)
     }
 
-    func restart(pageName: String?) {
+    func restart(pageName: String?, rs: String? = nil) {
         stopObserving()
         operationQueue.operations.forEach{ $0.cancel() }
         trackInfo.pageUrl = pageName
+        trackInfo.recirculationSource = rs
         pageVars.removeAll()
         trackInfo.sessionId = storage.sessionId
         tick = 0

CompassSDK/Tracker/Core/IngestTrackInfo.swift

@@ -14,6 +14,8 @@ struct IngestTrackInfo: Encodable {
         case scrollPercent = "sc"
         case implodedConversions = "conv"
         case landingPage = "lp"
+        case cc = "cc"
+        case recirculationSoruce = "rs"
     }
 
     private var trackInfo = TrackInfo()
@@ -28,6 +30,7 @@ struct IngestTrackInfo: Encodable {
     private var implodedConversions: String?
 
     var landingPage: String?
+    var recirculationSource: String?
 
     public func encode(to encoder: Encoder) throws {
         var container = encoder.container(keyedBy: CodingKeys.self)
@@ -38,6 +41,8 @@ struct IngestTrackInfo: Encodable {
         try container.encodeIfPresent(scrollPercent, forKey: .scrollPercent)
         try container.encodeIfPresent(implodedConversions, forKey: .implodedConversions)
         try container.encodeIfPresent(landingPage, forKey: .landingPage)
+        try container.encodeIfPresent(cc, forKey: .cc)
+        try container.encodeIfPresent(recirculationSource, forKey: .recirculationSoruce)
     }
 }
 
@@ -192,4 +197,17 @@ extension IngestTrackInfo {
             trackInfo.hasConsent
         }
     }
+    
+    var cc: Int {
+        get {
+            switch hasConsent {
+            case true:
+                return 1
+            case false:
+                return 0
+            default:
+                return 3
+            }
+        }
+    }
 }

MarfeelSDK-iOS.podspec

@@ -16,7 +16,7 @@ Pod::Spec.new do |spec|
   #
 
   spec.name         = "MarfeelSDK-iOS"
-  spec.version      = "2.15.0"
+  spec.version      = "2.16.0"
   spec.summary      = "iOS version of MarfeelSDK."
 
 

Playground/Playground/BlogPost.swift

@@ -17,6 +17,7 @@ struct BlogPost: Identifiable {
     var featured = false
     var url: String
     var videoId: String
+    var rs: String? = nil
 }
 
 var articleList: [BlogPost] = []

Playground/Playground/BlogPostStore.swift

@@ -25,7 +25,8 @@ class BlogPostsStore: ObservableObject {
             """,
             featured: true,
             url: "http://dev.marfeel.co/2022/11/25/article-with-video-html5/",
-            videoId: "UbjLtXKEE-I"
+            videoId: "UbjLtXKEE-I",
+            rs: "recirculation source"
         ),
         BlogPost(
             title: "Post 2 Title",

Playground/Playground/BlogPostView.swift

@@ -64,7 +64,7 @@ struct BlogPostView: View {
             .navigationBarTitleDisplayMode(.inline)
         }
         .onAppear(perform: {
-            CompassTracker.shared.trackNewPage(url: URL(string: blogPost.url)!)
+            CompassTracker.shared.trackNewPage(url: URL(string: blogPost.url)!, rs: blogPost.rs)
             CompassTracker.shared.setPageVar(name: "pepe", value: blogPost.id.description)
             CompassTracker.shared.setPageVar(name: "pepe2", value: blogPost.id.description)
             CompassTracker.shared.setUserVar(name: "pepe-user", value: blogPost.id.description)