Merge pull request #367 from BranchMetrics/answers

Answers

Author: aaustin

Branch-SDK/Branch-SDK/BNCFabricAnswers.h

@@ -0,0 +1,16 @@
+//
+//  BNCFabricAnswers.h
+//  Branch-TestBed
+//
+//  Created by Ahmed Nawar on 6/2/16.
+//  Copyright © 2016 Branch Metrics. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface BNCFabricAnswers : NSObject
+
++ (void)sendEventWithName:(NSString*)name andAttributes:(NSDictionary*)attributes;
++ (NSDictionary *)prepareBranchDataForAnswers:(NSDictionary *)dictionary;
+
+@end

Branch-SDK/Branch-SDK/BNCFabricAnswers.m

@@ -0,0 +1,51 @@
+//
+//  BNCFabricAnswers.m
+//  Branch-TestBed
+//
+//  Created by Ahmed Nawar on 6/2/16.
+//  Copyright © 2016 Branch Metrics. All rights reserved.
+//
+
+#import "BNCFabricAnswers.h"
+#import "BNCPreferenceHelper.h"
+#import "../Fabric/Answers.h"
+
+@implementation BNCFabricAnswers
+
++ (void)sendEventWithName:(NSString *)name andAttributes:(NSDictionary *)attributes {
+    ANSLogCustomEvent(name, [self prepareBranchDataForAnswers:attributes]);
+}
+
++ (NSDictionary *)prepareBranchDataForAnswers:(NSDictionary *)dictionary {
+    NSMutableDictionary *temp = [[NSMutableDictionary alloc] init];
+    
+    for (NSString *key in dictionary.allKeys) {
+        if ([key hasPrefix:@"+"] || ([key hasPrefix:@"$"] && ![key isEqualToString:@"$identity_id"])) {
+            // ignore because this data is not found on the ShareSheet
+            continue;
+        } else if ([dictionary[key] isKindOfClass:[NSArray class]]) {
+            // flatten arrays, special treatement for ~tags
+            NSString *aKey;
+            if ([key hasPrefix:@"~"])
+                aKey = [key substringFromIndex:1];
+            else
+                aKey = key;
+            NSArray *valuesArray = dictionary[key];
+            for (NSUInteger i = 0; i < valuesArray.count; ++i) {
+                temp[[NSString stringWithFormat:@"%@.%lu", aKey, (unsigned long)i]] = valuesArray[i];
+            }
+        } else if ([key hasPrefix:@"~"]) {
+            // strip tildes ~
+            temp[[key substringFromIndex:1]] = dictionary[key];
+        } else if ([key isEqualToString:@"$identity_id"]) {
+            temp[@"referring_branch_identity"] = dictionary[key];
+        }
+    }
+    
+    BNCPreferenceHelper *preferenceHelper = [BNCPreferenceHelper preferenceHelper];
+    temp[@"branch_identity"] = preferenceHelper.identityID;
+    
+    return temp;
+}
+
+@end

Branch-SDK/Branch-SDK/BNCPreferenceHelper.m

@@ -10,6 +10,7 @@
 #import "BNCEncodingUtils.h"
 #import "BNCConfig.h"
 #import "Branch.h"
+#import "../Fabric/Fabric+FABKits.h"
 
 static const NSTimeInterval DEFAULT_TIMEOUT = 5.5;
 static const NSTimeInterval DEFAULT_RETRY_INTERVAL = 0;
@@ -45,6 +46,9 @@
 
 NSString * const BRANCH_PREFS_KEY_BRANCH_VIEW_USAGE_CNT = @"bnc_branch_view_usage_cnt_";
 
+// The name of this key was specified in the account-creation API integration
+static NSString * const BNC_BRANCH_FABRIC_APP_KEY_KEY = @"branch_key";
+
 @interface BNCPreferenceHelper ()
 
 @property (strong, nonatomic) NSMutableDictionary *persistenceDict;
@@ -193,6 +197,17 @@ - (NSString *)getBranchKey:(BOOL)isLive {
         else if ([ret isKindOfClass:[NSDictionary class]]) {
             self.branchKey = isLive ? ret[@"live"] : ret[@"test"];
         }
+    } else {
+        Class fabric = NSClassFromString(@"Fabric");
+        
+        if (fabric) {
+            NSDictionary *configDictionary = [fabric configurationDictionaryForKitClass:[Branch class]];
+            ret = [configDictionary objectForKey:BNC_BRANCH_FABRIC_APP_KEY_KEY];
+            
+            if ([ret isKindOfClass:[NSString class]]) {
+                self.branchKey = ret;
+            }
+        }
     }
 
     return _branchKey;

Branch-SDK/Branch-SDK/Branch.m

@@ -42,7 +42,6 @@
 #import "../Fabric/FABKitProtocol.h"
 #import "../Fabric/Fabric+FABKits.h"
 
-
 NSString * const BRANCH_FEATURE_TAG_SHARE = @"share";
 NSString * const BRANCH_FEATURE_TAG_REFERRAL = @"referral";
 NSString * const BRANCH_FEATURE_TAG_INVITE = @"invite";
@@ -326,7 +325,6 @@ - (void)initSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)
 
 - (void)initSessionWithLaunchOptions:(NSDictionary *)options isReferrable:(BOOL)isReferrable explicitlyRequestedReferrable:(BOOL)explicitlyRequestedReferrable automaticallyDisplayController:(BOOL)automaticallyDisplayController {
     self.shouldAutomaticallyDeepLink = automaticallyDisplayController;
-    
     self.preferenceHelper.isReferrable = isReferrable;
     self.preferenceHelper.explicitlyRequestedReferrable = explicitlyRequestedReferrable;
 

Branch-SDK/Branch-SDK/BranchActivityItemProvider.m

@@ -73,7 +73,6 @@ - (id)item {
     if ([channel isEqualToString:@"facebook"] || [channel isEqualToString:@"twitter"]  || [channel isEqualToString:@"com.tinyspeck.chatlyio.share"]) {
         return [NSURL URLWithString:[[Branch getInstance] getShortURLWithParams:params andTags:tags andChannel:channel andFeature:feature andStage:stage andAlias:alias ignoreUAString:self.userAgentString forceLinkCreation:YES]];
     }
-    
     return [NSURL URLWithString:[[Branch getInstance] getShortURLWithParams:params andTags:tags andChannel:channel andFeature:feature andStage:stage andAlias:alias ignoreUAString:nil forceLinkCreation:YES]];
 }
 

Branch-SDK/Branch-SDK/BranchUniversalObject.m

@@ -10,6 +10,7 @@
 #import "BNCError.h"
 #import "BranchConstants.h"
 #import "BNCPreferenceHelper.h"
+#import "BNCFabricAnswers.h"
 
 @implementation BranchUniversalObject {
     BNCPreferenceHelper *_preferenceHelper;
@@ -164,6 +165,7 @@ - (void)showShareSheetWithLinkProperties:(BranchLinkProperties *)linkProperties
         shareViewController.completionWithItemsHandler = ^(NSString *activityType, BOOL completed, NSArray *returnedItems, NSError *activityError) {
             if (completion) {
                 completion(activityType, completed);
+                [BNCFabricAnswers sendEventWithName:@"Branch Share" andAttributes:[self getDictionaryWithCompleteLinkProperties:linkProperties]];
             }
         };
     } else {
@@ -354,6 +356,18 @@ - (NSDictionary *)getParamsForServerRequestWithAddedLinkProperties:(BranchLinkPr
     return [temp copy];
 }
 
+- (NSDictionary *)getDictionaryWithCompleteLinkProperties:(BranchLinkProperties *)linkProperties {
+    NSMutableDictionary *temp = [[self getParamsForServerRequestWithAddedLinkProperties:linkProperties] mutableCopy];
+    
+    [self safeSetValue:linkProperties.tags forKey:[NSString stringWithFormat:@"~%@", BRANCH_REQUEST_KEY_URL_TAGS] onDict:temp];
+    [self safeSetValue:linkProperties.feature forKey:[NSString stringWithFormat:@"~%@", BRANCH_REQUEST_KEY_URL_FEATURE] onDict:temp];
+    [self safeSetValue:linkProperties.alias forKey:[NSString stringWithFormat:@"~%@", BRANCH_REQUEST_KEY_URL_ALIAS] onDict:temp];
+    [self safeSetValue:linkProperties.channel forKey:[NSString stringWithFormat:@"~%@", BRANCH_REQUEST_KEY_URL_CHANNEL] onDict:temp];
+    [self safeSetValue:linkProperties.stage forKey:[NSString stringWithFormat:@"~%@", BRANCH_REQUEST_KEY_URL_STAGE] onDict:temp];
+    [self safeSetValue:@(linkProperties.matchDuration) forKey:[NSString stringWithFormat:@"~%@", BRANCH_REQUEST_KEY_URL_DURATION] onDict:temp];
+
+    return [temp copy];
+}
 - (void)safeSetValue:(NSObject *)value forKey:(NSString *)key onDict:(NSMutableDictionary *)dict {
     if (value) {
         dict[key] = value;

Branch-SDK/Branch-SDK/Requests/BranchOpenRequest.m

@@ -12,6 +12,7 @@
 #import "BranchConstants.h"
 #import "BNCEncodingUtils.h"
 #import "BranchViewHandler.h"
+#import "BNCFabricAnswers.h"
 
 @interface BranchOpenRequest ()
 
@@ -80,32 +81,35 @@ - (void)processResponse:(BNCServerResponse *)response error:(NSError *)error {
     preferenceHelper.userUrl = data[BRANCH_RESPONSE_KEY_USER_URL];
     preferenceHelper.userIdentity = userIdentity;
     preferenceHelper.sessionID = data[BRANCH_RESPONSE_KEY_SESSION_ID];
-    
     [BNCSystemObserver setUpdateState];
 
     NSString *sessionData = data[BRANCH_RESPONSE_KEY_SESSION_DATA];
 
     // Update session params
     preferenceHelper.sessionParams = sessionData;
-    
+
     // Scenarios:
     // If no data, data isn't from a link click, or isReferrable is false, don't set, period.
     // Otherwise,
     // * On Install: set.
     // * On Open and installParams set: don't set.
     // * On Open and stored installParams are empty: set.
-    if (sessionData.length && preferenceHelper.isReferrable) {
+    if (sessionData.length) {
         NSDictionary *sessionDataDict = [BNCEncodingUtils decodeJsonStringToDictionary:sessionData];
         BOOL dataIsFromALinkClick = [sessionDataDict[BRANCH_RESPONSE_KEY_CLICKED_BRANCH_LINK] isEqual:@1];
-        
         BOOL storedParamsAreEmpty = YES;
+        
         if ([preferenceHelper.installParams isKindOfClass:[NSString class]]) {
             storedParamsAreEmpty = !preferenceHelper.installParams.length;
         }
 
         if (dataIsFromALinkClick && (self.isInstall || storedParamsAreEmpty)) {
             preferenceHelper.installParams = sessionData;
         }
+        
+        if (dataIsFromALinkClick) {
+            [BNCFabricAnswers sendEventWithName:[@"Branch " stringByAppendingString:[[self getActionName] capitalizedString]] andAttributes:sessionDataDict];
+        }
     }
 
     // Clear link identifiers so they don't get reused on the next open

Branch-SDK/Fabric/ANSCompatibility.h

@@ -0,0 +1,31 @@
+//
+//  ANSCompatibility.h
+//  AnswersKit
+//
+//  Copyright (c) 2015 Crashlytics, Inc. All rights reserved.
+//
+
+#pragma once
+
+#if !__has_feature(nullability)
+#define nonnull
+#define nullable
+#define _Nullable
+#define _Nonnull
+#endif
+
+#ifndef NS_ASSUME_NONNULL_BEGIN
+#define NS_ASSUME_NONNULL_BEGIN
+#endif
+
+#ifndef NS_ASSUME_NONNULL_END
+#define NS_ASSUME_NONNULL_END
+#endif
+
+#if __has_feature(objc_generics)
+#define ANS_GENERIC_NSARRAY(type) NSArray<type>
+#define ANS_GENERIC_NSDICTIONARY(key_type,object_key) NSDictionary<key_type, object_key>
+#else
+#define ANS_GENERIC_NSARRAY(type) NSArray
+#define ANS_GENERIC_NSDICTIONARY(key_type,object_key) NSDictionary
+#endif