Add additional methods which hopefully do not collide with private API

- See #201

Author: Bryant Luk

CardIO_Public_API/CardIOPaymentViewController.h

@@ -40,20 +40,11 @@
 /// ar,da,de,en,en_AU,en_GB,es,es_MX,fr,he,is,it,ja,ko,ms,nb,nl,pl,pt,pt_BR,ru,sv,th,tr,zh-Hans,zh-Hant,zh-Hant_TW.
 @property(nonatomic, copy, readwrite) NSString *languageOrLocale;
 
-/// If YES, the status bar's style will be kept as whatever your app has set it to.
-/// If NO, the status bar style will be set to the default style.
-/// Defaults to NO.
+/// @see keepStatusBarStyleForCardIO
 @property(nonatomic, assign, readwrite) BOOL keepStatusBarStyle;
-
-/// The default appearance of the navigation bar is navigationBarStyle == UIBarStyleDefault;
-/// tintColor == nil (pre-iOS 7), barTintColor == nil (iOS 7).
-/// Set either or both of these properties if you want to override these defaults.
-/// @see navigationBarTintColor
+/// @see navigationBarStyleForCardIO
 @property(nonatomic, assign, readwrite) UIBarStyle navigationBarStyle;
-/// The default appearance of the navigation bar is navigationBarStyle == UIBarStyleDefault;
-/// tintColor == nil (pre-iOS 7), barTintColor == nil (iOS 7).
-/// Set either or both of these properties if you want to override these defaults.
-/// @see navigationBarStyle
+/// @see navigationBarTintColorForCardIO
 @property(nonatomic, retain, readwrite) UIColor *navigationBarTintColor;
 
 /// Normally, card.io blurs the screen when the app is backgrounded,
@@ -183,3 +174,25 @@ extern NSString * const CardIOCurrentScanningOrientation;
 extern NSString * const CardIOScanningOrientationAnimationDuration;
 
 @end
+
+/// Methods with names that do not conflict with Apple's private APIs.
+@interface CardIOPaymentViewController (NonConflictingAPINames)
+
+/// If YES, the status bar's style will be kept as whatever your app has set it to.
+/// If NO, the status bar style will be set to the default style.
+/// Defaults to NO.
+@property(nonatomic, assign, readwrite) BOOL keepStatusBarStyleForCardIO;
+
+/// The default appearance of the navigation bar is navigationBarStyleForCardIO == UIBarStyleDefault;
+/// tintColor == nil (pre-iOS 7), barTintColor == nil (iOS 7).
+/// Set either or both of these properties if you want to override these defaults.
+/// @see navigationBarTintColorForCardIO
+@property(nonatomic, assign, readwrite) UIBarStyle navigationBarStyleForCardIO;
+
+/// The default appearance of the navigation bar is navigationBarStyleForCardIO == UIBarStyleDefault;
+/// tintColor == nil (pre-iOS 7), barTintColor == nil (iOS 7).
+/// Set either or both of these properties if you want to override these defaults.
+/// @see navigationBarStyleForCardIO
+@property(nonatomic, retain, readwrite) UIColor *navigationBarTintColorForCardIO;
+
+@end

CardIO_Public_API/CardIOUtilities.h

@@ -33,3 +33,19 @@
 + (UIImageView *)blurredScreenImageView;
 
 @end
+
+/// Methods with names that do not conflict with Apple's private APIs.
+@interface CardIOUtilities (NonConflictingAPINames)
+
+/// Please send the output of this method with any technical support requests.
+/// @return Human-readable version of this library.
++ (NSString *)cardIOLibraryVersion;
+
+/// The preload method prepares card.io to launch faster. Calling preload is optional but suggested.
+/// On an iPhone 5S, for example, preloading makes card.io launch ~400ms faster.
+/// The best time to call preload is when displaying a view from which card.io might be launched;
+/// e.g., inside your view controller's viewWillAppear: method.
+/// preload works in the background; the call to preload returns immediately.
++ (void)preloadCardIO;
+
+@end

Classes/CardIOContext.h

@@ -22,9 +22,9 @@
 @property(nonatomic, assign, readwrite) BOOL restrictPostalCodeToNumericOnly;
 @property(nonatomic, assign, readwrite) BOOL collectCardholderName;
 @property(nonatomic, assign, readwrite) BOOL disableManualEntryButtons;
-@property(nonatomic, assign, readwrite) BOOL keepStatusBarStyle;
-@property(nonatomic, assign, readwrite) UIBarStyle navigationBarStyle;
-@property(nonatomic, retain, readwrite) UIColor *navigationBarTintColor;
+@property(nonatomic, assign, readwrite) BOOL keepStatusBarStyleForCardIO;
+@property(nonatomic, assign, readwrite) UIBarStyle navigationBarStyleForCardIO;
+@property(nonatomic, retain, readwrite) UIColor *navigationBarTintColorForCardIO;
 @property(nonatomic, assign, readwrite) BOOL disableBlurWhenBackgrounding;
 @property(nonatomic, assign, readwrite) BOOL suppressScanConfirmation;
 @property(nonatomic, assign, readwrite) BOOL suppressScannedCardImage;
@@ -50,4 +50,4 @@
 
 @property(nonatomic, assign, readwrite) BOOL scanExpiry;
 
-@end
+@end

Classes/CardIODataEntryViewController.m

@@ -409,7 +409,7 @@ - (void)viewWillAppear:(BOOL)animated {
     }
   }
 
-  if (!self.context.keepStatusBarStyle) {
+  if (!self.context.keepStatusBarStyleForCardIO) {
     if (iOS_7_PLUS) {
       [UIApplication sharedApplication].statusBarStyle = UIStatusBarStyleDefault;
     }

Classes/CardIOPaymentViewController.m

@@ -111,17 +111,17 @@ - (void)viewWillAppear:(BOOL)animated {
     self.shouldStoreStatusBarStyle = NO; // only store the very first time
   }
 
-  self.navigationBar.barStyle = self.context.navigationBarStyle;
+  self.navigationBar.barStyle = self.context.navigationBarStyleForCardIO;
   if (iOS_7_PLUS) {
-    self.navigationBar.barTintColor = self.context.navigationBarTintColor;
+    self.navigationBar.barTintColor = self.context.navigationBarTintColorForCardIO;
   }
   else {
-    self.navigationBar.tintColor = self.context.navigationBarTintColor;
+    self.navigationBar.tintColor = self.context.navigationBarTintColorForCardIO;
   }
 
   [super viewWillAppear:animated];
 
-  if (self.modalPresentationStyle == UIModalPresentationFullScreen && !self.context.keepStatusBarStyle) {
+  if (self.modalPresentationStyle == UIModalPresentationFullScreen && !self.context.keepStatusBarStyleForCardIO) {
     if (iOS_7_PLUS) {
       [theApp setStatusBarStyle:UIStatusBarStyleDefault animated:animated];
     }
@@ -186,6 +186,30 @@ - (void)dealloc {
   [[NSNotificationCenter defaultCenter] removeObserver:self];
 }
 
+- (void)setKeepStatusBarStyle:(BOOL)keepStatusBarStyle {
+  self.keepStatusBarStyleForCardIO = keepStatusBarStyle;
+}
+
+- (BOOL)keepStatusBarStyle {
+  return self.keepStatusBarStyleForCardIO;
+}
+
+- (void)setNavigationBarStyle:(UIBarStyle)navigationBarStyle {
+  self.navigationBarStyleForCardIO = navigationBarStyle;
+}
+
+- (UIBarStyle)navigationBarStyle {
+  return self.navigationBarStyleForCardIO;
+}
+
+- (void)setNavigationBarTintColor:(UIColor *)navigationBarTintColor {
+  self.navigationBarTintColorForCardIO = navigationBarTintColor;
+}
+
+- (UIColor *)navigationBarTintColor {
+  return self.navigationBarTintColorForCardIO;
+}
+
 - (BOOL)shouldAutorotateToInterfaceOrientation:(UIInterfaceOrientation)toInterfaceOrientation {
   if (self.currentViewControllerIsDataEntry) {
     return YES;
@@ -339,7 +363,7 @@ - (void)didReceiveForegroundingNotification:(NSNotification *)notification {
 - (NSString *)description {
   return [NSString stringWithFormat:@"{delegate: %@; %s%s%s%s%s%s%s%s%s%s%s%s%s%s%s%s}"
           ,self.paymentDelegate
-          ,DESCRIBE_BOOL(keepStatusBarStyle)
+          ,DESCRIBE_BOOL(keepStatusBarStyleForCardIO)
           ,DESCRIBE_BOOL(disableBlurWhenBackgrounding)
           ,DESCRIBE_BOOL(suppressScanConfirmation)
           ,DESCRIBE_BOOL(suppressScannedCardImage)
@@ -380,9 +404,9 @@ - (void)set##prop_uc:(t)prop_lc { \
 
 
 CONTEXT_PASSTHROUGH_READWRITE(NSString *, languageOrLocale, LanguageOrLocale)
-CONTEXT_PASSTHROUGH_READWRITE(BOOL, keepStatusBarStyle, KeepStatusBarStyle)
-CONTEXT_PASSTHROUGH_READWRITE(UIBarStyle, navigationBarStyle, NavigationBarStyle)
-CONTEXT_PASSTHROUGH_READWRITE(UIColor *, navigationBarTintColor, NavigationBarTintColor)
+CONTEXT_PASSTHROUGH_READWRITE(BOOL, keepStatusBarStyleForCardIO, KeepStatusBarStyleForCardIO)
+CONTEXT_PASSTHROUGH_READWRITE(UIBarStyle, navigationBarStyleForCardIO, NavigationBarStyleForCardIO)
+CONTEXT_PASSTHROUGH_READWRITE(UIColor *, navigationBarTintColorForCardIO, NavigationBarTintColorForCardIO)
 CONTEXT_PASSTHROUGH_READWRITE(BOOL, disableBlurWhenBackgrounding, DisableBlurWhenBackgrounding)
 CONTEXT_PASSTHROUGH_READWRITE(BOOL, collectCVV, CollectCVV)
 CONTEXT_PASSTHROUGH_READWRITE(BOOL, collectPostalCode, CollectPostalCode)

Classes/CardIOUtilities.m

@@ -19,6 +19,10 @@ @implementation CardIOUtilities
 #pragma mark - Library version, for bug reporting etc.
 
 + (NSString *)libraryVersion {
+  return [self cardIOLibraryVersion];
+}
+
++ (NSString *)cardIOLibraryVersion {
   NSString *dateString = [[[NSString stringWithUTF8String:__DATE__] stringByReplacingOccurrencesOfString:@" " withString:@"."] stringByReplacingOccurrencesOfString:@".." withString:@"."];
   NSString *timeHash = [NSString stringWithUTF8String:__TIME__];
   NSMutableString *libraryVersion = [NSMutableString stringWithFormat:@"%@-%@", dateString, timeHash];
@@ -108,10 +112,14 @@ + (BOOL)canReadCardWithCamera {
 
 #pragma mark - Preload resources for faster launch of card.io
 
-+ (void)preload {
++ (void)preloadCardIO {
   [CardIOLocalizer preload];
 }
 
++ (void)preload {
+  [self preloadCardIO];
+}
+
 #pragma mark - Screen obfuscation on backgrounding
 
 + (UIImageView *)blurredScreenImageView {

Classes/RootViewController.m

@@ -361,7 +361,7 @@ - (void)viewDidLoad {
   [TestGeneratedModels selfCheck];
 #endif
 
-  [CardIOUtilities preload];
+  [CardIOUtilities preloadCardIO];
 }
 
 - (UIStatusBarStyle) preferredStatusBarStyle {

Classes/iccAppDelegate.m

@@ -19,7 +19,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
   self.window.rootViewController = [[RootViewController alloc] initWithNibName:nil bundle:nil];
   [self.window addSubview:self.window.rootViewController.view];
   [self.window makeKeyAndVisible];
-  CardIOLog(@"Client version is %@.", [CardIOUtilities libraryVersion]);
+  CardIOLog(@"Client version is %@.", [CardIOUtilities cardIOLibraryVersion]);
 	return YES;
 }
 

Release/README.md

@@ -125,7 +125,7 @@ Make an optional call to speed up the subsequent launch of card.io scanning:
 
 - (void)viewWillAppear:(BOOL)animated {
   [super viewWillAppear:animated];
-  [CardIOUtilities preload];
+  [CardIOUtilities preloadCardIO];
 }
 
 ```
@@ -202,7 +202,7 @@ Make an optional call to speed up the subsequent launch of card.io scanning:
 
 - (void)viewWillAppear:(BOOL)animated {
   [super viewWillAppear:animated];
-  [CardIOUtilities preload];
+  [CardIOUtilities preloadCardIO];
 }
 
 ```
@@ -287,7 +287,7 @@ Make an optional call to speed up the subsequent launch of card.io scanning:
 
 - (void)viewWillAppear:(BOOL)animated {
   [super viewWillAppear:animated];
-  [CardIOUtilities preload];
+  [CardIOUtilities preloadCardIO];
 }
 
 ```
@@ -338,4 +338,4 @@ Include a method to cancel card scanning:
 * Processing images can be memory intensive, so make sure to test that your app properly handles memory warnings.
 * For your users' security, [obscure your app's cached screenshots](https://viaforensics.com/resources/reports/best-practices-ios-android-secure-mobile-development/ios-avoid-cached-application-snapshots/).  
 **Note:** By default, a `CardIOPaymentViewController` automatically blurs its own screens when the app is backgrounded. A `CardIOView` does not do any automatic blurring.
-* The first time that you create either a `CardIOPaymentViewController` or a `CardIOView`, the card.io SDK must load resources, which can result in a noticeable delay. To avoid this delay you may optionally call `[CardIOUtilities preload]` in advance, so that this resource loading occurs in advance on a background thread.
+* The first time that you create either a `CardIOPaymentViewController` or a `CardIOView`, the card.io SDK must load resources, which can result in a noticeable delay. To avoid this delay you may optionally call `[CardIOUtilities preloadCardIO]` in advance, so that this resource loading occurs in advance on a background thread.