Merge pull request #390 from BranchMetrics/bye-appkey

Bid app key farewell

Author: aaustin

Branch-SDK/Branch-SDK/BNCPreferenceHelper.h

@@ -14,7 +14,6 @@
 @interface BNCPreferenceHelper : NSObject
 
 @property (strong, nonatomic) NSString *branchKey;
-@property (strong, nonatomic) NSString *appKey;
 @property (strong, nonatomic) NSString *lastRunBranchKey;
 @property (strong, nonatomic) NSDate *lastStrongMatchDate;
 @property (strong, nonatomic) NSString *appVersion;

Branch-SDK/Branch-SDK/BNCPreferenceHelper.m

@@ -18,7 +18,6 @@
 
 NSString * const BRANCH_PREFS_FILE = @"BNCPreferences";
 
-NSString * const BRANCH_PREFS_KEY_APP_KEY = @"bnc_app_key";
 NSString * const BRANCH_PREFS_KEY_APP_VERSION = @"bnc_app_version";
 NSString * const BRANCH_PREFS_KEY_LAST_RUN_BRANCH_KEY = @"bnc_last_run_branch_key";
 NSString * const BRANCH_PREFS_KEY_LAST_STRONG_MATCH_DATE = @"bnc_strong_match_created_date";
@@ -57,7 +56,6 @@ @interface BNCPreferenceHelper ()
 @implementation BNCPreferenceHelper
 
 @synthesize branchKey = _branchKey,
-            appKey = _appKey,
             lastRunBranchKey = _lastRunBranchKey,
             appVersion = _appVersion,
             deviceFingerprintID = _deviceFingerprintID,
@@ -161,23 +159,6 @@ - (NSString *)getEndpointFromURL:(NSString *)url {
 }
 #pragma mark - Preference Storage
 
-- (NSString *)appKey {
-    if (!_appKey) {
-        _appKey = [[[NSBundle mainBundle] infoDictionary] objectForKey:BRANCH_PREFS_KEY_APP_KEY];
-    }
-    
-    return _appKey;
-}
-
-- (void)setAppKey:(NSString *)appKey {
-    NSLog(@"Usage of App Key is deprecated, please move toward using a Branch key");
-    
-    if (![_appKey isEqualToString:appKey]) {
-        _appKey = appKey;
-        [self writeObjectToDefaults:BRANCH_PREFS_KEY_APP_KEY value:appKey];
-    }
-}
-
 - (NSString *)getBranchKey:(BOOL)isLive {
     // Already loaded a key, and it's the same state (live/test)
     if (_branchKey && isLive == self.isUsingLiveKey) {

Branch-SDK/Branch-SDK/BNCServerInterface.m

@@ -231,21 +231,16 @@ - (NSDictionary *)prepareParamDict:(NSDictionary *)params key:(NSString *)key re
     [fullParamDict addEntriesFromDictionary:params];
     fullParamDict[@"sdk"] = [NSString stringWithFormat:@"ios%@", SDK_VERSION];
     fullParamDict[@"retryNumber"] = @(retryNumber);
-    
+    fullParamDict[@"branch_key"] = key;
+
     NSMutableDictionary *metadata = [[NSMutableDictionary alloc] init];
     [metadata addEntriesFromDictionary:self.preferenceHelper.requestMetadataDictionary];
     [metadata addEntriesFromDictionary:fullParamDict[BRANCH_REQUEST_KEY_STATE]];
     fullParamDict[BRANCH_REQUEST_KEY_STATE] = metadata;
     if (self.preferenceHelper.instrumentationDictionary.count) {
         fullParamDict[BRANCH_REQUEST_KEY_INSTRUMENTATION] = self.preferenceHelper.instrumentationDictionary;
     }
-    if ([key hasPrefix:@"key_"]) {
-        fullParamDict[@"branch_key"] = key;
-    }
-    else {
-        fullParamDict[@"app_id"] = key;
-    }
-    
+   
     return fullParamDict;
 }
 

Branch-SDK/Branch-SDK/BNCStrongMatchHelper.m

@@ -100,12 +100,7 @@ - (void)presentSafariVCWithBranchKey:(NSString *)branchKey {
     }
 
     if (branchKey) {
-        if ([branchKey hasPrefix:@"key_"]) {
-            [urlString appendFormat:@"&branch_key=%@", branchKey];
-        }
-        else {
-            [urlString appendFormat:@"&app_id=%@", branchKey];
-        }
+        [urlString appendFormat:@"&branch_key=%@", branchKey];
     }
 
     [urlString appendFormat:@"&sdk=ios%@", SDK_VERSION];

Branch-SDK/Branch-SDK/Branch.m

@@ -97,18 +97,10 @@ + (Branch *)getInstance {
     NSString *branchKey = [preferenceHelper getBranchKey:YES];
     NSString *keyToUse = branchKey;
     if (!branchKey) {
-        // If no app key
-        NSString *appKey = preferenceHelper.appKey;
-        if (!appKey) {
-            [preferenceHelper logWarning:@"Please enter your branch_key in the plist!"];
-            return nil;
-        }
-        else {
-            keyToUse = appKey;
-            NSLog(@"Usage of App Key is deprecated, please move toward using a Branch key");
-        }
+        [preferenceHelper logWarning:@"Please enter your branch_key in the plist!"];
+        return nil;
     }
-    
+
     return [Branch getInstanceInternal:keyToUse returnNilIfNoCurrentInstance:NO];
 }
 
@@ -119,17 +111,8 @@ + (Branch *)getTestInstance {
     NSString *branchKey = [preferenceHelper getBranchKey:NO];
     NSString *keyToUse = branchKey;
     if (!branchKey) {
-        // If no app key
-        NSString *appKey = preferenceHelper.appKey;
-        if (!appKey) {
-            [preferenceHelper logWarning:@"Please enter your branch_key in the plist!"];
-            return nil;
-        }
-        // If they did provide an app key, show them a warning. Shouldn't use app key with a test instance.
-        else {
-            [preferenceHelper logWarning:@"You requested the test instance, but provided an app key. App Keys cannot be used for test instances. Additionally, usage of App Key is deprecated, please move toward using a Branch key"];
-            keyToUse = appKey;
-        }
+        [preferenceHelper logWarning:@"Please enter your branch_key in the plist!"];
+        return nil;
     }
 
     return [Branch getInstanceInternal:keyToUse returnNilIfNoCurrentInstance:NO];
@@ -138,11 +121,12 @@ + (Branch *)getTestInstance {
 + (Branch *)getInstance:(NSString *)branchKey {
     BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
 
-    if ([branchKey rangeOfString:@"key_"].location != NSNotFound) {
+    if ([branchKey hasPrefix:@"key_"]) {
         preferenceHelper.branchKey = branchKey;
     }
     else {
-        preferenceHelper.appKey = branchKey;
+        [preferenceHelper logWarning:@"Invalid Branch Key format!"];
+        return nil;
     }
 
     return [Branch getInstanceInternal:branchKey returnNilIfNoCurrentInstance:NO];

Branch-TestBed/Branch-SDK-Tests/BNCServerInterfaceTests.m

@@ -57,29 +57,6 @@ - (void)testParamAddForBranchKey {
 
 }
 
-//==================================================================================
-//TEST 02
-//This test checks to see that the branch key has been added to the GET request
-
-- (void)testParamAddForAppKey {
-  BNCServerInterface *serverInterface = [[BNCServerInterface alloc] init];
-  XCTestExpectation* expectation = [self expectationWithDescription:@"NSURLSessionDataTask completed"];
-  
-  [OHHTTPStubs stubRequestsPassingTest:^BOOL(NSURLRequest *request) {
-    // We're not sending a request, just verifying a "branch_key=key_foo" is present.
-    XCTAssertTrue([request.URL.query rangeOfString:@"app_id=non_branch_key"].location != NSNotFound, @"Branch App ID not added");
-    [expectation fulfill];
-    return [request.URL.query rangeOfString:@"app_id=key_foo"].location != NSNotFound;
-  } withStubResponse:^OHHTTPStubsResponse *(NSURLRequest *request) {
-    NSDictionary* dummyJSONResponse = @{@"key": @"value"};
-    return [OHHTTPStubsResponse responseWithJSONObject:dummyJSONResponse statusCode:200 headers:nil];
-  }];
-  
-  [serverInterface getRequest:nil url:@"http://foo" key:@"non_branch_key" callback:NULL];
-  
-  [self waitForExpectationsWithTimeout:5.0 /* 5 seconds */ handler:nil];
-}
-
 #pragma mark - Retry tests
 
 //==================================================================================