Harpy

Notify users when a new version of your iOS app is available, and prompt them with the App Store link.

---

About (current release: v2.3.7)

Harpy is a utility that checks a user's currently installed version of your iOS application against the version that is currently available in the AppStore. If a new version is available, an instance of UIAlertView is presented to the user informing them of the newer version, and giving them the option to update the application.

Features

• Three types of alerts to present to the end-user (see Screenshots section)
• Optional delegate and delegate methods (see Optional Delegate section)
• Cocoapods Support
• Localized for 14 languages: Basque, Chinese (Simplified), Chinese (Traditional), Danish, Dutch, English, French, German, Italian, Japanese, Korean, Portuguese, Russian, Spanish

Screenshots

• The left picture forces the user to update the app.
• The center picture gives the user the option to update the app.
• The right picture gives the user the skip the current update.
• This option is based on the HarpyAlertType struct that is found in Harpy.h.

Installation Instructions

Note: Harpy utilizes ARC. Add the -fobjc-arc compiler flag in the build phases tab if your project doesn't use ARC.

1. Copy the 'Harpy' folder into your Xcode project.
2. Import Harpy.h into your AppDelegate or Pre-Compiler Header (.pch)
3. In your AppDelegate, set the appID, and optionally, you can set the alertType.
4. In your AppDelegate, call only one of the checkVersion methods, as all three perform a check on your application's first launch. Use either:
   • checkVersion in application:didFinishLaunchingWithOptions:
   • checkVersionDaily in applicationDidBecomeActive:.
   • checkVersionWeekly in applicationDidBecomeActive:.

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{

	// Present Window before calling Harpy
	[self.window makeKeyAndVisible]
	
	// Set the App ID for your app
	[[Harpy sharedInstance] setAppID:@"<app_id>"];
	
	/* (Optional) Set the Alert Type for your app 
	 By default, the Singleton is initialized to HarpyAlertTypeOption */
	[[Harpy sharedInstance] setAlertType:<alert_type>];
	
	/* (Optional) If your application is not availabe in the U.S. Store, you must specify the two-letter
	 country code for the region in which your applicaiton is available in. */
	[[Harpy sharedInstance] setCountryCode:@"<countryCode>"]; 
	
	// Perform check for new version of your app 
	[[Harpy sharedInstance] checkVersion]; 
}

- (void)applicationDidBecomeActive:(UIApplication *)application
{

	/*
	 Perform daily check for new version of your app
	 Useful if user returns to you app from background after extended period of time
 	 Place in applicationDidBecomeActive:
 	 
 	 Also, performs version check on first launch.
 	*/
	[[Harpy sharedInstance] checkVersionDaily];

	/*
	 Perform weekly check for new version of your app
	 Useful if user returns to you app from background after extended period of time
	 Place in applicationDidBecomeActive:
	 
	 Also, performs version check on first launch.
	 */
	[[Harpy sharedInstance] checkVersionWeekly];
    
}

And you're all set!

Optinonal Delegate and Delegate Methods

If you'd like to handle or track the end-user's behavior, four delegate methods have been made available to you:

	// User presented with update dialog
	- (void)harpyDidShowUpdateDialog;
	
	// User did click on button that launched App Store.app
	- (void)harpyUserDidLaunchAppStore;
	
	// User did click on button that skips version update
	- (void)harpyUserDidSkipVersion;
	
	// User did click on button that cancels update dialog
	- (void)harpyUserDidCancel;

Important Note on AppStore Submissions

• The AppStore reviewer will not see the alert.

Release Notes (v2.3.7)

• Xcode 5 can now properly displays header-file method comments in quick-help window. You must manually enable -Weverything to see these comments.

Project Contributors

• Aaron Brager in v1.5.0
• Ercillagorka in v2.3.4
• Erick in v2.3.3
• Claas Lange in v2.0.0
• David Keegan in v2.3.0
• Jamie Ly in v2.3.6
• Josh T. Brown in v2.0.0
• Mark Rickert in v2.3.2
• Pius Uzamere in v1.0.1
• Rui Perese in v2.3.1
• TrentW in v2.3.5

Created and maintained by

• Arthur Ariel Sabintsev

License

The MIT License (MIT) Copyright (c) 2012-2013 Arthur Ariel Sabintsev

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.