diff --git a/MasterPassword-iOS.xcodeproj/project.pbxproj b/MasterPassword-iOS.xcodeproj/project.pbxproj index c6c3bc7d..2567a0dd 100644 --- a/MasterPassword-iOS.xcodeproj/project.pbxproj +++ b/MasterPassword-iOS.xcodeproj/project.pbxproj @@ -91,6 +91,8 @@ DA4DA1D91564471A00F6F596 /* libjrswizzle.a in Frameworks */ = {isa = PBXBuildFile; fileRef = DAC6326C148680650075AEA5 /* libjrswizzle.a */; }; DA4DA1DA1564471F00F6F596 /* libuicolor-utilities.a in Frameworks */ = {isa = PBXBuildFile; fileRef = DAC6325D1486805C0075AEA5 /* libuicolor-utilities.a */; }; DA4DA1DB1564475E00F6F596 /* libscryptenc-ios.a in Frameworks */ = {isa = PBXBuildFile; fileRef = DA79A9BB1557DB6F00BAA07A /* libscryptenc-ios.a */; }; + DA4ECA2B160D94A80012ABB9 /* libTestFlight.a in Frameworks */ = {isa = PBXBuildFile; fileRef = DA4ECA26160D94A80012ABB9 /* libTestFlight.a */; }; + DA4ECA2E160D94A80012ABB9 /* TestFlight.plist in Resources */ = {isa = PBXBuildFile; fileRef = DA4ECA2A160D94A80012ABB9 /* TestFlight.plist */; }; DA55873F15E81D9E00860B4F /* iTunesArtwork-Rounded-73.png in Resources */ = {isa = PBXBuildFile; fileRef = DA55873E15E81D9E00860B4F /* iTunesArtwork-Rounded-73.png */; }; DA55878015E82C0300860B4F /* FacebookSDK.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = DA55877F15E82C0300860B4F /* FacebookSDK.framework */; }; DA55878215E82C2B00860B4F /* FacebookSDKResources.bundle in Resources */ = {isa = PBXBuildFile; fileRef = DA55878115E82C2B00860B4F /* FacebookSDKResources.bundle */; }; @@ -779,10 +781,8 @@ DACABB8D1572A4A5008BA211 /* tip_basic_black_top_right@2x.png in Resources */ = {isa = PBXBuildFile; fileRef = DACABB8B1572A4A4008BA211 /* tip_basic_black_top_right@2x.png */; }; DACABB901572B76A008BA211 /* tip_basic_black_top.png in Resources */ = {isa = PBXBuildFile; fileRef = DACABB8E1572B769008BA211 /* tip_basic_black_top.png */; }; DACABB911572B76A008BA211 /* tip_basic_black_top@2x.png in Resources */ = {isa = PBXBuildFile; fileRef = DACABB8F1572B769008BA211 /* tip_basic_black_top@2x.png */; }; - DAD18EF4160A760600D15088 /* libTestFlight.a in Frameworks */ = {isa = PBXBuildFile; fileRef = DAD3126215528C9C00A3F9ED /* libTestFlight.a */; }; DAD3126715528C9C00A3F9ED /* Crashlytics.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = DAD3125F15528C9C00A3F9ED /* Crashlytics.framework */; }; DAD3126815528C9C00A3F9ED /* Crashlytics.plist in Resources */ = {isa = PBXBuildFile; fileRef = DAD3126015528C9C00A3F9ED /* Crashlytics.plist */; }; - DAD3126C15528C9C00A3F9ED /* TestFlight.plist in Resources */ = {isa = PBXBuildFile; fileRef = DAD3126615528C9C00A3F9ED /* TestFlight.plist */; }; DAD3127215528CD200A3F9ED /* Foundation.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = DA5BFA4A147E415C00F98B1E /* Foundation.framework */; }; DAD3129015528D1600A3F9ED /* Localytics.plist in Resources */ = {isa = PBXBuildFile; fileRef = DAD3127D15528D0F00A3F9ED /* Localytics.plist */; }; DAD312BB1552977200A3F9ED /* UIColor+Expanded.h in Headers */ = {isa = PBXBuildFile; fileRef = DAD312B71552977200A3F9ED /* UIColor+Expanded.h */; }; @@ -1110,6 +1110,11 @@ DA497BEA15E8C94300B52167 /* GTMOAuth2ViewTouch.xib */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.xib; path = GTMOAuth2ViewTouch.xib; sourceTree = ""; }; DA497BEB15E8C94300B52167 /* GTMObjC2Runtime.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = GTMObjC2Runtime.h; sourceTree = ""; }; DA497BEC15E8C94300B52167 /* GTMObjC2Runtime.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GTMObjC2Runtime.m; sourceTree = ""; }; + DA4ECA26160D94A80012ABB9 /* libTestFlight.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; path = libTestFlight.a; sourceTree = ""; }; + DA4ECA27160D94A80012ABB9 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = README.md; sourceTree = ""; }; + DA4ECA28160D94A80012ABB9 /* release_notes.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = release_notes.md; sourceTree = ""; }; + DA4ECA29160D94A80012ABB9 /* TestFlight.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = TestFlight.h; sourceTree = ""; }; + DA4ECA2A160D94A80012ABB9 /* TestFlight.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = TestFlight.plist; sourceTree = ""; }; DA55873E15E81D9E00860B4F /* iTunesArtwork-Rounded-73.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = "iTunesArtwork-Rounded-73.png"; sourceTree = ""; }; DA55877F15E82C0300860B4F /* FacebookSDK.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = FacebookSDK.framework; path = "External/facebook-ios-sdk/build/FacebookSDK.framework"; sourceTree = ""; }; DA55878115E82C2B00860B4F /* FacebookSDKResources.bundle */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.plug-in"; name = FacebookSDKResources.bundle; path = "External/facebook-ios-sdk/build/FacebookSDK.framework/Versions/A/Resources/FacebookSDKResources.bundle"; sourceTree = ""; }; @@ -1923,9 +1928,6 @@ DACABB8F1572B769008BA211 /* tip_basic_black_top@2x.png */ = {isa = PBXFileReference; lastKnownFileType = image.png; path = "tip_basic_black_top@2x.png"; sourceTree = ""; }; DAD3125F15528C9C00A3F9ED /* Crashlytics.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; path = Crashlytics.framework; sourceTree = ""; }; DAD3126015528C9C00A3F9ED /* Crashlytics.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Crashlytics.plist; sourceTree = ""; }; - DAD3126215528C9C00A3F9ED /* libTestFlight.a */ = {isa = PBXFileReference; lastKnownFileType = archive.ar; path = libTestFlight.a; sourceTree = ""; }; - DAD3126515528C9C00A3F9ED /* TestFlight.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = TestFlight.h; sourceTree = ""; }; - DAD3126615528C9C00A3F9ED /* TestFlight.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = TestFlight.plist; sourceTree = ""; }; DAD3127115528CD200A3F9ED /* libLocalytics.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libLocalytics.a; sourceTree = BUILT_PRODUCTS_DIR; }; DAD3127D15528D0F00A3F9ED /* Localytics.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Localytics.plist; sourceTree = ""; }; DAD312B71552977200A3F9ED /* UIColor+Expanded.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = "UIColor+Expanded.h"; path = "External/Pearl/External/uicolor-utilities/UIColor+Expanded.h"; sourceTree = SOURCE_ROOT; }; @@ -2110,7 +2112,7 @@ DAD3126715528C9C00A3F9ED /* Crashlytics.framework in Frameworks */, 93D399433EA75E50656040CB /* Twitter.framework in Frameworks */, DA55878015E82C0300860B4F /* FacebookSDK.framework in Frameworks */, - DAD18EF4160A760600D15088 /* libTestFlight.a in Frameworks */, + DA4ECA2B160D94A80012ABB9 /* libTestFlight.a in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -3473,9 +3475,11 @@ DAD3126115528C9C00A3F9ED /* TestFlight */ = { isa = PBXGroup; children = ( - DAD3126215528C9C00A3F9ED /* libTestFlight.a */, - DAD3126515528C9C00A3F9ED /* TestFlight.h */, - DAD3126615528C9C00A3F9ED /* TestFlight.plist */, + DA4ECA26160D94A80012ABB9 /* libTestFlight.a */, + DA4ECA27160D94A80012ABB9 /* README.md */, + DA4ECA28160D94A80012ABB9 /* release_notes.md */, + DA4ECA29160D94A80012ABB9 /* TestFlight.h */, + DA4ECA2A160D94A80012ABB9 /* TestFlight.plist */, ); path = TestFlight; sourceTree = ""; @@ -4602,7 +4606,6 @@ DAB8D93915036BF700CED3BC /* logo-bare.png in Resources */, DAFE4A5A1503982E003ABA7C /* Pearl.strings in Resources */, DAD3126815528C9C00A3F9ED /* Crashlytics.plist in Resources */, - DAD3126C15528C9C00A3F9ED /* TestFlight.plist in Resources */, DAD3129015528D1600A3F9ED /* Localytics.plist in Resources */, DA0A1D0515690A9A0092735D /* Default.png in Resources */, DA0A1D0615690A9A0092735D /* Default@2x.png in Resources */, @@ -4687,6 +4690,7 @@ DA6061D915F20C0900097266 /* page-gorillas@2x.png in Resources */, DA3EE946160145C700C68F6D /* Default-568h.png in Resources */, DA3EE947160145C700C68F6D /* Default-568h@2x.png in Resources */, + DA4ECA2E160D94A80012ABB9 /* TestFlight.plist in Resources */, ); runOnlyForDeploymentPostprocessing = 0; }; diff --git a/MasterPassword/iOS/MainStoryboard_iPhone.storyboard b/MasterPassword/iOS/MainStoryboard_iPhone.storyboard index dfc53104..6474e8c4 100644 --- a/MasterPassword/iOS/MainStoryboard_iPhone.storyboard +++ b/MasterPassword/iOS/MainStoryboard_iPhone.storyboard @@ -1,7 +1,6 @@ - @@ -2112,6 +2111,138 @@ You could use the word wall for inspiration in finding a memorable master passw + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/TestFlight/README.txt b/TestFlight/README.md similarity index 64% rename from TestFlight/README.txt rename to TestFlight/README.md index d16ba2f2..8ee31241 100644 --- a/TestFlight/README.txt +++ b/TestFlight/README.md @@ -1,24 +1,4 @@ -Thanks for downloading the TestFlight SDK 1.0! - -This document is also available on the web at https://www.testflightapp.com/sdk/doc - -1. Why use the TestFlight SDK? -2. Considerations -3. How do I integrate the SDK into my project? -4. Beta Testing and Release Differentiation -5. Using the Checkpoint API -6. Using the Feedback API -7. Upload your build -8. Questions API -9. View your results -10. Advanced Exception Handling -11. Remote Logging -12. iOS 3 - -START - - -1. Why use the TestFlight SDK? +##Introduction The TestFlight SDK allows you to track how beta testers are testing your application. Out of the box we track simple usage information, such as which tester is using your application, their device model/OS, how long they used the application, logs of their test session, and automatic recording of any crashes they encounter. @@ -30,34 +10,29 @@ Alongside the Checkpoint API is the Questions interface. The Questions interface For more detailed debugging we have a remote logging solution. Find out more about our logging system with TFLog in the Remote Logging section. -2. Considerations - +##Considerations + Information gathered by the SDK is sent to the website in real time. When an application is put into the background (iOS 4.x) or terminated (iOS 3.x) we try to send the finalizing information for the session during the time allowed for finalizing the application. Should all of the data not get sent the remaining data will be sent the next time the application is launched. As such, to get the most out of the SDK we recommend your application support iOS 4.0 and higher. This SDK can be run from both the iPhone Simulator and Device and has been tested using Xcode 4.0. -3. How do I integrate the SDK into my project? - - -1. Add the files to your project: File -> Add Files to "" + +##Integration +1. Add the files to your project: File -> Add Files to " " 1. Find and select the folder that contains the SDK 2. Make sure that "Copy items into destination folder (if needed)" is checked 3. Set Folders to "Create groups for any added folders" 4. Select all targets that you want to add the SDK to - -2. Verify that libTestFlight.a and has been added to the Link Binary With Libraries Build Phase for the targets you want to use the SDK with - +2. Verify that libTestFlight.a has been added to the Link Binary With Libraries Build Phase for the targets you want to use the SDK with 1. Select your Project in the Project Navigator 2. Select the target you want to enable the SDK for 3. Select the Build Phases tab 4. Open the Link Binary With Libraries Phase 5. If libTestFlight.a is not listed, drag and drop the library from your Project Navigator to the Link Binary With Libraries area 6. Repeat Steps 2 - 5 until all targets you want to use the SDK with have the SDK linked - 3. Add libz to your Link Binary With Libraries Build Phase - 1. Select your Project in the Project Navigator 2. Select the target you want to enable the SDK for 3. Select the Build Phases tab @@ -65,42 +40,42 @@ This SDK can be run from both the iPhone Simulator and Device and has been teste 5. Click the + to add a new library 6. Find libz.dylib in the list and add it 7. Repeat Steps 2 - 6 until all targets you want to use the SDK with have libz.dylib - + 4. In your Application Delegate: + 1. Import TestFlight: `#import "TestFlight.h"` + + ***NOTE:*** Rather than importing `TestFlight.h` in every file you may add the above line into you pre-compiled header (`_Prefix.pch`) file inside of the - 1. Import TestFlight: `#import "TestFlight.h"` - NOTE: If you do not want to import TestFlight.h in every file you may add the above line into you pre-compiled header (`_Prefix.pch`) file inside of the #ifdef __OBJC__ - section. - This will give you access to the SDK across all files. - - 2. Get your Team Token which you can find at [http://testflightapp.com/dashboard/team/](http://testflightapp.com/dashboard/team/) select the team you are using from the team selection drop down list on the top of the page and then select Team Info. + section. This will give you access to the SDK across all files. + + 2. Get your Team Token which you can find at [http://testflightapp.com/dashboard/team/](http://testflightapp.com/dashboard/team/) select the team you are using from the team selection drop down list on the top of the page and then select Team Info. + 3. Launch TestFlight with your Team Token -(BOOL)application:(UIApplication *)application - didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - // start of your application:didFinishLaunchingWithOptions - // ... - [TestFlight takeOff:@"Insert your Team Token here"]; - // The rest of your application:didFinishLaunchingWithOptions method - // ... + didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { + // start of your application:didFinishLaunchingWithOptions + // ... + [TestFlight takeOff:@"Insert your Team Token here"]; + // The rest of your application:didFinishLaunchingWithOptions method + // ... } 4. To report crashes to you we install our own uncaught exception handler. If you are not currently using an exception handler of your own then all you need to do is go to the next step. If you currently use an Exception Handler, or you use another framework that does please go to the section on advanced exception handling. - + 5. To enable the best crash reporting possible we recommend setting the following project build settings in Xcode to NO for all targets that you want to have live crash reporting for. You can find build settings by opening the Project Navigator (default command+1 or command+shift+j) then clicking on the project you are configuring (usually the first selection in the list). From there you can choose to either change the global project settings or settings on an individual project basis. All settings below are in the Deployment Section. - 1. Deployment Postrocessing + 1. Deployment Post Processing 2. Strip Debug Symbols During Copy 3. Strip Linked Product +##Beta Testing and Release Differentiation -4. Beta Testing and Release Differentiation - -In order to provide more information about your testers while beta testing you will need to provide the device's unique identifier. This identifier is not something that the SDK will collect from the device and we do not recommend using this in production. Here is the recommended code for providing the device unique identifier. +In order to provide more information about your testers while beta testing you will need to provide the device's unique identifier. This identifier is not something that the SDK will collect from the device and we do not recommend using this in production. To send the device identifier to us put the following code before your call to takeOff. #define TESTING 1 #ifdef TESTING @@ -109,94 +84,95 @@ In order to provide more information about your testers while beta testing you w This will allow you to have the best possible information during testing, but disable getting and sending of the device unique identifier when you release your application. When it is time to release simply comment out #define TESTING 1. If you decide to not include the device's unique identifier during your testing phase TestFlight will still collect all of the information that you send but it may be anonymized. -5. Use the Checkpoint API to create important checkpoints throughout your application. + +##Checkpoint API -When a tester does something you care about in your app you can pass a checkpoint. For example completing a level, adding a todo item, etc. The checkpoint progress is used to provide insight into how your testers are testing your apps. The passed checkpoints are also attached to crashes, which can help when creating steps to replicate. +When a tester does something you care about in your app you can pass a checkpoint. For example completing a level, adding a todo item, etc. The checkpoint progress is used to provide insight into how your testers are testing your apps. The passed checkpoints are also attached to crashes, which can help when creating steps to replicate. -`[TestFlight passCheckpoint:@"CHECKPOINT_NAME"];` -Use `+passCheckpoint:` to track when a user performs certain tasks in your application. This can be useful for making sure testers are hitting all parts of your application, as well as tracking which testers are being thorough. +`[TestFlight passCheckpoint:@"CHECKPOINT_NAME"];` Use `passCheckpoint:` to track when a user performs certain tasks in your application. This can be useful for making sure testers are hitting all parts of your application, as well as tracking which testers are being thorough. -6. Using the Feedback API - -To launch unguided feedback call the `openFeedbackView` method. We recommend that you call this from a GUI element. +##Feedback API + +To launch unguided feedback call the openFeedbackView method. We recommend that you call this from a GUI element. -(IBAction)launchFeedback { [TestFlight openFeedbackView]; } -If you want to create your own feedback form you can use the `submitCustomFeedback` method to submit the feedback that the user has entered. +If you want to create your own feedback form you can use the submitCustomFeedback method to submit the feedback that the user has entered. -(IBAction)submitFeedbackPressed:(id)sender { NSString *feedback = [self getUserFeedback]; - [TestFlight submitCustomFeedback:feedback]; + [TestFlight submitFeedback:feedback]; } The above sample assumes that [self getUserFeedback] is implemented such that it obtains the users feedback from the GUI element you have created and that submitFeedbackPressed is the action for your submit button. Once users have submitted feedback from inside of the application you can view it in the feedback area of your build page. -7. Upload your build. -After you have integrated the SDK into your application you need to upload your build to TestFlight. You can upload from your dashboard or or using the Upload API, full documentation at +##Upload your build + +After you have integrated the SDK into your application you need to upload your build to TestFlight. You can upload from your dashboard or or using the Upload API, full documentation at [https://testflightapp.com/api/doc/](https://testflightapp.com/api/doc/) -8. Add Questions to Checkpoints +##Questions Interface In order to ask a question, you'll need to associate it with a checkpoint. Make sure your checkpoints are initialized by running your app and hitting them all yourself before you start adding questions. There are three question types available: Yes/No, Multiple Choice, and Long Answer. -To create questions, visit your builds Questions page and click on 'Add Question'. If you choose Multiple Choice, you'll need to enter a list of possible answers for your testers to choose from — otherwise, you'll only need to enter your question's, well, question. If your build has no questions, you can also choose to migrate questions from another build (because seriously — who wants to do all that typing again)? +To create questions, visit your builds Questions page and click on 'Add Question'. If you choose Multiple Choice, you'll need to enter a list of possible answers for your testers to choose from — otherwise, you'll only need to enter your question's, well, question. If your build has no questions, you can also choose to migrate questions from another build (because seriously — who wants to do all that typing again)? After restarting your application on an approved device, when you pass the checkpoint associated with your questions a TestFlight modal question form will appear on the screen asking the beta tester to answer your question. After you upload a new build to TestFlight you will need to associate questions once again. However if your checkpoints and questions have remained the same you can choose "copy questions from an older build" and choose which build to copy the questions from. -9. View your results. - +##View the results + As testers install your build and start to test it you will see their session data on the web on the build report page for the build you've uploaded. -10. Advanced Exception Handling +##Advanced Exception Handling An uncaught exception means that your application is in an unknown state and there is not much that you can do but try and exit gracefully. Our SDK does its best to get the data we collect in this situation to you while it is crashing, but it is designed in such a way that the important act of saving the data occurs in as safe way a way as possible before trying to send anything. If you do use uncaught exception or signal handlers install your handlers before calling `takeOff`. Our SDK will then call your handler while ours is running. For example: - /* - My Apps Custom uncaught exception catcher, we do special stuff here, and TestFlight takes care of the rest - **/ - void HandleExceptions(NSException *exception) { - NSLog(@"This is where we save the application data during a exception"); - // Save application data on crash - } - /* - My Apps Custom signal catcher, we do special stuff here, and TestFlight takes care of the rest - **/ - void SignalHandler(int sig) { - NSLog(@"This is where we save the application data during a signal"); - // Save application data on crash - } + /* + My Apps Custom uncaught exception catcher, we do special stuff here, and TestFlight takes care of the rest + */ + void HandleExceptions(NSException *exception) { + NSLog(@"This is where we save the application data during a exception"); + // Save application data on crash + } + /* + My Apps Custom signal catcher, we do special stuff here, and TestFlight takes care of the rest + */ + void SignalHandler(int sig) { + NSLog(@"This is where we save the application data during a signal"); + // Save application data on crash + } - -(BOOL)application:(UIApplication *)application - didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { - // installs HandleExceptions as the Uncaught Exception Handler - NSSetUncaughtExceptionHandler(&HandleExceptions); - // create the signal action structure - struct sigaction newSignalAction; - // initialize the signal action structure - memset(&newSignalAction, 0, sizeof(newSignalAction)); - // set SignalHandler as the handler in the signal action structure - newSignalAction.sa_handler = &SignalHandler; - // set SignalHandler as the handlers for SIGABRT, SIGILL and SIGBUS - sigaction(SIGABRT, &newSignalAction, NULL); - sigaction(SIGILL, &newSignalAction, NULL); - sigaction(SIGBUS, &newSignalAction, NULL); - // Call takeOff after install your own unhandled exception and signal handlers - [TestFlight takeOff:@"Insert your Team Token here"]; - // continue with your application initialization - } + -(BOOL)application:(UIApplication *)application + didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { + // installs HandleExceptions as the Uncaught Exception Handler + NSSetUncaughtExceptionHandler(&HandleExceptions); + // create the signal action structure + struct sigaction newSignalAction; + // initialize the signal action structure + memset(&newSignalAction, 0, sizeof(newSignalAction)); + // set SignalHandler as the handler in the signal action structure + newSignalAction.sa_handler = &SignalHandler; + // set SignalHandler as the handlers for SIGABRT, SIGILL and SIGBUS + sigaction(SIGABRT, &newSignalAction, NULL); + sigaction(SIGILL, &newSignalAction, NULL); + sigaction(SIGBUS, &newSignalAction, NULL); + // Call takeOff after install your own unhandled exception and signal handlers + [TestFlight takeOff:@"Insert your Team Token here"]; + // continue with your application initialization + } You do not need to add the above code if your application does not use exception handling already. -11. Remote Logging - +##Remote Logging + To perform remote logging you can use the TFLog method which logs in a few different methods described below. In order to make the transition from NSLog to TFLog easy we have used the same method signature for TFLog as NSLog. You can easily switch over to TFLog by adding the following macro to your header #define NSLog TFLog @@ -227,22 +203,23 @@ The STDERR logger sends log messages to STDERR so that you can see your log stat The default option is YES. -12. iOS3 +## Advanced Remote Logging -We now require that anyone who is writing an application that supports iOS3 add the System.framework as an optional link. In order to provide a better shutdown experience we send any large log files to our servers in the background. To add System.framework as an optional link: - 1. Select your Project in the Project Navigator - 2. Select the target you want to enable the SDK for - 3. Select the Build Phases tab - 4. Open the Link Binary With Libraries Phase - 5. Click the + to add a new library - 6. Find libSystem.dylib in the list and add it - 7. To the right of libSystem.dylib in the Link Binary With Libraries pane change "Required" to "Optional" +For most users we expect using TFLog to provide all of the logging functionality that they need. For the occasion where you need to provide a wrapper around TFLog we provide -END + void TFLogv(NSString *format, va_list arg_list); -Please contact us if you have any questions. +Using TFLogv you can have your method that accepts a variable number of arguments that then passes that format and argument list to TFLog. -The TestFlight Team -w. http://www.testflightapp.com -e. beta@testflightapp.com +##iOS3 + +We now require that anyone who is writing an application that supports iOS3 add the System.framework as an optional link. In order to provide a better shutdown experience we send any large log files to our servers in the background. To add System.framework as an optional link: + +1. Select your Project in the Project Navigator +2. Select the target you want to enable the SDK for +3. Select the Build Phases tab +4. Open the Link Binary With Libraries Phase +5. Click the + to add a new library +6. Find libSystem.dylib in the list and add it +7. To the right of libSystem.dylib in the Link Binary With Libraries pane change "Required" to "Optional" diff --git a/TestFlight/TestFlight.h b/TestFlight/TestFlight.h index 2a4c9f4f..6b23af51 100644 --- a/TestFlight/TestFlight.h +++ b/TestFlight/TestFlight.h @@ -6,13 +6,14 @@ // Copyright 2011 TestFlight. All rights reserved. #import -#define TESTFLIGHT_SDK_VERSION @"1.0" +#define TESTFLIGHT_SDK_VERSION @"1.1" #undef TFLog #if __cplusplus extern "C" { #endif - void TFLog(NSString *format, ...); + void TFLog(NSString *format, ...); + void TFLogv(NSString *format, va_list arg_list); #if __cplusplus } #endif @@ -55,6 +56,10 @@ extern "C" { * NO - sends log statements to TestFlight log only * sendLogOnlyOnCrash [ NSNumber numberWithBool:YES ] NO - default, sends logs to TestFlight at the end of every session * YES - sends logs statements to TestFlight only if there was a crash + * attachBacktraceToFeedback [ NSNumber numberWithBool:YES ] NO - default, feedback is sent exactly as the user enters it + * YES - attaches the current backtrace, with symbols, to the feedback. + * disableInAppUpdates [ NSNumber numberWithBool:YES ] NO - default, in application updates are allowed + * YES - the in application update screen will not be displayed */ + (void)setOptions:(NSDictionary*)options; @@ -89,7 +94,7 @@ extern "C" { * [TestFlight setDeviceIdentifier:[[UIDevice currentDevice] uniqueIdentifier]]; * #endif * - * @param deviceIdentifier The current devices device identifier + * @param deviceIdentifer The current devices device identifier */ + (void)setDeviceIdentifier:(NSString*)deviceIdentifer; diff --git a/TestFlight/libTestFlight.a b/TestFlight/libTestFlight.a index 19a65af8..d1dc007b 100644 Binary files a/TestFlight/libTestFlight.a and b/TestFlight/libTestFlight.a differ diff --git a/TestFlight/release_notes.md b/TestFlight/release_notes.md new file mode 100644 index 00000000..56914d95 --- /dev/null +++ b/TestFlight/release_notes.md @@ -0,0 +1,199 @@ +##1.1 - September 13, 2012 + +* armv7s and iOS 6 support +* Updated for general release + +##1.1 BETA 3 - September 12, 2012 + +* armv7s slice added to library +* fixed typo for in application updates, inAppUdates changed to inAppUpdates + +##1.1 BETA 2 - September 6, 2012 + +* Re-enabled armv6 support +* Added option to disable in application updates + +##1.1 BETA 1 - July 13, 2012 + +* Added TFLogv to allow for log customizations. Check the README or online docs for more information. +* Added option attachBacktraceToFeedback, which attaches a backtrace to feedback sent from the SDK. For users who use feedback in more than one location in the application. +* Resolved issue where other exception handlers would not be called during an exception. +* SDK now sends the device language for a session. +* Documentation fixes. +* Stability fixes. + +###1.0 - March 29, 2012 + +* Resolved occurrences of exceptions with the message "No background task exists with identifier 0" + +###1.0 BETA 1 - March 23, 2012 + +* Privacy Updates +* UDID is no longer collected by the SDK. During testing please use `[TestFlight setDeviceIdentifier:[[UIDevice currentDevice] uniqueIdentifier]];` to send the UDID so you can identify your testers. For release do not set `+setDeviceIdentifier`. See Beta Testing and Release Differentiation in the README or online at [https://testflightapp.com/sdk/doc/1.0beta1/](http://testflightapp.com/sdk/doc/1.0beta1/) + +###0.8.3 - February 14, 2012 + +* Rolled previous beta code into release builds +* No longer allow in application updates to occur in applications that were obtained from the app store. + +**Tested compiled library with:** + +* Xcode 4.3 +* Xcode 4.2 +* Xcode 4.1 +* Xcode 3.2.6 + +###0.8.3 BETA 5 - February 10, 2012 + +* Changed logging from asynchronous to synchronous. +* Resolved crash when looking for a log path failed. +* Added submitFeedback to the TestFlight class to allow for custom feedback forms. + +###0.8.3 BETA 4 - January 20, 2012 + +* Resolved an issue that occured when an application was upgraded from 0.8.3 BETA 1 to 0.8.3 BETA 3+ with unsent data from 0.8.3 BETA 1 + +###0.8.3 BETA 3 - January 19, 2012 + +* On crash log files over 64k will not be sent until next launch. + +**Known Issues:** + +* Logging massive amounts of data at the end of a session may prevent the application from launching in time on next launch + +###0.8.3 BETA 2 - January 13, 2012 + +* libz.dylib is now required to be added to your "Link Binary with Libraries" build phase +* Log file compression, The compression is done on an as needed basis rather than before sending +* Changed all outgoing data from JSON to MessagePack +* Added option `logToSTDERR` to disable the `STDERR` logger + +###0.8.3 BETA 1 - December 29, 2011 + +* In rare occurrences old session data that had not been sent to our server may have been discarded or attached to the wrong build. It is now no longer discarded +* Made sending of Session End events more robust +* Network queuing system does better bursting of unsent data +* Log files that are larger than 64K are now sent sometime after the next launch +* Log files that are larger than 16MB are no longer supported and will be replaced with a message indicating the log file was too large +* Fixed crashes while resuming from background + +###0.8.2 - December 20, 2011 + +* Promoted 0.8.2 BETA 4 to stable + +**Known Issues:** + +* Under some circumstances Session End events may not be sent until the next launch. +* With large log files Session End events may take a long time to show up. + +**Tested compiled library with:** + +* Xcode 4.3 +* Xcode 4.2 +* Xcode 4.1 +* Xcode 3.2.6 + +###0.8.2 BETA 4 - December 12, 2011 + +* Prevented "The string argument is NULL" from occuring during finishedHandshake in rare cases +* Resolved issue where data recorded while offline may not be sent + +###0.8.2 BETA 3 - December 8, 2011 + +* Added auto-release pools to background setup and tear down + +###0.8.2 BETA 2 - December 5, 2011 + +* Fixed the "pointer being freed was not allocated" bug + +###0.8.1 - November 18, 2011 + +* Implemented TFLog logging system, see README for more information +* Fixed an issue where Session End events may not be sent until next launch +* Fixed an issue where duplicate events could be sent +* Fixed an issue with Session End events not being sent from some iPod touch models + +**Tested compiled library with:** + +* Xcode 4.2 +* Xcode 4.1 +* Xcode 3.2.6 + +###0.8 - November 8, 2011 + +* Added `SIGTRAP` as a signal type that we catch +* Removed all Objective-c from crash reporting +* Removed the use of non signal safe functions from signal handling +* Created a signal safe way to get symbols from a stack trace +* Changed the keyboardType for Long Answer Questions and Feedback to allow for international character input +* Changed `TESTFLIGHT_SDK_VERSION` string to be an `NSString` +* Changed cache folder from Library/Caches/TestFlight to Library/Caches/com.testflight.testflightsdk +* Fixed issue with saving data when device is offline +* Fixed compability issues with iOS 3 +* Added calling into the rootViewController shouldAutorotateToInterfaceOrientation if a rootViewController is set +* Made the comments in TestFlight.h compatible with Appledoc + +Tested compiled library with: + +* Xcode 4.2 +* Xcode 4.1 +* Xcode 3.2 + +###0.7.2 - September 29, 2011 + +* Changed `TESTFLIGHT_SDK_VERSION` string to be an `NSString` +* Fixed an issue where exiting an application while the SDK is active caused modal views to be dismissed + +###0.7.1 - September 22, 2011 + +* Internal release +* Refactoring + +###0.7 - September 21, 2011 + +* Moved TestFlight images and data to the Library/Caches folder +* Resolved an issue where sometimes the rootViewController could not be found and feedback, questions and upgrade views would not be displayed +* In application upgrade changed to allow skipping until the next version is installed and allows upgrades to be forced +* Fixed a memory leak when launching questions + +###0.6 - September 2, 2011 + +* Renamed base64_encode to testflight_base64_encode to remove a conflict with other third party libraries +* Added ability to reinstall crash handlers when they are overwritten using the setOptions API +* Fixed an issue where crash reports might not get sent under certain circumstances +* Fixed a deadlock when the application is put in the background and then resumed before all information can be sent +* Fixed an issue when attempting to un-install all signal handlers during a signal +* Added support for landscape mode on the iPad to the Questions and Feedback views +* Crash reporting now works in versions of Xcode earlier than 4.2 +* Fixed a memory leak during handshake + +###0.5 - August 19, 2011 + +* Feedback that is not attached to a checkpoint [TestFlight openFeedbackView] +* Usability changes to question views +* Removed pause and resume sessions, replaced with sessions being stopped and started +* Added text auto correction to the Long Answer question type +* Crash reports now send on crash instead of next launch + +###0.4 - August 15, 2011 + +* In Application Feedback with Questions +* In application updates +* Custom Environment Information added +* Networking stack reimplementation +* Exception handling fixes + +###0.3 - June 15, 2011 + +* Removed all mention of JSONKit from the README +* Added support for using both the Bundle Version and the Bundle Short Version string + +###0.2 - June 14, 2011 + +* Removed all categories this allows users to use the SDK without having to set -ObjC and -load_all +* Prefixed JSONKit for use in TestFlight to remove reported issues where some users were already using JSONKit +* Added support for armv6 again + +###0.1 - June 11, 2011 + +* Initial Version diff --git a/TestFlight/release_notes.txt b/TestFlight/release_notes.txt deleted file mode 100644 index 64ac4e36..00000000 --- a/TestFlight/release_notes.txt +++ /dev/null @@ -1,138 +0,0 @@ -1.0 - March 29, 2012 -Resolved occurrences of exceptions with the message "No background task exists with identifier 0" - -1.0 BETA 1 - March 23, 2012 -Privacy Updates - UDID is no longer collected by the SDK. During testing please use [TestFlight setDeviceIdentifier:[[UIDevice currentDevice] uniqueIdentifier]]; to send the UDID so you can identify your testers. For release do not set +setDeviceIdentifier. See Beta Testing and Release Differentiation in the README or online at https://testflightapp.com/sdk/doc/1.0beta1/ - -0.8.3 - February 14, 2012 -Rolled previous beta code into release builds -No longer allow in application updates to occur in applications that were obtained from the app store. - -Tested compiled library with: -Xcode 4.3 -Xcode 4.2 -Xcode 4.1 -Xcode 3.2.6 - -0.8.3 BETA 5 - February 10, 2012 -Changed logging from asynchronous to synchronous. -Resolved crash when looking for a log path failed. -Added submitFeedback to the TestFlight class to allow for custom feedback forms. - -0.8.3 BETA 4 - January 20, 2012 -Resolved an issue that occured when an application was upgraded from 0.8.3 BETA 1 to 0.8.3 BETA 3+ with unsent data from 0.8.3 BETA 1 - -0.8.3 BETA 3 - January 19, 2012 -On crash log files over 64k will not be sent until next launch. - -Known Issues: -Logging massive amounts of data at the end of a session may prevent the application from launching in time on next launch - -0.8.3 BETA 2 - January 13, 2012 -libz.dylib is now required to be added to your "Link Binary with Libraries" build phase -Log file compression, The compression is done on an as needed basis rather than before sending -Changed all outgoing data from JSON to MessagePack -Added option logToSTDERR to disable the STDERR logger - -0.8.3 BETA 1 - December 29, 2011 -In rare occurrences old session data that had not been sent to our server may have been discarded or attached to the wrong build. It is now no longer discarded -Made sending of Session End events more robust -Network queuing system does better bursting of unsent data -Log files that are larger than 64K are now sent sometime after the next launch -Log files that are larger than 16MB are no longer supported and will be replaced with a message indicating the log file was too large -Fixed crashes while resuming from background - -0.8.2 - December 20, 2011 -Promoted 0.8.2 BETA 4 to stable - -Known Issues: -Under some circumstances Session End events may not be sent until the next launch. -With large log files Session End events may take a long time to show up. - -Tested compiled library with: -Xcode 4.3 -Xcode 4.2 -Xcode 4.1 -Xcode 3.2.6 - -0.8.2 BETA 4 - December 12, 2011 -Prevented "The string argument is NULL" from occuring during finishedHandshake in rare cases -Resolved issue where data recorded while offline may not be sent - -0.8.2 BETA 3 - December 8, 2011 -Added auto-release pools to background setup and tear down - -0.8.2 BETA 2 - December 5, 2011 -Fixed the "pointer being freed was not allocated" bug - -0.8.1 - November 18, 2011 -Implemented TFLog logging system, see README for more information -Fixed an issue where Session End events may not be sent until next launch -Fixed an issue where duplicate events could be sent -Fixed an issue with Session End events not being sent from some iPod touch models - -Tested compiled library with: -Xcode 4.2 -Xcode 4.1 -Xcode 3.2.6 - -0.8 - November 8, 2011 -Added SIGTRAP as a signal type that we catch -Removed all Objective-c from crash reporting -Removed the use of non signal safe functions from signal handling -Created a signal safe way to get symbols from a stack trace -Changed the keyboardType for Long Answer Questions and Feedback to allow for international character input -Changed TESTFLIGHT_SDK_VERSION string to be an NSString -Changed cache folder from Library/Caches/TestFlight to Library/Caches/com.testflight.testflightsdk -Fixed issue with saving data when device is offline -Fixed compability issues with iOS 3 -Added calling into the rootViewController shouldAutorotateToInterfaceOrientation if a rootViewController is set -Made the comments in TestFlight.h compatible with Appledoc - -Tested compiled library with: -Xcode 4.2 -Xcode 4.1 -Xcode 3.2 - -0.7.2 - September 29, 2011 -Changed TESTFLIGHT_SDK_VERSION string to be an NSString -Fixed an issue where exiting an application while the SDK is active caused modal views to be dismissed -0.7.1 - September 22, 2011 -Internal release -Refactoring -0.7 - September 21, 2011 -Moved TestFlight images and data to the Library/Caches folder -Resolved an issue where sometimes the rootViewController could not be found and feedback, questions and upgrade views would not be displayed -In application upgrade changed to allow skipping until the next version is installed and allows upgrades to be forced -Fixed a memory leak when launching questions -0.6 - September 2, 2011 -Renamed base64_encode to testflight_base64_encode to remove a conflict with other third party libraries -Added ability to reinstall crash handlers when they are overwritten using the setOptions API -Fixed an issue where crash reports might not get sent under certain circumstances -Fixed a deadlock when the application is put in the background and then resumed before all information can be sent -Fixed an issue when attempting to un-install all signal handlers during a signal -Added support for landscape mode on the iPad to the Questions and Feedback views -Crash reporting now works in versions of Xcode earlier than 4.2 -Fixed a memory leak during handshake -0.5 - August 19, 2011 -Feedback that is not attached to a checkpoint [TestFlight openFeedbackView] -Usability changes to question views -Removed pause and resume sessions, replaced with sessions being stopped and started -Added text auto correction to the Long Answer question type -Crash reports now send on crash instead of next launch -0.4 - August 15, 2011 -In Application Feedback with Questions -In application updates -Custom Environment Information added -Networking stack reimplementation -Exception handling fixes -0.3 - June 15, 2011 -Removed all mention of JSONKit from the README -Added support for using both the Bundle Version and the Bundle Short Version string -0.2 - June 14, 2011 -Removed all categories this allows users to use the SDK without having to set -ObjC and -load_all -Prefixed JSONKit for use in TestFlight to remove reported issues where some users were already using JSONKit -Added support for armv6 again -0.1 - June 11, 2011 -Initial Version \ No newline at end of file