Merge pull request #415 from BranchMetrics/buo

Make BUO great!

Author: ahmednawar

Branch-SDK/Branch-SDK/Branch.h

@@ -103,6 +103,20 @@ extern NSString * const BRANCH_INIT_KEY_PHONE_NUMBER;
 extern NSString * const BRANCH_INIT_KEY_IS_FIRST_SESSION;
 extern NSString * const BRANCH_INIT_KEY_CLICKED_BRANCH_LINK;
 
+// BUO Constants
+extern NSString * const BNCCanonicalIdList;
+extern NSString * const BNCPurchaseAmount;
+extern NSString * const BNCPurchaseCurrency;
+extern NSString * const BNCCanonicalIdList;
+extern NSString * const BNCPurchaseAmount;
+extern NSString * const BNCRegisterViewEvent;
+extern NSString * const BNCAddToWishlistEvent;
+extern NSString * const BNCAddToCartEvent;
+extern NSString * const BNCPurchaseInitiatedEvent;
+extern NSString * const BNCPurchasedEvent;
+extern NSString * const BNCShareInitiatedEvent;
+extern NSString * const BNCShareCompletedEvent;
+
 #pragma mark - Branch Enums
 typedef NS_ENUM(NSUInteger, BranchCreditHistoryOrder) {
     BranchMostRecentFirst,

Branch-SDK/Branch-SDK/Branch.m

@@ -56,6 +56,17 @@
 NSString * const BRANCH_INIT_KEY_CLICKED_BRANCH_LINK = @"+clicked_branch_link";
 NSString * const BRANCH_PUSH_NOTIFICATION_PAYLOAD_KEY = @"branch";
 
+NSString * const BNCCanonicalIdList = @"$canonical_identifier_list";
+NSString * const BNCPurchaseAmount = @"$amount";
+NSString * const BNCPurchaseCurrency = @"$currency";
+NSString * const BNCRegisterViewEvent = @"View";
+NSString * const BNCAddToWishlistEvent = @"Add to Wishlist";
+NSString * const BNCAddToCartEvent = @"Add to Cart";
+NSString * const BNCPurchaseInitiatedEvent = @"Purchase Started";
+NSString * const BNCPurchasedEvent = @"Purchased";
+NSString * const BNCShareInitiatedEvent = @"Share Started";
+NSString * const BNCShareCompletedEvent = @"Share Completed";
+
 @interface Branch() <BranchDeepLinkingControllerCompletionDelegate, FABKit>
 
 

Branch-SDK/Branch-SDK/BranchUniversalObject.h

@@ -11,8 +11,7 @@
 
 @class BranchLinkProperties;
 
-typedef void (^callback) ();
-typedef void (^shareCompletion) (NSString *activityType, BOOL completed);
+typedef void (^shareCompletion) (NSString *_Nonnull activityType, BOOL completed);
 
 typedef NS_ENUM(NSInteger, ContentIndexMode) {
     ContentIndexModePublic,
@@ -33,6 +32,9 @@ typedef NS_ENUM(NSInteger, ContentIndexMode) {
 @property (nonatomic, strong) NSArray *keywords;
 @property (nonatomic, strong) NSDate *expirationDate;
 @property (nonatomic, strong) NSString *spotlightIdentifier;
+@property (nonatomic, assign) CGFloat price;
+@property (nonatomic, strong) NSString *currency;
+
 
 - (instancetype)initWithCanonicalIdentifier:(NSString *)canonicalIdentifier;
 - (instancetype)initWithTitle:(NSString *)title;
@@ -42,6 +44,8 @@ typedef NS_ENUM(NSInteger, ContentIndexMode) {
 - (void)registerView;
 - (void)registerViewWithCallback:(callbackWithParams)callback;
 
+- (void)userCompletedAction:(NSString *)action;
+
 - (NSString *)getShortUrlWithLinkProperties:(BranchLinkProperties *)linkProperties;
 - (NSString *)getShortUrlWithLinkPropertiesAndIgnoreFirstClick:(BranchLinkProperties *)linkProperties;
 - (void)getShortUrlWithLinkProperties:(BranchLinkProperties *)linkProperties andCallback:(callbackWithUrl)callback;

Branch-SDK/Branch-SDK/BranchUniversalObject.m

@@ -74,6 +74,15 @@ - (void)registerViewWithCallback:(callbackWithParams)callback {
     [[Branch getInstance] registerViewWithParams:[self getParamsForServerRequest] andCallback:callback];
 }
 
+- (void)userCompletedAction:(NSString *)action {
+    NSMutableDictionary *actionPayload = [[NSMutableDictionary alloc] init];
+    NSDictionary *linkParams = [self getParamsForServerRequest];
+    actionPayload[BNCCanonicalIdList] = @[self.canonicalIdentifier];
+    actionPayload[self.canonicalIdentifier] = linkParams;
+    
+    [[Branch getInstance] userCompletedAction:action withState:actionPayload];
+}
+
 #pragma mark - Link Creation Methods
 
 - (NSString *)getShortUrlWithLinkProperties:(BranchLinkProperties *)linkProperties {
@@ -311,6 +320,12 @@ + (BranchUniversalObject *)getBranchUniversalObjectFromDictionary:(NSDictionary
     if (dictionary[BRANCH_LINK_DATA_KEY_KEYWORDS]) {
         universalObject.keywords = dictionary[BRANCH_LINK_DATA_KEY_KEYWORDS];
     }
+    if (dictionary[BNCPurchaseAmount]) {
+        universalObject.price = [dictionary[BNCPurchaseAmount] floatValue];
+    }
+    if (dictionary[BNCPurchaseCurrency]) {
+        universalObject.currency = dictionary[BNCPurchaseCurrency];
+    }
 
     return universalObject;
 }
@@ -337,6 +352,12 @@ - (NSDictionary *)getParamsForServerRequest {
     [self safeSetValue:self.keywords forKey:BRANCH_LINK_DATA_KEY_KEYWORDS onDict:temp];
     [self safeSetValue:@(1000 * [self.expirationDate timeIntervalSince1970]) forKey:BRANCH_LINK_DATA_KEY_CONTENT_EXPIRATION_DATE onDict:temp];
     [self safeSetValue:self.type forKey:BRANCH_LINK_DATA_KEY_CONTENT_TYPE onDict:temp];
+    [self safeSetValue:self.currency forKey:BNCPurchaseCurrency onDict:temp];
+    if (self.price) {
+        // have to add if statement because safeSetValue only accepts objects so even if self.price is not set
+        // a valid NSNumber object will be created and the request will have amount:0 in all cases.
+        [self safeSetValue:[NSNumber numberWithFloat:self.price] forKey:BNCPurchaseAmount onDict:temp];
+    }
 
     [temp addEntriesFromDictionary:[self.metadata copy]];
     return [temp copy];

Branch-SDK/Branch-SDK/Requests/BranchShortUrlRequest.h

@@ -11,6 +11,8 @@
 
 @interface BranchShortUrlRequest : BNCServerRequest
 
+@property (nonatomic, assign) BOOL isSpotlightRequest;
+
 - (id)initWithTags:(NSArray *)tags alias:(NSString *)alias type:(BranchLinkType)type matchDuration:(NSInteger)duration channel:(NSString *)channel feature:(NSString *)feature stage:(NSString *)stage campaign:(NSString *)campaign params:(NSDictionary *)params linkData:(BNCLinkData *)linkData linkCache:(BNCLinkCache *)linkCache callback:(callbackWithUrl)callback;
 
 @end

Branch-SDK/Branch-SDK/Requests/BranchShortUrlRequest.m

@@ -44,6 +44,7 @@ - (id)initWithTags:(NSArray *)tags alias:(NSString *)alias type:(BranchLinkType)
         _callback = callback;
         _linkCache = linkCache;
         _linkData = linkData;
+        _isSpotlightRequest = NO;
     }
 
     return self;
@@ -54,7 +55,10 @@ - (void)makeRequest:(BNCServerInterface *)serverInterface key:(NSString *)key ca
 
     BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
     params[BRANCH_REQUEST_KEY_DEVICE_FINGERPRINT_ID] = preferenceHelper.deviceFingerprintID;
-    params[BRANCH_REQUEST_KEY_BRANCH_IDENTITY] = preferenceHelper.identityID;
+    
+    if (!_isSpotlightRequest) {
+        params[BRANCH_REQUEST_KEY_BRANCH_IDENTITY] = preferenceHelper.identityID;
+    }
     params[BRANCH_REQUEST_KEY_SESSION_ID] = preferenceHelper.sessionID;
 
     [serverInterface postRequest:params url:[preferenceHelper getAPIURL:BRANCH_REQUEST_ENDPOINT_GET_SHORT_URL] key:key callback:callback];

Branch-SDK/Branch-SDK/Requests/BranchSpotlightUrlRequest.m

@@ -22,9 +22,9 @@ - (id)initWithParams:(NSDictionary *)params callback:(callbackWithParams)callbac
     [linkData setupChannel:@"spotlight"];
 
     if (self = [super initWithTags:nil alias:nil type:BranchLinkTypeUnlimitedUse matchDuration:0 channel:@"spotlight" feature:BRANCH_FEATURE_TAG_SHARE stage:nil campaign:nil params:params linkData:linkData linkCache:nil callback:nil]) {
+        self.isSpotlightRequest = YES;
         _spotlightCallback = callback;
     }
-
     return self;
 }
 

Branch-TestBed/Branch-TestBed/ViewController.m

@@ -55,6 +55,8 @@ - (void)viewDidLoad {
     _branchUniversalObject.title = contentTitle;
     _branchUniversalObject.contentDescription = contentDescription;
     _branchUniversalObject.imageUrl = imageUrl;
+    _branchUniversalObject.price = 1000;
+    _branchUniversalObject.currency = @"$";
     [_branchUniversalObject addMetadataKey:@"deeplink_text" value:[NSString stringWithFormat:
                                                                    @"This text was embedded as data in a Branch link with the following characteristics:\n\n  canonicalUrl: %@\n  title: %@\n  contentDescription: %@\n  imageUrl: %@\n", canonicalUrl, contentTitle, contentDescription, imageUrl]];
     [self refreshRewardPoints];