Merge pull request #1262 from BranchMetrics/SDK-1934-add-public-method-for-BranchAPIBaseURL

Sdk 1934 add public method for branch api base url

Author: echo-branch

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

@@ -10,6 +10,8 @@
 #import "BNCPreferenceHelper.h"
 #import "BNCEncodingUtils.h"
 #import "Branch.h"
+#import "BranchPluginSupport.h"
+#import "BNCConfig.h"
 
 @interface BNCPreferenceHelper()
 
@@ -208,4 +210,60 @@ - (void)testURLSkipList {
     XCTAssert([filterDesc isEqualToString:valueDesc]);
 }
 
+- (void)testSetAPIURL_Example {
+    
+    NSString *url = @"https://www.example.com/";
+    [BranchPluginSupport setAPIUrl:url] ;
+    
+    NSString *urlStored = [BNCPreferenceHelper sharedInstance].branchAPIURL ;
+    XCTAssert([url isEqualToString:urlStored]);
+}
+
+- (void)testSetAPIURL_InvalidHttp {
+    
+    NSString *url = @"Invalid://www.example.com/";
+    [BranchPluginSupport setAPIUrl:url] ;
+    
+    NSString *urlStored = [BNCPreferenceHelper sharedInstance].branchAPIURL ;
+    XCTAssert(![url isEqualToString:urlStored]);
+    XCTAssert([urlStored isEqualToString:BNC_API_BASE_URL]);
+}
+
+- (void)testSetAPIURL_InvalidEmpty {
+    
+    [BranchPluginSupport setAPIUrl:@""] ;
+    
+    NSString *urlStored = [BNCPreferenceHelper sharedInstance].branchAPIURL ;
+    XCTAssert(![urlStored isEqualToString:@""]);
+    XCTAssert([urlStored isEqualToString:BNC_API_BASE_URL]);
+}
+
+- (void)testSetCDNBaseURL_Example {
+    
+    NSString *url = @"https://www.example.com/";
+    [BranchPluginSupport setCDNBaseUrl:url] ;
+    
+    NSString *urlStored = [BNCPreferenceHelper sharedInstance].patternListURL ;
+    XCTAssert([url isEqualToString:urlStored]);
+}
+
+- (void)testSetCDNBaseURL_InvalidHttp {
+    
+    NSString *url = @"Invalid://www.example.com/";
+    [BranchPluginSupport setCDNBaseUrl:url] ;
+    
+    NSString *urlStored = [BNCPreferenceHelper sharedInstance].patternListURL ;
+    XCTAssert(![url isEqualToString:urlStored]);
+    XCTAssert([urlStored isEqualToString:BNC_CDN_URL]);
+}
+
+- (void)testSetCDNBaseURL_InvalidEmpty {
+    
+    [BranchPluginSupport setCDNBaseUrl:@""] ;
+    
+    NSString *urlStored = [BNCPreferenceHelper sharedInstance].patternListURL ;
+    XCTAssert(![urlStored isEqualToString:@""]);
+    XCTAssert([urlStored isEqualToString:BNC_CDN_URL]);
+}
+
 @end

BranchSDK/BNCConfig.h

@@ -17,3 +17,4 @@ FOUNDATION_EXPORT NSString*_Nonnull const BNC_SDK_VERSION;
 FOUNDATION_EXPORT NSString*_Nonnull const BNC_API_BASE_URL;
 FOUNDATION_EXPORT NSString*_Nonnull const BNC_API_VERSION;
 FOUNDATION_EXPORT NSString*_Nonnull const BNC_LINK_URL;
+FOUNDATION_EXPORT NSString* _Nonnull const BNC_CDN_URL;

BranchSDK/BNCConfig.m

@@ -12,3 +12,4 @@
 NSString * const BNC_API_VERSION     = @"v1";
 NSString * const BNC_LINK_URL        = @"https://bnc.lt";
 NSString * const BNC_SDK_VERSION     = @"2.1.2";
+NSString * const BNC_CDN_URL         = @"https://cdn.branch.io";

BranchSDK/BNCPreferenceHelper.h

@@ -87,6 +87,9 @@ NSURL* /* _Nonnull */ BNCURLForBranchDirectory(void);
 - (NSString *)getAPIURL:(NSString *)endpoint;
 - (NSString *)getEndpointFromURL:(NSString *)url;
 
+- (void) setBranchAPIURL:(NSString*)branchAPIURL;
+- (void) setPatternListURL:(NSString*)cdnURL;
+
 - (void)setRequestMetadataKey:(NSString *)key value:(NSObject *)value;
 - (NSMutableDictionary *)requestMetadataDictionary;
 

BranchSDK/BNCPreferenceHelper.m

@@ -26,6 +26,9 @@
 static NSString * const BRANCH_PREFS_KEY_LAST_RUN_BRANCH_KEY = @"bnc_last_run_branch_key";
 static NSString * const BRANCH_PREFS_KEY_LAST_STRONG_MATCH_DATE = @"bnc_strong_match_created_date";
 
+static NSString * const BRANCH_PREFS_KEY_API_URL = @"bnc_api_url";
+static NSString * const BRANCH_PREFS_KEY_PATTERN_LIST_URL = @"bnc_pattern_list_url";
+
 static NSString * const BRANCH_PREFS_KEY_RANDOMIZED_DEVICE_TOKEN = @"bnc_randomized_device_token";
 static NSString * const BRANCH_PREFS_KEY_RANDOMIZED_BUNDLE_TOKEN = @"bnc_randomized_bundle_token";
 
@@ -108,7 +111,8 @@ @implementation BNCPreferenceHelper
     highestConversionValueSent = _highestConversionValueSent,
     logInAppPurchasesAsBranchEvents = _logInAppPurchasesAsBranchEvents,
     referringURLQueryParameters = _referringURLQueryParameters,
-    anonID = _anonID;
+    anonID = _anonID,
+    patternListURL = _patternListURL;
 
 + (BNCPreferenceHelper *)sharedInstance {
     static BNCPreferenceHelper *preferenceHelper;
@@ -131,7 +135,6 @@ - (instancetype)init {
         _persistPrefsQueue = [[NSOperationQueue alloc] init];
         _persistPrefsQueue.maxConcurrentOperationCount = 1;
 
-        self.patternListURL = @"https://cdn.branch.io";
         self.disableAdNetworkCallouts = NO;
     }
     return self;
@@ -150,13 +153,18 @@ - (void) dealloc {
 - (void) setBranchAPIURL:(NSString*)branchAPIURL_ {
     @synchronized (self) {
         _branchAPIURL = [branchAPIURL_ copy];
+        [self writeObjectToDefaults:BRANCH_PREFS_KEY_API_URL value:_branchAPIURL];
     }
 }
 
 - (NSString*) branchAPIURL {
     @synchronized (self) {
         if (!_branchAPIURL) {
+            _branchAPIURL = [self readStringFromDefaults:BRANCH_PREFS_KEY_API_URL];
+        }
+        if (_branchAPIURL == nil || [_branchAPIURL isEqualToString:@""]) {
             _branchAPIURL = [BNC_API_BASE_URL copy];
+            [self writeObjectToDefaults:BRANCH_PREFS_KEY_API_URL value:_branchAPIURL];
         }
         return _branchAPIURL;
     }
@@ -181,6 +189,26 @@ - (NSString *)getEndpointFromURL:(NSString *)url {
     return @"";
 }
 
+- (void) setPatternListURL:(NSString*)url {
+    @synchronized (self) {
+        _patternListURL = url;
+        [self writeObjectToDefaults:BRANCH_PREFS_KEY_PATTERN_LIST_URL value:url];
+    }
+}
+
+- (NSString*) patternListURL {
+    @synchronized (self) {
+        if (!_patternListURL) {
+            _patternListURL =  [self readStringFromDefaults:BRANCH_PREFS_KEY_PATTERN_LIST_URL];
+        }
+        if (_patternListURL == nil || [_patternListURL isEqualToString:@""]) {
+            _patternListURL = BNC_CDN_URL;
+            [self writeObjectToDefaults:BRANCH_PREFS_KEY_PATTERN_LIST_URL value:_patternListURL];
+        }
+        return _patternListURL;
+    }
+}
+
 #pragma mark - Preference Storage
 
 - (NSString *)lastRunBranchKey {

BranchSDK/BranchPluginSupport.h

@@ -13,6 +13,17 @@ NS_ASSUME_NONNULL_BEGIN
 @interface BranchPluginSupport : NSObject
 
 + (BranchPluginSupport *)instance;
+/**
+Sets a custom base URL for all calls to the Branch API.
+@param url  Base URL that the Branch API will use.
+*/
++ (void)setAPIUrl:(NSString *)url;
+
+/**
+Sets a custom CDN base URL
+@param url Base URL for CDN endpoints.
+*/
++ (void)setCDNBaseUrl:(NSString *)url;
 
 - (NSDictionary<NSString *, NSString *> *)deviceDescription;
 

BranchSDK/BranchPluginSupport.m

@@ -11,6 +11,8 @@
 #import "BNCDeviceInfo.h"
 #import "BNCPreferenceHelper.h"
 #import "Branch.h"
+#import "BNCLog.h"
+#import "BNCConfig.h"
 
 @implementation BranchPluginSupport
 
@@ -50,4 +52,24 @@ + (BranchPluginSupport *)instance {
     return dictionary;
 }
 
+#pragma mark - Server URL methods
+
++ (void)setAPIUrl:(NSString *)url {
+    if([url hasPrefix:@"http://"] || [url hasPrefix:@"https://"] ){
+        [[BNCPreferenceHelper sharedInstance] setBranchAPIURL:url];
+    } else {
+        BNCLogWarning([NSString stringWithFormat:@"Not setting url - %@. Its invalid.", url]);
+        [[BNCPreferenceHelper sharedInstance] setBranchAPIURL:BNC_API_BASE_URL];
+    }
+}
+
++ (void)setCDNBaseUrl:(NSString *)url {
+    if([url hasPrefix:@"http://"] || [url hasPrefix:@"https://"] ){
+        [[BNCPreferenceHelper sharedInstance] setPatternListURL:url];
+    } else {
+        BNCLogWarning([NSString stringWithFormat:@"Not setting url - %@. Its invalid.", url]);
+        [[BNCPreferenceHelper sharedInstance] setPatternListURL:BNC_CDN_URL];
+    }
+}
+
 @end