Merge pull request #111 from adjust/nicolas-brugneaux-sociomantic-soc-encode-parameters

nonelse · nonelse · commit 24ee0805b162 · 2015-06-05T17:18:32.000+02:00
Nicolas brugneaux sociomantic soc encode parameters
diff --git a/Adjust.podspec b/Adjust.podspec
@@ -1,14 +1,26 @@
 Pod::Spec.new do |s|
   s.name           = "Adjust"
-  s.version        = "4.2.4"
+  s.version        = "4.2.5"
   s.summary        = "This is the iOS SDK of adjust. You can read more about it at http://adjust.com."
   s.homepage       = "http://adjust.com"
   s.license        = { :type => 'MIT', :file => 'MIT-LICENSE' }
   s.author         = { "Christian Wellenbrock" => "welle@adjust.com" }
-  s.source         = { :git => "https://github.com/adjust/ios_sdk.git", :tag => "v4.2.4" }
+  s.source         = { :git => "https://github.com/adjust/ios_sdk.git", :tag => "v4.2.5" }
   s.platform       = :ios, '4.3'
   s.framework      = 'SystemConfiguration'
   s.weak_framework = 'AdSupport', 'iAd'
   s.source_files   = 'Adjust/*.{h,m}', 'Adjust/ADJAdditions/*.{h,m}'
   s.requires_arc   = true
+  s.default_subspec = 'Standard'
+
+  s.subspec 'Standard' do |standard|
+  end
+
+  s.subspec 'Sociomantic' do |sm|
+    sm.source_files = 'plugin/Sociomantic/*.{h,m}'
+  end
+
+  s.subspec 'Criteo' do |cr|
+    cr.source_files = 'plugin/Criteo/*.{h,m}'
+  end
 end
diff --git a/Adjust/ADJUtil.m b/Adjust/ADJUtil.m
@@ -16,7 +16,7 @@
 #include <sys/xattr.h>
 
 static NSString * const kBaseUrl   = @"https://app.adjust.com";
-static NSString * const kClientSdk = @"ios4.2.4";
+static NSString * const kClientSdk = @"ios4.2.5";
 
 static NSString * const kDateFormat = @"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'Z";
 static NSDateFormatter *dateFormat;
diff --git a/AdjustTests/ADJActivityHandlerTests.m b/AdjustTests/ADJActivityHandlerTests.m
@@ -121,7 +121,7 @@ - (void)testFirstRun
     ADJActivityPackage *activityPackage = (ADJActivityPackage *) self.packageHandlerMock.packageQueue[0];
 
     //  check the Sdk version is being tested
-    XCTAssertEqual(@"ios4.2.4", activityPackage.clientSdk, @"%@", activityPackage.extendedString);
+    XCTAssertEqual(@"ios4.2.5", activityPackage.clientSdk, @"%@", activityPackage.extendedString);
 
     // check the server url
     XCTAssertEqual(@"https://app.adjust.com", ADJUtil.baseUrl);
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ If you're using [CocoaPods][cocoapods], you can add the following line to your
 `Podfile` and continue with [step 3](#step3):
 
 ```ruby
-pod 'Adjust', :git => 'git://github.com/adjust/ios_sdk.git', :tag => 'v4.2.4'
+pod 'Adjust', :git => 'git://github.com/adjust/ios_sdk.git', :tag => 'v4.2.5'
 ```
 
 ### 1. Get the SDK
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-4.2.4
+4.2.5
diff --git a/doc/criteo_plugin.md b/doc/criteo_plugin.md
@@ -2,7 +2,7 @@
 
 Integrate adjust with Criteo events by following these steps:
 
-1. Locate the `plugin` folder inside the downloaded archive from our [releases page](https://github.com/adjust/ios_sdk/releases).
+1. Locate the `plugin/Criteo` folder inside the downloaded archive from our [releases page](https://github.com/adjust/ios_sdk/releases).
 
 2. Drag the `ADJCriteo.h` and `ADJCriteo.m` files into the `Adjust` folder inside your project.
 
@@ -137,7 +137,7 @@ ADJEvent *event = [ADJEvent eventWithEventToken:@"{customEvent2EventToken}"];
 It's possible to attach an hashed email in every Criteo event with the `injectHashedEmailIntoCriteoEvents` method.
 The hashed email will be sent with every Criteo event for the duration of the application lifecycle,
 so it must be set again when the app is re-lauched.
-The hashed email can be removed by setting the `injectHashedEmailIntoCriteoEvents` method with `nil`.
+The hashed email can be removed by setting the `injectHashedEmailIntoCriteoEvents` value with `nil`.
 
 ```objc
 #import "ADJCriteo.h"
@@ -149,10 +149,22 @@ The hashed email can be removed by setting the `injectHashedEmailIntoCriteoEvent
 
 It's possible to attach a check-in and check-out date to every Criteo event with the `injectViewSearchDatesIntoCriteoEvent` method. The dates will be sent with every Criteo event for the duration of the application lifecycle, so it must be set again when the app is re-lauched.
 
-The search dates can be removed by setting the `injectViewSearchDatesIntoCriteoEvents` dates with `nil`.
+The search dates can be removed by setting the `injectViewSearchDatesIntoCriteoEvents` values with `nil`.
 
 ```objc
 #import "ADJCriteo.h"
 
 [ADJCriteo injectViewSearchDatesIntoCriteoEvents:@"2015-01-01" checkOutDate:@"2015-01-07"];
 ```
+
+### Partner id
+
+It's possible to attach a partner id to every Criteo event with the `injectPartnerIdIntoCriteoEvent` method. The partner id will be sent with every Criteo event for the duration of the application lifecycle, so it must be set again when the app is re-lauched.
+
+The search dates can be removed by setting the `injectPartnerIdIntoCriteoEvent` value with `nil`.
+
+```objc
+#import "ADJCriteo.h"
+
+[ADJCriteo injectPartnerIdIntoCriteoEvents:@"{criteoPartnerId}"];
+```
diff --git a/doc/migrate.md b/doc/migrate.md
@@ -1,4 +1,4 @@
-## Migrate your adjust SDK for iOS to v4.2.4 from v3.4.0
+## Migrate your adjust SDK for iOS to v4.2.5 from v3.4.0
 
 ### Initial setup
 
diff --git a/doc/sociomantic_plugin.md b/doc/sociomantic_plugin.md
@@ -2,7 +2,7 @@
 
 Integrate adjust with Sociomantic events by following these steps:
 
-1. Locate the `plugin` folder inside the downloaded archive from our [releases page](https://github.com/adjust/ios_sdk/releases).
+1. Locate the `plugin/Sociomantic` folder inside the downloaded archive from our [releases page](https://github.com/adjust/ios_sdk/releases).
 
 2. Drag the `ADJSociomantic.h` and `ADJSociomantic.m` files into the `Adjust` folder inside your project.
 
diff --git a/plugin/Criteo/ADJCriteo.h b/plugin/Criteo/ADJCriteo.h
@@ -69,4 +69,7 @@
 
 + (void)injectViewSearchDatesIntoCriteoEvents:(NSString *)checkInDate
                                 checkOutDate:(NSString *)checkOutDate;
+
++ (void)injectPartnerIdIntoCriteoEvents:(NSString *)partnerId;
+
 @end
diff --git a/plugin/Criteo/ADJCriteo.m b/plugin/Criteo/ADJCriteo.m
@@ -42,6 +42,7 @@ @implementation ADJCriteo
 static NSString * hashEmailInternal;
 static NSString * checkInDateInternal;
 static NSString * checkOutDateInternal;
+static NSString * partnerIdInternal;
 
 + (id<ADJLogger>) logger {
     return ADJAdjustFactory.logger;
@@ -173,9 +174,15 @@ + (void)injectViewSearchDatesIntoCriteoEvents:(NSString *)checkInDate
     checkOutDateInternal = checkOutDate;
 }
 
++ (void)injectPartnerIdIntoCriteoEvents:(NSString *)partnerId
+{
+    partnerIdInternal = partnerId;
+}
+
 + (void)injectOptionalParams:(ADJEvent *)event {
     [ADJCriteo injectHashEmail:event];
     [ADJCriteo injectSearchDates:event];
+    [ADJCriteo injectPartnerId:event];
 }
 
 + (void)injectHashEmail:(ADJEvent *)event {
@@ -193,6 +200,13 @@ + (void)injectSearchDates:(ADJEvent *)event {
     [event addPartnerParameter:@"dout" value:checkOutDateInternal];
 }
 
++ (void)injectPartnerId:(ADJEvent *)event {
+    if (partnerIdInternal == nil) {
+        return;
+    }
+    [event addPartnerParameter:@"criteo_partner_id" value:partnerIdInternal];
+}
+
 + (NSString*) createCriteoVBFromProducts:(NSArray*) products
 {
     if (products == nil) {
diff --git a/plugin/Sociomantic/ADJSociomantic.h b/plugin/Sociomantic/ADJSociomantic.h
diff --git a/plugin/Sociomantic/ADJSociomantic.m b/plugin/Sociomantic/ADJSociomantic.m
@@ -164,8 +164,8 @@ + (void)injectCustomerDataIntoEvent:(ADJEvent *)event
          _data[key] = value;
      }];
 
-    NSString *dob = [ADJSociomantic stringify:_data];
-    [event addPartnerParameter:@"socio_dob" value:dob];
+    NSString *dob = [ADJSociomantic stringifyAndEncode:_data];
+    [event addPartnerParameter:@"socio_do" value:dob];
 }
 
 
@@ -195,7 +195,7 @@ + (void)injectViewListingIntoEvent:(ADJEvent *)event
         co[SCMTimestamp] = date;
     }
 
-    NSString *jsonCo = [ADJSociomantic stringify:co];
+    NSString *jsonCo = [ADJSociomantic stringifyAndEncode:@{@"category":co}];
     [event addPartnerParameter:@"socio_co" value:jsonCo];
 }
 
@@ -221,7 +221,7 @@ + (void)injectViewProductIntoEvent:(ADJEvent *)event
         [ADJSociomantic filter:parameters withAliases:aliases modifies:product ];
     }
 
-    NSString *jsonPo = [ADJSociomantic stringify:@[product]];
+    NSString *jsonPo = [ADJSociomantic stringifyAndEncode:@{@"products": @[product]}];
     [event addPartnerParameter:@"socio_po" value:jsonPo];
 }
 
@@ -253,7 +253,7 @@ + (void)injectCartIntoEvent:(ADJEvent *)event
 
     if ( 0 < po.count )
     {
-        NSString *jsonPo = [ADJSociomantic stringify:po];
+        NSString *jsonPo = [ADJSociomantic stringifyAndEncode:@{@"products":po}];
         [event addPartnerParameter:@"socio_po" value:jsonPo];
     }
 }
@@ -322,7 +322,7 @@ + (void)injectTransactionIntoEvent:(ADJEvent *)event
             }
         }];
 
-        NSString *jsonPo = [ADJSociomantic stringify:po];
+        NSString *jsonPo = [ADJSociomantic stringifyAndEncode:@{@"products":po}];
         [event addPartnerParameter:@"socio_po" value:jsonPo];
     }
 
@@ -337,7 +337,7 @@ + (void)injectTransactionIntoEvent:(ADJEvent *)event
     }
 
     to[@"transaction"]  = transactionID;
-    NSString *jsonTo    = [ADJSociomantic stringify:@{@"transaction":to}];
+    NSString *jsonTo    = [ADJSociomantic stringifyAndEncode:@{@"transaction":to}];
     [event addPartnerParameter:@"socio_to" value:jsonTo];
 
 }
@@ -360,7 +360,7 @@ + (void)injectLeadIntoEvent:(ADJEvent *)event
     }
 
     to[@"transaction"]  = leadID;
-    NSString *jsonTo    = [ADJSociomantic stringify:@{@"transaction":to}];
+    NSString *jsonTo    = [ADJSociomantic stringifyAndEncode:@{@"transaction":to}];
     [event addPartnerParameter:@"socio_to" value:jsonTo];
 }
 
@@ -435,4 +435,15 @@ + (NSString*)stringify:(NSObject*)object
     }
 }
 
++ (NSString*) encode:(NSString*) unencodedString
+{
+    NSString *encoded = [unencodedString stringByReplacingOccurrencesOfString:@"\\/" withString:@"/"];
+    return encoded;
+}
+
++ (NSString*) stringifyAndEncode:(NSObject*) object
+{
+    return [ADJSociomantic encode:[ADJSociomantic stringify:object]];
+}
+
 @end

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## Migrate your adjust SDK for iOS to v4.2.4 from v3.4.0`
	`1`	`+## Migrate your adjust SDK for iOS to v4.2.5 from v3.4.0`
`2`	`2`
`3`	`3`	`### Initial setup`
`4`	`4`