release v2.0.0

BradenHancock · BradenHancock · commit 9ec28b89c620 · 2024-12-19T16:29:41.000Z
diff --git a/README.md b/README.md
@@ -1,23 +1,3 @@
-> **Warning**
-> 
-> **Starting June 2022, this repository is no longer being maintained.** The iProov iOS API Client is now made available directly as part of the [iProov iOS Biometrics SDK](https://github.com/iProov/ios).
->
-> You should upgrade your Podfile from:
-> 
-> ```
-> pod 'iProovAPIClient', :git => 'https://github.com/iProov/ios-api-client.git'
-> ```
->
-> to:
->
-> ```
-> pod 'iProovAPIClient', :podspec => 'https://raw.githubusercontent.com/iProov/ios/master/iProovAPIClient/iProovAPIClient.podspec'
-> ```
->
-> For further details, see the [Upgrade Guide for SDK v9.4](https://github.com/iProov/ios/wiki/Upgrade-Guide#api-client).
-
----
-
 # iProov iOS API Client
 
 ## Introduction
@@ -49,8 +29,6 @@ And then run `pod install`.
 - `validate()` - Validates an existing token.
 - `enrolPhotoAndGetVerifyToken()` - A helper function which chains together `getToken()` for the enrolment token, `enrolPhoto()` to enrol the photo, and then `getToken()` for the verify token, which you can then use to launch the SDK.
 
-You can find the API-calling code [here](https://github.com/iProov/swift-api-client/blob/master/iProovAPIClient/Classes/APIClient.swift).
-
 ## Example
 
 Example of using iProov API Client together with iProov to get a verify token for an existing user and then launch the iProov SDK to perform the verification using Genuine Presence Assurance:
diff --git a/_Pods.xcodeproj b/_Pods.xcodeproj
diff --git a/iProovAPIClient.podspec b/iProovAPIClient.podspec
@@ -1,12 +1,13 @@
 Pod::Spec.new do |s|
   s.name             = 'iProovAPIClient'
-  s.version          = '1.1.0'
+  s.version          = '2.0.0'
   s.summary          = 'iOS API Client for iProov REST API v2'
-  s.homepage         = 'https://github.com/iproov/ios-api-client'
-  s.license          = { :type => 'BSD-3', :file => 'LICENSE' }
+  s.homepage         = 'https://github.com/iProov/ios-api-client'
+  s.license          = { :type => 'BSD-3', :file => 'LICENSE.md' }
   s.author           = { 'iProov' => 'support@iproov.com' }
   s.source           = { :git => 'https://github.com/iProov/ios-api-client.git', :tag => s.version.to_s }
-  s.ios.deployment_target = '10.0'
+  s.swift_version = '5.5'
+  s.ios.deployment_target = '13.0'
   s.source_files = 'iProovAPIClient/Classes/**/*'
 
   s.dependency 'Alamofire', '~> 5.0'
diff --git a/iProovAPIClient/Assets/.gitkeep b/iProovAPIClient/Assets/.gitkeep
diff --git a/iProovAPIClient/Classes/APIClient.swift b/iProovAPIClient/Classes/APIClient.swift
@@ -1,13 +1,13 @@
-// Copyright (c) 2021 iProov Ltd. All rights reserved.
+// Copyright (c) 2024 iProov Ltd. All rights reserved.
 
 // ⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
 //    THIS CODE IS PROVIDED FOR DEMO PURPOSES ONLY AND SHOULD NOT BE USED IN
 //  PRODUCTION! YOU SHOULD NEVER EMBED YOUR CREDENTIALS IN A PUBLIC APP RELEASE!
 //      THESE API CALLS SHOULD ONLY EVER BE MADE FROM YOUR BACK-END SERVER
 // ⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️⚠️
 
-import Foundation
 import Alamofire
+import Foundation
 
 typealias JSON = [String: Any]
 
@@ -38,13 +38,13 @@ public class APIClient {
         public var errorDescription: String? {
             switch self {
             case .invalidImage:
-                return "Invalid image"
+                "Invalid image"
             case .noToken:
-                return "No token"
+                "No token"
             case .invalidJSON:
-                return "Invalid JSON"
+                "Invalid JSON"
             case let .serverError(errorDescription):
-                return errorDescription
+                errorDescription
             }
         }
     }
@@ -70,16 +70,17 @@ public class APIClient {
     public func getToken(assuranceType: AssuranceType,
                          type: ClaimType,
                          userID: String,
+                         resource: String? = nil,
                          additionalOptions: [String: Any] = [:],
-                         completion: @escaping (Result<String, Swift.Error>) -> Void) {
-
+                         completion: @escaping (Result<String, Swift.Error>) -> Void)
+    {
         let url = String(format: "%@/claim/%@/token", baseURL, type.rawValue)
 
         var params: [String: Any] = [
             "assurance_type": assuranceType.rawValue,
             "api_key": apiKey,
             "secret": secret,
-            "resource": appID,
+            "resource": resource ?? appID,
             "client": "ios",
             "user_id": userID,
         ]
@@ -89,15 +90,15 @@ public class APIClient {
         }
 
         AF.request(url, method: .post, parameters: params, encoding: JSONEncoding(), headers: nil)
-            .validate(statusCode: 200..<500)
+            .validate(statusCode: 200 ..< 500)
             .responseToken(completionHandler: completion)
     }
 
     public func enrolPhoto(token: String,
                            image: UIImage,
                            source: PhotoSource,
-                           completion: @escaping (Result<String, Swift.Error>) -> Void) {
-
+                           completion: @escaping (Result<String, Swift.Error>) -> Void)
+    {
         let url = String(format: "%@/claim/enrol/image", baseURL)
 
         guard let jpegData = image.safeJPEGData(compressionQuality: 1.0) else {
@@ -115,14 +116,14 @@ public class APIClient {
             multipartFormData.append(source.rawValue, withName: "source")
 
         }, to: url)
-        .validate(statusCode: 200..<500)
-        .responseToken(completionHandler: completion)
+            .validate(statusCode: 200 ..< 500)
+            .responseToken(completionHandler: completion)
     }
 
     public func validate(token: String,
                          userID: String,
-                         completion: @escaping (Result<ValidationResult, Swift.Error>) -> Void) {
-
+                         completion: @escaping (Result<ValidationResult, Swift.Error>) -> Void)
+    {
         let url = String(format: "%@/claim/verify/validate", baseURL)
 
         let params = [
@@ -132,16 +133,17 @@ public class APIClient {
             "token": token,
             "ip": "127.0.0.1",
             "client": appID,
+            "risk_profile": "",
         ]
 
         AF.request(url, method: .post, parameters: params, encoding: JSONEncoding(), headers: nil)
-            .validate(statusCode: 200..<500)
-            .responseJSON { response in
+            .validate(statusCode: 200 ..< 500)
+            .responseData { response in
 
                 switch response.result {
-                case let .success(json):
+                case let .success(data):
 
-                    guard let json = json as? JSON else {
+                    guard let json = try? JSONSerialization.jsonObject(with: data) as? JSON else {
                         completion(.failure(Error.invalidJSON))
                         return
                     }
@@ -162,12 +164,11 @@ public class APIClient {
 }
 
 public extension APIClient {
-
     private struct ErrorSink<T> {
         let failure: (Swift.Error) -> Void
 
         func onSuccess(_ next: @escaping (T) -> Void) -> (Result<T, Swift.Error>) -> Void {
-            return { result in
+            { result in
                 switch result {
                 case let .success(value):
                     next(value)
@@ -182,29 +183,26 @@ public extension APIClient {
     func enrolPhotoAndGetVerifyToken(userID: String,
                                      image: UIImage,
                                      source: PhotoSource,
-                                     completion: @escaping (Result<String, Swift.Error>) -> Void) {
-
+                                     completion: @escaping (Result<String, Swift.Error>) -> Void)
+    {
         let errorSink = ErrorSink<String> { completion(.failure($0)) }
 
         getToken(assuranceType: .genuinePresence, type: .enrol, userID: userID, completion: errorSink.onSuccess { token in
-            self.enrolPhoto(token: token, image: image, source: source, completion: errorSink.onSuccess { token in
+            self.enrolPhoto(token: token, image: image, source: source, completion: errorSink.onSuccess { _ in
                 self.getToken(assuranceType: .genuinePresence, type: .verify, userID: userID, completion: completion)
             })
         })
-
     }
 }
 
-extension DataRequest {
-
+public extension DataRequest {
     @discardableResult
-    public func responseToken(completionHandler: @escaping (Result<String, Swift.Error>) -> Void) -> Self {
-
-        responseJSON { response in
+    func responseToken(completionHandler: @escaping (Result<String, Swift.Error>) -> Void) -> Self {
+        responseData { response in
             switch response.result {
-            case let .success(json):
+            case let .success(data):
 
-                guard let json = json as? JSON else {
+                guard let json = try? JSONSerialization.jsonObject(with: data) as? JSON else {
                     completionHandler(.failure(APIClient.Error.invalidJSON))
                     return
                 }
@@ -225,6 +223,5 @@ extension DataRequest {
                 completionHandler(.failure(error))
             }
         }
-
     }
 }
diff --git a/iProovAPIClient/Classes/MultipartFormData+Append.swift b/iProovAPIClient/Classes/MultipartFormData+Append.swift
@@ -1,4 +1,4 @@
-// Copyright (c) 2021 iProov Ltd. All rights reserved.
+// Copyright (c) 2024 iProov Ltd. All rights reserved.
 
 import Alamofire
 import Foundation
diff --git a/iProovAPIClient/Classes/UIImage+Base64.swift b/iProovAPIClient/Classes/UIImage+Base64.swift
@@ -1,4 +1,4 @@
-// Copyright (c) 2021 iProov Ltd. All rights reserved.
+// Copyright (c) 2024 iProov Ltd. All rights reserved.
 
 import UIKit
 
diff --git a/iProovAPIClient/Classes/UIImage+JPEG.swift b/iProovAPIClient/Classes/UIImage+JPEG.swift
@@ -1,4 +1,4 @@
-// Copyright (c) 2021 iProov Ltd. All rights reserved.
+// Copyright (c) 2024 iProov Ltd. All rights reserved.
 
 import UIKit
 
@@ -11,8 +11,8 @@ extension UIImage {
             return jpegData(compressionQuality: compressionQuality)
         }
 
-        guard let ciImage = ciImage,
-            let cgImage = CIContext(options: nil).createCGImage(ciImage, from: ciImage.extent)
+        guard let ciImage,
+              let cgImage = CIContext(options: nil).createCGImage(ciImage, from: ciImage.extent)
         else { return nil }
 
         return UIImage(cgImage: cgImage).jpegData(compressionQuality: compressionQuality)
diff --git a/iProovAPIClient/Classes/ValidationResult.swift b/iProovAPIClient/Classes/ValidationResult.swift
@@ -1,27 +1,76 @@
-// Copyright (c) 2021 iProov Ltd. All rights reserved.
+// Copyright (c) 2024 iProov Ltd. All rights reserved.
 
 import Foundation
 
-public struct ValidationResult {
+public struct ValidationResult: CustomStringConvertible {
     public let isPassed: Bool
     public let token: String
+    public let type: String
+    public let isFrameAvailable: Bool?
     public let frame: UIImage?
     public let failureReason: String?
+    public let riskProfile: String?
+    public let assuranceType: String?
+    public let signals: [String: Any]?
+
+    enum Keys {
+        static let isPassed = "passed"
+        static let token = "token"
+        static let type = "type"
+        static let isFrameAvailable = "frame_available"
+        static let frame = "frame"
+        static let failureReason = "reason"
+        static let riskProfile = "risk_profile"
+        static let assuranceType = "assurance_type"
+        static let signals = "signals"
+    }
 
     init(json: JSON) {
-        isPassed = json["passed"] as! Bool
-        token = json["token"] as! String
-        if let frameBase64 = json["frame"] as? String {
+        isPassed = json[Keys.isPassed] as! Bool
+        token = json[Keys.token] as! String
+        type = json[Keys.type] as! String
+        isFrameAvailable = json[Keys.isFrameAvailable] as? Bool
+
+        if let frameBase64 = json[Keys.frame] as? String {
             frame = UIImage(base64String: frameBase64)
         } else {
             frame = nil
         }
 
-        if let resultJSON = json["result"] as? JSON {
-            failureReason = resultJSON["reason"] as? String
-        } else {
-            failureReason = nil
+        failureReason = json[Keys.failureReason] as? String
+        riskProfile = json[Keys.riskProfile] as? String
+        assuranceType = json[Keys.assuranceType] as? String
+        signals = json[Keys.signals] as? JSON
+    }
+
+    public var description: String {
+        var baseDescription =
+            """
+            Validation: \(isPassed)
+            \(Keys.token): \(token)
+            \(Keys.type): \(type)
+            """
+
+        if let isFrameAvailable {
+            baseDescription += "\n\(Keys.isFrameAvailable): \(isFrameAvailable)"
+        }
+
+        if let riskProfile {
+            baseDescription += "\n\(Keys.riskProfile): \(riskProfile)"
+        }
+
+        if let failureReason {
+            baseDescription += "\n\(Keys.failureReason): \(failureReason)"
+        }
+
+        if let assuranceType {
+            baseDescription += "\n\(Keys.assuranceType): \(assuranceType)"
+        }
+
+        if let signals {
+            baseDescription += "\n\(Keys.signals): \(signals)"
         }
 
+        return baseDescription
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) 2021 iProov Ltd. All rights reserved.`
	`1`	`+// Copyright (c) 2024 iProov Ltd. All rights reserved.`
`2`	`2`
`3`	`3`	`import Alamofire`
`4`	`4`	`import Foundation`