Merge pull request #492 from BranchMetrics/Add-Keys-AIS-109-AIS-106

Add-Keys-AIS-109-AIS-106

Author: E-B-Smith

Branch-SDK/Branch-SDK/BNCDeviceInfo.h

@@ -28,8 +28,12 @@
 @property (nonatomic, strong) NSNumber *screenHeight;
 @property (nonatomic) BOOL isAdTrackingEnabled;
 
+@property (nonatomic, strong) NSString* country;            //  iso2 Country name (us, in,etc).
+@property (nonatomic, strong) NSString* language;           //  iso2 language code (en, ml).
+@property (nonatomic, strong) NSString* browserUserAgent;   //  Simple user agent string.
+
 
 //----------Methods----------------//
 + (BNCDeviceInfo *)getInstance;
 
-@end
+@end

Branch-SDK/Branch-SDK/BNCDeviceInfo.m

@@ -7,6 +7,7 @@
 //
 
 #import <Foundation/Foundation.h>
+#import <UIKit/UIKit.h>
 #import "BNCDeviceInfo.h"
 #import "BNCPreferenceHelper.h"
 #import "BNCSystemObserver.h"
@@ -27,26 +28,62 @@ + (BNCDeviceInfo *)getInstance {
 }
 
 - (id)init {
-    if (self = [super init]) {
-        BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
-        BOOL isRealHardwareId;
-        NSString *hardwareIdType;
-        NSString *hardwareId = [BNCSystemObserver getUniqueHardwareId:&isRealHardwareId isDebug:preferenceHelper.isDebug andType:&hardwareIdType];
-        if (hardwareId) {
-            self.hardwareId = hardwareId;
-            self.isRealHardwareId = isRealHardwareId;
-            self.hardwareIdType = hardwareIdType;
+    self = [super init];
+    if (!self) return self;
+
+    BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
+    BOOL isRealHardwareId;
+    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];
+    self.brandName = [BNCSystemObserver getBrand];
+    self.modelName = [BNCSystemObserver getModel];
+    self.osName = [BNCSystemObserver getOS];
+    self.osVersion = [BNCSystemObserver getOSVersion];
+    self.screenWidth = [BNCSystemObserver getScreenWidth];
+    self.screenHeight = [BNCSystemObserver getScreenHeight];
+    self.isAdTrackingEnabled = [BNCSystemObserver adTrackingSafe];
+
+    //  Get the locale info --
+    CGFloat systemVersion = [UIDevice currentDevice].systemVersion.floatValue;
+    if (systemVersion < 9.0) {
+
+        self.language = [[NSLocale preferredLanguages] firstObject];
+        NSString *rawLocale = [NSLocale currentLocale].localeIdentifier;
+        NSRange range = [rawLocale rangeOfString:@"_"];
+        if (range.location != NSNotFound) {
+            range = NSMakeRange(range.location+1, rawLocale.length-range.location-1);
+            self.country = [rawLocale substringWithRange:range];
         }
-        
-        self.vendorId = [BNCSystemObserver getVendorId];
-        self.brandName = [BNCSystemObserver getBrand];
-        self.modelName = [BNCSystemObserver getModel];
-        self.osName = [BNCSystemObserver getOS];
-        self.osVersion = [BNCSystemObserver getOSVersion];
-        self.screenWidth = [BNCSystemObserver getScreenWidth];
-        self.screenHeight = [BNCSystemObserver getScreenHeight];
-        self.isAdTrackingEnabled = [BNCSystemObserver adTrackingSafe];
+
+    } else if (systemVersion < 10.0) {
+
+        NSString *rawLanguage = [[NSLocale preferredLanguages] firstObject];
+        NSDictionary *languageDictionary = [NSLocale componentsFromLocaleIdentifier:rawLanguage];
+        self.country = [languageDictionary objectForKey:@"kCFLocaleCountryCodeKey"];
+        self.language = [languageDictionary  objectForKey:@"kCFLocaleLanguageCodeKey"];
+
+    } else {
+
+        self.country = [NSLocale currentLocale].countryCode;
+        self.language = [NSLocale currentLocale].languageCode;
+
     }
+
+    self.browserUserAgent =
+        [[[UIWebView alloc]
+            initWithFrame:CGRectZero]
+                stringByEvaluatingJavaScriptFromString:@"navigator.userAgent"];
+
     return self;
 }
 

Branch-SDK/Branch-SDK/BNCServerInterface.m

@@ -298,7 +298,11 @@ - (void)updateDeviceInfoToMutableDictionary:(NSMutableDictionary *)dict {
     [self safeSetValue:deviceInfo.osVersion forKey:BRANCH_REQUEST_KEY_OS_VERSION onDict:dict];
     [self safeSetValue:deviceInfo.screenWidth forKey:BRANCH_REQUEST_KEY_SCREEN_WIDTH onDict:dict];
     [self safeSetValue:deviceInfo.screenHeight forKey:BRANCH_REQUEST_KEY_SCREEN_HEIGHT onDict:dict];
-    
+
+    [self safeSetValue:deviceInfo.browserUserAgent forKey:@"user_agent" onDict:dict];
+    [self safeSetValue:deviceInfo.country forKey:@"country" onDict:dict];
+    [self safeSetValue:deviceInfo.language forKey:@"language" onDict:dict];
+
     dict[BRANCH_REQUEST_KEY_AD_TRACKING_ENABLED] = @(deviceInfo.isAdTrackingEnabled);
 
 }

Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj

@@ -112,7 +112,7 @@
 		67486B8D1B93B48A0044D872 /* BNCStrongMatchHelper.h in Headers */ = {isa = PBXBuildFile; fileRef = 67486B8B1B93B48A0044D872 /* BNCStrongMatchHelper.h */; };
 		67486B8E1B93B48A0044D872 /* BNCStrongMatchHelper.m in Sources */ = {isa = PBXBuildFile; fileRef = 67486B8C1B93B48A0044D872 /* BNCStrongMatchHelper.m */; };
 		677F4CB51C1FB1910029F2B3 /* Branch-TestBed.entitlements in Resources */ = {isa = PBXBuildFile; fileRef = 677F4CB41C1FB0FA0029F2B3 /* Branch-TestBed.entitlements */; };
-		67F270891BA9FCFF002546A7 /* CoreSpotlight.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 67F270881BA9FCFF002546A7 /* CoreSpotlight.framework */; settings = {ATTRIBUTES = (Required, ); }; };
+		67F270891BA9FCFF002546A7 /* CoreSpotlight.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 67F270881BA9FCFF002546A7 /* CoreSpotlight.framework */; settings = {ATTRIBUTES = (Weak, ); }; };
 		7D0C97191D8753C9004E14B1 /* BranchContentDiscoverer.m in Sources */ = {isa = PBXBuildFile; fileRef = 7D0C97181D8753C9004E14B1 /* BranchContentDiscoverer.m */; };
 		7D0C971D1D875465004E14B1 /* BranchContentDiscoveryManifest.m in Sources */ = {isa = PBXBuildFile; fileRef = 7D0C971C1D875465004E14B1 /* BranchContentDiscoveryManifest.m */; };
 		7D0C97201D87549B004E14B1 /* BranchContentPathProperties.m in Sources */ = {isa = PBXBuildFile; fileRef = 7D0C971F1D87549B004E14B1 /* BranchContentPathProperties.m */; };

ChangeLog.md

@@ -1,5 +1,11 @@
 Branch iOS SDK change log
 
+- v0.12.13
+  * AIS-106: Included user_agent in device POST parameters.
+  * AIS-109: Included language & country in device POST parameters.
+  * INT-2882: Moved Branch support files from Documents directory to Application Support directory.
+  * Github #487: Updated documentation to mention that application:willFinishLaunchingWithOptions:
+    also has to return YES on app launch.
 - v0.12.12
   * Updated Swift example to Swift 3.0
   * Updated Update README.md Documentation Syntax for Swift
@@ -18,7 +24,7 @@ Branch iOS SDK change log
 - v0.12.10
   * Fix for issue causing initsession hang on cold start from universal link
   * Adding few crash protection
-  * Removing BUO nullable fields  
+  * Removing BUO nullable fields
 
 - v0.12.9
   * Fixing the time delay for strong match check using SVC
@@ -37,7 +43,7 @@ Branch iOS SDK change log
   * Remove debug gesture
   * Better instrumentation on retries
   * Add checksumming to the release procedure
-  * Fix Branch & Mopub Fabric header conflict 
+  * Fix Branch & Mopub Fabric header conflict
   * Nullability and nonnull support for Swift
   * Add campaign to link properties
   * iOS 10 optimizations
@@ -47,7 +53,7 @@ Branch iOS SDK change log
   * fix module.map path on Carthage project
   * ability to whitelist URI schemes
 
-- v0.12.4 
+- v0.12.4
   * setDebug must be called on getInstance. It's no longer a static method.
   * referral code and promo code methods are no longer available
   * action count methods are no longer available
@@ -60,7 +66,7 @@ Branch iOS SDK change log
 - v0.12.3
   * Fabric Answers integration
   * Swift Testbed
-  * Retry in poor network conditions 
+  * Retry in poor network conditions
   * Fix for Facebook calling openUrl from within the app
   * Fix Fabric headers conflict
   * Simplify Carthage project
@@ -111,7 +117,7 @@ Branch iOS SDK change log
   * workaround for Facebook sometimes returning NO from didFinishLaunching
   * spotlight IDs optionally returned in indexing callbacks
   * added ability to have custom parameters appear in deeplink data for debugging
-  * removed fftl 
+  * removed fftl
   * added externalIntentURI to capture referrals
 
 - v0.11.13
@@ -128,7 +134,7 @@ Branch iOS SDK change log
   * Set email subject on share sheet
   * 100% matching prototype. Woo!
   * BRanchUniversalObject with only canonical url allowed
-  * Update register-view call so it's no longer a flat object  
+  * Update register-view call so it's no longer a flat object
   * Fix debug tests
   * Fix setUserUrl capitalization
   * TeamID can be gotten from plist or original way
@@ -162,7 +168,7 @@ Branch iOS SDK change log
     * easy listing for Spotlight search
   * fixed bugs / made additions for debug mode
   * squashed annoying warnings that some users saw
-  * safer unarchiving of saved info (BNCPreferenceHelper) 
+  * safer unarchiving of saved info (BNCPreferenceHelper)
 
 - v0.11.6
   * fix race condition if certain methods are invoked before initSession
@@ -227,7 +233,7 @@ Branch iOS SDK change log
     * If isReferrable is false, it will not be set.
     * If the session data returned from the API call is empty, it will not be set.
     * If the session data is not from a link click, it will not be set.
-    * If the request is an open request, it will only be set if install params are empty.  
+    * If the request is an open request, it will only be set if install params are empty.
 
 - v0.10.2
   * Fixing potential for bad types to come through in UserIdentity (number rather than string).

ReleaseNotes.md

@@ -2,15 +2,26 @@
 Branch SDK Release Notes
 ========================
 
+
+*  Check the change log for specific fixes:  [Change log on Github.](https://github.com/BranchMetrics/ios-branch-deep-linking/blob/master/ChangeLog.md)
+
+
+####  Branch Version 0.12.13
+Better Match keys, Better Documentation - Tuesday, October 25 2016
+
+*  There are no breaking changes in this release.
+
+*  There are no significant new features in this release.
+
+
 ####  Branch Version 0.12.12
-Bug fixes, Swift Updates, and iOS 10 Compatibility – Tuesday, October 11 2016
+Bug Fixes, Swift Updates, and iOS 10 Compatibility – Tuesday, October 11 2016
 
-* There are no breaking changes in this release.
+*  There are no breaking changes in this release.
 
-* The Swift example and documentation have been updated for Swift 3.0.
+*  The Swift example and documentation have been updated for Swift 3.0.
 
-* We've diagnosed an open problem when Branch, Localytics, and Google Analytics are all used 
-  in the same app.  You can read the details and work-arounds in the Github issue 
-  [Branch, Localytics, and Google Analytics.](https://github.com/BranchMetrics/ios-branch-deep-linking/issues/485)
+*  We've diagnosed an open problem when Branch, Localytics, and Google Analytics are all used
+   in the same app.  You can read the details and work-arounds in the Github issue
+   [Branch, Localytics, and Google Analytics.](https://github.com/BranchMetrics/ios-branch-deep-linking/issues/485)
 
-* Check the change log for specific fixes:  [Change log on Github.](https://github.com/BranchMetrics/ios-branch-deep-linking/blob/master/ChangeLog.md)