nullscreen / bark

A streamlined issue reporting library for iOS

BARK (Better App Reporting Kit) is a simple, in-app issue reporting library for iOS. Shaking the app pulls up an action sheet, where beta users can instantly send email or create GitHub issues - with screenshots automatically attached.

## Get Started ##

1. Clone the repository with git clone [e-mail]:stagebloc/bark.git
2. Link the following frameworks in the Build Phases tab:
   • MessageUI - to send emails from within the app
   • SystemConfiguration - for network reachability support
   • Security - for secure storage of GitHub credentials
   • MobileCoreServices - for file MIME type detection on uploaded images
3. In your AppDelegate.h file, #import "SBBark.h", and add <SBBarkDelegate> to the delegate list.
4. Take a look at the example didFinishLaunchingWithOptions method below. #import "SBWindow.h" and copy the provided code. You'll need to set a few variables, like the repository name you want to submit issues to.
5. (Optional) Register for an ImageShack API key. As of now, GitHub doesn't allow image uploads directly through their API. Because of this, all uploads are done through the ImageShack API, and then automatically embedded in the markdown when an issue is created. This means you must register for an API key if you wish to attach images to GitHub issues.

#import "SBWindow.h"
...

// an example applicationdidFinishLaunchingWithOptions method
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    // start copying here
    SBWindow *window = [[SBWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
    SBBark *bark = [SBBark sharedBark];
    bark.repositoryName = @"e.g. stagebloc/bark";
    bark.apiKey = @"your_ImageShack_API_key";
    bark.delegate = self;
    [[NSNotificationCenter defaultCenter] addObserverForName:kSBWindowDidShakeNotification 
                                                      object:window 
                                                       queue:[NSOperationQueue mainQueue] 
                                                  usingBlock:^(NSNotification *note) {
        [bark showBark];
    }];
    
    self.window = window;
    // stop copying here
    
    // Override point for customization after application launch.
    SBRootViewController *rootViewController = [[SBRootViewController alloc] init];
    self.window.rootViewController = rootViewController;
    self.window.backgroundColor = [UIColor whiteColor];
    [self.window makeKeyAndVisible];
    return YES;
}

Finally, implement the shouldShowActionSheet method below. return YES to always show the action sheet on shake, or add your own custom logic.

- (BOOL)shouldShowActionSheet
{
    /* add the logic to determine whether or not to show the action sheet. Something like:
     if([currentUser isAdmin]) {
        return YES;
     } else return NO;
    */
    return YES;
}

Features

BARK comes with a set of features to make quick adjustments. You can set these below repositoryName on the bark object.

// email
bark.emailRecipients = @[@"[e-mail]", @"[e-mail]"];
bark.emailSubject = @"Subject";
bark.emailBody = @"Body"; // note that this will override sending device info
bark.attachScreenshot = YES; // defaults to YES

// github
bark.defaultAssignee = @"your_username";
bark.defaultMilestone = @"milestone_title";
bark.attachDeviceInfo = YES; // defaults to YES

BARK can also be shown programmatically anywhere in the application using the SBBark singleton:

[[SBBark sharedBark] showBark];

Using BARK in Production

BARK can be used in production by customizing the shouldShowActionSheet method. You'll need to create your own way of determining whether or not the current user is an admin. Take a look at the example below - we check against the logged in user's email address.

- (BOOL)shouldShowActionSheet
{
    NSArray *adminEmails = @[@"[e-mail]", @"[e-mail]"];
    for(NSString *email in adminEmails) {
        if([email isEqualToString:[[self getLoggedInUser] email]]) {
            return YES;
        }
    }
    
    return NO;
}

License

BARK is published under the MIT License (MIT)

Copyright (c) 2013 StageBloc

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.