[Feature] Anonymous User Tracking

CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [6.6.0-beta3]
+
+- This release includes fixes for the Anonymous user activation private beta:
+    - Criteria is now fetched on foregrounding the app by default. This feature can be turned off setting enableForegroundCriteriaFetch flag to false. 
+    - anonymous user ids are only generated once when multiple track calls are made.
+- Anonymous user activation is currently in private beta. If you'd like to learn more about it or discuss using it, talk to your Iterable customer success manager (who can also provide detailed documentation).
+
+## [6.6.0-beta2]
+
+- This release fixes beta1 release which was released from the wrong branch.
+
+## [6.6.0-beta1]
+
+- This release includes initial support for Anonymous user activation, a feature that allows marketers to convert valuable visitors into customers. With this feature, the SDK can:
+  - Fetch anonymous profile creation criteria from your Iterable project, and then automatically create Iterable user profiles for anonymous users who meet these criteria.
+  - Save information about a user's previous interactions with your application to their anonymous profile, after it's created.
+  - Display personalized messages for anonymous users (in-app, push, and embedded messages).
+  - Merge anonymous profiles into an existing, known user profiles (when needed).
+- Anonymous user activation is currently in private beta. If you'd like to learn more about it or discuss using it, talk to your Iterable customer success manager (who can also provide detailed documentation).
+
 ## [Unreleased]
 - Adding section for unreleased changes
 

Iterable-iOS-AppExtensions.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name         = "Iterable-iOS-AppExtensions"
   s.module_name  = "IterableAppExtensions"
-  s.version      = "6.5.11"
+  s.version      = "6.6.0-beta3"
   s.summary      = "App Extensions for Iterable SDK"
 
   s.description  = <<-DESC

Iterable-iOS-SDK.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
   s.name         = "Iterable-iOS-SDK"
   s.module_name  = "IterableSDK"
-  s.version      = "6.5.11"
+  s.version      = "6.6.0-beta3"
   s.summary      = "Iterable's official SDK for iOS"
 
   s.description  = <<-DESC

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

@@ -12,12 +12,28 @@ import UserNotifications
 import IterableSDK
 
 @UIApplicationMain
-class AppDelegate: UIResponder, UIApplicationDelegate {
+class AppDelegate: UIResponder, UIApplicationDelegate, IterableAuthDelegate {
+    func onAuthTokenRequested(completion: @escaping IterableSDK.AuthTokenRetrievalHandler) {
+        // ITBL: Set your actual secret.
+        let jwt = IterableTokenGenerator.generateJwtForUserId(
+            secret: "",
+            iat: Int(Date().timeIntervalSince1970),
+            exp: Int(Date().timeIntervalSince1970) + (24*60),
+            userId: IterableAPI.userId ?? "")
+        print(jwt)
+        completion(jwt)
+    }
+
+
+    func onAuthFailure(_ authFailure: IterableSDK.AuthFailure) {
+
+    }
+
     var window: UIWindow?
 
     // ITBL: Set your actual api key here.
     let iterableApiKey = ""
-    
+
     func application(_: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
         // ITBL: Setup Notification
         setupNotifications()
@@ -27,7 +43,9 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         config.customActionDelegate = self
         config.urlDelegate = self
         config.inAppDisplayInterval = 1
-
+        config.anonUserDelegate = self
+        config.enableAnonTracking = true
+        config.authDelegate = self
         IterableAPI.initialize(apiKey: iterableApiKey,
                                launchOptions: launchOptions,
                                config: config)
@@ -157,6 +175,12 @@ extension AppDelegate: IterableURLDelegate {
     }
 }
 
+extension AppDelegate: IterableAnonUserDelegate {
+    func onAnonUserCreated(userId: String) {
+        print("UserId Created from anonsession: \(userId)")
+    }
+}
+
 // MARK: IterableCustomActionDelegate
 
 extension AppDelegate: IterableCustomActionDelegate {
@@ -171,3 +195,4 @@ extension AppDelegate: IterableCustomActionDelegate {
         return false
     }
 }
+

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 disable Anonymous Usage Track" : "Tap to enable 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
         }