Merge pull request #927 from BranchMetrics/SDK-208-apple-receipt

echo-branch · web-flow · commit eb00d9d85172 · 2019-08-28T16:02:56.000-07:00
SDK-208 apple receipt
diff --git a/Branch-SDK-Tests/BNCAppleReceiptTests.m b/Branch-SDK-Tests/BNCAppleReceiptTests.m
@@ -0,0 +1,32 @@
+//
+//  BNCAppleReceiptTests.m
+//  Branch-SDK-Tests
+//
+//  Created by Ernest Cho on 7/15/19.
+//  Copyright © 2019 Branch, Inc. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+#import "BNCAppleReceipt.h"
+
+@interface BNCAppleReceiptTests : XCTestCase
+
+@end
+
+@implementation BNCAppleReceiptTests
+
+- (void)setUp {
+    // Put setup code here. This method is called before the invocation of each test method in the class.
+}
+
+- (void)tearDown {
+    // Put teardown code here. This method is called after the invocation of each test method in the class.
+}
+
+- (void)testReceiptIsNil {
+    BNCAppleReceipt *receipt = [BNCAppleReceipt new];
+    XCTAssertNil([receipt installReceipt]);
+    XCTAssertFalse([receipt isTestFlight]);
+}
+
+@end
diff --git a/Branch-SDK-Tests/BranchInstallRequestTests.m b/Branch-SDK-Tests/BranchInstallRequestTests.m
@@ -88,7 +88,8 @@ - (void)testRequestBody {
         @"link_identifier":             @"foo-link-id",
         @"first_install_time":          BNCWireFormatFromDate(appDate),
         @"uri_scheme":                  @"foo-uri-scheme",
-        @"update":                      @0
+        @"update":                      @0,
+        @"apple_testflight":            @0
     }];
     if (!self.class.isApplication) expectedParams[@"ios_team_id"] = nil;
 
diff --git a/Branch-SDK-Tests/BranchOpenRequestTests.m b/Branch-SDK-Tests/BranchOpenRequestTests.m
@@ -93,7 +93,8 @@ - (void)testRequestBodyWithNoFingerprintID {
         @"lastest_update_time":         BNCWireFormatFromDate(installDate),
         @"first_install_time":          BNCWireFormatFromDate(installDate),
         @"previous_update_time":        BNCWireFormatFromDate(updateDate),
-        @"update":                      @1
+        @"update":                      @1,
+        @"apple_testflight":            @0
     }];
     if (!self.class.isApplication) expectedParams[@"ios_team_id"] = nil;
 
@@ -173,7 +174,8 @@ - (void)testRequestBodyWithFingerprintID {
         @"lastest_update_time":         BNCWireFormatFromDate(installDate),
         @"first_install_time":          BNCWireFormatFromDate(installDate),
         @"previous_update_time":        BNCWireFormatFromDate(updateDate),
-        @"update":                      @1
+        @"update":                      @1,
+        @"apple_testflight":            @0
     }];
     if (!self.class.isApplication) expectedParams[@"ios_team_id"] = nil;
 
diff --git a/Branch-SDK/Branch-SDK/BNCAppleReceipt.h b/Branch-SDK/Branch-SDK/BNCAppleReceipt.h
@@ -0,0 +1,23 @@
+//
+//  BNCAppleReceipt.h
+//  Branch
+//
+//  Created by Ernest Cho on 7/11/19.
+//  Copyright © 2019 Branch, Inc. All rights reserved.
+//
+
+@import Foundation;
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface BNCAppleReceipt : NSObject
+
++ (BNCAppleReceipt *)instance;
+
+// this is only available on builds from Apple
+- (nullable NSString *)installReceipt;
+- (BOOL)isTestFlight;
+
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/Branch-SDK/Branch-SDK/BNCAppleReceipt.m b/Branch-SDK/Branch-SDK/BNCAppleReceipt.m
@@ -0,0 +1,56 @@
+//
+//  BNCAppleReceipt.m
+//  Branch
+//
+//  Created by Ernest Cho on 7/11/19.
+//  Copyright © 2019 Branch, Inc. All rights reserved.
+//
+
+#import "BNCAppleReceipt.h"
+
+@interface BNCAppleReceipt()
+@property (nonatomic, copy, readwrite) NSString *receipt;
+@property (nonatomic, assign, readwrite) BOOL isSandboxReceipt;
+@end
+
+@implementation BNCAppleReceipt
+
++ (BNCAppleReceipt *)instance {
+    static BNCAppleReceipt *singleton;
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        singleton = [[BNCAppleReceipt alloc] init];
+    });
+    return singleton;
+}
+
+- (instancetype)init {
+    self = [super init];
+    if (self) {
+        [self readReceipt];
+    }
+    return self;
+}
+
+- (void)readReceipt {
+    NSURL *receiptURL = [[NSBundle mainBundle] appStoreReceiptURL];
+    if (receiptURL) {
+        self.isSandboxReceipt = [receiptURL.lastPathComponent isEqualToString:@"sandboxReceipt"];
+    }
+    
+    NSData *receiptData = [NSData dataWithContentsOfURL:receiptURL];
+    if (receiptData) {
+        self.receipt = [receiptData base64EncodedStringWithOptions:0];
+    }
+}
+
+- (nullable NSString *)installReceipt {
+    return self.receipt;
+}
+
+- (BOOL)isTestFlight {
+    // sandbox receipts are from testflight
+    return self.isSandboxReceipt;
+}
+
+@end
diff --git a/Branch-SDK/Branch-SDK/BranchConstants.h b/Branch-SDK/Branch-SDK/BranchConstants.h
@@ -65,6 +65,8 @@ extern NSString * const BRANCH_REQUEST_KEY_IS_SIMULATOR;
 extern NSString * const BRANCH_REQUEST_KEY_LOG;
 extern NSString * const BRANCH_REQUEST_KEY_EXTERNAL_INTENT_URI;
 extern NSString * const BRANCH_REQUEST_KEY_INSTRUMENTATION;
+extern NSString * const BRANCH_REQUEST_KEY_APPLE_RECEIPT;
+extern NSString * const BRANCH_REQUEST_KEY_APPLE_TESTFLIGHT;
 
 extern NSString * const BRANCH_REQUEST_ENDPOINT_SET_IDENTITY;
 extern NSString * const BRANCH_REQUEST_ENDPOINT_APP_LINK_SETTINGS;
diff --git a/Branch-SDK/Branch-SDK/BranchConstants.m b/Branch-SDK/Branch-SDK/BranchConstants.m
@@ -60,6 +60,8 @@
 NSString * const BRANCH_REQUEST_KEY_IS_SIMULATOR = @"is_simulator";
 NSString * const BRANCH_REQUEST_KEY_LOG = @"log";
 NSString * const BRANCH_REQUEST_KEY_INSTRUMENTATION = @"instrumentation";
+NSString * const BRANCH_REQUEST_KEY_APPLE_RECEIPT = @"apple_receipt";
+NSString * const BRANCH_REQUEST_KEY_APPLE_TESTFLIGHT = @"apple_testflight";
 
 NSString * const BRANCH_REQUEST_ENDPOINT_SET_IDENTITY = @"profile";
 NSString * const BRANCH_REQUEST_ENDPOINT_APP_LINK_SETTINGS = @"app-link-settings";
diff --git a/Branch-SDK/Branch-SDK/Networking/Requests/BranchInstallRequest.m b/Branch-SDK/Branch-SDK/Networking/Requests/BranchInstallRequest.m
@@ -13,6 +13,7 @@
 #import "BNCStrongMatchHelper.h"
 #import "BNCEncodingUtils.h"
 #import "BNCApplication.h"
+#import "BNCAppleReceipt.h"
 
 @implementation BranchInstallRequest
 
@@ -37,6 +38,9 @@ - (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:[[BNCAppleReceipt instance] installReceipt] forKey:BRANCH_REQUEST_KEY_APPLE_RECEIPT onDict:params];
+    [self safeSetValue:[NSNumber numberWithBool:[[BNCAppleReceipt instance] isTestFlight]] forKey:BRANCH_REQUEST_KEY_APPLE_TESTFLIGHT onDict:params];
+    
     params[BRANCH_REQUEST_KEY_DEBUG] = @(preferenceHelper.isDebug);
 
     if (preferenceHelper.appleSearchAdNeedsSend) {
diff --git a/Branch-SDK/Branch-SDK/Networking/Requests/BranchOpenRequest.m b/Branch-SDK/Branch-SDK/Networking/Requests/BranchOpenRequest.m
@@ -17,6 +17,7 @@
 #import "BNCDeviceInfo.h"
 #import "Branch.h"
 #import "BNCApplication.h"
+#import "BNCAppleReceipt.h"
 
 @interface BranchOpenRequest ()
 @property (assign, nonatomic) BOOL isInstall;
@@ -64,6 +65,8 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
     if (preferenceHelper.limitFacebookTracking)
         params[@"limit_facebook_tracking"] = (__bridge NSNumber*) kCFBooleanTrue;
 
+    [self safeSetValue:[NSNumber numberWithBool:[[BNCAppleReceipt instance] isTestFlight]] forKey:BRANCH_REQUEST_KEY_APPLE_TESTFLIGHT onDict:params];
+    
     NSMutableDictionary *cdDict = [[NSMutableDictionary alloc] init];
     BranchContentDiscoveryManifest *contentDiscoveryManifest = [BranchContentDiscoveryManifest getInstance];
     [cdDict bnc_safeSetObject:[contentDiscoveryManifest getManifestVersion] forKey:BRANCH_MANIFEST_VERSION_KEY];
diff --git a/Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj b/Branch-TestBed/Branch-TestBed.xcodeproj/project.pbxproj
@@ -168,6 +168,9 @@
 		5F67F48E228F535500067429 /* BNCEncodingUtilsTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 5F67F48D228F535500067429 /* BNCEncodingUtilsTests.m */; };
 		5F8B7B4021B5F5CD009CE0A6 /* libBranch.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 466B58381B17773000A69EDE /* libBranch.a */; };
 		5F8B7B4721B5F5F0009CE0A6 /* Branch_setBranchKeyTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 5F8B7B4621B5F5F0009CE0A6 /* Branch_setBranchKeyTests.m */; };
+		5FC7326822D81002006E6FBC /* BNCAppleReceipt.h in Headers */ = {isa = PBXBuildFile; fileRef = 5FC7326622D81002006E6FBC /* BNCAppleReceipt.h */; };
+		5FC7326922D81002006E6FBC /* BNCAppleReceipt.m in Sources */ = {isa = PBXBuildFile; fileRef = 5FC7326722D81002006E6FBC /* BNCAppleReceipt.m */; };
+		5FC7327022DD1F93006E6FBC /* BNCAppleReceiptTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 5FC7326F22DD1F93006E6FBC /* BNCAppleReceiptTests.m */; };
 		5FC7327722DE9A44006E6FBC /* BNCServerInterfaceTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 5FC7327622DE9A44006E6FBC /* BNCServerInterfaceTests.m */; };
 		63E4C4881D25E16A00A45FD8 /* LogOutputViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = 63E4C4871D25E16A00A45FD8 /* LogOutputViewController.m */; };
 		63E4C48B1D25E17B00A45FD8 /* NavigationController.m in Sources */ = {isa = PBXBuildFile; fileRef = 63E4C48A1D25E17B00A45FD8 /* NavigationController.m */; };
@@ -392,6 +395,9 @@
 		5F8B7B3B21B5F5CD009CE0A6 /* Branch-SDK-Unhosted-Tests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = "Branch-SDK-Unhosted-Tests.xctest"; sourceTree = BUILT_PRODUCTS_DIR; };
 		5F8B7B3F21B5F5CD009CE0A6 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
 		5F8B7B4621B5F5F0009CE0A6 /* Branch_setBranchKeyTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = Branch_setBranchKeyTests.m; sourceTree = "<group>"; };
+		5FC7326622D81002006E6FBC /* BNCAppleReceipt.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = BNCAppleReceipt.h; sourceTree = "<group>"; };
+		5FC7326722D81002006E6FBC /* BNCAppleReceipt.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = BNCAppleReceipt.m; sourceTree = "<group>"; };
+		5FC7326F22DD1F93006E6FBC /* BNCAppleReceiptTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCAppleReceiptTests.m; sourceTree = "<group>"; };
 		5FC7327622DE9A44006E6FBC /* BNCServerInterfaceTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = BNCServerInterfaceTests.m; sourceTree = "<group>"; };
 		63E4C4861D25E16A00A45FD8 /* LogOutputViewController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = LogOutputViewController.h; sourceTree = "<group>"; };
 		63E4C4871D25E16A00A45FD8 /* LogOutputViewController.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = LogOutputViewController.m; sourceTree = "<group>"; };
@@ -582,6 +588,7 @@
 		4D16837A2098C901008819E3 /* Branch-SDK-Tests */ = {
 			isa = PBXGroup;
 			children = (
+				5FC7326F22DD1F93006E6FBC /* BNCAppleReceiptTests.m */,
 				4D1683972098C901008819E3 /* BNCApplication.Test.m */,
 				4D7881FB209CF2D4002B750F /* BNCApplication+BNCTest.h */,
 				4D7881FC209CF2D4002B750F /* BNCApplication+BNCTest.m */,
@@ -732,6 +739,8 @@
 		670016BB1946309100A9E103 /* Branch-SDK */ = {
 			isa = PBXGroup;
 			children = (
+				5FC7326622D81002006E6FBC /* BNCAppleReceipt.h */,
+				5FC7326722D81002006E6FBC /* BNCAppleReceipt.m */,
 				4D59B51B2006979B00F89FD5 /* BNCApplication.h */,
 				4D59B51C2006979B00F89FD5 /* BNCApplication.m */,
 				4D8999EA1DC108FF00F7EE0A /* BNCAvailability.h */,
@@ -864,6 +873,7 @@
 				4DCAC8181F426F7C00405D1D /* BranchLinkProperties.h in Headers */,
 				4DCAC81A1F426F7C00405D1D /* BranchUniversalObject.h in Headers */,
 				4DCAC8191F426F7C00405D1D /* BranchShareLink.h in Headers */,
+				5FC7326822D81002006E6FBC /* BNCAppleReceipt.h in Headers */,
 				4D41123D1FE8976400C44FA5 /* BranchView.h in Headers */,
 				4DE6491A1FE1D7F500226507 /* BNCFieldDefines.h in Headers */,
 				4DCAC81C1F426F7C00405D1D /* BranchViewHandler.h in Headers */,
@@ -1126,6 +1136,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				5FC7326922D81002006E6FBC /* BNCAppleReceipt.m in Sources */,
 				7D58823A1CA1DF2700FF6358 /* BNCDeviceInfo.m in Sources */,
 				7B18DF4A1F1F00E200C25C84 /* BNCCrashlyticsWrapper.m in Sources */,
 				7D0C971D1D875465004E14B1 /* BranchContentDiscoveryManifest.m in Sources */,
@@ -1242,6 +1253,7 @@
 				4D7881FF209CF2D4002B750F /* BNCApplication+BNCTest.m in Sources */,
 				4D1683C02098C902008819E3 /* BranchUniversalObject.Test.m in Sources */,
 				4D1683B52098C902008819E3 /* BNCLocalization.Test.m in Sources */,
+				5FC7327022DD1F93006E6FBC /* BNCAppleReceiptTests.m in Sources */,
 				4D1683C82098C902008819E3 /* NSString+Branch.Test.m in Sources */,
 				4D1683C22098C902008819E3 /* BranchUserCompletedActionTests.m in Sources */,
 				4D1683AA2098C902008819E3 /* BranchOpenRequestTests.m in Sources */,
