Merge pull request #176 from BlinkID/feature/v4.0.0

Feature/v4.0.0

.swift-version

@@ -1 +1 @@
-3.1
+4.0

.travis.yml

@@ -1,5 +1,5 @@
 language: objective-c
-osx_image: xcode9
+osx_image: xcode9.4
 
 install: true
 before_install: ./travis/before_script.sh

CHANGELOG.md

@@ -1,3 +1,17 @@
+# Release notes
+
+## 4.0.0
+
+- new API, which is not backward compatible. Please check [README](README.md) and updated demo applications for more information, but the gist of it is:
+    - `PPScanningViewController` has been renamed to `MBRecognizerRunnerViewController` and `MBCoordinator` to `MBRecognizerRunner`
+    - `PPBarcodeOverlayViewController` has been renamed to `MBBarcodeOverlayViewController`
+    - previously internal `MBRecognizer` objects are not internal anymore - instead of having opaque `MBRecognizerSettings` and `MBRecognizerResult` objects, you now have stateful `MBRecognizer` object that contains its `MBResult` within and mutates it while performing recognition. For more information, see [README](README.md) and updated demo applications
+    - introduced `MBFieldByFieldOverlayViewController` that can be used for easy integration of the _field-by-field scanning_ feature (previously known as _segment scan_)
+    - introduced `MBDocumentVerificationController` that can be used for easy integration of _ID verification scanning_ feature (previously available only in [BlinkID AppStore app](https://itunes.apple.com/us/app/blinkid/id1258136557?mt=8)
+    - introduced `MBProcessor` concept. For more information, check updated code samples, [README](README.md) and [this blog post](https://microblink.com/blog/major-change-of-the-api-and-in-the-license-key-formats)
+- new licence format, which is not backward compatible. Full details are given in [README](README.md) and in updated applications, but the gist of it is:
+    - licence can now be provided with either file, byte array or base64-encoded bytes
+
 ## 2.18.2
 
 - Bugfixes

MicroBlink.bundle/en.strings

@@ -10,3 +10,12 @@
 "photopay_light_on" = "Light";
 "photopay_light_off" = "Light";
 "photopay_camera_permission_denied" = "{font:@Medium}%@{/font} does not have permission to use the camera.\n\nPlease go to:\n• {font:@Medium}Settings{/font}\n• {font:@Medium}%@{/font}\n• Make sure that {font:@Medium}Camera{/font} is enabled";
+"photopay_id_position_tooltip" = "Position ID card in this Frame";
+"photopay_glare_status" = "Slightly move ID to eliminate glare.";
+
+"photopay_front_verification_document" = "Place the front side of the document in the frame and wait for automatic scan.";
+"photopay_back_verification_document" = "Place the back side of the document in the frame and wait for automatic scan.";
+"photopay_front_splash_verification_document" = "Document front side";
+"photopay_back_splash_verification_document" = "Document back side";
+
+"photopay_time_restricted_license_key" = "Using time-limited license!";

MicroBlink.framework/Headers/MBAmountParser.h

@@ -0,0 +1,63 @@
+//
+//  MBAmountParser.h
+//  MicroBlinkDev
+//
+//  Created by Jura Skrlec on 09/03/2018.
+//
+
+#import <Foundation/Foundation.h>
+#import "MBMicroBlinkDefines.h"
+#import "MBParser.h"
+#import "MBAmountParserResult.h"
+#import "MBMicroBlinkInitialization.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * MBAmountParser is used for extracting amount from OCR result
+ */
+MB_CLASS_AVAILABLE_IOS(8.0) MB_FINAL
+@interface MBAmountParser : MBParser <NSCopying>
+
+MB_INIT
+
+/**
+ * Amount parser result
+ */
+@property (nonatomic, strong, readonly) MBAmountParserResult *result;
+
+/**
+ * Indicates whether negative values are accepted as valid amounts.
+ * Setting this to YES can yield to more false positives.
+ *
+ * Default: NO
+ */
+@property (nonatomic, assign) BOOL allowNegativeAmounts;
+
+/**
+ * Indicates whether amounts with space separators between groups of digits(thousands) are allowed.
+ *
+ * Default: NO
+ */
+@property (nonatomic, assign) BOOL allowSpaceSeparators;
+
+/**
+ * Indicates whether amounts without decimal are accepted as valid. For example 1.465 is
+ * accepted as valid amount, but 1465 is not, unless this is set to YES.
+ * Setting this to {@code true} can yield to more false positives
+ * because any set of consequent digits can represent valid amount.
+ *
+ * Default: NO
+ */
+@property (nonatomic, assign) BOOL allowMissingDecimals;
+/**
+ * Indicates whether Arabic-Indic mode is enabled. In Arabic-Indic mode parser can recognize
+ * only amounts which consist of Arabic-Indic digits and decimal separator.
+ *
+ * Default: NO
+ */
+@property (nonatomic, assign) BOOL arabicIndicMode;
+
+@end
+
+NS_ASSUME_NONNULL_END

MicroBlink.framework/Headers/MBAmountParserResult.h

@@ -0,0 +1,30 @@
+//
+//  MBAmountParserResult.h
+//  MicroBlinkDev
+//
+//  Created by Jura Skrlec on 09/03/2018.
+//
+
+#import <Foundation/Foundation.h>
+
+#import "MBMicroBlinkDefines.h"
+#import "MBParserResult.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * MBAmountParser is used for extracting amount from OCR result
+ */
+MB_CLASS_AVAILABLE_IOS(8.0)
+@interface MBAmountParserResult : MBParserResult <NSCopying>
+
+MB_INIT_UNAVAILABLE
+
+/**
+ * Returns the recognized amount number or empty string if recognition failed.
+ */
+@property (nonatomic, nullable, strong, readonly) NSString *amount;
+
+@end
+
+NS_ASSUME_NONNULL_END

MicroBlink.framework/Headers/MBAustraliaDlBackRecognizer.h

@@ -0,0 +1,56 @@
+//
+//  MBAustraliaDlBackRecognizer.h
+//  MicroBlinkDev
+//
+//  Created by Dino Gustin on 22/05/2018.
+//
+
+#import "MBLegacyRecognizer.h"
+#import "MBAustraliaDlBackRecognizerResult.h"
+
+#import <Foundation/Foundation.h>
+#import "MBFullDocumentImage.h"
+#import "MBFullDocumentImageDpi.h"
+
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Class for configuring Australia DL Back Recognizer.
+ *
+ * Australia DL Back recognizer is used for scanning back side of Australia DL.
+ */
+PP_CLASS_AVAILABLE_IOS(8.0)
+@interface MBAustraliaDlBackRecognizer : MBLegacyRecognizer <NSCopying, MBFullDocumentImage, MBFullDocumentImageDpi>
+
+MB_INIT
+
+/**
+ * Australia DL Back recognizer result
+ */
+@property (nonatomic, strong, readonly) MBAustraliaDlBackRecognizerResult *result;
+
+/**
+ *  Defines if last name of Australian DL owner should be extracted
+ *
+ *  Default: YES
+ */
+@property (nonatomic, assign) BOOL extractLastName;
+
+/**
+ *  Defines if sex of Australian DL owner should be extracted
+ *
+ *  Default: YES
+ */
+@property (nonatomic, assign) BOOL extractAddress;
+
+/**
+ * Defines if date of expiry should be extracted from Australian DL
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractDateOfExpiry;
+
+@end
+
+NS_ASSUME_NONNULL_END

MicroBlink.framework/Headers/MBAustraliaDlBackRecognizerResult.h

@@ -0,0 +1,49 @@
+//
+//  MBAustraliaDlBackRecognizerResult.h
+//  MicroBlinkDev
+//
+//  Created by Dino Gustin on 22/05/2018.
+//
+
+#import "MBLegacyRecognizerResult.h"
+
+#import "MBFullDocumentImageResult.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Class representing values obtained when scanning back side of Australia DL
+ */
+MB_CLASS_AVAILABLE_IOS(8.0)
+@interface MBAustraliaDlBackRecognizerResult : MBLegacyRecognizerResult<NSCopying, MBFullDocumentImageResult>
+
+MB_INIT_UNAVAILABLE
+
+/**
+ * The last name of the Australian DL owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *lastName;
+
+/**
+ * The licence number of the Australian DL owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *licenceNumber;
+
+/**
+ * The address of the Australian DL owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *address;
+
+/**
+ * The document date of expiry of the Australian DL in DD.MM.yyyy format.
+ */
+@property (nonatomic, readonly, nullable) NSString *rawDocumentDateOfExpiry;
+
+/**
+ * The document date of expiry of the Australian DL
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfExpiry;
+
+@end
+
+NS_ASSUME_NONNULL_END

MicroBlink.framework/Headers/MBAustraliaDlFrontRecognizer.h

@@ -0,0 +1,65 @@
+//
+//  MBAustraliaDlFrontRecognizer.h
+//  MicroBlinkDev
+//
+//  Created by Dino Gustin on 22/05/2018.
+//
+
+#import "MBLegacyRecognizer.h"
+#import "MBAustraliaDlFrontRecognizerResult.h"
+
+#import <Foundation/Foundation.h>
+#import "MBFaceImage.h"
+#import "MBSignatureImage.h"
+#import "MBFullDocumentImage.h"
+#import "MBFullDocumentImageDpi.h"
+
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Class for configuring Australia DL Front Recognizer.
+ *
+ * Australia DL Front recognizer is used for scanning front side of Australia DL.
+ */
+PP_CLASS_AVAILABLE_IOS(8.0)
+@interface MBAustraliaDlFrontRecognizer : MBLegacyRecognizer <NSCopying, MBFaceImage, MBSignatureImage, MBFullDocumentImage, MBFullDocumentImageDpi>
+
+MB_INIT
+
+/**
+ * Australia DL Front recognizer result
+ */
+@property (nonatomic, strong, readonly) MBAustraliaDlFrontRecognizerResult *result;
+
+/**
+ *  Defines if sex of Australian DL owner should be extracted
+ *
+ *  Default: YES
+ */
+@property (nonatomic, assign) BOOL extractAddress;
+
+/**
+ * Defines if citizenship of Australian DL owner should be extracted
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractLicenceNumber;
+
+/**
+ * Defines if date of birth of Australian DL owner should be extracted
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractDateOfBirth;
+
+/**
+ * Defines if date of expiry should be extracted from Australian DL
+ *
+ * Default: YES
+ */
+@property (nonatomic, assign) BOOL extractDateOfExpiry;
+
+@end
+
+NS_ASSUME_NONNULL_END

MicroBlink.framework/Headers/MBAustraliaDlFrontRecognizerResult.h

@@ -0,0 +1,66 @@
+//
+//  MBAustraliaDlFrontRecognizerResult.h
+//  MicroBlinkDev
+//
+//  Created by Dino Gustin on 22/05/2018.
+//
+
+#import "MBLegacyRecognizerResult.h"
+
+#import "MBFaceImageResult.h"
+#import "MBSignatureImageResult.h"
+#import "MBFullDocumentImageResult.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+/**
+ * Class representing values obtained when scanning front side of Australia DL
+ */
+MB_CLASS_AVAILABLE_IOS(8.0)
+@interface MBAustraliaDlFrontRecognizerResult : MBLegacyRecognizerResult<NSCopying, MBFaceImageResult, MBSignatureImageResult, MBFullDocumentImageResult>
+
+MB_INIT_UNAVAILABLE
+
+/**
+ * The first name of the Australian DL owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *name;
+
+/**
+ * The licence type of Australian DL.
+ */
+@property (nonatomic, readonly, nullable) NSString *licenceType;
+
+/**
+ * The licence number of the Australian DL owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *licenceNumber;
+
+/**
+ * The address of the Australian DL owner.
+ */
+@property (nonatomic, readonly, nullable) NSString *address;
+
+/**
+ * The date of birth of Australian DL owner in DD.MM.yyyy format.
+ */
+@property (nonatomic, readonly, nullable) NSString *rawDateOfBirth;
+
+/**
+ * The date of birth of Australian DL owner
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfBirth;
+
+/**
+ * The document date of expiry of the Australian DL in DD.MM.yyyy format.
+ */
+@property (nonatomic, readonly, nullable) NSString *rawDocumentDateOfExpiry;
+
+/**
+ * The document date of expiry of the Australian DL
+ */
+@property (nonatomic, readonly, nullable) NSDate *dateOfExpiry;
+
+@end
+
+NS_ASSUME_NONNULL_END