Limit app tracking (AIS-417) (#754)

* Added limit_app_tracking.
* Updated variable names, added test.
* Update test framework scheme.
* Fixed merge error.

Author: E-B-Smith

Branch-SDK/Branch-SDK/BNCCommerceEvent.m

@@ -354,6 +354,8 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface
 		params[@"metadata"] = self.metadata;
 	if (self.commerceDictionary)
 		params[@"commerce_data"] = self.commerceDictionary;
+    if (preferenceHelper.limitFacebookTracking)
+        params[@"limit_facebook_tracking"] = CFBridgingRelease(kCFBooleanTrue);
 
 	NSString *URL = [preferenceHelper getAPIURL:BRANCH_REQUEST_ENDPOINT_USER_COMPLETED_ACTION];
     [serverInterface postRequest:params

Branch-SDK/Branch-SDK/BNCDeviceInfo.m

@@ -436,7 +436,7 @@ - (NSDictionary*) v2dictionary {
     addNumber(screenWidth,          screen_width);
     addBoolean(unidentifiedDevice,  unidentified_device);
     addString(localIPAddress,       local_ip);
-    
+
     #include "BNCFieldDefines.h"
 
     if (!self.isAdTrackingEnabled)
@@ -451,6 +451,9 @@ - (NSDictionary*) v2dictionary {
     s = preferences.deviceFingerprintID;
     if (s.length) dictionary[@"device_fingerprint_id"] = s;
 
+    if (preferences.limitFacebookTracking)
+        dictionary[@"limit_facebook_tracking"] = CFBridgingRelease(kCFBooleanTrue);
+
     dictionary[@"sdk"] = @"ios";
     dictionary[@"sdk_version"] = BNC_SDK_VERSION;
 

Branch-SDK/Branch-SDK/BNCPreferenceHelper.h

@@ -48,6 +48,7 @@ NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
 @property (strong, nonatomic) NSString *browserUserAgentString;
 @property (strong, atomic) NSString *referringURL;
 @property (strong, atomic) NSString *branchAPIURL;
+@property (assign, atomic) BOOL      limitFacebookTracking;
 
 + (BNCPreferenceHelper *)preferenceHelper;
 

Branch-SDK/Branch-SDK/BNCPreferenceHelper.m

@@ -550,6 +550,18 @@ - (void)clearInstrumentationDictionary {
     }
 }
 
+- (BOOL) limitFacebookTracking {
+    @synchronized (self) {
+        return [self readBoolFromDefaults:@"_limitFacebookTracking"];
+    }
+}
+
+- (void) setLimitFacebookTracking:(BOOL)limitFacebookTracking {
+    @synchronized (self) {
+        [self writeBoolToDefaults:@"_limitFacebookTracking" value:limitFacebookTracking];
+    }
+}
+
 #pragma mark - Credit Storage
 
 - (NSMutableDictionary *)creditsDictionary {

Branch-SDK/Branch-SDK/Networking/Requests/BranchOpenRequest.m

@@ -62,6 +62,8 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
     [self safeSetValue:preferenceHelper.spotlightIdentifier forKey:BRANCH_REQUEST_KEY_SPOTLIGHT_IDENTIFIER onDict:params];
     [self safeSetValue:preferenceHelper.universalLinkUrl forKey:BRANCH_REQUEST_KEY_UNIVERSAL_LINK_URL onDict:params];
     [self safeSetValue:preferenceHelper.externalIntentURI forKey:BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI onDict:params];
+    if (preferenceHelper.limitFacebookTracking)
+        params[@"limit_facebook_tracking"] = CFBridgingRelease(kCFBooleanTrue);
 
     NSMutableDictionary *cdDict = [[NSMutableDictionary alloc] init];
     BranchContentDiscoveryManifest *contentDiscoveryManifest = [BranchContentDiscoveryManifest getInstance];

Branch-SDK/Branch-SDK/Networking/Requests/BranchUserCompletedActionRequest.m

@@ -53,7 +53,9 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface
     params[BRANCH_REQUEST_KEY_DEVICE_FINGERPRINT_ID] = preferenceHelper.deviceFingerprintID;
     params[BRANCH_REQUEST_KEY_BRANCH_IDENTITY] = preferenceHelper.identityID;
     params[BRANCH_REQUEST_KEY_SESSION_ID] = preferenceHelper.sessionID;
-    
+    if (preferenceHelper.limitFacebookTracking)
+        params[@"limit_facebook_tracking"] = CFBridgingRelease(kCFBooleanTrue);
+
     if (self.state) {
         params[BRANCH_REQUEST_KEY_STATE] = self.state;
     }

Branch-TestBed/Branch-TestBed-UITests/UITestBed.xcodeproj/xcshareddata/xcschemes/UITestBed.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0830"
+   LastUpgradeVersion = "0910"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -26,6 +26,7 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      language = ""
       shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
       </Testables>
@@ -45,6 +46,7 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      language = ""
       launchStyle = "0"
       useCustomWorkingDirectory = "NO"
       ignoresPersistentStateOnLaunch = "NO"

Branch-TestBed/Branch-TestBed-UITests/UITestBed/Assets.xcassets/AppIcon.appiconset/Contents.json

@@ -84,6 +84,11 @@
       "idiom" : "ipad",
       "size" : "83.5x83.5",
       "scale" : "2x"
+    },
+    {
+      "idiom" : "ios-marketing",
+      "size" : "1024x1024",
+      "scale" : "1x"
     }
   ],
   "info" : {

Branch-TestBed/Branch-TestBed-UITests/UITestBed/TBBranchViewController.m

@@ -69,6 +69,7 @@ - (void)initializeTableData {
     row(@"Show Local IP Addess", showLocalIPAddress:);
     row(@"Show Current View Controller", showCurrentViewController:)
     row(@"Show App Dates", showDatesAction:)
+    row(@"Toggle Facebook App Tracking", toggleFacebookAppTrackingAction:)
 
     #undef section
     #undef row
@@ -317,6 +318,18 @@ - (IBAction) showCurrentViewController:(id)send {
     ];
 }
 
+- (IBAction) toggleFacebookAppTrackingAction:(id)sender {
+    BNCPreferenceHelper *prefs = [BNCPreferenceHelper preferenceHelper];
+    BOOL nextState = !prefs.limitFacebookTracking;
+    prefs.limitFacebookTracking = nextState;
+    [self showDataViewControllerWithObject:@{
+            @"Limit Facebook App Tracking": (nextState) ? @"On" : @"Off"
+        }
+        title:@"Limit Facebook App Tracking"
+        message:nil
+    ];
+}
+
 - (IBAction) showDatesAction:(id)sender {
     NSDate *buildDate = [BNCSystemObserver appBuildDate];
     NSDate *installDate = [BNCSystemObserver appInstallDate];