[Feature] Anonymous User Tracking

AnonymousUserEventTracking.md

@@ -0,0 +1,113 @@
+# AnonymousUserManager Class
+
+## Class Introduction
+
+The `AnonymousUserManager` class is responsible for managing anonymous user sessions and tracking events.
+The `AnonymousUserManager+Functions` class is contains util functions and `CriteriaCompletionChecker` struct which contains criteria checking logic.
+It includes methods for updating sessions, tracking events (i.e custom event, update cart, update user and purchase) and create a user if criterias are met.
+We call track methods of this class internally to make sure we have tracked the events even when user is NOT logged in and after certain criterias are met we create a user and logs them automatically and sync events through Iterable API.
+
+## Class Structure
+
+The `AnonymousUserManager` class includes the following key components:
+
+- **Methods:**
+    - `updateAnonSession()`: Updates the anonymous user session.
+    - `trackAnonEvent(name: String, dataFields: [AnyHashable: Any]?)`: Tracks an anonymous event and store it locally.
+    - `trackAnonPurchaseEvent(total: NSNumber, items: [CommerceItem], dataFields: [AnyHashable: Any]?)`: Tracks an anonymous purchase event and store it locally.
+    - `trackAnonUpdateUser(_ dataFields: [AnyHashable: Any])`: Tracks an anonymous update user event and store it locally.
+    - `trackAnonUpdateCart(items: [CommerceItem])`: Tracks an anonymous cart event and store it locally.
+    - `trackAnonTokenRegistration(token: String)`: Tracks an anonymous token registration event and store it locally.
+    - `getAnonCriteria()`: Gets the anonymous criteria.
+    - `checkCriteriaCompletion()`: Checks if criterias are being met.
+    - `createKnownUser()`: Creates a user after criterias met and login the user and then sync the data through track APIs.
+    - `syncEvents()`: Syncs locally saved data through track APIs.
+    - `updateAnonSession()`: Stores an anonymous sessions locally. Update the last session time when new session is created.
+    - `storeEventData()`: Stores event data locally.
+    - `logout()`: Reset the locally saved data when user logs out to make sure no old data is left.
+    - `syncNonSyncedEvents()`: Syncs unsynced data which might have failed to sync when calling syncEvents for the first time after criterias met.
+    - `convertCommerceItems(from dictionaries: [[AnyHashable: Any]]) -> [CommerceItem]`: Convert to commerce items from dictionaries.
+    - `convertCommerceItemsToDictionary(_ items: [CommerceItem]) -> [[AnyHashable:Any]]`: Convert commerce items to dictionaries.
+    - `getUTCDateTime()`: Converts UTC Datetime from current time.
+
+
+## Methods Description
+
+### `updateAnonSession()`
+
+This method updates the anonymous user session. It does the following:
+
+* Retrieves the previous session data from local storage.
+* Increments the session number.
+* Stores the updated session data back to local storage.
+
+### `trackAnonEvent(name: String, dataFields: [AnyHashable: Any]?)`
+
+This method tracks an anonymous event. It does the following:
+
+* Creates a dictionary object with event details, including the event name, timestamp, data fields, and tracking type.
+* Stores the event data in local storage.
+* Checks criteria completion and creates a known user if criteria are met.
+
+### `trackAnonPurchaseEvent(total: NSNumber, items: [CommerceItem], dataFields: [AnyHashable: Any]?)`
+
+This method tracks an anonymous purchase event. It does the following:
+
+* Converts the list of commerce items to JSON.
+* Creates a dictionary object with purchase event details, including items, total, timestamp, data fields, and tracking type.
+* Stores the purchase event data in local storage.
+* Checks criteria completion and creates a known user if criteria are met.
+
+### `trackAnonUpdateUser(dataFields: [AnyHashable: Any]?)`
+
+This method tracks an anonymous update user event. It does the following:
+
+* Creates a dictionary object with event details, including the event name, timestamp, data fields, and tracking type.
+* Stores the event data in local storage, and if data of this event already exists it replaces the data.
+* Checks criteria completion and creates a known user if criteria are met.
+
+### `trackAnonUpdateCart(items: [CommerceItem])`
+
+This method tracks an anonymous cart update. It does the following:
+
+* Converts the list of commerce items to dictionary.
+* Creates a dictionary object with cart update details, including items, timestamp, and tracking type.
+* Stores the cart update data in local storage.
+* Checks criteria completion and creates a known user if criteria are met.
+
+### `trackAnonTokenRegistration(token: String)`
+
+This method tracks an anonymous token registration event and stores it locally.
+
+### `getAnonCriteria()`
+
+This method is responsible for fetching criteria data. It simulates calling an API and saving data in local storage.
+
+### `checkCriteriaCompletion()`
+
+This private method checks if criteria for creating a known user are met. It compares stored event data with predefined criteria and returns `criteriaId` if any of the criteria is matched.
+
+### `createKnownUser()`
+
+This  method is responsible for creating a known user in the Iterable API. It does the following:
+
+* Sets a random user ID using a UUID (Universally Unique Identifier).
+* Retrieves user session data from local storage.
+* If user session data exists, it updates the user information in the Iterable API.
+* Calls the syncEvents() method to synchronize anonymous tracked events.
+* Finally, it clears locally stored data after data is syncronized.
+
+### `syncEvents()`
+
+This method is used to synchronize anonymous tracked events stored in local storage with the Iterable API. It performs the following tasks:
+
+* Retrieves the list of tracked events from local storage.
+* Iterates through the list of events and processes each event based on its type.
+* Supported event types include regular event tracking, purchase event tracking, and cart update tracking.
+* For each event, it extracts relevant data, including event name, data fields, items (for purchase and cart update events), and timestamps.
+* It then calls the Iterable API to sync these events.
+* After processing all the events, it clears locally stored event data.
+
+### `updateAnonSession()`
+
+This method is responsible for storing/updating anonymous sessions locally. It updates the last session time each time when new session is created.

AnonymousUserMerge.md

@@ -0,0 +1,38 @@
+# AnonymousUserMerge Class
+
+## Class Introduction
+
+The `AnonymousUserMerge` class is responsible for merging anonymous user with logged-in one.
+It includes methods for merge user by userId and emailId.
+We call methods of this class internally to merge user when setUserId or setEmail method call. After merge we sync events through Iterable API.
+
+## Class Structure
+
+The `AnonymousUserMerge` class includes the following key components:
+
+- **Methods:**
+    - `mergeUserUsingUserId(apiClient: IterableApiClient, destinationUserId: String)`: Merge user using userID if anonymous user exists and sync events
+    - `mergeUserUsingEmail(apiClient: IterableApiClient, destinationEmail: String)`: Merge user using emailId if anonymous user exists and sync events
+    - `callMergeApi(apiClient: IterableApiClient, sourceEmail: String, sourceUserId: String, destinationEmail: String, destinationUserId: String)`: Call API to merge user and sync remaining events.
+
+## Methods Description
+
+### `mergeUserUsingUserId(apiClient: IterableApiClient, destinationUserId: String)`
+
+This method merge the anonymous user with the logged-in one. It does the following:
+
+* Check for user exists using userId.
+* If user exists then call the merge user API.
+
+### `mergeUserUsingEmail(apiClient: IterableApiClient, destinationEmail: String)`
+
+This method merge the anonymous user with the logged-in one. It does the following:
+
+* Check for user exists using emailId.
+* If user exists then call the merge user API.
+
+### `callMergeApi(apiClient: IterableApiClient, sourceEmail: String, sourceUserId: String, destinationEmail: String, destinationUserId: String)`
+
+This method call API to merge user. It does the following:
+
+* Call the Iterable API and sync remaining events.

sample-apps/swift-sample-app/swift-sample-app.xcodeproj/project.pbxproj

@@ -7,6 +7,8 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		37088F332B3C38250000B218 /* IterableAppExtensions in Frameworks */ = {isa = PBXBuildFile; productRef = 37088F322B3C38250000B218 /* IterableAppExtensions */; };
+		37088F352B3C38250000B218 /* IterableSDK in Frameworks */ = {isa = PBXBuildFile; productRef = 37088F342B3C38250000B218 /* IterableSDK */; };
 		551A5FF1251AB1950004C9A0 /* IterableSDK in Frameworks */ = {isa = PBXBuildFile; productRef = 551A5FF0251AB1950004C9A0 /* IterableSDK */; };
 		551A5FF3251AB19B0004C9A0 /* IterableAppExtensions in Frameworks */ = {isa = PBXBuildFile; productRef = 551A5FF2251AB19B0004C9A0 /* IterableAppExtensions */; };
 		AC1BDF5820E304BC000010CA /* CoffeeListTableViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = AC5ECD9E20E304000081E1DA /* CoffeeListTableViewController.swift */; };
@@ -79,13 +81,15 @@
 			buildActionMask = 2147483647;
 			files = (
 				551A5FF1251AB1950004C9A0 /* IterableSDK in Frameworks */,
+				37088F352B3C38250000B218 /* IterableSDK in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
 		ACA3A14B20E2F83D00FEF74F /* Frameworks */ = {
 			isa = PBXFrameworksBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				37088F332B3C38250000B218 /* IterableAppExtensions in Frameworks */,
 				551A5FF3251AB19B0004C9A0 /* IterableAppExtensions in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
@@ -219,6 +223,7 @@
 			name = "swift-sample-app";
 			packageProductDependencies = (
 				551A5FF0251AB1950004C9A0 /* IterableSDK */,
+				37088F342B3C38250000B218 /* IterableSDK */,
 			);
 			productName = "swift-sample-app";
 			productReference = ACA3A13520E2F6AF00FEF74F /* swift-sample-app.app */;
@@ -239,6 +244,7 @@
 			name = "swift-sample-app-notification-extension";
 			packageProductDependencies = (
 				551A5FF2251AB19B0004C9A0 /* IterableAppExtensions */,
+				37088F322B3C38250000B218 /* IterableAppExtensions */,
 			);
 			productName = "swift-sample-app-notification-extension";
 			productReference = ACA3A14E20E2F83D00FEF74F /* swift-sample-app-notification-extension.appex */;
@@ -281,6 +287,8 @@
 				Base,
 			);
 			mainGroup = ACA3A12C20E2F6AF00FEF74F;
+			packageReferences = (
+			);
 			productRefGroup = ACA3A13620E2F6AF00FEF74F /* Products */;
 			projectDirPath = "";
 			projectRoot = "";
@@ -592,6 +600,14 @@
 /* End XCConfigurationList section */
 
 /* Begin XCSwiftPackageProductDependency section */
+		37088F322B3C38250000B218 /* IterableAppExtensions */ = {
+			isa = XCSwiftPackageProductDependency;
+			productName = IterableAppExtensions;
+		};
+		37088F342B3C38250000B218 /* IterableSDK */ = {
+			isa = XCSwiftPackageProductDependency;
+			productName = IterableSDK;
+		};
 		551A5FF0251AB1950004C9A0 /* IterableSDK */ = {
 			isa = XCSwiftPackageProductDependency;
 			productName = IterableSDK;

sample-apps/swift-sample-app/swift-sample-app/AppDelegate.swift

@@ -27,7 +27,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         config.customActionDelegate = self
         config.urlDelegate = self
         config.inAppDisplayInterval = 1
-
+        config.anonUserDelegate = self
         IterableAPI.initialize(apiKey: iterableApiKey,
                                launchOptions: launchOptions,
                                config: config)
@@ -157,6 +157,12 @@ extension AppDelegate: IterableURLDelegate {
     }
 }
 
+extension AppDelegate: IterableAnonUserDelegate {
+    func onAnonUserCreated(userId: String) {
+        print("UserId Created from anonsession: \(userId)")
+    }
+}
+
 // MARK: IterableCustomActionDelegate
 
 extension AppDelegate: IterableCustomActionDelegate {

sample-apps/swift-sample-app/swift-sample-app/Base.lproj/Main.storyboard

@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="22505" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="umW-9Q-hvM">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="32700.99.1234" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="umW-9Q-hvM">
     <device id="retina4_7" orientation="portrait" appearance="light"/>
     <dependencies>
         <deployment identifier="iOS"/>
-        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="22504"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="22685"/>
         <capability name="Safe area layout guides" minToolsVersion="9.0"/>
         <capability name="collection view cell content view" minToolsVersion="11.0"/>
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
@@ -19,7 +19,7 @@
                         <color key="backgroundColor" white="1" alpha="1" colorSpace="custom" customColorSpace="genericGamma22GrayColorSpace"/>
                         <color key="tintColor" red="0.31372549020000001" green="0.71372549019999998" blue="0.98823529409999999" alpha="1" colorSpace="calibratedRGB"/>
                         <view key="tableFooterView" contentMode="scaleToFill" id="VEA-om-wVt">
-                            <rect key="frame" x="0.0" y="121.5" width="375" height="44"/>
+                            <rect key="frame" x="0.0" y="165" width="375" height="44"/>
                             <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMaxY="YES"/>
                             <color key="backgroundColor" white="1" alpha="1" colorSpace="custom" customColorSpace="genericGamma22GrayColorSpace"/>
                         </view>
@@ -35,6 +35,14 @@
                                     <segue destination="Ez8-MY-tka" kind="show" identifier="showCoffeeSegue" id="pgY-3d-VNl"/>
                                 </connections>
                             </tableViewCell>
+                            <tableViewCell clipsSubviews="YES" contentMode="scaleToFill" preservesSuperviewLayoutMargins="YES" selectionStyle="default" accessoryType="checkmark" indentationWidth="10" reuseIdentifier="anonymousUsageTrackCell" id="nSd-28-WlN">
+                                <rect key="frame" x="0.0" y="93.5" width="375" height="43.5"/>
+                                <autoresizingMask key="autoresizingMask"/>
+                                <tableViewCellContentView key="contentView" opaque="NO" clipsSubviews="YES" multipleTouchEnabled="YES" contentMode="center" preservesSuperviewLayoutMargins="YES" insetsLayoutMarginsFromSafeArea="NO" tableViewCell="nSd-28-WlN" id="4YR-d9-FwM">
+                                    <rect key="frame" x="0.0" y="0.0" width="335" height="43.5"/>
+                                    <autoresizingMask key="autoresizingMask"/>
+                                </tableViewCellContentView>
+                            </tableViewCell>
                         </prototypes>
                         <connections>
                             <outlet property="dataSource" destination="AsM-Cj-iLA" id="zCP-mf-9X0"/>

sample-apps/swift-sample-app/swift-sample-app/CoffeeListTableViewController.swift

@@ -60,22 +60,42 @@ class CoffeeListTableViewController: UITableViewController {
     }
 
     // MARK: - TableViewDataSourceDelegate Functions
-
-    override func tableView(_: UITableView, numberOfRowsInSection _: Int) -> Int {
-        filtering ? filteredCoffees.count : coffees.count
+    override func numberOfSections(in tableView: UITableView) -> Int {
+        return 2
+    }
+    override func tableView(_: UITableView, numberOfRowsInSection section: Int) -> Int {
+        if section == 0 {
+            return 1
+        } else {
+            return filtering ? filteredCoffees.count : coffees.count
+        }
+
     }
-
     override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
-        let cell = tableView.dequeueReusableCell(withIdentifier: "coffeeCell", for: indexPath)
-
-        let coffeeList = filtering ? filteredCoffees : coffees
-        let coffee = coffeeList[indexPath.row]
-        cell.textLabel?.text = coffee.name
-        cell.imageView?.image = coffee.image
-
-        return cell
+        if indexPath.section == 0 {
+            let cell = tableView.dequeueReusableCell(withIdentifier: "anonymousUsageTrackCell", for: indexPath)
+            cell.textLabel?.text = IterableAPI.getAnonymousUsageTracked() ? "Tap to enable Anonymous Usage Track" : "Tap to disable Anonymous Usage Track"
+            cell.textLabel?.numberOfLines = 0
+            cell.accessoryType = IterableAPI.getAnonymousUsageTracked() ? .checkmark : .none
+            return cell
+        } else {
+            let cell = tableView.dequeueReusableCell(withIdentifier: "coffeeCell", for: indexPath)
+            let coffeeList = filtering ? filteredCoffees : coffees
+            let coffee = coffeeList[indexPath.row]
+            cell.textLabel?.text = coffee.name
+            cell.imageView?.image = coffee.image
+            return cell
+        }
     }
-
+
+    override func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) {
+        if indexPath.section == 0 {
+            let permissionToTrack = IterableAPI.getAnonymousUsageTracked()
+            IterableAPI.setAnonymousUsageTracked(isAnonymousUsageTracked: !permissionToTrack)
+            self.tableView.reloadData()
+        }
+    }
+
     // MARK: Tap Handlers
 
     @IBAction func loginOutBarButtonTapped(_: UIBarButtonItem) {
@@ -93,7 +113,7 @@ class CoffeeListTableViewController: UITableViewController {
     // MARK: - Navigation
 
     override func prepare(for segue: UIStoryboardSegue, sender _: Any?) {
-        guard let indexPath = tableView.indexPathForSelectedRow else {
+        guard let indexPath = tableView.indexPathForSelectedRow, indexPath.section == 1 else {
             return
         }