Merge branch 'trunk' into feat/5983-usecase-unit-tests

# Conflicts:
#	WooCommerce/Classes/ViewModels/CardPresentPayments/PaymentCaptureOrchestrator.swift
#	WooCommerce/WooCommerce.xcodeproj/project.pbxproj

Author: jaclync

Hardware/Hardware.xcodeproj/project.pbxproj

@@ -21,6 +21,7 @@
 		55CD4BB4273E617C007686D3 /* ReceiptRendererTest.swift in Sources */ = {isa = PBXBuildFile; fileRef = 55CD4BB3273E617C007686D3 /* ReceiptRendererTest.swift */; };
 		5A747BE9FA06EC8752A35752 /* Pods_HardwareTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = B1DC5B6141B8184FAC29B0A4 /* Pods_HardwareTests.framework */; };
 		8FFAA245E257B9EB98E2FCBD /* Pods_SampleReceiptPrinter.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 2AFA997D6786C67B0A061854 /* Pods_SampleReceiptPrinter.framework */; };
+		B9C4AB2327FDE133007008B8 /* Email.swift in Sources */ = {isa = PBXBuildFile; fileRef = B9C4AB2227FDE133007008B8 /* Email.swift */; };
 		C5D2CB7D21CEE28FEBF18BF6 /* Pods_Hardware.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = E9F0AC202B287C1221EA2C99 /* Pods_Hardware.framework */; platformFilter = ios; };
 		D80409A625FBE42B006F9BDA /* PaymentIntentParameters+Stripe.swift in Sources */ = {isa = PBXBuildFile; fileRef = D80409A525FBE42B006F9BDA /* PaymentIntentParameters+Stripe.swift */; };
 		D80B4652260E19590092EDC0 /* PaymentIntentParametersTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D80B4651260E19590092EDC0 /* PaymentIntentParametersTests.swift */; };
@@ -156,6 +157,7 @@
 		9726331F55A9621F2F887E13 /* Pods-Hardware.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Hardware.release.xcconfig"; path = "Target Support Files/Pods-Hardware/Pods-Hardware.release.xcconfig"; sourceTree = "<group>"; };
 		AE60F16D43C20AD4523A61A5 /* Pods-SampleReceiptPrinter.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-SampleReceiptPrinter.debug.xcconfig"; path = "Target Support Files/Pods-SampleReceiptPrinter/Pods-SampleReceiptPrinter.debug.xcconfig"; sourceTree = "<group>"; };
 		B1DC5B6141B8184FAC29B0A4 /* Pods_HardwareTests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_HardwareTests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
+		B9C4AB2227FDE133007008B8 /* Email.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Email.swift; sourceTree = "<group>"; };
 		C61D1642BE09D1A1AD6AA9FA /* Pods-HardwareTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-HardwareTests.release.xcconfig"; path = "Target Support Files/Pods-HardwareTests/Pods-HardwareTests.release.xcconfig"; sourceTree = "<group>"; };
 		C810BBAD03E7D4ECFD29D7AC /* Pods-SampleReceiptPrinter.release-alpha.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-SampleReceiptPrinter.release-alpha.xcconfig"; path = "Target Support Files/Pods-SampleReceiptPrinter/Pods-SampleReceiptPrinter.release-alpha.xcconfig"; sourceTree = "<group>"; };
 		D80409A525FBE42B006F9BDA /* PaymentIntentParameters+Stripe.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "PaymentIntentParameters+Stripe.swift"; sourceTree = "<group>"; };
@@ -426,6 +428,7 @@
 				D845BDC1262D98C400A3E40F /* CardBrand.swift */,
 				D845BDD9262DAADB00A3E40F /* PaymentMethod.swift */,
 				317975BF274EB1F9004357B1 /* DeclineReason.swift */,
+				B9C4AB2227FDE133007008B8 /* Email.swift */,
 			);
 			path = CardReader;
 			sourceTree = "<group>";
@@ -768,6 +771,7 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				B9C4AB2327FDE133007008B8 /* Email.swift in Sources */,
 				D845BE59262ED84000A3E40F /* AirPrintReceiptPrinterService.swift in Sources */,
 				317975C2274EBC1F004357B1 /* DeclineReason+Stripe.swift in Sources */,
 				D845BDB8262D97B300A3E40F /* ReceiptDetails.swift in Sources */,

Hardware/Hardware/CardReader/Email.swift

@@ -0,0 +1,31 @@
+/// A property wrapper to validate that a property is a valid email
+/// Property Wrappers can not throw, so
+/// what this wrapper does is return a nil when trying to set an invalid
+/// email address as a value of a property of type String.
+/// The reason to do this is add an extra layer of validation before passing
+/// an instance of PaymentIntentParameters to the Stripe Terminal SDK
+/// https://emailregex.com
+@propertyWrapper
+public struct Email<Value: StringProtocol> {
+    var value: Value?
+
+    public init(wrappedValue value: Value?) {
+        self.value = value
+    }
+
+    public var wrappedValue: Value? {
+        get {
+            return validate(email: value) ? value : nil
+        }
+        set {
+            value = newValue
+        }
+    }
+    private func validate(email: Value?) -> Bool {
+        guard let email = email else { return false }
+        // https://emailregex.com
+        let emailRegEx = "[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,64}"
+        let emailPred = NSPredicate(format: "SELF MATCHES %@", emailRegEx)
+        return emailPred.evaluate(with: email)
+    }
+}

Hardware/Hardware/CardReader/PaymentIntentParameters.swift

@@ -24,6 +24,10 @@ public struct PaymentIntentParameters {
     @StatementDescriptor
     public private(set) var statementDescription: String?
 
+    /// Email address that the receipt for the resulting payment will be sent to.
+    @Email
+    public private(set) var receiptEmail: String?
+
     /// Set of key-value pairs that you can attach to an object.
     /// This can be useful for storing additional information about the object in a structured format.
     public let metadata: [AnyHashable: Any]?
@@ -38,12 +42,14 @@ public struct PaymentIntentParameters {
                 currency: String,
                 receiptDescription: String? = nil,
                 statementDescription: String? = nil,
+                receiptEmail: String? = nil,
                 paymentMethodTypes: [String] = [],
                 metadata: [AnyHashable: Any]? = nil) {
         self.amount = amount
         self.currency = currency
         self.receiptDescription = receiptDescription
         self.statementDescription = statementDescription
+        self.receiptEmail = receiptEmail
         self.paymentMethodTypes = paymentMethodTypes
         self.metadata = metadata
     }

Hardware/Hardware/CardReader/StripeCardReader/PaymentIntentParameters+Stripe.swift

@@ -32,6 +32,7 @@ extension Hardware.PaymentIntentParameters {
             returnValue.statementDescriptor = descriptor
         }
 
+        returnValue.receiptEmail = receiptEmail
         returnValue.metadata = metadata
 
         return returnValue

Hardware/HardwareTests/PaymentIntentParametersTests.swift

@@ -2,6 +2,18 @@ import XCTest
 @testable import Hardware
 
 final class PaymentIntentParametersTests: XCTestCase {
+    func test_validEmail_is_saved() {
+        let params = PaymentIntentParameters(amount: 100, currency: "usd", receiptEmail: "[email protected]", paymentMethodTypes: ["card_present"])
+
+        XCTAssertNotNil(params.receiptEmail)
+    }
+
+    func test_not_validEmail_is_ignored() {
+        let params = PaymentIntentParameters(amount: 100, currency: "usd", receiptEmail: "woocommerce", paymentMethodTypes: ["card_present"])
+
+        XCTAssertNil(params.receiptEmail)
+    }
+
     func test_currency_is_lowercased() {
         let params = PaymentIntentParameters(amount: 100, currency: "USD", paymentMethodTypes: ["card_present"])
 

WooCommerce/Classes/Tools/PaymentsPluginsDataProvider.swift

@@ -0,0 +1,86 @@
+import Yosemite
+import Foundation
+import Storage
+
+/// Provides data and helper methods related to the Payments Plugins (WCPay, Stripe).
+/// It extracts the information from the provided `StorageManagerType`, but please notice that it does not
+/// take care of syncing the data, so it should be done beforehand.
+///
+protocol CardPresentPluginsDataProviderProtocol {
+    func getWCPayPlugin() -> Yosemite.SystemPlugin?
+    func getStripePlugin() -> Yosemite.SystemPlugin?
+    func bothPluginsInstalledAndActive(wcPay: Yosemite.SystemPlugin?, stripe: Yosemite.SystemPlugin?) -> Bool
+    func wcPayInstalledAndActive(wcPay: Yosemite.SystemPlugin?) -> Bool
+    func stripeInstalledAndActive(stripe: Yosemite.SystemPlugin?) -> Bool
+    func isWCPayVersionSupported(plugin: Yosemite.SystemPlugin) -> Bool
+    func isStripeVersionSupported(plugin: Yosemite.SystemPlugin) -> Bool
+}
+
+struct CardPresentPluginsDataProvider: CardPresentPluginsDataProviderProtocol {
+    private let storageManager: StorageManagerType
+    private let stores: StoresManager
+
+    init(
+        storageManager: StorageManagerType = ServiceLocator.storageManager,
+        stores: StoresManager = ServiceLocator.stores
+    ) {
+        self.storageManager = storageManager
+        self.stores = stores
+    }
+
+    private var siteID: Int64? {
+        stores.sessionManager.defaultStoreID
+    }
+
+    func getWCPayPlugin() -> Yosemite.SystemPlugin? {
+        guard let siteID = siteID else {
+            return nil
+        }
+        return storageManager.viewStorage
+            .loadSystemPlugin(siteID: siteID, name: CardPresentPaymentsPlugins.wcPay.pluginName)?
+            .toReadOnly()
+    }
+
+    func getStripePlugin() -> Yosemite.SystemPlugin? {
+        guard let siteID = siteID else {
+            return nil
+        }
+        return storageManager.viewStorage
+            .loadSystemPlugin(siteID: siteID, name: CardPresentPaymentsPlugins.stripe.pluginName)?
+            .toReadOnly()
+    }
+
+    func bothPluginsInstalledAndActive(wcPay: Yosemite.SystemPlugin?, stripe: Yosemite.SystemPlugin?) -> Bool {
+        guard let wcPay = wcPay, let stripe = stripe else {
+            return false
+        }
+
+        return wcPay.active && stripe.active
+    }
+
+    func wcPayInstalledAndActive(wcPay: Yosemite.SystemPlugin?) -> Bool {
+        // If the WCPay plugin is not installed, immediately return false
+        guard let wcPay = wcPay else {
+            return false
+        }
+
+        return wcPay.active
+    }
+
+    func stripeInstalledAndActive(stripe: Yosemite.SystemPlugin?) -> Bool {
+        // If the Stripe plugin is not installed, immediately return false
+        guard let stripe = stripe else {
+            return false
+        }
+
+        return stripe.active
+    }
+
+    func isWCPayVersionSupported(plugin: Yosemite.SystemPlugin) -> Bool {
+        VersionHelpers.isVersionSupported(version: plugin.version, minimumRequired: CardPresentPaymentsPlugins.wcPay.minimumSupportedPluginVersion)
+    }
+
+    func isStripeVersionSupported(plugin: Yosemite.SystemPlugin) -> Bool {
+        VersionHelpers.isVersionSupported(version: plugin.version, minimumRequired: CardPresentPaymentsPlugins.stripe.minimumSupportedPluginVersion)
+    }
+}

WooCommerce/Classes/ViewModels/CardPresentPayments/PaymentCaptureOrchestrator.swift

@@ -19,6 +19,7 @@ struct CardPresentCapturedPaymentData {
 final class PaymentCaptureOrchestrator {
     private let currencyFormatter = CurrencyFormatter(currencySettings: ServiceLocator.currencySettings)
     private let personNameComponentsFormatter = PersonNameComponentsFormatter()
+    private let paymentReceiptEmailParameterDeterminer = PaymentReceiptEmailParameterDeterminer()
 
     private let celebration = PaymentCaptureCelebration()
 
@@ -51,47 +52,50 @@ final class PaymentCaptureOrchestrator {
 
         stores.dispatch(setAccount)
 
-        guard let parameters = paymentParameters(
+        paymentParameters(
                 order: order,
                 statementDescriptor: paymentGatewayAccount.statementDescriptor,
                 paymentMethodTypes: paymentMethodTypes
-        ) else {
-            DDLogError("Error: failed to create payment parameters for an order")
-            onCompletion(.failure(CardReaderServiceError.paymentCapture()))
-            return
-        }
+        ) { [weak self] result in
+            guard let self = self else { return }
 
-        /// Briefly suppress pass (wallet) presentation so that the merchant doesn't attempt to pay for the buyer's order when the
-        /// reader begins to collect payment.
-        ///
-        suppressPassPresentation()
-
-        let paymentAction = CardPresentPaymentAction.collectPayment(
-            siteID: order.siteID,
-            orderID: order.orderID,
-            parameters: parameters,
-            onCardReaderMessage: { (event) in
-                switch event {
-                case .waitingForInput:
-                    onWaitingForInput()
-                case .displayMessage(let message):
-                    onDisplayMessage(message)
-                default:
-                    break
-                }
-            },
-            onCompletion: { [weak self] result in
-                self?.allowPassPresentation()
-                onProcessingMessage()
-                self?.completePaymentIntentCapture(
-                    order: order,
-                    captureResult: result,
-                    onCompletion: onCompletion
+            switch result {
+            case let .success(parameters):
+                /// Briefly suppress pass (wallet) presentation so that the merchant doesn't attempt to pay for the buyer's order when the
+                /// reader begins to collect payment.
+                ///
+                self.suppressPassPresentation()
+
+                let paymentAction = CardPresentPaymentAction.collectPayment(
+                    siteID: order.siteID,
+                    orderID: order.orderID,
+                    parameters: parameters,
+                    onCardReaderMessage: { (event) in
+                        switch event {
+                        case .waitingForInput:
+                            onWaitingForInput()
+                        case .displayMessage(let message):
+                            onDisplayMessage(message)
+                        default:
+                            break
+                        }
+                    },
+                    onCompletion: { [weak self] result in
+                        self?.allowPassPresentation()
+                        onProcessingMessage()
+                        self?.completePaymentIntentCapture(
+                            order: order,
+                            captureResult: result,
+                            onCompletion: onCompletion
+                        )
+                    }
                 )
-            }
-        )
 
-        stores.dispatch(paymentAction)
+                self.stores.dispatch(paymentAction)
+            case let .failure(error):
+                onCompletion(Result.failure(error))
+             }
+        }
     }
 
     func cancelPayment(onCompletion: @escaping (Result<Void, Error>) -> Void) {
@@ -216,27 +220,44 @@ private extension PaymentCaptureOrchestrator {
         stores.dispatch(action)
     }
 
-    func paymentParameters(order: Order, statementDescriptor: String?, paymentMethodTypes: [String]) -> PaymentParameters? {
+    func paymentParameters(order: Order,
+                           statementDescriptor: String?,
+                           paymentMethodTypes: [String],
+                           onCompletion: @escaping ((Result<PaymentParameters, Error>) -> Void)) {
         guard let orderTotal = currencyFormatter.convertToDecimal(from: order.total) else {
             DDLogError("Error: attempted to collect payment for an order without a valid total.")
-            return nil
+            onCompletion(Result.failure(NotValidAmountError.other))
+
+            return
         }
 
-        let metadata = PaymentIntent.initMetadata(
-            store: stores.sessionManager.defaultSite?.name,
-            customerName: buildCustomerNameFromBillingAddress(order.billingAddress),
-            customerEmail: order.billingAddress?.email,
-            siteURL: stores.sessionManager.defaultSite?.url,
-            orderID: order.orderID,
-            paymentType: PaymentIntent.PaymentTypes.single
-        )
-
-        return PaymentParameters(amount: orderTotal as Decimal,
-                                 currency: order.currency,
-                                 receiptDescription: receiptDescription(orderNumber: order.number),
-                                 statementDescription: statementDescriptor,
-                                 paymentMethodTypes: paymentMethodTypes,
-                                 metadata: metadata)
+        paymentReceiptEmailParameterDeterminer.receiptEmail(from: order) { [weak self] result in
+            guard let self = self else { return }
+
+            var receiptEmail: String?
+            if case let .success(email) = result {
+                receiptEmail = email
+            }
+
+            let metadata = PaymentIntent.initMetadata(
+                store: self.stores.sessionManager.defaultSite?.name,
+                customerName: self.buildCustomerNameFromBillingAddress(order.billingAddress),
+                customerEmail: order.billingAddress?.email,
+                siteURL: self.stores.sessionManager.defaultSite?.url,
+                orderID: order.orderID,
+                paymentType: PaymentIntent.PaymentTypes.single
+            )
+
+            let parameters = PaymentParameters(amount: orderTotal as Decimal,
+                                               currency: order.currency,
+                                               receiptDescription: self.receiptDescription(orderNumber: order.number),
+                                               statementDescription: statementDescriptor,
+                                               receiptEmail: receiptEmail,
+                                               paymentMethodTypes: paymentMethodTypes,
+                                               metadata: metadata)
+
+            onCompletion(Result.success(parameters))
+        }
     }
 
     func receiptDescription(orderNumber: String) -> String? {