Skip to content

Commit

Permalink
Release 7.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathanellis committed Mar 17, 2020
1 parent 1ab051a commit fd95c82
Show file tree
Hide file tree
Showing 31 changed files with 453 additions and 285 deletions.
37 changes: 25 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
# iProov iOS SDK v7.2.2
# iProov iOS SDK v7.3.0

## 📖 Table of contents

- [Introduction](#-introduction)
- [Repository contents](#-repository-contents)
- [Upgrading from earlier versions](#-upgrading-from-earlier-versions)
- [Registration](#-registration)
- [Installation](#-installation)
- [Get started](#-get-started)
- [Options](#-options)
- [Localization](#-localization)
- [Sample code](#-sample-code)
- [Help & support](#-help--support)

## 🤳 Introduction

The iProov iOS SDK enables you to integrate iProov into your iOS app. We also have an [Android SDK](https://github.com/iproov/android) and [HTML5 client](https://github.com/iProov/html5).
The iProov iOS SDK enables you to integrate iProov into your iOS app. We also have an [Android SDK](https://github.com/iproov/android), [HTML5 client](https://github.com/iProov/html5), and [Xamarin bindings](https://github.com/iProov/xamarin).

### Requirements

Expand All @@ -27,19 +40,19 @@ As of iProov SDK 7.2.0, module stability is supported for Swift 5.1 and above. T

iProov is now built with the _"Build Libraries for Distribution"_ build setting enabled, which means that its dependencies should also be built in the same fashion. However, this is not supported directly in either Cocoapods nor Carthage as of October 2019, therefore some workarounds are required (see installation documentation for details).

## 📖 Contents
## 📦 Repository contents

The framework package is provided via this repository, which contains the following:

* **README.md** - This document
* **WaterlooBank** - A sample project of iProov for the fictitious _Waterloo Bank_, written in Swift.
* **iProov.framework** - The framework file itself. You can add this to your project manually, if you aren't using a dependency manager. (Please note this is a "fat" framework for both device & simulator).
* **iProov.podspec** - Required by Cocoapods. You do not need to do anything with this file.
* **resources** -- Directory containing additional development resources you may find helpful.
* **resources** - Directory containing additional development resources you may find helpful.

## ⬆️ Upgrading from earlier versions

Consult the [Upgrade Guide](https://github.com/iProov/ios/wiki/Upgrade-Guide) for detailed information about how to upgrade your app.
If you're already using an older version of the iProov SDK, consult the [Upgrade Guide](https://github.com/iProov/ios/wiki/Upgrade-Guide) for detailed information about how to upgrade your app.

## ✍️ Registration

Expand Down Expand Up @@ -95,7 +108,7 @@ Full instructions installing and setting up Carthage [are available here](https:

2. You can now build the dependencies with Carthage (see the note below about the custom build settings for module stability).

```
```bash
echo 'BUILD_LIBRARY_FOR_DISTRIBUTION=YES'>/tmp/iproov.xcconfig; XCODE_XCCONFIG_FILE=/tmp/iproov.xcconfig carthage build; rm /tmp/iproov.xcconfig
```

Expand All @@ -115,7 +128,7 @@ In a production app, you normally would want to obtain the token via a server-to

Once you have obtained the token, you can simply call `IProov.launch()`:

```
```swift
let token = "{{ your token here }}"

IProov.launch(token: token, callback: { (status) in
Expand All @@ -126,8 +139,8 @@ IProov.launch(token: token, callback: { (status) in
// the user. This will be called multiple time as the progress updates.

case let .success(token):
// The user was successfully verified/enrolled and the token has been validated.
// The token passed back will be the same as the one passed in to the original call.
// The user was successfully verified/enrolled and the token has been validated.
// The token passed back will be the same as the one passed in to the original call.

case let .failure(reason, feedbackCode):
// The user was not successfully verified/enrolled, as their identity could not be verified,
Expand Down Expand Up @@ -213,7 +226,7 @@ This resulted in an easy-to-use zero-config API, however this didn't necessarily

We listened to your feedback! SDK v7 still provides the existing behaviour as a default, however it is now possible to pass a custom `presentationDelegate` to the UI options, which allows you to override the presentation/dismissal behaviour of the iProov view controller:

```
```swift
extension MyViewController: IProovPresentationDelegate {

func present(iProovViewController: UIViewController) {
Expand All @@ -233,7 +246,7 @@ extension MyViewController: IProovPresentationDelegate {
>
> 2. To avoid the risk of retain cycles, `Options` only holds a **weak** reference to your presentation delegate. Ensure that your presentation delegate is retained for the lifetime of the iProov capture session, or you may result in a defective flow.

## 🌎 String localization & customization
## 🌎 Localization

The SDK ships with English strings only. If you wish to customise the strings in the app or localize them into a different language, see our [Localization Guide](https://github.com/iProov/ios/wiki/Localization).

Expand Down Expand Up @@ -281,7 +294,7 @@ A description of these cases are as follows:
* `cameraPermissionDenied` - The user disallowed access to the camera when prompted. You should direct the user to re-enable camera access via Settings.
* `serverError(String?)` - A server-side error/token invalidation occurred. The associated string will contain further information about the error.

## 🏦 Waterloo Bank sample code
## 🏦 Sample code

For a simple iProov experience that is ready to run out-of-the-box, check out the [Waterloo Bank sample project](/tree/master/WaterlooBank).

Expand Down
32 changes: 16 additions & 16 deletions WaterlooBank/Podfile.lock
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
PODS:
- Alamofire (4.8.2)
- Alamofire (4.9.1)
- Alamofire-SwiftyJSON (3.0.0):
- Alamofire (~> 4.5)
- SwiftyJSON (~> 4.0.0)
- iProov (7.2.0):
- KeychainAccess (~> 3.2.0)
- Socket.IO-Client-Swift (~> 15.1.0)
- iProov (7.3.0):
- KeychainAccess (~> 4.1.0)
- Socket.IO-Client-Swift (~> 15.2.0)
- SwiftyJSON (~> 4.0.0)
- KeychainAccess (3.2.0)
- MBProgressHUD (1.1.0)
- Socket.IO-Client-Swift (15.1.0):
- KeychainAccess (4.1.0)
- MBProgressHUD (1.2.0)
- Socket.IO-Client-Swift (15.2.0):
- Starscream (~> 3.1)
- Starscream (3.1.0)
- Starscream (3.1.1)
- SwiftyJSON (4.0.0)

DEPENDENCIES:
Expand All @@ -21,7 +21,7 @@ DEPENDENCIES:
- MBProgressHUD

SPEC REPOS:
https://github.com/CocoaPods/Specs.git:
trunk:
- Alamofire
- Alamofire-SwiftyJSON
- KeychainAccess
Expand All @@ -35,15 +35,15 @@ EXTERNAL SOURCES:
:path: "../"

SPEC CHECKSUMS:
Alamofire: ae5c501addb7afdbb13687d7f2f722c78734c2d3
Alamofire: 85e8a02c69d6020a0d734f6054870d7ecb75cf18
Alamofire-SwiftyJSON: 2b3649d57dc7bb2880fb8b86f8bb969397666916
iProov: 1070c8136587ab35d1114e59a736cca1c4662dae
KeychainAccess: 3b1bf8a77eb4c6ea1ce9404c292e48f948954c6b
MBProgressHUD: e7baa36a220447d8aeb12769bf0585582f3866d9
Socket.IO-Client-Swift: 7cb44c0ffb86e158cee32d0642d30ec5fdcf8f61
Starscream: 08172b481e145289c4930cb567230fb55897cfa4
iProov: 6ff202ee804f1f08b672d81c11bd99cf5a3ebf79
KeychainAccess: 445e28864fe6d3458b41fa211bcdc39890e8bd5a
MBProgressHUD: 3ee5efcc380f6a79a7cc9b363dd669c5e1ae7406
Socket.IO-Client-Swift: 1e3e3a1f09f3312a167f0d781eb2f383d477357c
Starscream: 4bb2f9942274833f7b4d296a55504dcfc7edb7b0
SwiftyJSON: 070dabdcb1beb81b247c65ffa3a79dbbfb3b48aa

PODFILE CHECKSUM: 1710baf2e28b49bbaa247e87f13f29ed3e4302bc

COCOAPODS: 1.8.4
COCOAPODS: 1.9.0
1 change: 1 addition & 0 deletions carthage/IProov.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@
"7.2.0": "https://raw.githubusercontent.com/iProov/ios/master/carthage/iProov_7_2_0.zip",
"7.2.1": "https://raw.githubusercontent.com/iProov/ios/master/carthage/iProov_7_2_1.zip",
"7.2.2": "https://raw.githubusercontent.com/iProov/ios/master/carthage/iProov_7_2_2.zip",
"7.3.0": "https://raw.githubusercontent.com/iProov/ios/master/carthage/iProov_7_3_0.zip",
}
Binary file added carthage/iProov_7_3_0.zip
Binary file not shown.
Binary file modified iProov.framework/Assets.car
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading

0 comments on commit fd95c82

Please sign in to comment.