Merge branch 'develop' into issue/5296-order-fields-param

Author: jaclync

Hardware/Hardware/CardReader/CardReaderServiceError.swift

@@ -186,6 +186,9 @@ public enum UnderlyingError: Error {
     /// The SDK will attempt to auto-disconnect for you and you should instruct your user to reconnect it.
     case readerSessionExpired
 
+    /// The underlying request returned an API error.
+    case processorAPIError
+
     /// Catch-all error case. Indicates there is something wrong with the
     /// internal state of the CardReaderService.
     case internalServiceError
@@ -305,6 +308,9 @@ updating the application or using a different reader
         case .readerSessionExpired:
             return NSLocalizedString("The card reader session has expired - please disconnect and reconnect the card reader and then try again",
                                      comment: "Error message when the card reader session has timed out.")
+        case .processorAPIError:
+            return NSLocalizedString("The payment can not be processed by the payment processor.",
+                                     comment: "Error message when the payment can not be processed (i.e. order amount is below the minimum amount allowed.)")
         case .internalServiceError:
             return NSLocalizedString("Sorry, this payment couldn’t be processed",
                                      comment: "Error message when the card reader service experiences an unexpected internal service error.")

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

@@ -79,6 +79,8 @@ extension UnderlyingError {
             self = .requestTimedOut
         case ErrorCode.Code.sessionExpired.rawValue:
             self = .readerSessionExpired
+        case ErrorCode.Code.stripeAPIError.rawValue:
+            self = .processorAPIError
         default:
             self = .internalServiceError
         }

Hardware/HardwareTests/ErrorCodesTests.swift

@@ -154,6 +154,10 @@ final class CardReaderServiceErrorTests: XCTestCase {
         XCTAssertEqual(.readerSessionExpired, domainError(stripeCode: 9060))
     }
 
+    func test_stripe_error_api_maps_to_stripeAPI() {
+        XCTAssertEqual(.processorAPIError, domainError(stripeCode: 9020))
+    }
+
     func test_stripe_catch_all_error() {
         // Any error code not mapped to an specific error will be
         // mapped to `internalServiceError`

Networking/Networking.xcodeproj/project.pbxproj

@@ -142,6 +142,9 @@
 		31104E142630DDA700587C1E /* wcpay-account-wrong-json.json in Resources */ = {isa = PBXBuildFile; fileRef = 31104E132630DDA700587C1E /* wcpay-account-wrong-json.json */; };
 		311976E02602BD4B006AC56C /* SitePluginsMapperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 311976DF2602BD4B006AC56C /* SitePluginsMapperTests.swift */; };
 		314703082670222500EF253A /* PaymentGatewayAccount.swift in Sources */ = {isa = PBXBuildFile; fileRef = 314703072670222500EF253A /* PaymentGatewayAccount.swift */; };
+		3158A49F2729F3F600C3CFA8 /* wcpay-account-live-live.json in Resources */ = {isa = PBXBuildFile; fileRef = 3158A49E2729F3F600C3CFA8 /* wcpay-account-live-live.json */; };
+		3158A4A12729F40F00C3CFA8 /* wcpay-account-live-test.json in Resources */ = {isa = PBXBuildFile; fileRef = 3158A4A02729F40F00C3CFA8 /* wcpay-account-live-test.json */; };
+		3158A4A32729F42500C3CFA8 /* wcpay-account-dev-test.json in Resources */ = {isa = PBXBuildFile; fileRef = 3158A4A22729F42500C3CFA8 /* wcpay-account-dev-test.json */; };
 		3158FE6026129ADD00E566B9 /* wcpay-account-none.json in Resources */ = {isa = PBXBuildFile; fileRef = 3158FE5F26129ADD00E566B9 /* wcpay-account-none.json */; };
 		3158FE6426129B1300E566B9 /* wcpay-account-complete.json in Resources */ = {isa = PBXBuildFile; fileRef = 3158FE6326129B1300E566B9 /* wcpay-account-complete.json */; };
 		3158FE6826129CE200E566B9 /* wcpay-account-rejected-fraud.json in Resources */ = {isa = PBXBuildFile; fileRef = 3158FE6726129CE200E566B9 /* wcpay-account-rejected-fraud.json */; };
@@ -704,6 +707,9 @@
 		31104E132630DDA700587C1E /* wcpay-account-wrong-json.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "wcpay-account-wrong-json.json"; sourceTree = "<group>"; };
 		311976DF2602BD4B006AC56C /* SitePluginsMapperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SitePluginsMapperTests.swift; sourceTree = "<group>"; };
 		314703072670222500EF253A /* PaymentGatewayAccount.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PaymentGatewayAccount.swift; sourceTree = "<group>"; };
+		3158A49E2729F3F600C3CFA8 /* wcpay-account-live-live.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "wcpay-account-live-live.json"; sourceTree = "<group>"; };
+		3158A4A02729F40F00C3CFA8 /* wcpay-account-live-test.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "wcpay-account-live-test.json"; sourceTree = "<group>"; };
+		3158A4A22729F42500C3CFA8 /* wcpay-account-dev-test.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "wcpay-account-dev-test.json"; sourceTree = "<group>"; };
 		3158FE5F26129ADD00E566B9 /* wcpay-account-none.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "wcpay-account-none.json"; sourceTree = "<group>"; };
 		3158FE6326129B1300E566B9 /* wcpay-account-complete.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "wcpay-account-complete.json"; sourceTree = "<group>"; };
 		3158FE6726129CE200E566B9 /* wcpay-account-rejected-fraud.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "wcpay-account-rejected-fraud.json"; sourceTree = "<group>"; };
@@ -1707,6 +1713,9 @@
 				318E8FD826C324D900F519D7 /* wcpay-customer-error.json */,
 				3158FE5F26129ADD00E566B9 /* wcpay-account-none.json */,
 				3158FE6326129B1300E566B9 /* wcpay-account-complete.json */,
+				3158A49E2729F3F600C3CFA8 /* wcpay-account-live-live.json */,
+				3158A4A22729F42500C3CFA8 /* wcpay-account-dev-test.json */,
+				3158A4A02729F40F00C3CFA8 /* wcpay-account-live-test.json */,
 				31B8D6B326583662008E3DB2 /* wcpay-account-not-eligible.json */,
 				3158FE6726129CE200E566B9 /* wcpay-account-rejected-fraud.json */,
 				3158FE6B26129D2E00E566B9 /* wcpay-account-rejected-terms-of-service.json */,
@@ -2083,6 +2092,7 @@
 				31054734262E36AB00C5C02B /* wcpay-payment-intent-error.json in Resources */,
 				45ED4F12239E8C57004F1BE3 /* taxes-classes.json in Resources */,
 				B5A2417B217F98FC00595DEF /* broken-notifications.json in Resources */,
+				3158A4A32729F42500C3CFA8 /* wcpay-account-dev-test.json in Resources */,
 				31104E142630DDA700587C1E /* wcpay-account-wrong-json.json in Resources */,
 				3158FE7C26129E2100E566B9 /* wcpay-account-restricted-pending.json in Resources */,
 				D823D91422377EE600C90817 /* shipment_tracking_providers.json in Resources */,
@@ -2142,6 +2152,7 @@
 				74C947862193A6C70024CB60 /* comment-moderate-unapproved.json in Resources */,
 				3105472C262E303400C5C02B /* wcpay-payment-intent-unknown-status.json in Resources */,
 				B559EBAA20A0B5CD00836CD4 /* orders-load-all.json in Resources */,
+				3158A4A12729F40F00C3CFA8 /* wcpay-account-live-test.json in Resources */,
 				74C8F06620EEB76400B6EDC9 /* order-notes.json in Resources */,
 				7426CA1321AF34A3004E9FFC /* site-api.json in Resources */,
 				453305ED2459E1AA00264E50 /* site-post.json in Resources */,
@@ -2207,6 +2218,7 @@
 				74ABA1CB213F19FE00FFAD30 /* top-performers-week.json in Resources */,
 				456930AD2652AF00009ED69D /* shipping-label-carriers-and-rates-success.json in Resources */,
 				B524194721AC643900D6FC0A /* device-settings.json in Resources */,
+				3158A49F2729F3F600C3CFA8 /* wcpay-account-live-live.json in Resources */,
 				318E8FD926C324D900F519D7 /* wcpay-customer-error.json in Resources */,
 				CEF88DAB233E911A00BED485 /* order-fully-refunded.json in Resources */,
 				02698CFA24C188E9005337C4 /* product-variations-load-all-alternative-types.json in Resources */,

Networking/Networking/Model/Product/ProductCategory.swift

@@ -27,12 +27,12 @@ public struct ProductCategory: Codable, Equatable, GeneratedFakeable {
     /// Public initializer for ProductCategory.
     ///
     public init(from decoder: Decoder) throws {
-        guard let siteID = decoder.userInfo[.siteID] as? Int64 else {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        guard let siteID = ProductCategory.siteID(from: decoder, container: container) else {
             throw ProductCategoryDecodingError.missingSiteID
         }
 
-        let container = try decoder.container(keyedBy: CodingKeys.self)
-
         let categoryID = try container.decode(Int64.self, forKey: .categoryID)
         // Some product endpoints don't include the parent category ID
         let parentID = container.failsafeDecodeIfPresent(Int64.self, forKey: .parentID) ?? 0
@@ -48,6 +48,8 @@ public struct ProductCategory: Codable, Equatable, GeneratedFakeable {
         try container.encode(categoryID, forKey: .categoryID)
         try container.encode(name, forKey: .name)
         try container.encode(slug, forKey: .slug)
+        try container.encode(siteID, forKey: .siteID)
+        try container.encode(parentID, forKey: .parentID)
     }
 }
 
@@ -56,13 +58,30 @@ public struct ProductCategory: Codable, Equatable, GeneratedFakeable {
 ///
 private extension ProductCategory {
     enum CodingKeys: String, CodingKey {
+        case siteID     = "siteID"
         case categoryID = "id"
         case name       = "name"
         case slug       = "slug"
         case parentID   = "parent"
     }
 }
 
+private extension ProductCategory {
+    /// Provides the siteID, that can be found as a encoded value or in the Decoder user info
+    ///
+    private static func siteID(from decoder: Decoder, container: KeyedDecodingContainer<ProductCategory.CodingKeys>) -> Int64? {
+        var siteID: Int64?
+
+        if let userInfoSiteID = decoder.userInfo[.siteID] as? Int64 {
+            siteID = userInfoSiteID
+        } else if let decodedSiteID = try? container.decode(Int64.self, forKey: .siteID) {
+            siteID = decodedSiteID
+        }
+
+        return siteID
+    }
+}
+
 
 // MARK: - Comparable Conformance
 //

Networking/Networking/Model/WCPayAccount.swift

@@ -4,6 +4,13 @@ public struct WCPayAccount: Decodable {
     public static let gatewayID = "woocommerce-payments"
 
     public let status: WCPayAccountStatusEnum
+    /// Indicates whether the payment gateway is a live account that can accept actual payments, or just a test/developer account.
+    /// Not to be confused with "test mode" which is a separate concept (see `isInTestMode`)
+    ///
+    public let isLiveAccount: Bool
+    /// Indicates whether the payment gateway is currently in "Test" or "Debug" mode
+    ///
+    public let isInTestMode: Bool
     public let hasPendingRequirements: Bool
     public let hasOverdueRequirements: Bool
     public let currentDeadline: Date?
@@ -22,6 +29,8 @@ public struct WCPayAccount: Decodable {
 
     public init(
         status: WCPayAccountStatusEnum,
+        isLiveAccount: Bool,
+        isInTestMode: Bool,
         hasPendingRequirements: Bool,
         hasOverdueRequirements: Bool,
         currentDeadline: Date?,
@@ -32,6 +41,8 @@ public struct WCPayAccount: Decodable {
         isCardPresentEligible: Bool
     ) {
         self.status = status
+        self.isLiveAccount = isLiveAccount
+        self.isInTestMode = isInTestMode
         self.hasPendingRequirements = hasPendingRequirements
         self.hasOverdueRequirements = hasOverdueRequirements
         self.currentDeadline = currentDeadline
@@ -47,6 +58,8 @@ public struct WCPayAccount: Decodable {
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         let status = try container.decode(WCPayAccountStatusEnum.self, forKey: .status)
+        let isLiveAccount = try container.decode(Bool.self, forKey: .isLive)
+        let isInTestMode = try container.decode(Bool.self, forKey: .testMode)
         let hasPendingRequirements = try container.decode(Bool.self, forKey: .hasPendingRequirements)
         let hasOverdueRequirements = try container.decode(Bool.self, forKey: .hasOverdueRequirements)
         let currentDeadline = try container.decodeIfPresent(Date.self, forKey: .currentDeadline)
@@ -60,6 +73,8 @@ public struct WCPayAccount: Decodable {
 
         self.init(
             status: status,
+            isLiveAccount: isLiveAccount,
+            isInTestMode: isInTestMode,
             hasPendingRequirements: hasPendingRequirements,
             hasOverdueRequirements: hasOverdueRequirements,
             currentDeadline: currentDeadline,
@@ -75,6 +90,8 @@ public struct WCPayAccount: Decodable {
 public extension WCPayAccount {
     static let noAccount = WCPayAccount(
         status: .noAccount,
+        isLiveAccount: false,
+        isInTestMode: false,
         hasPendingRequirements: false,
         hasOverdueRequirements: false,
         currentDeadline: nil,
@@ -89,17 +106,19 @@ public extension WCPayAccount {
 private extension WCPayAccount {
     enum CodingKeys: String, CodingKey {
         case status = "status"
+        case isLive = "is_live"
+        case testMode = "test_mode"
         case hasPendingRequirements = "has_pending_requirements"
         case hasOverdueRequirements = "has_overdue_requirements"
         case currentDeadline = "current_deadline"
         case statementDescriptor = "statement_descriptor"
         case storeCurrencies = "store_currencies"
-        case country = "country"
+        case country
         case cardPresentEligible = "card_present_eligible"
     }
 
     enum CurrencyCodingKeys: String, CodingKey {
         case defaultCurrency = "default"
-        case supported = "supported"
+        case supported
     }
 }

Networking/Networking/Remote/ProductsRemote.swift

@@ -16,6 +16,7 @@ public protocol ProductsRemoteProtocol {
                          stockStatus: ProductStockStatus?,
                          productStatus: ProductStatus?,
                          productType: ProductType?,
+                         productCategory: ProductCategory?,
                          orderBy: ProductsRemote.OrderKey,
                          order: ProductsRemote.Order,
                          excludedProductIDs: [Int64],
@@ -104,16 +105,19 @@ public final class ProductsRemote: Remote, ProductsRemoteProtocol {
                                 stockStatus: ProductStockStatus? = nil,
                                 productStatus: ProductStatus? = nil,
                                 productType: ProductType? = nil,
+                                productCategory: ProductCategory? = nil,
                                 orderBy: OrderKey = .name,
                                 order: Order = .ascending,
                                 excludedProductIDs: [Int64] = [],
                                 completion: @escaping (Result<[Product], Error>) -> Void) {
         let stringOfExcludedProductIDs = excludedProductIDs.map { String($0) }
             .joined(separator: ",")
+
         let filterParameters = [
             ParameterKey.stockStatus: stockStatus?.rawValue ?? "",
             ParameterKey.productStatus: productStatus?.rawValue ?? "",
             ParameterKey.productType: productType?.rawValue ?? "",
+            ParameterKey.category: filterProductCategoryParemeterValue(from: productCategory),
             ParameterKey.exclude: stringOfExcludedProductIDs
             ].filter({ $0.value.isEmpty == false })
 
@@ -298,6 +302,7 @@ public extension ProductsRemote {
         static let productStatus: String = "status"
         static let productType: String = "type"
         static let stockStatus: String = "stock_status"
+        static let category: String   = "category"
         static let fields: String     = "_fields"
     }
 
@@ -306,6 +311,18 @@ public extension ProductsRemote {
     }
 }
 
+private extension ProductsRemote {
+    /// Returns the category Id in string format, or empty string if the product category is nil
+    ///
+    func filterProductCategoryParemeterValue(from productCategory: ProductCategory?) -> String {
+        guard let productCategory = productCategory else {
+            return ""
+        }
+
+        return String(productCategory.categoryID)
+    }
+}
+
 private extension ProductsRemote.OrderKey {
     var value: String {
         switch self {

Networking/NetworkingTests/Remote/WCPayRemoteTests.swift

@@ -310,6 +310,63 @@ final class WCPayRemoteTests: XCTestCase {
         XCTAssertTrue(error is DecodingError)
     }
 
+    /// Properly decodes live account in live mode wcpay-account-live-live
+    ///
+    func test_loadAccount_properly_handles_live_account_in_live_mode() throws {
+        let remote = WCPayRemote(network: network)
+
+        network.simulateResponse(requestUrlSuffix: "payments/accounts", filename: "wcpay-account-live-live")
+
+        let result: Result<WCPayAccount, Error> = waitFor { promise in
+            remote.loadAccount(for: self.sampleSiteID) { result in
+                promise(result)
+            }
+        }
+
+        XCTAssertTrue(result.isSuccess)
+        let account = try result.get()
+        XCTAssertEqual(account.isLiveAccount, true)
+        XCTAssertEqual(account.isInTestMode, false)
+    }
+
+    /// Properly decodes live account in test mode wcpay-account-live-test
+    ///
+    func test_loadAccount_properly_handles_live_account_in_test_mode() throws {
+        let remote = WCPayRemote(network: network)
+
+        network.simulateResponse(requestUrlSuffix: "payments/accounts", filename: "wcpay-account-live-test")
+
+        let result: Result<WCPayAccount, Error> = waitFor { promise in
+            remote.loadAccount(for: self.sampleSiteID) { result in
+                promise(result)
+            }
+        }
+
+        XCTAssertTrue(result.isSuccess)
+        let account = try result.get()
+        XCTAssertEqual(account.isLiveAccount, true)
+        XCTAssertEqual(account.isInTestMode, true)
+    }
+
+    /// Properly decodes developer account in test mode wcpay-account-dev-test
+    ///
+    func test_loadAccount_properly_handles_dev_account_in_test_mode() throws {
+        let remote = WCPayRemote(network: network)
+
+        network.simulateResponse(requestUrlSuffix: "payments/accounts", filename: "wcpay-account-dev-test")
+
+        let result: Result<WCPayAccount, Error> = waitFor { promise in
+            remote.loadAccount(for: self.sampleSiteID) { result in
+                promise(result)
+            }
+        }
+
+        XCTAssertTrue(result.isSuccess)
+        let account = try result.get()
+        XCTAssertEqual(account.isLiveAccount, false)
+        XCTAssertEqual(account.isInTestMode, true)
+    }
+
     /// Verifies that loadAccount properly handles networking errors
     ///
     func test_loadAccount_properly_handles_networking_errors() throws {

Networking/NetworkingTests/Responses/wcpay-account-complete.json

@@ -1,5 +1,6 @@
 {
     "data": {
+        "is_live": true,
         "has_pending_requirements": false,
         "has_overdue_requirements": false,
         "current_deadline": null,
@@ -12,6 +13,7 @@
             ]
         },
         "country": "US",
-        "card_present_eligible": true
+        "card_present_eligible": true,
+        "test_mode": false
     }
 }

Networking/NetworkingTests/Responses/wcpay-account-dev-test.json

@@ -0,0 +1,19 @@
+{
+    "data": {
+        "is_live": false,
+        "has_pending_requirements": false,
+        "has_overdue_requirements": false,
+        "current_deadline": null,
+        "status": "complete",
+        "statement_descriptor": "MY.FANCY.US.STORE",
+        "store_currencies": {
+            "default": "usd",
+            "supported": [
+                "usd"
+            ]
+        },
+        "country": "US",
+        "card_present_eligible": true,
+        "test_mode": true
+    }
+}