Merge pull request #17 from adeven/development

wellle · wellle · commit b3b8e533c3ae · 2013-09-16T09:42:33.000-07:00
Version 2.1.0
diff --git a/AdjustIO.podspec b/AdjustIO.podspec
@@ -1,11 +1,11 @@
 Pod::Spec.new do |s|
   s.name         = "AdjustIO"
-  s.version      = "2.0.1"
+  s.version      = "2.1.0"
   s.summary      = "This is the iOS SDK of AdjustIo. You can read more about it at http://adjust.io."
   s.homepage     = "http://adjust.io"
   s.license      = { :type => 'MIT', :file => 'MIT-LICENSE' }
   s.author       = { "Christian Wellenbrock" => "welle@adeven.com" }
-  s.source       = { :git => "https://github.com/adeven/adjust_ios_sdk.git", :tag => "v2.0.1" }
+  s.source       = { :git => "https://github.com/adeven/adjust_ios_sdk.git", :tag => "v2.1.0" }
   s.platform     = :ios, '4.3'
   s.framework    = 'AdSupport', 'SystemConfiguration'
   s.source_files = 'AdjustIo/*.{h,m}', 'AdjustIo/AIAdditions/*.{h,m}'
diff --git a/AdjustIo/AIActivityHandler.h b/AdjustIo/AIActivityHandler.h
@@ -6,8 +6,13 @@
 //  Copyright (c) 2013 adeven. All rights reserved.
 //
 
+#import "AdjustIo.h"
+
 @interface AIActivityHandler : NSObject
 
+@property (nonatomic, copy) NSString *environment;
+@property (nonatomic, assign) BOOL bufferEvents;
+
 + (AIActivityHandler *)handlerWithAppToken:(NSString *)appToken;
 - (id)initWithAppToken:(NSString *)appToken;
 
diff --git a/AdjustIo/AIActivityHandler.m b/AdjustIo/AIActivityHandler.m
@@ -6,6 +6,7 @@
 //  Copyright (c) 2013 adeven. All rights reserved.
 //
 
+#import "AIActivityPackage.h"
 #import "AIActivityHandler.h"
 #import "AIActivityState.h"
 #import "AIPackageBuilder.h"
@@ -40,6 +41,7 @@ @interface AIActivityHandler()
 @property (nonatomic, copy) NSString *fbAttributionId;
 @property (nonatomic, copy) NSString *userAgent;
 @property (nonatomic, copy) NSString *clientSdk;
+@property (nonatomic, assign) BOOL trackingEnabled;
 
 @end
 
@@ -57,6 +59,7 @@ - (id)initWithAppToken:(NSString *)yourAppToken {
 
     [self addNotificationObserver];
     self.internalQueue = dispatch_queue_create(kInternalQueueName, DISPATCH_QUEUE_SERIAL);
+    self.environment   = @"unknown"; // default value
 
     dispatch_async(self.internalQueue, ^{
         [self initInternal:yourAppToken];
@@ -105,6 +108,7 @@ - (void)initInternal:(NSString *)yourAppToken {
     self.appToken         = yourAppToken;
     self.macSha1          = macAddress.aiSha1;
     self.macShortMd5      = macShort.aiMd5;
+    self.trackingEnabled  = UIDevice.currentDevice.aiTrackingEnabled;
     self.idForAdvertisers = UIDevice.currentDevice.aiIdForAdvertisers;
     self.fbAttributionId  = UIDevice.currentDevice.aiFbAttributionId;
     self.userAgent        = AIUtil.userAgent;
@@ -201,6 +205,12 @@ - (void)eventInternal:(NSString *)eventToken
     AIActivityPackage *eventPackage = [eventBuilder buildEventPackage];
     [self.packageHandler addPackage:eventPackage];
 
+    if (self.bufferEvents) {
+        [AILogger info:@"Buffered event%@", eventPackage.suffix];
+    } else {
+        [self.packageHandler sendFirstPackage];
+    }
+
     [self writeActivityState];
     [AILogger debug:@"Event %d", self.activityState.eventCount];
 }
@@ -229,6 +239,12 @@ - (void)revenueInternal:(double)amount
     AIActivityPackage *revenuePackage = [revenueBuilder buildRevenuePackage];
     [self.packageHandler addPackage:revenuePackage];
 
+    if (self.bufferEvents) {
+        [AILogger info:@"Buffered revenue%@", revenuePackage.suffix];
+    } else {
+        [self.packageHandler sendFirstPackage];
+    }
+
     [self writeActivityState];
     [AILogger debug:@"Event %d (revenue)", self.activityState.eventCount];
 }
@@ -302,25 +318,28 @@ - (void)transferSessionPackage {
     [self.activityState injectSessionAttributes:sessionBuilder];
     AIActivityPackage *sessionPackage = [sessionBuilder buildSessionPackage];
     [self.packageHandler addPackage:sessionPackage];
+    [self.packageHandler sendFirstPackage];
 }
 
 - (void)injectGeneralAttributes:(AIPackageBuilder *)builder {
-    builder.userAgent = self.userAgent;
-    builder.clientSdk = self.clientSdk;
-    builder.appToken = self.appToken;
-    builder.macShortMd5 = self.macShortMd5;
-    builder.macSha1 = self.macSha1;
+    builder.userAgent        = self.userAgent;
+    builder.clientSdk        = self.clientSdk;
+    builder.appToken         = self.appToken;
+    builder.macShortMd5      = self.macShortMd5;
+    builder.macSha1          = self.macSha1;
+    builder.trackingEnabled  = self.trackingEnabled;
     builder.idForAdvertisers = self.idForAdvertisers;
-    builder.fbAttributionId = self.fbAttributionId;
+    builder.fbAttributionId  = self.fbAttributionId;
+    builder.environment      = self.environment;
 }
 
 # pragma mark - timer
 - (void)startTimer {
     if (self.timer == nil) {
         self.timer = [AITimer timerWithInterval:kTimerInterval
-                                    leeway:kTimerLeeway
-                                     queue:self.internalQueue
-                                     block:^{ [self timerFired]; }];
+                                         leeway:kTimerLeeway
+                                          queue:self.internalQueue
+                                          block:^{ [self timerFired]; }];
     }
     [self.timer resume];
 }
diff --git a/AdjustIo/AIAdditions/NSData+AIAdditions.h b/AdjustIo/AIAdditions/NSData+AIAdditions.h
@@ -3,7 +3,7 @@
 //  AdjustIo
 //
 //  Created by Christian Wellenbrock on 01.10.12.
-//  Copyright (c) 2012 adeven. All rights reserved.
+//  Copyright (c) 2012-2013 adeven. All rights reserved.
 //
 
 #import <Foundation/Foundation.h>
diff --git a/AdjustIo/AIAdditions/NSData+AIAdditions.m b/AdjustIo/AIAdditions/NSData+AIAdditions.m
@@ -3,7 +3,7 @@
 //  AdjustIo
 //
 //  Created by Christian Wellenbrock on 01.10.12.
-//  Copyright (c) 2012 adeven. All rights reserved.
+//  Copyright (c) 2012-2013 adeven. All rights reserved.
 //
 
 #import "NSData+AIAdditions.h"
diff --git a/AdjustIo/AIAdditions/NSString+AIAdditions.h b/AdjustIo/AIAdditions/NSString+AIAdditions.h
@@ -3,7 +3,7 @@
 //  AdjustIo
 //
 //  Created by Christian Wellenbrock on 23.07.12.
-//  Copyright (c) 2012 adeven. All rights reserved.
+//  Copyright (c) 2012-2013 adeven. All rights reserved.
 //
 
 #import <Foundation/Foundation.h>
diff --git a/AdjustIo/AIAdditions/NSString+AIAdditions.m b/AdjustIo/AIAdditions/NSString+AIAdditions.m
@@ -3,7 +3,7 @@
 //  AdjustIo
 //
 //  Created by Christian Wellenbrock on 23.07.12.
-//  Copyright (c) 2012 adeven. All rights reserved.
+//  Copyright (c) 2012-2013 adeven. All rights reserved.
 //
 
 #import "NSString+AIAdditions.h"
diff --git a/AdjustIo/AIAdditions/UIDevice+AIAdditions.h b/AdjustIo/AIAdditions/UIDevice+AIAdditions.h
@@ -3,13 +3,14 @@
 //  AdjustIo
 //
 //  Created by Christian Wellenbrock on 23.07.12.
-//  Copyright (c) 2012 adeven. All rights reserved.
+//  Copyright (c) 2012-2013 adeven. All rights reserved.
 //
 
 #import <Foundation/Foundation.h>
 
 @interface UIDevice(AIAdditions)
 
+- (BOOL)aiTrackingEnabled;
 - (NSString *)aiIdForAdvertisers;
 - (NSString *)aiFbAttributionId;
 - (NSString *)aiMacAddress;
diff --git a/AdjustIo/AIAdditions/UIDevice+AIAdditions.m b/AdjustIo/AIAdditions/UIDevice+AIAdditions.m
@@ -3,7 +3,7 @@
 //  AdjustIo
 //
 //  Created by Christian Wellenbrock on 23.07.12.
-//  Copyright (c) 2012 adeven. All rights reserved.
+//  Copyright (c) 2012-2013 adeven. All rights reserved.
 //
 
 #import "UIDevice+AIAdditions.h"
@@ -17,6 +17,14 @@
 
 @implementation UIDevice(AIAdditions)
 
+- (BOOL)aiTrackingEnabled {
+    if (NSClassFromString(@"ASIdentifierManager")) {
+        return ASIdentifierManager.sharedManager.advertisingTrackingEnabled;
+    } else {
+        return NO;
+    }
+}
+
 - (NSString *)aiIdForAdvertisers {
     if (NSClassFromString(@"ASIdentifierManager")) {
         return ASIdentifierManager.sharedManager.advertisingIdentifier.UUIDString;
diff --git a/AdjustIo/AILogger.h b/AdjustIo/AILogger.h
@@ -3,7 +3,7 @@
 //  AdjustIo
 //
 //  Created by Christian Wellenbrock on 2012-11-15.
-//  Copyright (c) 2012 adeven. All rights reserved.
+//  Copyright (c) 2012-2013 adeven. All rights reserved.
 //
 
 typedef enum {
@@ -29,6 +29,7 @@ typedef enum {
 + (void)info:   (NSString *)message, ...;
 + (void)warn:   (NSString *)message, ...;
 + (void)error:  (NSString *)message, ...;
++ (void)assert: (NSString *)message, ...;
 
 + (AILogger *)loggerWithTag:(NSString *)logTag;
 - (id)initWithTag:(NSString *)logTag;
@@ -38,5 +39,6 @@ typedef enum {
 - (void)info:   (NSString *)message, ...;
 - (void)warn:   (NSString *)message, ...;
 - (void)error:  (NSString *)message, ...;
+- (void)assert: (NSString *)message, ...;
 
 @end
diff --git a/AdjustIo/AILogger.m b/AdjustIo/AILogger.m
@@ -3,7 +3,7 @@
 //  AdjustIo
 //
 //  Created by Christian Wellenbrock on 2012-11-15.
-//  Copyright (c) 2012 adeven. All rights reserved.
+//  Copyright (c) 2012-2013 adeven. All rights reserved.
 //
 
 #import "AILogger.h"
@@ -66,6 +66,12 @@ - (void)error:(NSString *)format, ... {
     [self logLevel:@"e" format:format parameters:parameters];
 }
 
+- (void)assert: (NSString *)format, ... {
+    if (self.logLevel > AILogLevelAssert) return;
+    va_list parameters; va_start(parameters, format);
+    [self logLevel:@"a" format:format parameters:parameters];
+}
+
 + (void)verbose:(NSString *)format, ... {
     if (AILogger.getDefaultLogger.logLevel > AILogLevelVerbose) return;
     va_list parameters; va_start(parameters, format);
@@ -96,6 +102,12 @@ + (void)error:(NSString *)format, ... {
     [AILogger.getDefaultLogger logLevel:@"e" format:format parameters:parameters];
 }
 
++ (void)assert:(NSString *)format, ... {
+    if (AILogger.getDefaultLogger.logLevel > AILogLevelAssert) return;
+    va_list parameters; va_start(parameters, format);
+    [AILogger.getDefaultLogger logLevel:@"e" format:format parameters:parameters];
+}
+
 - (void)logLevel:(NSString *)logLevel format:(NSString *)format parameters:(va_list) parameters {
     NSString *string = [[NSString alloc] initWithFormat:format arguments:parameters];
     va_end(parameters);
diff --git a/AdjustIo/AIPackageBuilder.h b/AdjustIo/AIPackageBuilder.h
@@ -16,8 +16,10 @@
 @property (nonatomic, copy) NSString *macShortMd5;
 @property (nonatomic, copy) NSString *idForAdvertisers;
 @property (nonatomic, copy) NSString *fbAttributionId;
+@property (nonatomic, copy) NSString *environment;
 @property (nonatomic, copy) NSString *userAgent;
 @property (nonatomic, copy) NSString *clientSdk;
+@property (nonatomic, assign) BOOL trackingEnabled;
 
 // sessions
 @property (nonatomic, assign) int sessionCount;
diff --git a/AdjustIo/AIPackageBuilder.m b/AdjustIo/AIPackageBuilder.m
@@ -74,6 +74,8 @@ - (NSMutableDictionary *)defaultParameters {
     [self parameters:parameters setString:self.macShortMd5      forKey:@"mac_md5"];
     [self parameters:parameters setString:self.idForAdvertisers forKey:@"idfa"];
     [self parameters:parameters setString:self.fbAttributionId  forKey:@"fb_id"];
+    [self parameters:parameters setString:self.environment      forKey:@"environment"];
+    [self parameters:parameters setInt:self.trackingEnabled     forKey:@"tracking_enabled"];
 
     // session related (used for events as well)
     [self parameters:parameters setInt:self.sessionCount         forKey:@"session_count"];
diff --git a/AdjustIo/AIPackageHandler.m b/AdjustIo/AIPackageHandler.m
@@ -87,7 +87,6 @@ - (void)addInternal:(AIActivityPackage *)newPackage {
     [AILogger verbose:@"%@", newPackage.extendedString];
 
     [self writePackageQueue];
-    [self sendFirstInternal];
 }
 
 - (void)sendFirstInternal {
diff --git a/AdjustIo/AIUtil.m b/AdjustIo/AIUtil.m
@@ -10,7 +10,7 @@
 #import "UIDevice+AIAdditions.h"
 
 static NSString * const kBaseUrl   = @"https://app.adjust.io";
-static NSString * const kClientSdk = @"ios2.0.1";
+static NSString * const kClientSdk = @"ios2.1.0";
 
 
 #pragma mark -
diff --git a/AdjustIo/AdjustIo.h b/AdjustIo/AdjustIo.h
@@ -3,11 +3,15 @@
 //  AdjustIo
 //
 //  Created by Christian Wellenbrock on 2012-07-23.
-//  Copyright (c) 2012 adeven. All rights reserved.
+//  Copyright (c) 2012-2013 adeven. All rights reserved.
 //
 
 #import "AILogger.h"
 
+// TODO: add comment
+static NSString * const AIEnvironmentSandbox    = @"sandbox";
+static NSString * const AIEnvironmentProduction = @"production";
+
 /**
  * The main interface to AdjustIo.
  *
@@ -61,6 +65,15 @@
 + (void)trackRevenue:(double)amountInCents forEvent:(NSString *)eventToken;
 + (void)trackRevenue:(double)amountInCents forEvent:(NSString *)eventToken withParameters:(NSDictionary *)parameters;
 
+// TODO: add comment
+// sets logLevel to Assert
+// should be called after appDidLaunch and setLogLevel
++ (void)setEnvironment:(NSString *)environment;
+
+// TODO: add comment
+// should be called after appDidLaunch
++ (void)setEventBufferingEnabled:(BOOL)enabled;
+
 /**
  * Change the verbosity of AdjustIo's logs.
  *
diff --git a/AdjustIo/AdjustIo.m b/AdjustIo/AdjustIo.m
@@ -3,7 +3,7 @@
 //  AdjustIo
 //
 //  Created by Christian Wellenbrock on 2012-07-23.
-//  Copyright (c) 2012 adeven. All rights reserved.
+//  Copyright (c) 2012-2013 adeven. All rights reserved.
 //
 
 #import "AdjustIo.h"
@@ -47,6 +47,32 @@ + (void)trackRevenue:(double)amountInCents
     [activityHandler trackRevenue:amountInCents forEvent:eventToken withParameters:parameters];
 }
 
++ (void)setEnvironment:(NSString *)environment {
+    if (activityHandler == nil) {
+        [AILogger error:@"Please call `setEnvironment` after `appDidLaunch`!"];
+    } else if ([environment isEqualToString:AIEnvironmentSandbox]) {
+        activityHandler.environment = environment;
+        [AILogger assert:@"SANDBOX: AdjustIo is running in Sandbox mode. Use this setting for testing. Don't forget to set the environment to AIEnvironmentProduction before publishing!"];
+    } else if ([environment isEqualToString:AIEnvironmentProduction]) {
+        activityHandler.environment = environment;
+        [AILogger assert:@"PRODUCTION: AdjustIo is running in Production mode. Use this setting only for the build that you want to publish. Set the environment to AIEnvironmentSandbox if you want to test your app!"];
+        [AILogger setLogLevel:AILogLevelAssert];
+    } else {
+        activityHandler.environment = @"malformed";
+        [AILogger error:@"Malformed environment '%@'", environment];
+    }
+}
+
++ (void)setEventBufferingEnabled:(BOOL)enabled {
+    if (activityHandler == nil) {
+        [AILogger error:@"Please call `setEventBufferingEnabled` after `appDidLaunch`!"];
+        return;
+    }
+
+    activityHandler.bufferEvents = enabled;
+    if (enabled) [AILogger info:@"Event buffering is enabled"];
+}
+
 + (void)setLogLevel:(AILogLevel)logLevel {
     [AILogger setLogLevel:logLevel];
 }
diff --git a/MIT-LICENSE b/MIT-LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2012 adeven GmbH, 
+Copyright (c) 2012-2013 adeven GmbH, 
 http://www.adeven.com
 
 Permission is hereby granted, free of charge, to any person obtaining
@@ -18,4 +18,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
diff --git a/VERSION b/VERSION
diff --git a/doc/migration.md b/doc/migration.md
