Permalink
Browse files

updated changelog and installation partial

  • Loading branch information...
1 parent 9c725d6 commit 57fa4734baabf83e0b8af15378273f89e1fd71a7 @calebd calebd committed Jun 6, 2011
View
@@ -4,4 +4,6 @@
- improved error handling to makre sure corrupt notices don't cause issues
- use regex for callstack parsing
- added Traditional Chinese localization
-- environment info is now posted in signal notices
+- environment info is now posted in signal notices
+- fixed bug where some delegate methods weren't called on the main thread
+- added app version to notice payload for filtering
@@ -105,7 +105,7 @@
3BA58924137C871300D9C544 /* HTNotifierDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = HTNotifierDelegate.h; sourceTree = "<group>"; };
3BA58927137C871300D9C544 /* ro */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = ro; path = ro.lproj/HTNotifier.strings; sourceTree = "<group>"; };
3BA58928137C871300D9C544 /* ru */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.strings; name = ru; path = ru.lproj/HTNotifier.strings; sourceTree = "<group>"; };
- 3BA58935137C87C000D9C544 /* INSTALLATION.html */ = {isa = PBXFileReference; lastKnownFileType = text.html; path = INSTALLATION.html; sourceTree = "<group>"; };
+ 3BA58935137C87C000D9C544 /* INSTALLATION.html */ = {isa = PBXFileReference; lastKnownFileType = text.html; path = INSTALLATION.html; sourceTree = "<group>"; wrapsLines = 1; };
3BA58936137C87C000D9C544 /* README.markdown */ = {isa = PBXFileReference; lastKnownFileType = text; path = README.markdown; sourceTree = "<group>"; wrapsLines = 1; };
3BFC84DB139C5F54000D2BB2 /* CHANGELOG.markdown */ = {isa = PBXFileReference; lastKnownFileType = text; path = CHANGELOG.markdown; sourceTree = "<group>"; };
/* End PBXFileReference section */
View
@@ -21,19 +21,15 @@
<h3>Running the notifier</h3>
<p>Import the notifier header file</p>
- <p><pre>#import "HTNotifier.h"</pre></p>
+ <pre>#import "HTNotifier.h"</pre>
<p>Call the main notifier method at the very beginning of your <code>application:didFinishLaunchingWithOptions:</code></p>
- <p><pre>
+ <pre>
[HTNotifier startNotifierWithAPIKey:(API KEY)
environmentName:HTNotifierDevelopmentEnvironment];
- </pre></p>
+ </pre>
<h3>Testing</h3>
- <p>
- To test that the notifier is working inside your application, a simple test method is provided. This method creates a notice with all of the parameters filled out as if a method, <code>crash</code>, was called on the shared <code>HTNotifier</code> object. That notice will be picked up by the notifier and reported just like an actual crash. Add this code to your <code>application:didFinishLaunchingWithOptions:</code> to test the notifier:
- </p>
- <p><pre>
-[[HTNotifier sharedNotifier] writeTestNotice];
- </pre></p>
+ <p>To test that the notifier is working inside your application, a simple test method is provided. This method raises an exception, catches it, and reports it as if a real crash happened. Add this code to your `application:didFinishLaunchingWithOptions:` to test the notifier:</p>
+ <pre>[[HTNotifier sharedNotifier] writeTestNotice];</pre>
</div>
@@ -1,10 +1,26 @@
-//
-// HTHandler.h
-// CrashPhone
-//
-// Created by Caleb Davenport on 12/15/10.
-// Copyright 2010 GUI Cocoa, LLC. All rights reserved.
-//
+/*
+
+ Copyright (C) 2011 GUI Cocoa, LLC.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+
+ */
#import <Foundation/Foundation.h>
@@ -44,13 +60,16 @@ NSArray *HTParseCallstack(NSArray *);
NSString *HTActionFromParsedCallstack(NSArray *);
/*
+
returns a string with all of the hoptoad variables
replaced by their appropriate values
+
*/
NSString * HTStringByReplacingHoptoadVariablesInString(NSString *);
#if TARGET_OS_IPHONE
/*
+
return the class name of the on screen view controller.
this does not indicate the controller where the crash
@@ -62,10 +81,12 @@ NSString * HTStringByReplacingHoptoadVariablesInString(NSString *);
if not, the rootViewController of the key window will be
inspected (if it exists)
+
*/
NSString * HTCurrentViewController();
/*
+
return the name of the visible view controller given a
starting view controller.
@@ -76,6 +97,7 @@ NSString * HTCurrentViewController();
this method is recursive and is called by
+ currentViewController
+
*/
NSString * HTVisibleViewControllerWithViewController(UIViewController *);
#endif
@@ -1,10 +1,26 @@
-//
-// HTHandler.m
-// CrashPhone
-//
-// Created by Caleb Davenport on 12/15/10.
-// Copyright 2010 GUI Cocoa, LLC. All rights reserved.
-//
+/*
+
+ Copyright (C) 2011 GUI Cocoa, LLC.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+
+ */
#import <execinfo.h>
#import <fcntl.h>
View
@@ -1,10 +1,26 @@
-//
-// HTNotice.h
-// HoptoadNotifier
-//
-// Created by Caleb Davenport on 10/2/10.
-// Copyright 2010 GUI Cocoa, LLC. All rights reserved.
-//
+/*
+
+ Copyright (C) 2011 GUI Cocoa, LLC.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+
+ */
#import <Foundation/Foundation.h>
View
@@ -1,10 +1,26 @@
-//
-// HTNotice.m
-// HoptoadNotifier
-//
-// Created by Caleb Davenport on 10/2/10.
-// Copyright 2010 GUI Cocoa, LLC. All rights reserved.
-//
+/*
+
+ Copyright (C) 2011 GUI Cocoa, LLC.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+
+ */
#import <objc/runtime.h>
#import <TargetConditionals.h>
@@ -1,10 +1,26 @@
-//
-// HTNotifier.h
-// HoptoadNotifier
-//
-// Created by Caleb Davenport on 10/2/10.
-// Copyright 2010 GUI Cocoa, LLC. All rights reserved.
-//
+/*
+
+ Copyright (C) 2011 GUI Cocoa, LLC.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+
+ */
#import <TargetConditionals.h>
@@ -27,28 +43,34 @@ extern NSString *HTNotifierVersion;
extern NSString *HTNotifierAlwaysSendKey;
/*
+
use these variables in your alert title, alert body, and
environment name to have their values replaced at runtime
+
*/
extern NSString *HTNotifierBundleName; // app name
extern NSString *HTNotifierBundleVersion; // bundle version
/*
+
use these standard environment names to have default
values provided to hoptoad
+
*/
extern NSString *HTNotifierDevelopmentEnvironment;
extern NSString *HTNotifierAdHocEnvironment;
extern NSString *HTNotifierAppStoreEnvironment;
extern NSString *HTNotifierReleaseEnvironment;
/*
+
HTNotifier is the primary class of the notifer library
start the notifier by calling
startNotifierWithAPIKey:environmentName:
access the shared instance by calling sharedNotifier
+
*/
#if TARGET_OS_IPHONE
@interface HTNotifier : NSObject <UIAlertViewDelegate> {
@@ -71,14 +93,17 @@ extern NSString *HTNotifierReleaseEnvironment;
@property (nonatomic, assign) NSObject<HTNotifierDelegate> *delegate;
/*
+
control whether notices are posted using SSL. your account
must support this feature
default:NO
+
*/
@property (nonatomic, assign) BOOL useSSL;
/*
+
this method is the entry point for the library. any code
executed after this method call is monitored for crashes
and signals
@@ -88,39 +113,50 @@ extern NSString *HTNotifierReleaseEnvironment;
include any of the above constant strings in the
enviromnent name to have the value replaced by the library
+
*/
+ (void)startNotifierWithAPIKey:(NSString *)key environmentName:(NSString *)name;
/*
+
access the shared notifier object.
if this is called before `startNotifierWithAPIKey:environmentName:`
nil will be returned.
+
*/
+ (HTNotifier *)sharedNotifier;
/*
+
writes a test notice if one does not exist already. it
will be reported just as an actual crash.
+
*/
- (void)writeTestNotice;
/*
+
set environment info key/value pair. passing nil as the
value will remove the value for the given key.
+
*/
- (void)setEnvironmentValue:(NSString *)valueOrNil forKey:(NSString *)key;
/*
+
get environment info value for a given key.
+
*/
- (NSString *)environmentValueForKey:(NSString *)key;
/*
+
scan for notices and take action if hoptoad is reachable.
if the user has chosen to always send notices they will
be posted imediately, otherwise the user will be asked
for their preference.
+
*/
- (BOOL)postNotices;
@@ -1,10 +1,26 @@
-//
-// HTNotifier.m
-// HoptoadNotifier
-//
-// Created by Caleb Davenport on 10/2/10.
-// Copyright 2010 GUI Cocoa, LLC. All rights reserved.
-//
+/*
+
+ Copyright (C) 2011 GUI Cocoa, LLC.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.
+
+ */
#import "HTNotifier.h"
#import "HTNotice.h"
Oops, something went wrong.

0 comments on commit 57fa473

Please sign in to comment.