Merge pull request #1 from passageidentity/PSG-3965-passkey-readiness

Added tests for passkey readiness methods

Author: rickycpadilla

Package.swift

@@ -4,21 +4,21 @@
 import PackageDescription
 
 let package = Package(
-    name: "passage-authentikit-ios",
+    name: "Passage Authentikit",
     platforms: [.iOS(.v14), .macOS(.v10_13), .visionOS(.v1), .tvOS(.v13)],
     products: [
         // Products define the executables and libraries a package produces, making them visible to other packages.
         .library(
-            name: "passage-authentikit-ios",
-            targets: ["passage-authentikit-ios"]),
+            name: "Passage Authentikit",
+            targets: ["Authentikit"]),
     ],
     targets: [
         // Targets are the basic building blocks of a package, defining a module or a test suite.
         // Targets can depend on other targets in this package and products from dependencies.
         .target(
-            name: "passage-authentikit-ios"),
+            name: "Authentikit"),
         .testTarget(
             name: "passage-authentikit-iosTests",
-            dependencies: ["passage-authentikit-ios"]),
+            dependencies: ["Authentikit"]),
     ]
 )

Sources/passage-authentikit-ios/Authentikit.swift renamed to Sources/Authentikit/Authentikit.swift

@@ -4,7 +4,7 @@ public class Authentikit {
 
     public let passkey: Passkey
 
-    internal static let BASE_PATH = "https://auth-uat.passage.dev"
+    internal static var BASE_PATH = "https://auth.passage.id"
     internal static let PACKAGE_VERSION = "0.1.0"
 
     public init(clientSideKey: String) {

Sources/Authentikit/AuthentikitException.swift

@@ -0,0 +1,17 @@
+import Foundation
+
+public class AuthentikitException: Error, CustomStringConvertible {
+    public var message: String
+
+    public init(_ message: String) {
+        self.message = message
+    }
+    
+    public var description: String {
+        return message
+    }
+}
+
+public class PasskeyException: AuthentikitException {}
+
+public class PasskeyEvaluationException: PasskeyException {}

Sources/passage-authentikit-ios/Passkey.swift renamed to Sources/Authentikit/Passkey.swift

@@ -4,22 +4,23 @@ public class Passkey {
 
     private let clientSideKey: String
     private let userDefaults = UserDefaults.standard
-    private let lastEvaluationKey = "lastEvaluationDate"
+    private static let LAST_EVALUATION_KEY = "LAST_EVALUATION_KEY"
 
     init(clientSideKey: String) {
         self.clientSideKey = clientSideKey
     }
 
-    public func evaluateReadiness() async {
+    public func evaluateReadiness() async throws {
         guard canEvaluateReadiness() else {
-            print("❌ Evaluate readiness can only be called once in 24 hours.")
             return
         }
         let device = await UIDevice.current
+        let bundleId = Bundle.main.bundleIdentifier ?? ""
         let requestHeaders: [String : String] = await [
-            "app_identifier": Bundle.main.bundleIdentifier ?? "",
+            "app_identifier": bundleId,
             "device_os": device.systemName,
             "device_os_version": device.systemVersion,
+            "origin": bundleId,
             "Content-Type": "application/json",
             "Passage-Version": "Passage Authentikit iOS \(Authentikit.PACKAGE_VERSION)",
             "X-API-KEY": clientSideKey,
@@ -35,9 +36,11 @@ public class Passkey {
             "security_key": supportsPassekeys,
         ]
         let urlString = "\(Authentikit.BASE_PATH)/v1/analytics/passkey-readiness"
+        print(urlString)
+        print(requestHeaders)
+        print(requestBody)
         guard let url = URL(string: urlString) else {
-            print("❌ Failed evaluate passkey readiness.")
-            return
+            throw PasskeyEvaluationException("Could not initialize URL.")
         }
         var request = URLRequest(url: url)
         request.httpMethod = "POST"
@@ -47,30 +50,33 @@ public class Passkey {
         do {
             let jsonData = try JSONSerialization.data(withJSONObject: requestBody, options: [])
             request.httpBody = jsonData
-            let (data, response) = try await URLSession.shared.data(for: request)
+            let (_, response) = try await URLSession.shared.data(for: request)
             guard let httpResponse = response as? HTTPURLResponse,
                   (200...299).contains(httpResponse.statusCode)
             else {
-                print("❌ Failed evaluate passkey readiness.")
-                return
+                throw PasskeyEvaluationException("Network request failed.")
             }
             updateLastEvaluationDate()
-            print("✅ Successfully evaluated passkey readiness.")
+            return
         } catch {
-            print("❌ Failed evaluate passkey readiness.")
+            throw PasskeyEvaluationException(error.localizedDescription)
         }
 
     }
 
     private func canEvaluateReadiness() -> Bool {
-        if let lastEvaluationDate = userDefaults.object(forKey: lastEvaluationKey) as? Date {
+        if let lastEvaluationDate = userDefaults.object(forKey: Passkey.LAST_EVALUATION_KEY) as? Date {
             return Date().timeIntervalSince(lastEvaluationDate) > 24 * 60 * 60
         }
         return true
     }
 
     private func updateLastEvaluationDate() {
-        userDefaults.set(Date(), forKey: lastEvaluationKey)
+        userDefaults.set(Date(), forKey: Passkey.LAST_EVALUATION_KEY)
+    }
+    
+    internal func clearLastEvaluationDate() {
+        userDefaults.set(nil, forKey: Passkey.LAST_EVALUATION_KEY)
     }
 
 }

Sources/passage-authentikit-ios/Utilities.swift renamed to Sources/Authentikit/Utilities.swift

@@ -0,0 +1,35 @@
+import XCTest
+@testable import Authentikit
+
+final class AuthentikitTests: XCTestCase {
+    
+    static let VALID_KEY = "PLACEHOLDER_VALID_KEY"
+    static let INVALID_KEY = "INVALID_KEY"
+    
+    override class func setUp() {
+        super.setUp()
+        Authentikit.BASE_PATH = "https://auth-uat.passage.dev"
+    }
+    
+    override class func tearDown() {
+        super.tearDown()
+        let authentikit = Authentikit(clientSideKey: AuthentikitTests.VALID_KEY)
+        authentikit.passkey.clearLastEvaluationDate()
+    }
+    
+    func testValidClientKeySucceeds() async throws {
+        let authentikit = Authentikit(clientSideKey: AuthentikitTests.VALID_KEY)
+        try await authentikit.passkey.evaluateReadiness()
+        authentikit.passkey.clearLastEvaluationDate()
+    }
+    
+    func testInvalidClientKeyFails() async {
+        let authentikit = Authentikit(clientSideKey: AuthentikitTests.INVALID_KEY)
+        do {
+            try await authentikit.passkey.evaluateReadiness()
+            XCTFail("evaluateReadiness should fail with PasskeyEvaluationException")
+        } catch {
+            XCTAssertTrue(error is PasskeyEvaluationException)
+        }
+    }
+}