Merge pull request #349 from woocommerce/issue/218-privacy-settings

Settings: Privacy Settings

Author: mindgraffiti

WooCommerce/Classes/Analytics/AnalyticsProvider.swift

@@ -14,11 +14,19 @@ public protocol AnalyticsProvider {
     func track(_ eventName: String)
 
 
-    /// Track a spcific event with associated properties
+    /// Track a specific event with associated properties
     ///
     /// - Parameters:
     ///   - eventName: the event name
     ///   - properties: a collection of properties
     ///
     func track(_ eventName: String, withProperties properties: [AnyHashable: Any]?)
+
+    /// Clear queued events
+    ///
+    func clearEvents()
+
+    /// Switch between an authed user and anon user
+    ///
+    func clearUsers()
 }

WooCommerce/Classes/Analytics/TracksProvider.swift

@@ -41,6 +41,24 @@ public extension TracksProvider {
             DDLogInfo("🔵 Tracked \(eventName)")
         }
     }
+
+    func clearEvents() {
+        tracksService.clearQueuedEvents()
+    }
+
+    /// When a user opts-out, wipe data
+    ///
+    func clearUsers() {
+        guard WooAnalytics.shared.userHasOptedIn else {
+            // To be safe, nil out the anonymousUserID guid so a fresh one is regenerated
+            UserDefaults.standard[.defaultAnonymousID] = nil
+            UserDefaults.standard[.analyticsUsername] = nil
+            tracksService.switchToAnonymousUser(withAnonymousID: StoresManager.shared.sessionManager.anonymousUserID)
+            return
+        }
+
+        switchTracksUsersIfNeeded()
+    }
 }
 
 

WooCommerce/Classes/Analytics/WooAnalytics.swift

@@ -18,6 +18,18 @@ public class WooAnalytics {
     ///
     private var applicationOpenedTime: Date?
 
+    /// Check user opt-in for analytics
+    ///
+    var userHasOptedIn: Bool {
+        get {
+            let optedIn: Bool? = UserDefaults.standard.object(forKey: .userOptedInAnalytics)
+            return optedIn ?? true // analytics tracking on by default
+        }
+        set {
+            UserDefaults.standard.set(newValue, forKey: .userOptedInAnalytics)
+        }
+    }
+
 
     // MARK: - Initialization
 
@@ -48,6 +60,10 @@ public extension WooAnalytics {
     /// It's good to call this function after a user logs in or out of the app.
     ///
     func refreshUserData() {
+        guard userHasOptedIn == true else {
+            return
+        }
+
         analyticsProvider.refreshUserData()
     }
 
@@ -56,6 +72,10 @@ public extension WooAnalytics {
     /// - Parameter stat: the event name
     ///
     func track(_ stat: WooAnalyticsStat) {
+        guard userHasOptedIn == true else {
+            return
+        }
+
         track(stat, withProperties: nil)
     }
 
@@ -66,6 +86,10 @@ public extension WooAnalytics {
     ///   - properties: a collection of properties related to the event
     ///
     func track(_ stat: WooAnalyticsStat, withProperties properties: [AnyHashable: Any]?) {
+        guard userHasOptedIn == true else {
+            return
+        }
+
         if let updatedProperties = updatePropertiesIfNeeded(for: stat, properties: properties) {
             analyticsProvider.track(stat.rawValue, withProperties: updatedProperties)
         } else {
@@ -80,6 +104,10 @@ public extension WooAnalytics {
     ///   - error: the error to track
     ///
     func track(_ stat: WooAnalyticsStat, withError error: Error) {
+        guard userHasOptedIn == true else {
+            return
+        }
+
         let err = error as NSError
         let errorDictionary = [Constants.errorKeyCode: "\(err.code)",
                                Constants.errorKeyDomain: err.domain,
@@ -90,15 +118,45 @@ public extension WooAnalytics {
 }
 
 
+// MARK: - Opt Out
+//
+extension WooAnalytics {
+
+    func setUserHasOptedIn(_ optedIn: Bool) {
+        userHasOptedIn = optedIn
+
+        if optedIn {
+            refreshUserData()
+            startObservingNotifications()
+            DDLogInfo("🔵 Tracking started.")
+        } else {
+            stopObservingNotifications()
+            analyticsProvider.clearEvents()
+            analyticsProvider.clearUsers()
+            DDLogInfo("🔴 Tracking opt-out complete.")
+        }
+    }
+}
+
+
 // MARK: - Private Helpers
 //
 private extension WooAnalytics {
 
     func startObservingNotifications() {
+        guard userHasOptedIn == true else {
+            return
+        }
+
         NotificationCenter.default.addObserver(self, selector: #selector(trackApplicationOpened), name: UIApplication.didBecomeActiveNotification, object: nil)
         NotificationCenter.default.addObserver(self, selector: #selector(trackApplicationClosed), name: UIApplication.didEnterBackgroundNotification, object: nil)
     }
 
+    func stopObservingNotifications() {
+        NotificationCenter.default.removeObserver(self, name: UIApplication.didBecomeActiveNotification, object: nil)
+        NotificationCenter.default.removeObserver(self, name: UIApplication.didEnterBackgroundNotification, object: nil)
+    }
+
     @objc func trackApplicationOpened() {
         track(.applicationOpened)
         applicationOpenedTime = Date()

WooCommerce/Classes/Analytics/WooAnalyticsStat.swift

@@ -77,10 +77,17 @@ public enum WooAnalyticsStat: String {
 
     // Settings View Events
     //
-    case settingsTapped                         = "main_menu_settings_tapped"
-    case settingsContactSupportTapped           = "main_menu_contact_support_tapped"
-    case settingsLogoutTapped                   = "settings_logout_button_tapped"
-    case settingsLogoutConfirmation             = "settings_logout_confirmation_dialog_result"
+    case settingsTapped                     = "main_menu_settings_tapped"
+    case settingsContactSupportTapped       = "main_menu_contact_support_tapped"
+
+    case settingsPrivacySettingsTapped      = "settings_privacy_settings_tapped"
+    case settingsCollectInfoToggled         = "settings_privacy_settings_collect_info_toggled"
+    case settingsPrivacyPolicyTapped        = "settings_privacy_settings_privacy_policy_link_tapped"
+    case settingsShareInfoLearnMoreTapped   = "settings_privacy_settings_share_info_link_tapped"
+    case settingsThirdPartyLearnMoreTapped  = "settings_privacy_settings_third_party_tracking_info_link_tapped"
+
+    case settingsLogoutTapped               = "settings_logout_button_tapped"
+    case settingsLogoutConfirmation         = "settings_logout_confirmation_dialog_result"
 
     // Order View Events
     //

WooCommerce/Classes/AppDelegate.swift

@@ -154,7 +154,6 @@ private extension AppDelegate {
     ///
     func setupFabric() {
         fabricManager.initialize()
-        fabricManager.startListeningToAuthNotifications()
     }
 
     /// Sets up the WordPress Authenticator.

WooCommerce/Classes/Extensions/UserDefaults+Woo.swift

@@ -10,6 +10,8 @@ extension UserDefaults {
         case defaultUsername
         case defaultStoreID
         case defaultAnonymousID
+        case userOptedInAnalytics
+        case userOptedInCrashlytics
         case versionOfLastRun
         case analyticsUsername
     }

WooCommerce/Classes/System/WooConstants.swift

@@ -24,4 +24,12 @@ enum WooConstants {
     /// Support Email
     ///
     static let supportMail = "[email protected]"
+
+    /// Cookie policy URL
+    ///
+    static let cookieURL = URL(string:"https://automattic.com/cookies/")
+
+    /// Privacy policy URL
+    ///
+    static let privacyURL = URL(string: "https://automattic.com/privacy/")
 }

WooCommerce/Classes/Tools/Fabric/FabricManager.swift

@@ -12,14 +12,37 @@ import Yosemite
 ///
 class FabricManager {
 
+    /// Check user opt-in for Crash Reporting
+    ///
+    var userHasOptedIn: Bool {
+        get {
+            let optedIn: Bool? = UserDefaults.standard.object(forKey: .userOptedInCrashlytics)
+            return optedIn ?? true // crash reports turned on by default
+        }
+        set {
+            UserDefaults.standard.set(newValue, forKey: .userOptedInCrashlytics)
+        }
+    }
+
     deinit {
         NotificationCenter.default.removeObserver(self)
     }
 
     /// Initializes the Fabric SDK.
     ///
     func initialize() {
+        startCrashlyticsIfNeeded()
+    }
+
+    /// Starts Crashlytics
+    ///
+    func startCrashlyticsIfNeeded() {
+        guard userHasOptedIn else {
+            return
+        }
+
         Fabric.with([Crashlytics.self])
+        startListeningToAuthNotifications()
     }
 
     /// Starts listening to Authentication Notifications: Fabric's metadata will be refreshed accordingly.
@@ -29,6 +52,13 @@ class FabricManager {
         nc.addObserver(self, selector: #selector(defaultAccountWasUpdated), name: .defaultAccountWasUpdated, object: nil)
     }
 
+    /// Stops listening to Authentication Notifications
+    /// after tracking opt-out event
+    func stopListeningToAuthNotifications() {
+        let nc = NotificationCenter.default
+        nc.removeObserver(self, name: .defaultAccountWasUpdated, object: nil)
+    }
+
     /// Handles the `.sessionWasAuthenticated` notification.
     ///
     @objc func defaultAccountWasUpdated(sender: Notification) {
@@ -45,4 +75,33 @@ class FabricManager {
             DDLogInfo("🌡 Fabric Account Nuked!")
         }
     }
+
+    /// Clears Crashlytics data after opt-out of tracking event
+    ///
+    func clearCrashlyticsParameters() {
+        let crashlytics = Crashlytics.sharedInstance()
+
+        crashlytics.setUserName(nil)
+        crashlytics.setUserEmail(nil)
+        crashlytics.setUserIdentifier(nil)
+    }
+}
+
+
+// MARK: - Tracking Opt Out
+//
+extension FabricManager {
+
+    func setUserHasOptedIn(_ optedIn: Bool) {
+        userHasOptedIn = optedIn
+
+        if optedIn {
+            startCrashlyticsIfNeeded()
+            DDLogInfo("🔵 Crashlytics reporting restored.")
+        } else {
+            clearCrashlyticsParameters()
+            stopListeningToAuthNotifications()
+            DDLogInfo("🔴 Crashlytics opt-out complete.")
+        }
+    }
 }

WooCommerce/Classes/ViewRelated/Dashboard/Dashboard.storyboard

@@ -1,10 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14113" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="z1L-hy-XB6">
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14313.18" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="z1L-hy-XB6">
     <device id="retina4_7" orientation="portrait">
         <adaptation id="fullscreen"/>
     </device>
     <dependencies>
-        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14088"/>
+        <deployment identifier="iOS"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="14283.14"/>
         <capability name="Safe area layout guides" minToolsVersion="9.0"/>
         <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
     </dependencies>
@@ -197,12 +198,47 @@
                     </view>
                     <connections>
                         <outlet property="tableView" destination="wI4-XX-k2z" id="6bZ-RB-KF9"/>
+                        <segue destination="tLZ-3e-cJY" kind="show" identifier="ShowPrivacySettingsViewController" id="26d-pC-r7k"/>
                     </connections>
                 </viewController>
                 <placeholder placeholderIdentifier="IBFirstResponder" id="FEk-Qx-6OE" userLabel="First Responder" sceneMemberID="firstResponder"/>
             </objects>
             <point key="canvasLocation" x="270" y="1987"/>
         </scene>
+        <!--Privacy Settings View Controller-->
+        <scene sceneID="g1b-rK-cDR">
+            <objects>
+                <viewController storyboardIdentifier="PrivacySettingsViewController" id="tLZ-3e-cJY" customClass="PrivacySettingsViewController" customModule="WooCommerce" customModuleProvider="target" sceneMemberID="viewController">
+                    <view key="view" contentMode="scaleToFill" id="eDL-oC-fDz">
+                        <rect key="frame" x="0.0" y="0.0" width="375" height="667"/>
+                        <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
+                        <subviews>
+                            <tableView clipsSubviews="YES" contentMode="scaleToFill" layoutMarginsFollowReadableWidth="YES" alwaysBounceVertical="YES" dataMode="prototypes" style="grouped" separatorStyle="default" rowHeight="-1" estimatedRowHeight="-1" sectionHeaderHeight="18" sectionFooterHeight="18" translatesAutoresizingMaskIntoConstraints="NO" id="hwi-He-cKY">
+                                <rect key="frame" x="0.0" y="64" width="375" height="554"/>
+                                <color key="backgroundColor" cocoaTouchSystemColor="groupTableViewBackgroundColor"/>
+                                <connections>
+                                    <outlet property="dataSource" destination="tLZ-3e-cJY" id="uum-dx-Yau"/>
+                                    <outlet property="delegate" destination="tLZ-3e-cJY" id="Ig0-wR-2Ms"/>
+                                </connections>
+                            </tableView>
+                        </subviews>
+                        <color key="backgroundColor" white="1" alpha="1" colorSpace="custom" customColorSpace="genericGamma22GrayColorSpace"/>
+                        <constraints>
+                            <constraint firstAttribute="bottomMargin" secondItem="hwi-He-cKY" secondAttribute="bottom" id="UPd-Rr-5ev"/>
+                            <constraint firstItem="hwi-He-cKY" firstAttribute="trailing" secondItem="e4p-U3-YVf" secondAttribute="trailing" id="mcB-Fh-FAx"/>
+                            <constraint firstItem="hwi-He-cKY" firstAttribute="top" secondItem="eDL-oC-fDz" secondAttribute="topMargin" id="sVu-Pi-CPd"/>
+                            <constraint firstItem="hwi-He-cKY" firstAttribute="leading" secondItem="e4p-U3-YVf" secondAttribute="leading" id="tE5-ir-eJR"/>
+                        </constraints>
+                        <viewLayoutGuide key="safeArea" id="e4p-U3-YVf"/>
+                    </view>
+                    <connections>
+                        <outlet property="tableView" destination="hwi-He-cKY" id="dz2-gV-Lqe"/>
+                    </connections>
+                </viewController>
+                <placeholder placeholderIdentifier="IBFirstResponder" id="8Ut-YJ-O7J" userLabel="First Responder" sceneMemberID="firstResponder"/>
+            </objects>
+            <point key="canvasLocation" x="1388" y="2331.1844077961023"/>
+        </scene>
         <!--Dashboard-->
         <scene sceneID="GIl-fY-LQR">
             <objects>