Merge lp:~rockstar/ubuntuone-ios-music/crashlytics into lp:ubuntuone-ios-music

[Paul Hummer]

Add Crashlytics reporting

It's my day off, but I just got in on the Crashlytics crash reporting beta, and after installing it in the app I wanted to try it out on, I immediately created a Canonical organization and added to U1 Music. This is the change to actually use it.

[lp:~rockstar/ubuntuone-ios-music/crashlytics]

247. By Paul Hummer on 2013-02-08

Add crashlytics

Duh. You have to commit before you push and submit for merge, dummkopf

[Mike McCracken (mikemc)]

Looks good to me on visual inspection.

LulZ!

review: Approve

=== added directory 'Crashlytics.framework'
=== added symlink 'Crashlytics.framework/Crashlytics'
=== target is u'Versions/Current/Crashlytics'
=== added symlink 'Crashlytics.framework/Headers'
=== target is u'Versions/Current/Headers'
=== added symlink 'Crashlytics.framework/Resources'
=== target is u'Versions/Current/Resources'
=== added directory 'Crashlytics.framework/Versions'
=== added directory 'Crashlytics.framework/Versions/A'
=== added file 'Crashlytics.framework/Versions/A/Crashlytics'
Binary files Crashlytics.framework/Versions/A/Crashlytics	1970-01-01 00:00:00 +0000 and Crashlytics.framework/Versions/A/Crashlytics	2013-02-08 17:07:26 +0000 differ
=== added directory 'Crashlytics.framework/Versions/A/Headers'
=== added file 'Crashlytics.framework/Versions/A/Headers/Crashlytics.h'
--- Crashlytics.framework/Versions/A/Headers/Crashlytics.h	1970-01-01 00:00:00 +0000
+++ Crashlytics.framework/Versions/A/Headers/Crashlytics.h	2013-02-08 17:07:26 +0000
@@ -0,0 +1,192 @@
+//
+//  Crashlytics.h
+//  Crashlytics
+//
+//  Copyright 2012 Crashlytics, Inc. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+/**
+ *
+ * The CLS_LOG macro provides as easy way to gather more information in your log messages that are
+ * sent with your crash data. CLS_LOG prepends your custom log message with the function name and
+ * line number where the macro was used. If your app was built with the DEBUG preprocessor macro
+ * defined CLS_LOG uses the CLSNSLog function which forwards your log message to NSLog and CLSLog.
+ * If the DEBUG preprocessor macro is not defined CLS_LOG uses CLSLog only.
+ *
+ * Example output:
+ * -[AppDelegate login:] line 134 $ login start
+ *
+ * If you would like to change this macro, create a new header file, unset our define and then define
+ * your own version. Make sure this new header file is imported after the Crashlytics header file.
+ *
+ * #undef CLS_LOG
+ * #define CLS_LOG(__FORMAT__, ...) CLSNSLog...
+ *
+ **/
+#ifdef DEBUG
+#define CLS_LOG(__FORMAT__, ...) CLSNSLog((@"%s line %d $ " __FORMAT__), __PRETTY_FUNCTION__, __LINE__, ##__VA_ARGS__)
+#else
+#define CLS_LOG(__FORMAT__, ...) CLSLog((@"%s line %d $ " __FORMAT__), __PRETTY_FUNCTION__, __LINE__, ##__VA_ARGS__)
+#endif
+
+/**
+ *
+ * Add logging that will be sent with your crash data. This logging will not show up in the system.log
+ * and will only be visible in your Crashlytics dashboard.
+ *
+ **/
+OBJC_EXTERN void CLSLog(NSString *format, ...) NS_FORMAT_FUNCTION(1,2);
+
+/**
+ *
+ * Add logging that will be sent with your crash data. This logging will show up in the system.log
+ * and your Crashlytics dashboard. It is not recommended for Release builds.
+ *
+ **/
+OBJC_EXTERN void CLSNSLog(NSString *format, ...) NS_FORMAT_FUNCTION(1,2);
+
+@protocol CrashlyticsDelegate;
+
+@interface Crashlytics : NSObject
+
+@property (nonatomic, readonly, copy) NSString *apiKey;
+@property (nonatomic, readonly, copy) NSString *version;
+@property (nonatomic, assign)         BOOL      debugMode;
+
+@property (nonatomic, assign)         NSObject <CrashlyticsDelegate> *delegate;
+
+/**
+ *
+ * The recommended way to install Crashlytics into your application is to place a call
+ * to +startWithAPIKey: in your -application:didFinishLaunchingWithOptions: method.
+ *
+ * This delay defaults to 1 second in order to generally give the application time to
+ * fully finish launching.
+ *
+ **/
++ (Crashlytics *)startWithAPIKey:(NSString *)apiKey;
++ (Crashlytics *)startWithAPIKey:(NSString *)apiKey afterDelay:(NSTimeInterval)delay;
+
+/**
+ *
+ * If you need the functionality provided by the CrashlyticsDelegate protocol, you can use
+ * these convenience methods to activate the framework and set the delegate in one call.
+ *
+ **/
++ (Crashlytics *)startWithAPIKey:(NSString *)apiKey delegate:(NSObject <CrashlyticsDelegate> *)delegate;
++ (Crashlytics *)startWithAPIKey:(NSString *)apiKey delegate:(NSObject <CrashlyticsDelegate> *)delegate afterDelay:(NSTimeInterval)delay;
+
+/**
+ *
+ * Access the singleton Crashlytics instance.
+ *
+ **/
++ (Crashlytics *)sharedInstance;
+
+/**
+ *
+ * The easiest way to cause a crash - great for testing!
+ *
+ **/
+- (void)crash;
+
+/**
+ *
+ * Many of our customers have requested the ability to tie crashes to specific end-users of their
+ * application in order to facilitate responses to support requests or permit the ability to reach
+ * out for more information. We allow you to specify up to three separate values for display within
+ * the Crashlytics UI - but please be mindful of your end-user's privacy.
+ *
+ * We recommend specifying a user identifier - an arbitrary string that ties an end-user to a record
+ * in your system. This could be a database id, hash, or other value that is meaningless to a
+ * third-party observer but can be indexed and queried by you.
+ *
+ * Optionally, you may also specify the end-user's name or username, as well as email address if you
+ * do not have a system that works well with obscured identifiers.
+ *
+ * Pursuant to our EULA, this data is transferred securely throughout our system and we will not
+ * disseminate end-user data unless required to by law. That said, if you choose to provide end-user
+ * contact information, we strongly recommend that you disclose this in your application's privacy
+ * policy. Data privacy is of our utmost concern.
+ *
+ **/
+- (void)setUserIdentifier:(NSString *)identifier;
+- (void)setUserName:(NSString *)name;
+- (void)setUserEmail:(NSString *)email;
+
++ (void)setUserIdentifier:(NSString *)identifier;
++ (void)setUserName:(NSString *)name;
++ (void)setUserEmail:(NSString *)email;
+
+/**
+ *
+ * Set a value for a key to be associated with your crash data.
+ *
+ **/
+- (void)setObjectValue:(id)value forKey:(NSString *)key;
+- (void)setIntValue:(int)value forKey:(NSString *)key;
+- (void)setBoolValue:(BOOL)value forKey:(NSString *)key;
+- (void)setFloatValue:(float)value forKey:(NSString *)key;
+
++ (void)setObjectValue:(id)value forKey:(NSString *)key;
++ (void)setIntValue:(int)value forKey:(NSString *)key;
++ (void)setBoolValue:(BOOL)value forKey:(NSString *)key;
++ (void)setFloatValue:(float)value forKey:(NSString *)key;
+
+@end
+
+/**
+ * The CLSCrashReport protocol exposes methods that you can call on crash report objects passed
+ * to delegate methods. If you want these values or the entire object to stay in memory retain
+ * them or copy them.
+ **/
+@protocol CLSCrashReport <NSObject>
+@required
+
+/**
+ * Returns the session identifier for the crash report.
+ **/
+- (NSString *)identifier;
+
+/**
+ * Returns the custom key value data for the crash report.
+ **/
+- (NSDictionary *)customKeys;
+
+@end
+
+/**
+ *
+ * The CrashlyticsDelegate protocol provides a mechanism for your application to take
+ * action on events that occur in the Crashlytics crash reporting system.  You can make
+ * use of these calls by assigning an object to the Crashlytics' delegate property directly,
+ * or through the convenience startWithAPIKey:delegate:... methods.
+ *
+ **/
+@protocol CrashlyticsDelegate <NSObject>
+@optional
+
+/**
+ *
+ * Called once a Crashlytics instance has determined that the last execution of the
+ * application ended in a crash.  This is called some time after the crash reporting
+ * process has begun.  If you have specified a delay in one of the
+ * startWithAPIKey:... calls, this will take at least that long to be invoked.
+ *
+ **/
+- (void)crashlyticsDidDetectCrashDuringPreviousExecution:(Crashlytics *)crashlytics;
+
+/**
+ *
+ * Just like crashlyticsDidDetectCrashDuringPreviousExecution this delegate method is
+ * called once a Crashlytics instance has determined that the last execution of the
+ * application ended in a crash. A CLSCrashReport is passed back that contains data about
+ * the last crash report that was generated. See the CLSCrashReport protocol for method details.
+ * This method is called after crashlyticsDidDetectCrashDuringPreviousExecution.
+ *
+ **/
+- (void)crashlytics:(Crashlytics *)crashlytics didDetectCrashDuringPreviousExecution:(id <CLSCrashReport>)crash;
+
+@end

=== added directory 'Crashlytics.framework/Versions/A/Resources'
=== added file 'Crashlytics.framework/Versions/A/Resources/Info.plist'
--- Crashlytics.framework/Versions/A/Resources/Info.plist	1970-01-01 00:00:00 +0000
+++ Crashlytics.framework/Versions/A/Resources/Info.plist	2013-02-08 17:07:26 +0000
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>BuildMachineOSBuild</key>
+	<string>12C60</string>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>English</string>
+	<key>CFBundleExecutable</key>
+	<string>Crashlytics</string>
+	<key>CFBundleIdentifier</key>
+	<string>com.crashlytics.ios</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>Crashlytics</string>
+	<key>CFBundlePackageType</key>
+	<string>FMWK</string>
+	<key>CFBundleShortVersionString</key>
+	<string>2.0.3</string>
+	<key>CFBundleSupportedPlatforms</key>
+	<array>
+		<string>iPhoneOS</string>
+	</array>
+	<key>CFBundleVersion</key>
+	<string>0200.03.00</string>
+	<key>DTCompiler</key>
+	<string>com.apple.compilers.llvm.clang.1_0</string>
+	<key>DTPlatformBuild</key>
+	<string>10A403</string>
+	<key>DTPlatformName</key>
+	<string>iphoneos</string>
+	<key>DTPlatformVersion</key>
+	<string>6.0</string>
+	<key>DTSDKBuild</key>
+	<string>10A403</string>
+	<key>DTSDKName</key>
+	<string>iphoneos6.0</string>
+	<key>DTXcode</key>
+	<string>0451</string>
+	<key>DTXcodeBuild</key>
+	<string>4G1004</string>
+	<key>MinimumOSVersion</key>
+	<string>4.0</string>
+</dict>
+</plist>

=== added symlink 'Crashlytics.framework/Versions/Current'
=== target is u'A'
=== added file 'Crashlytics.framework/run'
Binary files Crashlytics.framework/run	1970-01-01 00:00:00 +0000 and Crashlytics.framework/run	2013-02-08 17:07:26 +0000 differ
=== modified file 'Music/UOAppDelegate.m'
--- Music/UOAppDelegate.m	2013-01-27 21:34:28 +0000
+++ Music/UOAppDelegate.m	2013-02-08 17:07:26 +0000
@@ -32,6 +32,7 @@
 #import "UOAuthManager.h"
 #import "U1LocalMusicServer.h"
 #import "StreamingPlayer.h"
+#import <Crashlytics/Crashlytics.h>
 
 #if TARGET_IPHONE_SIMULATOR
 @implementation NSURLRequest(AllowAllCerts)
@@ -54,6 +55,7 @@
 @synthesize musicServer = _musicServer;
 
 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions: (NSDictionary *)launchOptions {
+    [Crashlytics startWithAPIKey:@"0606692bafe724ed1413548f6211a8557140eade"];
     
     self.window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds ]];
 

=== modified file 'U1Music.xcodeproj/project.pbxproj'
--- U1Music.xcodeproj/project.pbxproj	2013-01-30 20:07:42 +0000
+++ U1Music.xcodeproj/project.pbxproj	2013-02-08 17:07:26 +0000
@@ -28,6 +28,7 @@
 		523B3CFA15B73BA0004394F4 /* [e-mail] in Resources */ = {isa = PBXBuildFile; fileRef = 523B3CF615B73BA0004394F4 /* [e-mail] */; };
 		523B3CFB15B73BA0004394F4 /* download.png in Resources */ = {isa = PBXBuildFile; fileRef = 523B3CF715B73BA0004394F4 /* download.png */; };
 		523B3CFC15B73BA0004394F4 /* [e-mail] in Resources */ = {isa = PBXBuildFile; fileRef = 523B3CF815B73BA0004394F4 /* [e-mail] */; };
+		5257416D16C5653100530CCC /* Crashlytics.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 5257416C16C5653100530CCC /* Crashlytics.framework */; };
 		5268509716AE5267001F65A6 /* libRestKit.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 5268509016AE516C001F65A6 /* libRestKit.a */; };
 		526850A816AEE4E1001F65A6 /* Storyboard_iPhone.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 526850A516AEE4E1001F65A6 /* Storyboard_iPhone.storyboard */; };
 		526850A916AEE4E1001F65A6 /* UOAppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 526850A716AEE4E1001F65A6 /* UOAppDelegate.m */; };
@@ -270,6 +271,7 @@
 		523B3CF615B73BA0004394F4 /* [e-mail] */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = "[e-mail]"; sourceTree = "<group>"; };
 		523B3CF715B73BA0004394F4 /* download.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = download.png; sourceTree = "<group>"; };
 		523B3CF815B73BA0004394F4 /* [e-mail] */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = "[e-mail]"; sourceTree = "<group>"; };
+		5257416C16C5653100530CCC /* Crashlytics.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; path = Crashlytics.framework; sourceTree = "<group>"; };
 		5268508516AE516B001F65A6 /* RestKit.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = RestKit.xcodeproj; path = ../RestKit/RestKit.xcodeproj; sourceTree = "<group>"; };
 		526850A516AEE4E1001F65A6 /* Storyboard_iPhone.storyboard */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.storyboard; path = Storyboard_iPhone.storyboard; sourceTree = "<group>"; };
 		526850A616AEE4E1001F65A6 /* UOAppDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = UOAppDelegate.h; sourceTree = "<group>"; };
@@ -615,6 +617,7 @@
 				9132827D144E07EA00395F40 /* libTestFlight.a in Frameworks */,
 				5268509716AE5267001F65A6 /* libRestKit.a in Frameworks */,
 				52E7F4A316AF1522003A46DA /* UbuntuOneAuthKit.a in Frameworks */,
+				5257416D16C5653100530CCC /* Crashlytics.framework in Frameworks */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -664,6 +667,7 @@
 		29B97323FDCFA39411CA2CEA /* Frameworks */ = {
 			isa = PBXGroup;
 			children = (
+				5257416C16C5653100530CCC /* Crashlytics.framework */,
 				5268510716AEFD20001F65A6 /* MobileCoreServices.framework */,
 				1DF5F4DF0D08C38300B7A737 /* UIKit.framework */,
 				1D30AB110D05D00D00671497 /* Foundation.framework */,
@@ -1281,6 +1285,7 @@
 				913A54A81450C1310081FD67 /* Run Script */,
 				1D60588D0D05DD3D006BFB54 /* Resources */,
 				5297671616B70D6A00A40EDB /* ShellScript */,
+				5257416616C5650900530CCC /* ShellScript */,
 			);
 			buildRules = (
 			);
@@ -1466,6 +1471,19 @@
 /* End PBXResourcesBuildPhase section */
 
 /* Begin PBXShellScriptBuildPhase section */
+		5257416616C5650900530CCC /* ShellScript */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "./Crashlytics.framework/run 0606692bafe724ed1413548f6211a8557140eade";
+		};
 		5297671616B70D6A00A40EDB /* ShellScript */ = {
 			isa = PBXShellScriptBuildPhase;
 			buildActionMask = 2147483647;
@@ -1615,6 +1633,10 @@
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
 				COPY_PHASE_STRIP = NO;
 				CURRENT_PROJECT_VERSION = 6;
+				FRAMEWORK_SEARCH_PATHS = (
+					"$(inherited)",
+					"\"$(SRCROOT)\"",
+				);
 				GCC_DYNAMIC_NO_PIC = NO;
 				GCC_OPTIMIZATION_LEVEL = 0;
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
@@ -1653,6 +1675,10 @@
 				"CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Distribution";
 				COPY_PHASE_STRIP = NO;
 				CURRENT_PROJECT_VERSION = 6;
+				FRAMEWORK_SEARCH_PATHS = (
+					"$(inherited)",
+					"\"$(SRCROOT)\"",
+				);
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = U1Music_Prefix.pch;
 				GCC_THUMB_SUPPORT = NO;