Merge pull request #12 from PDF417/feature/v4.2.1

Feature/v4.2.1

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release notes
 
+## 4.2.1
+
+- Added new callback method to `PPScanDelegate` which is called when license key is invalid: `scanningViewController:invalidLicenseKeyWithError:`
+
 ## 4.2.0
 
 - Added bitcode support for Xcode 7

MicroBlink.embeddedframework/MicroBlink.framework/Versions/A/Headers/PPScanDelegate.h

@@ -33,11 +33,10 @@
  * Scanning library found an error. The error object is returned and contains
  * description of the error, in a specified language. Do your error handling here.
  *
- * Currently, only two situations result with this callback being called:
- * - 1. License key for using scanning library is invalid
- * - 2. Using camera session resulted with AVCaptureSessionRuntimeErrorNotification notification
+ * Currently, only one situation can result with this callback being called:
+ * - Using camera session resulted with AVCaptureSessionRuntimeErrorNotification notification
  *
- * Probably the best option at the moment is to Log the error (GA, Crashlytics, Flurry) and let the user continue
+ * The best way to handle this is to Log the error (GA, Crashlytics, Flurry) and let the user continue
  * using the app.
  *
  *  @param scanningViewController Scanning view controller which was responsible for scanning
@@ -46,15 +45,13 @@
 - (void)scanningViewController:(UIViewController<PPScanningViewController>*)scanningViewController
                   didFindError:(NSError*)error;
 
-
 /**
  * Scanning library was closed, usually by the user pressing close button and cancelling the scan
  *
  *  @param scanningViewController Scanning view controller responsible for scanning
  */
 - (void)scanningViewControllerDidClose:(UIViewController<PPScanningViewController>*)scanningViewController;
 
-
 /**
  * Scanning library did output scanning results (array of PPRecognizerResult objects). Do your next steps here.
  *
@@ -78,6 +75,26 @@
 
 @optional
 
+/**
+ * Scanning library found an invalid license key.
+ *
+ * This can happen in two situations:
+ *   1) Completely invalid license key was used (either it's not set, or it's garbage, or it expired)
+ *   2) License key is in fact valid, but the features you're using aren't enabled by the license key
+ *
+ * If you don't implement this method, the SDK will present an UIAlertView with error and call your
+ *
+ * This is intended for you to easily spot the issue as soon as possible.
+ *
+ * If you implement this method, you have a chance to handle the situation. However, scanning won't work 
+ * without a valid license key!
+ *
+ *  @param scanningViewController Scanning view controller which was responsible for scanning
+ *  @param error                  Error object describing the error
+ */
+- (void)scanningViewController:(UIViewController<PPScanningViewController>*)scanningViewController
+    invalidLicenseKeyWithError:(NSError*)error;
+
 /**
  * Called when Scanning library wants to display help screens. This can happen when the user press
  * help button on scanning UI, or on first run of the application

PPpdf417.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name        = "PPpdf417"
-  s.version     = "4.2.0"
+  s.version     = "4.2.1"
   s.summary     = "A delightful component for barcode scanning"
   s.homepage    = "http://pdf417.mobi"
 
@@ -39,7 +39,7 @@ Pod::Spec.new do |s|
 
   s.source      = { 
         :git => 'https://github.com/PDF417/pdf417-ios.git', 
-        :tag => 'v4.2.0'
+        :tag => 'v4.2.1'
   }
 
   s.preserve_paths = 'MicroBlink.embeddedframework/*'

README.md

@@ -42,7 +42,7 @@ pod try PPpdf417
 
 ```ruby
 platform :ios, '6.0'
-pod 'PPpdf417', '~> 4.2.0'
+pod 'PPpdf417', '~> 4.2.1'
 ```
 
 ## Requirements

Release notes.md

@@ -1,5 +1,9 @@
 # Release notes
 
+## 4.2.1
+
+- Added new callback method to `PPScanDelegate` which is called when license key is invalid: `scanningViewController:invalidLicenseKeyWithError:`
+
 ## 4.2.0
 
 - Added bitcode support for Xcode 7

Transition guide.md

@@ -1,3 +1,9 @@
+## Transition to 4.2.1
+
+- Added new callback method to `PPScanDelegate` which is called when license key is invalid: `scanningViewController:invalidLicenseKeyWithError:`
+
+- Previously, this error was returned in `scanningViewController:didFindError` (although not in all situations), so if you handled the error in that callback, switch to the new one.
+
 ## Transition to 4.2.0
 
 - If you're using Xcode 7, replace all .dylib libraries with .tbt libraries

buildCommit.txt

@@ -1 +1 @@
-Built from core repository commit 23d4eb923d297507d361bb5d951b3fb6c1e435d4
+Built from core repository commit e8904eac118e03031b9d4ace8b80d51c2d00c50b