TrustedEntitlements: new VerificationResult.isVerified (#2788)

The documentation was slightly updated, because we also need to accept `.verifiedOnDevice`.
RevenueCat · Jul 11, 2023 · be5ce74 · be5ce74
1 parent b798114
commit be5ce74
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 1 deletion.
diff --git a/RevenueCat.xcodeproj/project.pbxproj b/RevenueCat.xcodeproj/project.pbxproj
@@ -208,6 +208,7 @@
 		4F2018732A15797D0061F6EF /* TestLogHandler.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57057FF728B0048900995F21 /* TestLogHandler.swift */; };
 		4F2F2EFF2A3CDAA800652B24 /* FileHandler.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4F2F2EFE2A3CDAA800652B24 /* FileHandler.swift */; };
 		4F2F2F142A3CEAB500652B24 /* FileHandlerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4F2F2F132A3CEAB500652B24 /* FileHandlerTests.swift */; };
+		4F34AEEC2A5DCCBA00F4BCB0 /* VerificationResultTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4F34AEEB2A5DCCBA00F4BCB0 /* VerificationResultTests.swift */; };
 		4F3C986A2A44FA60009AECA3 /* ErrorResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4F3C98692A44FA60009AECA3 /* ErrorResponse.swift */; };
 		4F3D56632A1E66A10070105A /* CustomerInfoManagerPostReceiptTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4F3D56622A1E66A10070105A /* CustomerInfoManagerPostReceiptTests.swift */; };
 		4F4FF3E12A3B731A0028018C /* ETagStrings.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4F4FF3E02A3B731A0028018C /* ETagStrings.swift */; };
@@ -935,6 +936,7 @@
 		4F2017D42A15587F0061F6EF /* OfflineStoreKitIntegrationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OfflineStoreKitIntegrationTests.swift; sourceTree = "<group>"; };
 		4F2F2EFE2A3CDAA800652B24 /* FileHandler.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileHandler.swift; sourceTree = "<group>"; };
 		4F2F2F132A3CEAB500652B24 /* FileHandlerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileHandlerTests.swift; sourceTree = "<group>"; };
+		4F34AEEB2A5DCCBA00F4BCB0 /* VerificationResultTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = VerificationResultTests.swift; sourceTree = "<group>"; };
 		4F3C98692A44FA60009AECA3 /* ErrorResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ErrorResponse.swift; sourceTree = "<group>"; };
 		4F3D56622A1E66A10070105A /* CustomerInfoManagerPostReceiptTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CustomerInfoManagerPostReceiptTests.swift; sourceTree = "<group>"; };
 		4F4FF3E02A3B731A0028018C /* ETagStrings.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ETagStrings.swift; sourceTree = "<group>"; };
@@ -2454,6 +2456,7 @@
 			isa = PBXGroup;
 			children = (
 				57E6C27D29723F9E001AFE98 /* SigningTests.swift */,
+				4F34AEEB2A5DCCBA00F4BCB0 /* VerificationResultTests.swift */,
 			);
 			path = Security;
 			sourceTree = "<group>";
@@ -3490,6 +3493,7 @@
 				351B515C26D44B7900BD2BD7 /* MockIntroEligibilityCalculator.swift in Sources */,
 				5733D01128D00354008638D8 /* PromotionalOfferTests.swift in Sources */,
 				57544C28285FA94B004E54D5 /* MockAttributeSyncing.swift in Sources */,
+				4F34AEEC2A5DCCBA00F4BCB0 /* VerificationResultTests.swift in Sources */,
 				57DE80802807529F008D6C6F /* MockStorefront.swift in Sources */,
 				5759B464296E1A4B002472D5 /* MockBundle.swift in Sources */,
 				35D83312262FBD4200E60AC5 /* MockETagManager.swift in Sources */,

diff --git a/Sources/Security/VerificationResult.swift b/Sources/Security/VerificationResult.swift
@@ -31,7 +31,7 @@ import Foundation
 /// )
 ///
 /// let customerInfo = try await purchases.customerInfo()
-/// if customerInfo.entitlements.verification != .verified {
+/// if !customerInfo.entitlements.verification.isVerified {
 ///   print("Entitlements could not be verified")
 /// }
 /// ```
@@ -68,6 +68,20 @@ public enum VerificationResult: Int {
 
 extension VerificationResult: Sendable, Codable {}
 
+extension VerificationResult {
+
+    /// Whether the result is ``VerificationResult/verified`` or ``VerificationResult/verifiedOnDevice``.
+    public var isVerified: Bool {
+        switch self {
+        case .verified, .verifiedOnDevice:
+            return true
+        case .notRequested, .failed:
+            return false
+        }
+    }
+
+}
+
 extension VerificationResult: DefaultValueProvider {
 
     static let defaultValue: Self = .notRequested

diff --git a/Tests/APITesters/SwiftAPITester/SwiftAPITester/VerificationResultAPI.swift b/Tests/APITesters/SwiftAPITester/SwiftAPITester/VerificationResultAPI.swift
@@ -10,6 +10,8 @@ import RevenueCat
 
 func checkVerificationResultAPI(_ mode: EntitlementVerificationMode = .disabled,
                                 _ result: VerificationResult = .notRequested) {
+    let _: Bool = result.isVerified
+
     switch mode {
     case .disabled,
             .informational,

diff --git a/Tests/UnitTests/Security/VerificationResultTests.swift b/Tests/UnitTests/Security/VerificationResultTests.swift
@@ -0,0 +1,28 @@
+//
+//  Copyright RevenueCat Inc. All Rights Reserved.
+//
+//  Licensed under the MIT License (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//      https://opensource.org/licenses/MIT
+//
+//  VerificationResultTests.swift
+//
+//  Created by Nacho Soto on 7/11/23.
+
+import Nimble
+import XCTest
+
+@testable import RevenueCat
+
+class VerificationResultTests: TestCase {
+
+    func testIsVerified() {
+        expect(VerificationResult.notRequested.isVerified) == false
+        expect(VerificationResult.failed.isVerified) == false
+        expect(VerificationResult.verified.isVerified) == true
+        expect(VerificationResult.verifiedOnDevice.isVerified) == true
+    }
+
+}