Merge branch 'staging' into check-fb-app-links-client-side

aaustin · aaustin · commit e1e3207f02f1 · 2016-05-24T09:58:12.000-07:00
# Conflicts:
#	Branch-SDK/Branch-SDK/BNCPreferenceHelper.m
diff --git a/Branch-SDK/Branch-SDK/BNCDeviceInfo.h b/Branch-SDK/Branch-SDK/BNCDeviceInfo.h
@@ -17,7 +17,9 @@
 
 //---------Properties-------------//
 @property (nonatomic, strong) NSString *hardwareId;
+@property (nonatomic, strong) NSString *hardwareIdType;
 @property (nonatomic) BOOL isRealHardwareId;
+@property (nonatomic, strong) NSString *vendorId;
 @property (nonatomic, strong) NSString *brandName;
 @property (nonatomic, strong) NSString *modelName;
 @property (nonatomic, strong) NSString *osName;
diff --git a/Branch-SDK/Branch-SDK/BNCDeviceInfo.m b/Branch-SDK/Branch-SDK/BNCDeviceInfo.m
@@ -30,12 +30,15 @@ - (id)init {
     if (self = [super init]) {
         BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
         BOOL isRealHardwareId;
-        NSString *hardwareId = [BNCSystemObserver getUniqueHardwareId:&isRealHardwareId andIsDebug:preferenceHelper.isDebug];
+        NSString *hardwareIdType;
+        NSString *hardwareId = [BNCSystemObserver getUniqueHardwareId:&isRealHardwareId isDebug:preferenceHelper.isDebug andType:&hardwareIdType];
         if (hardwareId) {
             self.hardwareId = hardwareId;
             self.isRealHardwareId = isRealHardwareId;
+            self.hardwareIdType = hardwareIdType;
         }
         
+        self.vendorId = [BNCSystemObserver getVendorId:preferenceHelper.isDebug];
         self.brandName = [BNCSystemObserver getBrand];
         self.modelName = [BNCSystemObserver getModel];
         self.osName = [BNCSystemObserver getOS];
diff --git a/Branch-SDK/Branch-SDK/BNCPreferenceHelper.h b/Branch-SDK/Branch-SDK/BNCPreferenceHelper.h
@@ -65,6 +65,9 @@
 - (void)updateBranchViewCount:(NSString *)branchViewID;
 - (NSInteger)getBranchViewCount:(NSString *)branchViewID;
 
+- (void)setRequestMetadataKey:(NSString *)key value:(NSObject *)value;
+- (NSMutableDictionary *)requestMetadataDictionary;
+
 - (void)log:(NSString *)filename line:(int)line message:(NSString *)format, ...;
 - (void)logWarning:(NSString *)message;
 @end
diff --git a/Branch-SDK/Branch-SDK/BNCPreferenceHelper.m b/Branch-SDK/Branch-SDK/BNCPreferenceHelper.m
@@ -50,6 +50,7 @@ @interface BNCPreferenceHelper ()
 @property (strong, nonatomic) NSMutableDictionary *persistenceDict;
 @property (strong, nonatomic) NSMutableDictionary *countsDictionary;
 @property (strong, nonatomic) NSMutableDictionary *creditsDictionary;
+@property (strong, nonatomic) NSMutableDictionary *requestMetadataDictionary;
 @property (assign, nonatomic) BOOL isUsingLiveKey;
 
 @end
@@ -79,7 +80,8 @@ @implementation BNCPreferenceHelper
             retryInterval = _retryInterval,
             timeout = _timeout,
             lastStrongMatchDate = _lastStrongMatchDate,
-            checkedFacebookAppLinks = _checkedFacebookAppLinks;
+            checkedFacebookAppLinks = _checkedFacebookAppLinks,
+            requestMetadataDictionary = _requestMetadataDictionary;
 
 + (BNCPreferenceHelper *)preferenceHelper {
     static BNCPreferenceHelper *preferenceHelper;
@@ -460,6 +462,25 @@ - (id)getBranchUniversalLinkDomains {
     return [[[NSBundle mainBundle] infoDictionary] objectForKey:BRANCH_PREFS_KEY_BRANCH_UNIVERSAL_LINK_DOMAINS];
 }
 
+- (NSMutableDictionary *)requestMetadataDictionary {
+    if (!_requestMetadataDictionary) {
+        _requestMetadataDictionary = [NSMutableDictionary dictionary];
+    }
+    return _requestMetadataDictionary;
+}
+
+- (void)setRequestMetadataKey:(NSString *)key value:(NSObject *)value {
+    if (!key) {
+        return;
+    }
+    if ([self.requestMetadataDictionary objectForKey:key] && !value) {
+        [self.requestMetadataDictionary removeObjectForKey:key];
+    }
+    else if (value) {
+        [self.requestMetadataDictionary setObject:value forKey:key];
+    }
+}
+
 #pragma mark - Credit Storage
 
 - (NSMutableDictionary *)creditsDictionary {
diff --git a/Branch-SDK/Branch-SDK/BNCServerInterface.m b/Branch-SDK/Branch-SDK/BNCServerInterface.m
@@ -101,6 +101,9 @@ - (void)genericHTTPRequest:(NSURLRequest *)request retryNumber:(NSInteger)retryN
                 NSURLRequest *retryRequest = retryHandler(retryNumber);
                 [self genericHTTPRequest:retryRequest retryNumber:(retryNumber + 1) log:log callback:callback retryHandler:retryHandler];
             });
+            
+            // Do not continue on if retrying, else the callback will be called incorrectly
+            return;
         }
         else if (callback) {
             // Wrap up bad statuses w/ specific error messages
@@ -123,7 +126,7 @@ - (void)genericHTTPRequest:(NSURLRequest *)request retryNumber:(NSInteger)retryN
         }
         dispatch_async(dispatch_get_main_queue(), ^{
             if (callback)
-            callback(serverResponse, error);
+                callback(serverResponse, error);
         });
     };
     
@@ -214,6 +217,11 @@ - (NSDictionary *)prepareParamDict:(NSDictionary *)params key:(NSString *)key re
     fullParamDict[@"sdk"] = [NSString stringWithFormat:@"ios%@", SDK_VERSION];
     fullParamDict[@"retryNumber"] = @(retryNumber);
     
+    NSMutableDictionary *metadata = [[NSMutableDictionary alloc] init];
+    [metadata addEntriesFromDictionary:self.preferenceHelper.requestMetadataDictionary];
+    [metadata addEntriesFromDictionary:fullParamDict[BRANCH_REQUEST_KEY_STATE]];
+    fullParamDict[BRANCH_REQUEST_KEY_STATE] = metadata;
+    
     if ([key hasPrefix:@"key_"]) {
         fullParamDict[@"branch_key"] = key;
     }
@@ -248,9 +256,11 @@ - (void)updateDeviceInfoToMutableDictionary:(NSMutableDictionary *)dict {
    
     if (deviceInfo.hardwareId) {
         dict[BRANCH_REQUEST_KEY_HARDWARE_ID] = deviceInfo.hardwareId;
+        dict[BRANCH_REQUEST_KEY_HARDWARE_ID_TYPE] = deviceInfo.hardwareIdType;
         dict[BRANCH_REQUEST_KEY_IS_HARDWARE_ID_REAL] = @(deviceInfo.isRealHardwareId);
     }
     
+    [self safeSetValue:deviceInfo.vendorId forKey:BRANCH_REQUEST_KEY_IOS_VENDOR_ID onDict:dict];
     [self safeSetValue:deviceInfo.brandName forKey:BRANCH_REQUEST_KEY_BRAND onDict:dict];
     [self safeSetValue:deviceInfo.modelName forKey:BRANCH_REQUEST_KEY_MODEL onDict:dict];
     [self safeSetValue:deviceInfo.osName forKey:BRANCH_REQUEST_KEY_OS onDict:dict];
diff --git a/Branch-SDK/Branch-SDK/BNCStrongMatchHelper.m b/Branch-SDK/Branch-SDK/BNCStrongMatchHelper.m
@@ -80,7 +80,8 @@ - (void)presentSafariVCWithBranchKey:(NSString *)branchKey {
     
     BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
     BOOL isRealHardwareId;
-    NSString *hardwareId = [BNCSystemObserver getUniqueHardwareId:&isRealHardwareId andIsDebug:preferenceHelper.isDebug];
+    NSString *hardwareIdType;
+    NSString *hardwareId = [BNCSystemObserver getUniqueHardwareId:&isRealHardwareId isDebug:preferenceHelper.isDebug andType:&hardwareIdType];
     if (!hardwareId || !isRealHardwareId) {
         [preferenceHelper logWarning:@"Cannot use cookie-based matching while setDebug is enabled"];
         self.shouldDelayInstallRequest = NO;
@@ -111,8 +112,13 @@ - (void)presentSafariVCWithBranchKey:(NSString *)branchKey {
     
     Class SFSafariViewControllerClass = NSClassFromString(@"SFSafariViewController");
     if (SFSafariViewControllerClass) {
-        UIViewController * safController = [[SFSafariViewControllerClass alloc] initWithURL:[NSURL URLWithString:urlString]];
+        NSURL *strongMatchUrl = [NSURL URLWithString:[urlString stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding]];
+        if (!strongMatchUrl) {
+            self.requestInProgress = NO;
+            return;
+        }
         
+        UIViewController * safController = [[SFSafariViewControllerClass alloc] initWithURL:strongMatchUrl];
         self.secondWindow = [[UIWindow alloc] initWithFrame:[[[[UIApplication sharedApplication] windows] firstObject] bounds]];
         UIViewController *windowRootController = [[UIViewController alloc] init];
         self.secondWindow.rootViewController = windowRootController;
diff --git a/Branch-SDK/Branch-SDK/BNCSystemObserver.h b/Branch-SDK/Branch-SDK/BNCSystemObserver.h
@@ -10,7 +10,8 @@
 
 @interface BNCSystemObserver : NSObject
 
-+ (NSString *)getUniqueHardwareId:(BOOL *)isReal andIsDebug:(BOOL)debug;
++ (NSString *)getUniqueHardwareId:(BOOL *)isReal isDebug:(BOOL)debug andType:(NSString **)type;
++ (NSString *)getVendorId:(BOOL)debug;
 + (NSString *)getDefaultUriScheme;
 + (NSString *)getAppVersion;
 + (NSString *)getBundleID;
diff --git a/Branch-SDK/Branch-SDK/BNCSystemObserver.m b/Branch-SDK/Branch-SDK/BNCSystemObserver.m
@@ -16,7 +16,7 @@
 
 @implementation BNCSystemObserver
 
-+ (NSString *)getUniqueHardwareId:(BOOL *)isReal andIsDebug:(BOOL)debug {
++ (NSString *)getUniqueHardwareId:(BOOL *)isReal isDebug:(BOOL)debug andType:(NSString **)type {
     NSString *uid = nil;
     *isReal = YES;
 
@@ -27,20 +27,33 @@ + (NSString *)getUniqueHardwareId:(BOOL *)isReal andIsDebug:(BOOL)debug {
         SEL advertisingIdentifierSelector = NSSelectorFromString(@"advertisingIdentifier");
         NSUUID *uuid = ((NSUUID* (*)(id, SEL))[sharedManager methodForSelector:advertisingIdentifierSelector])(sharedManager, advertisingIdentifierSelector);
         uid = [uuid UUIDString];
+        *type = @"idfa";
     }
 
     if (!uid && NSClassFromString(@"UIDevice") && !debug) {
         uid = [[UIDevice currentDevice].identifierForVendor UUIDString];
+        *type = @"vendor_id";
     }
 
     if (!uid) {
         uid = [[NSUUID UUID] UUIDString];
+        *type = @"random";
         *isReal = NO;
     }
 
     return uid;
 }
 
++ (NSString *)getVendorId:(BOOL)debug {
+    NSString *vendorId = nil;
+    
+    if (!debug && NSClassFromString(@"UIDevice")) {
+        vendorId = [[UIDevice currentDevice].identifierForVendor UUIDString];
+    }
+    
+    return vendorId;
+}
+
 + (BOOL)adTrackingSafe {
     Class ASIdentifierManagerClass = NSClassFromString(@"ASIdentifierManager");
     if (ASIdentifierManagerClass) {
diff --git a/Branch-SDK/Branch-SDK/Branch.h b/Branch-SDK/Branch-SDK/Branch.h
@@ -428,6 +428,14 @@ typedef NS_ENUM(NSUInteger, BranchPromoCodeUsageType) {
 
 - (void)suppressWarningLogs;
 
+/**
+ Key-value pairs to be included in the metadata on every request.
+ 
+ @param key String to be included in request metadata
+ @param value Object to be included in request metadata
+ */
+- (void)setRequestMetadataKey:(NSString *)key value:(NSObject *)value;
+
 #pragma mark - Session Item methods
 
 ///--------------------
diff --git a/Branch-SDK/Branch-SDK/Branch.m b/Branch-SDK/Branch-SDK/Branch.m
@@ -267,6 +267,11 @@ - (void)accountForFacebookSDKPreventingAppLaunch {
 - (void)suppressWarningLogs {
     self.preferenceHelper.suppressWarningLogs = YES;
 }
+
+- (void)setRequestMetadataKey:(NSString *)key value:(NSObject *)value {
+    [self.preferenceHelper setRequestMetadataKey:key value:value];
+}
+
 #pragma mark - InitSession Permutation methods
 
 - (void)initSessionWithLaunchOptions:(NSDictionary *)options {
diff --git a/Branch-SDK/Branch-SDK/BranchConstants.h b/Branch-SDK/Branch-SDK/BranchConstants.h
@@ -38,7 +38,9 @@ extern NSString * const BRANCH_REQUEST_KEY_URL_DATA;
 extern NSString * const BRANCH_REQUEST_KEY_URL_IGNORE_UA_STRING;
 extern NSString * const BRANCH_REQUEST_KEY_APP_LIST;
 extern NSString * const BRANCH_REQUEST_KEY_HARDWARE_ID;
+extern NSString * const BRANCH_REQUEST_KEY_HARDWARE_ID_TYPE;
 extern NSString * const BRANCH_REQUEST_KEY_IS_HARDWARE_ID_REAL;
+extern NSString * const BRANCH_REQUEST_KEY_IOS_VENDOR_ID;
 extern NSString * const BRANCH_REQUEST_KEY_AD_TRACKING_ENABLED;
 extern NSString * const BRANCH_REQUEST_KEY_IS_REFERRABLE;
 extern NSString * const BRANCH_REQUEST_KEY_DEBUG;
diff --git a/Branch-SDK/Branch-SDK/BranchConstants.m b/Branch-SDK/Branch-SDK/BranchConstants.m
@@ -38,7 +38,9 @@
 NSString * const BRANCH_REQUEST_KEY_URL_IGNORE_UA_STRING = @"ignore_ua_string";
 NSString * const BRANCH_REQUEST_KEY_APP_LIST = @"apps_data";
 NSString * const BRANCH_REQUEST_KEY_HARDWARE_ID = @"hardware_id";
+NSString * const BRANCH_REQUEST_KEY_HARDWARE_ID_TYPE = @"hardware_id_type";
 NSString * const BRANCH_REQUEST_KEY_IS_HARDWARE_ID_REAL = @"is_hardware_id_real";
+NSString * const BRANCH_REQUEST_KEY_IOS_VENDOR_ID = @"ios_vendor_id";
 NSString * const BRANCH_REQUEST_KEY_AD_TRACKING_ENABLED = @"ad_tracking_enabled";
 NSString * const BRANCH_REQUEST_KEY_IS_REFERRABLE = @"is_referrable";
 NSString * const BRANCH_REQUEST_KEY_DEBUG = @"debug";
diff --git a/Branch-TestBed/Branch-SDK-Tests/BranchInstallRequestTests.m b/Branch-TestBed/Branch-SDK-Tests/BranchInstallRequestTests.m
@@ -53,7 +53,7 @@ - (void)testRequestBody {
     preferenceHelper.linkClickIdentifier = LINK_IDENTIFIER;
     
     id systemObserverMock = OCMClassMock([BNCSystemObserver class]);
-    [[[[systemObserverMock stub] ignoringNonObjectArgs] andReturn:HARDWARE_ID] getUniqueHardwareId:0 andIsDebug:YES];
+    [[[[systemObserverMock stub] ignoringNonObjectArgs] andReturn:HARDWARE_ID] getUniqueHardwareId:0 isDebug:YES andType:nil];
     [[[systemObserverMock stub] andReturnValue:AD_TRACKING_SAFE] adTrackingSafe];
     [[[systemObserverMock stub] andReturn:BUNDLE_ID] getBundleID];
     [[[systemObserverMock stub] andReturn:APP_VERSION] getAppVersion];
diff --git a/Branch.podspec b/Branch.podspec
@@ -21,7 +21,15 @@ Use the Branch SDK (branch.io) to create and power the links that point back to
   s.platform     = :ios, '6.0'
   s.requires_arc = true
 
-  s.source_files = "Branch-SDK/Branch-SDK/*.{h,m}", "Branch-SDK/Fabric/*.h", "Branch-SDK/Branch-SDK/Requests/*.{h,m}"
+  s.subspec 'Core' do |core|
+    core.source_files = "Branch-SDK/Branch-SDK/*.{h,m}", "Branch-SDK/Fabric/*.h", "Branch-SDK/Branch-SDK/Requests/*.{h,m}"
 
-  s.frameworks = 'AdSupport', 'CoreTelephony', 'MobileCoreServices'
+    core.frameworks = 'AdSupport', 'CoreTelephony', 'MobileCoreServices'
+  end
+
+  s.subspec 'without-IDFA' do |idfa|
+    idfa.source_files = "Branch-SDK/Branch-SDK/*.{h,m}", "Branch-SDK/Fabric/*.h", "Branch-SDK/Branch-SDK/Requests/*.{h,m}"
+
+    idfa.frameworks = 'CoreTelephony', 'MobileCoreServices'
+  end
 end
diff --git a/README.md b/README.md
@@ -634,7 +634,7 @@ UIActivityView is the standard way of allowing users to share content from your
 
 **Sample UIActivityView Share Sheet**
 
-![UIActivityView Share Sheet](https://dev.branch.io/img/pages/getting-started/branch-universal-object/ios_share_sheet.png)
+![UIActivityView Share Sheet](https://dev.branch.io/img/ingredients/sdk_links/ios_share_sheet.jpg)
 
 The Branch iOS SDK includes a wrapper on the UIActivityViewController, that will generate a Branch short URL and automatically tag it with the channel the user selects (Facebook, Twitter, etc.).
 
