DAND-61-Add support for groups (#47)

* DAND-61-Update Mixpanel, Analytics versions, use older version of OCMOckito to avoid pod dependency issue.

* DAND-61- Add support for groups with and without names and setOnce traits

* DAND-61-Update tests to include groups

* Add support for example usage of analytics, and mixpanel usage, with identify and use group in app delegate of example project.

* DAND-61-Update changelod and update podspec version for release

* DAND-61- Remove specific write key and add more group properties in tests

* DAND-61-Add groupIdentifierTraits  settings check and handling. Updated tests accordingly.

* DAND-61- Remove check on group name, and set group with identifier value.

* DAND-61-Update test to verify groupIdentifierTraits

* DAND-61-Revert the version update in CHANGELOG and podspec

Author: OllaAshour

Example/Podfile

@@ -10,7 +10,7 @@ end
 target 'Segment-Mixpanel_Tests' do
   pod "Segment-Mixpanel", :path => "../"
 
-  pod 'OCMockito'
+  pod 'OCMockito', '~> 3.0'
   pod 'Specta'
   pod 'Expecta'
 end

Example/Podfile.lock

@@ -1,23 +1,23 @@
 PODS:
-  - Analytics (3.2.6)
-  - Expecta (1.0.3)
-  - Mixpanel (3.4.9)
-  - OCHamcrest (5.2.0)
-  - OCMockito (3.0.1):
+  - Analytics (3.7.0)
+  - Expecta (1.0.6)
+  - Mixpanel (3.5.0)
+  - OCHamcrest (5.4.0)
+  - OCMockito (3.0.2):
     - OCHamcrest (~> 5.1)
-  - Segment-Mixpanel (1.3.0):
+  - Segment-Mixpanel (1.4.0):
     - Analytics (~> 3.0)
-    - Mixpanel (~> 3.4.7)
+    - Mixpanel (~> 3.5)
   - Specta (1.0.7)
 
 DEPENDENCIES:
   - Expecta
-  - OCMockito
+  - OCMockito (~> 3.0)
   - Segment-Mixpanel (from `../`)
   - Specta
 
 SPEC REPOS:
-  https://github.com/cocoapods/specs.git:
+  https://github.com/CocoaPods/Specs.git:
     - Analytics
     - Expecta
     - Mixpanel
@@ -30,14 +30,14 @@ EXTERNAL SOURCES:
     :path: "../"
 
 SPEC CHECKSUMS:
-  Analytics: ad1c5bdc169866d72afdbc918084d0695010e35a
-  Expecta: 9d1bff6c8b0eeee73a166a2ee898892478927a15
-  Mixpanel: 5aca6e506b34650b96dc759a208513d86650fac7
-  OCHamcrest: 218dc4022a5e928a275771da70c5dbea9f859287
-  OCMockito: 9eee3c61e42f7cb8aa015d66f8cc16849701d973
-  Segment-Mixpanel: 4ff970648d9c49ee0a62a32eec777346316ee7ea
+  Analytics: 77fd5fb102a4a5eedafa2c2b0245ceb7b7c15e45
+  Expecta: 3b6bd90a64b9a1dcb0b70aa0e10a7f8f631667d5
+  Mixpanel: 399997670f5452de026449f9e9ecd52eccbb9ff7
+  OCHamcrest: 5c1d441c5a82fb18ac17c2aeb52ec1a99edb971b
+  OCMockito: 2cb6c2267cbc76537be56281cd47cdb5a7c27541
+  Segment-Mixpanel: 625bb010c65f66acdd976d9db240a420aa67b132
   Specta: 3e1bd89c3517421982dc4d1c992503e48bd5fe66
 
-PODFILE CHECKSUM: 507a152874203f544f8656b6532dd0f45dd3c57d
+PODFILE CHECKSUM: 6ff827a80dc2a21042246602306af45cb1c9f2a8
 
-COCOAPODS: 1.7.5
+COCOAPODS: 1.8.4

Example/Segment-Mixpanel/SEGAppDelegate.m

@@ -7,13 +7,30 @@
 //
 
 #import "SEGAppDelegate.h"
-
+#import <Analytics/SEGAnalytics.h>
+#import <Segment-Mixpanel/SEGMixpanelIntegrationFactory.h>
 
 @implementation SEGAppDelegate
 
 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
 {
     // Override point for customization after application launch.
+    
+    // Override point for customization after application launch.
+    [SEGAnalytics debug:YES];
+    SEGAnalyticsConfiguration *config = [SEGAnalyticsConfiguration configurationWithWriteKey:@"YOUR_WRITE_KEY_HERE"];
+    
+    // Add any of your bundled integrations.
+    [config use:[SEGMixpanelIntegrationFactory instance]];
+    
+    [SEGAnalytics setupWithConfiguration:config];
+    
+    [[SEGAnalytics sharedAnalytics] identify:@"segment-fake-tester-Mixpanel"
+                                      traits:@{ @"email": @"[email protected]" }];
+    
+    [[SEGAnalytics sharedAnalytics] group:@"testversion1" traits:@{ @"name": @"test group"}];
+    
+    
     return YES;
 }
 

Example/Tests/SEGPayloadBuilder.h

@@ -23,4 +23,6 @@
 
 + (SEGAliasPayload *)alias:(NSString *)newId;
 
++ (SEGGroupPayload *)group:(NSString *) groupId withTraits:(NSDictionary *)traits;
+
 @end

Example/Tests/SEGPayloadBuilder.m

@@ -41,4 +41,9 @@ + (SEGAliasPayload *)alias:(NSString *)newId
     return [[SEGAliasPayload alloc] initWithNewId:newId context:@{} integrations:@{}];
 }
 
++ (SEGGroupPayload *)group:(NSString *)groupId withTraits:(NSDictionary *)traits
+{
+    return [[SEGGroupPayload alloc] initWithGroupId:groupId traits:traits context:@{} integrations:@{}];
+}
+
 @end

Example/Tests/Tests.m

@@ -9,22 +9,27 @@
 // https://github.com/Specta/Specta
 
 #import "SEGPayloadBuilder.h"
+#import <MixpanelGroup.h>
 
 SpecBegin(InitialSpecs)
 
 describe(@"Mixpanel Integration", ^{
     __block SEGMixpanelIntegration *integration;
     __block Mixpanel *mixpanel;
     __block MixpanelPeople *mixpanelPeople;
+    __block MixpanelGroup *mixpanelGroup;
 
     beforeEach(^{
         mixpanel = mock([Mixpanel class]);
         mixpanelPeople = mock([MixpanelPeople class]);
         [given([mixpanel people]) willReturn:mixpanelPeople];
-
+        
+        mixpanelGroup = mock([MixpanelGroup class]);
+        
         integration = [[SEGMixpanelIntegration alloc] initWithSettings:@{
             @"trackAllPages" : @1,
-            @"setAllTraitsByDefault" : @1
+            @"setAllTraitsByDefault" : @1,
+            @"groupIdentifierTraits" : @[@"group_id", @"group_name", @"group_idtest2"]
         } andMixpanel:mixpanel];
     });
 
@@ -118,7 +123,77 @@
             @"age" : @24
         }];
     });
+    
+    
+    it(@"simple group", ^{
+        NSDictionary *groupTraits = @{
+                                      @"groupCity" : @"Cairo",
+                                      @"group_name" : @"mixPanelTest1Group"
+                                      };
+        [integration group:[SEGPayloadBuilder group:@"groupTest1" withTraits:groupTraits]];
+        
+        NSDictionary *groupIdentifierTraits = integration.settings[@"groupIdentifierTraits"];
+        
+        for (NSString *identifierTrait in groupIdentifierTraits) {
+            NSString *groupIdentifierVal = groupTraits[identifierTrait];
+            if (groupIdentifierVal) {
+                 [verify(mixpanel) getGroup:groupIdentifierVal groupID:@"groupTest1"];
+            }
+           
+        }
+        
+    });
+    
+    it(@"complex group", ^{
+        NSDictionary *groupTraits = @{
+                                      @"groupCity" : @"Alexandria",
+                                      @"name" : @"mixPanelTest1Group",
+                                      @"address": @{@"city": @"Alexandria", @"postalCode": @"22314", @"state":@"Virginia", @"street": @"105 N Union St" },
+                                      @"description": @"Art Center",
+                                      @"avatar" : @"https://gravatar.com/avatar/f8b72def445675a558fe68b1cb651da1?s=400&d=robohash&r=x"
+                                      };
+        [integration group:[SEGPayloadBuilder group:@"groupTest1" withTraits:groupTraits]];
+        
+        NSDictionary *groupIdentifierTraits = integration.settings[@"groupIdentifierTraits"];
+        
+        for (NSString *identifierTrait in groupIdentifierTraits) {
+            NSString *groupIdentifierVal = groupTraits[identifierTrait];
+            if (groupIdentifierVal) {
+                [verify(mixpanel) getGroup:groupIdentifierVal groupID:@"groupTest1"];
+            }
+            
+        }
+      
+    });
 
+    it(@"simple group without name", ^{
+        NSDictionary *groupTraits = @{
+                                      @"groupCity" : @"Cairo"
+                                      };
+        [integration group:[SEGPayloadBuilder group:@"groupTest2" withTraits:groupTraits]];
+        
+        NSDictionary *groupIdentifierTraits = integration.settings[@"groupIdentifierTraits"];
+        
+        for (NSString *identifierTrait in groupIdentifierTraits) {
+            NSString *groupIdentifierVal = groupTraits[identifierTrait];
+             [given([mixpanel getGroup:groupIdentifierVal groupID:@"groupTest2"]) willReturn:nil];
+            
+        }
+    });
+    
+    it(@"simple group setOnce traits", ^{
+        [given([mixpanel getGroup:@"test1" groupID:@"groupTest2"]) willReturn:mixpanelGroup];
+        NSDictionary *groupTraits = @{
+                                      @"groupCity" : @"Cairo",
+                                      @"groupCount" : @"20",
+                                      @"group_id" : @"test1"
+                                      };
+        [integration group:[SEGPayloadBuilder group:@"groupTest2" withTraits:groupTraits]];
+        
+        [verify(mixpanelGroup) setOnce:groupTraits];
+        [verify(mixpanel) getGroup:@"test1" groupID:@"groupTest2"];
+    });
+    
     it(@"alias", ^{
         [given([mixpanel distinctId]) willReturn:@"123456"];
         [integration alias:[SEGPayloadBuilder alias:@"prateek"]];

Pod/Classes/SEGMixpanelIntegration.m

@@ -1,5 +1,6 @@
 #import "SEGMixpanelIntegration.h"
 #import <Analytics/SEGAnalyticsUtils.h>
+#import <MixpanelGroup.h>
 
 
 @implementation SEGMixpanelIntegration
@@ -139,6 +140,31 @@ - (void)screen:(SEGScreenPayload *)payload
     }
 }
 
+
+- (void) group:(SEGGroupPayload *)payload {
+    
+    NSString *groupID = payload.groupId;
+    NSDictionary *traits = [payload traits];
+    
+    NSArray *groupIdentifierProperties = [self.settings objectForKey:@"groupIdentifierTraits"];
+    
+    if(!groupID || groupID.length == 0 || groupIdentifierProperties.count == 0) {
+        return;
+    }
+    
+    if(traits != nil || traits.count != 0){
+        for (NSString *groupIdentiferProperty in groupIdentifierProperties) {
+            [[self.mixpanel getGroup:traits[groupIdentiferProperty] groupID:groupID ] setOnce:traits];
+        }
+    }
+    
+    for (NSString *groupIdentiferProperty in groupIdentifierProperties) {
+        [self.mixpanel setGroup:traits[groupIdentiferProperty] groupID:groupID];
+        SEGLog(@"[Mixpanel setGroup:%@ groupID:%@]", groupIdentiferProperty, groupID);
+    }
+    
+}
+
 + (NSNumber *)extractRevenue:(NSDictionary *)dictionary withKey:(NSString *)revenueKey
 {
     id revenueProperty = nil;

Segment-Mixpanel.podspec

@@ -22,5 +22,5 @@ Pod::Spec.new do |s|
   s.source_files = 'Pod/Classes/**/*'
 
   s.dependency 'Analytics', '~> 3.0'
-  s.dependency 'Mixpanel', '~> 3.4.7'
+  s.dependency 'Mixpanel', '~> 3.5'
 end