7479 Parse instructions for PaymentGateway

joshheald · joshheald · commit 033242d424a9 · 2022-08-19T13:15:49.000+01:00
diff --git a/Fakes/Fakes/Networking.generated.swift b/Fakes/Fakes/Networking.generated.swift
@@ -579,7 +579,18 @@ extension PaymentGateway {
             title: .fake(),
             description: .fake(),
             enabled: .fake(),
-            features: .fake()
+            features: .fake(),
+            instructions: .fake()
+        )
+    }
+}
+extension PaymentGateway.Setting {
+    /// Returns a "ready to use" type filled with fake values.
+    ///
+    public static func fake() -> PaymentGateway.Setting {
+        .init(
+            settingID: .fake(),
+            value: .fake()
         )
     }
 }
diff --git a/Networking/Networking/Model/Copiable/Models+Copiable.generated.swift b/Networking/Networking/Model/Copiable/Models+Copiable.generated.swift
@@ -665,22 +665,40 @@ extension PaymentGateway {
         title: CopiableProp<String> = .copy,
         description: CopiableProp<String> = .copy,
         enabled: CopiableProp<Bool> = .copy,
-        features: CopiableProp<[PaymentGateway.Feature]> = .copy
+        features: CopiableProp<[PaymentGateway.Feature]> = .copy,
+        instructions: NullableCopiableProp<String> = .copy
     ) -> PaymentGateway {
         let siteID = siteID ?? self.siteID
         let gatewayID = gatewayID ?? self.gatewayID
         let title = title ?? self.title
         let description = description ?? self.description
         let enabled = enabled ?? self.enabled
         let features = features ?? self.features
+        let instructions = instructions ?? self.instructions
 
         return PaymentGateway(
             siteID: siteID,
             gatewayID: gatewayID,
             title: title,
             description: description,
             enabled: enabled,
-            features: features
+            features: features,
+            instructions: instructions
+        )
+    }
+}
+
+extension PaymentGateway.Setting {
+    public func copy(
+        settingID: CopiableProp<String> = .copy,
+        value: CopiableProp<String> = .copy
+    ) -> PaymentGateway.Setting {
+        let settingID = settingID ?? self.settingID
+        let value = value ?? self.value
+
+        return PaymentGateway.Setting(
+            settingID: settingID,
+            value: value
         )
     }
 }
diff --git a/Networking/Networking/Model/PaymentGateway.swift b/Networking/Networking/Model/PaymentGateway.swift
@@ -13,6 +13,19 @@ public struct PaymentGateway: Equatable, GeneratedFakeable, GeneratedCopiable {
         case custom(raw: String)
     }
 
+    /// Setting for a payment gateway
+    ///
+    public struct Setting: Equatable, GeneratedCopiable, GeneratedFakeable {
+        public let settingID: String
+        public let value: String
+
+        public init(settingID: String,
+                    value: String) {
+            self.settingID = settingID
+            self.value = value
+        }
+    }
+
     /// Site identifier.
     ///
     public let siteID: Int64
@@ -37,17 +50,28 @@ public struct PaymentGateway: Equatable, GeneratedFakeable, GeneratedCopiable {
     ///
     public let features: [Feature]
 
-    public init(siteID: Int64, gatewayID: String, title: String, description: String, enabled: Bool, features: [Feature]) {
+    /// Instructions shown to the customer after purchase.
+    ///
+    public let instructions: String?
+
+    public init(siteID: Int64,
+                gatewayID: String,
+                title: String,
+                description: String,
+                enabled: Bool,
+                features: [Feature],
+                instructions: String?) {
         self.siteID = siteID
         self.gatewayID = gatewayID
         self.title = title
         self.description = description
         self.enabled = enabled
         self.features = features
+        self.instructions = instructions
     }
 }
 
-// MARK: Gateway Decodable
+// MARK: Gateway Codable
 extension PaymentGateway: Codable {
 
     public enum DecodingError: Error {
@@ -60,7 +84,8 @@ extension PaymentGateway: Codable {
         case description
         case enabled
         case features = "method_supports"
-
+        case instructions
+        case settings
     }
 
     public init(from decoder: Decoder) throws {
@@ -75,16 +100,37 @@ extension PaymentGateway: Codable {
         let enabled = try container.decode(Bool.self, forKey: .enabled)
         let features = try container.decode([Feature].self, forKey: .features)
 
+        // Settings can have different types for `value`, this implementation only handles `String`
+        let settings = try? container.decodeIfPresent([String: Setting].self, forKey: .settings)
+        let instructions = settings?[Setting.Keys.instructions]?.value
+
         self.init(siteID: siteID,
                   gatewayID: gatewayID,
                   title: title,
                   description: description,
                   enabled: enabled,
-                  features: features)
+                  features: features,
+                  instructions: instructions)
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+
+        try container.encode(gatewayID, forKey: .gatewayID)
+        try container.encode(title, forKey: .title)
+        try container.encode(description, forKey: .description)
+        try container.encode(enabled, forKey: .enabled)
+        try container.encode(features, forKey: .features)
+
+        guard let instructions = instructions else {
+            return
+        }
+        let settings = [Setting.Keys.instructions: instructions]
+        try container.encode(settings, forKey: .settings)
     }
 }
 
-// MARK: Features Decodable
+// MARK: - Features Decodable
 extension PaymentGateway.Feature: RawRepresentable, Codable {
 
     /// Enum containing the 'Known' Feature Keys
@@ -116,3 +162,20 @@ extension PaymentGateway.Feature: RawRepresentable, Codable {
         }
     }
 }
+
+// MARK: - Settings Codable
+extension PaymentGateway.Setting: Codable {
+    /// The known keys, which match `settingID`
+    ///
+    fileprivate enum Keys {
+        static let title = "title"
+        static let instructions = "instructions"
+        static let enableForMethods = "enable_for_methods"
+        static let enableForVirtual = "enable_for_virtual"
+    }
+
+    private enum CodingKeys: String, CodingKey {
+        case settingID = "id"
+        case value
+    }
+}
diff --git a/Networking/NetworkingTests/Mapper/PaymentGatewayListMapperTests.swift b/Networking/NetworkingTests/Mapper/PaymentGatewayListMapperTests.swift
@@ -31,26 +31,30 @@ private extension PaymentGatewayListMapperTests {
                                                         "Please use your Order ID as the payment reference. " +
                                                         "Your order will not be shipped until the funds have cleared in our account.",
                                                     enabled: false,
-                                                    features: [.products])
+                                                    features: [.products],
+                                                    instructions: "")
 
     static let checkGateway = PaymentGateway(siteID: sampleSiteID,
                                              gatewayID: "cheque",
                                              title: "Check payments",
                                              description: "Please send a check to Store Name, Store Street, Store Town, Store State / County, Store Postcode.",
                                              enabled: false,
-                                             features: [.products])
+                                             features: [.products],
+                                             instructions: "")
 
     static let cashGateway = PaymentGateway(siteID: sampleSiteID,
                                             gatewayID: "cod",
                                             title: "Cash on delivery",
                                             description: "Pay with cash upon delivery.",
                                             enabled: true,
-                                            features: [.products])
+                                            features: [.products],
+                                            instructions: "Pay with cash upon delivery.")
 
     static let paypalGateway = PaymentGateway(siteID: sampleSiteID,
                                               gatewayID: "paypal",
                                               title: "PayPal",
                                               description: "Pay via PayPal; you can pay with your credit card if you don't have a PayPal account.",
                                               enabled: false,
-                                              features: [.products, .refunds])
+                                              features: [.products, .refunds],
+                                              instructions: "")
 }
diff --git a/Networking/NetworkingTests/Mapper/PaymentGatewayMapperTests.swift b/Networking/NetworkingTests/Mapper/PaymentGatewayMapperTests.swift
@@ -31,7 +31,8 @@ final class PaymentGatewayMapperTests: XCTestCase {
                                                     title: "Cash on delivery",
                                                     description: "Pay with cash upon delivery.",
                                                     enabled: true,
-                                                    features: [.products])
+                                                    features: [.products],
+                                                    instructions: "Pay with cash upon delivery.")
 
         XCTAssertEqual(paymentGateway, expectedPaymentGateway)
     }
diff --git a/Networking/NetworkingTests/Remote/PaymentsGatewayRemoteTests.swift b/Networking/NetworkingTests/Remote/PaymentsGatewayRemoteTests.swift
@@ -88,13 +88,14 @@ final class PaymentsGatewayRemoteTests: XCTestCase {
 
 // MARK: - Helper methods
 
-extension PaymentsGatewayRemoteTests {
+private extension PaymentsGatewayRemoteTests {
     func samplePaymentGateway() -> PaymentGateway {
         PaymentGateway.fake().copy(siteID: sampleSiteID,
                                    gatewayID: "cod",
                                    title: "Cash on delivery",
                                    description: "Pay with cash upon delivery.",
                                    enabled: true,
-                                   features: [.products])
+                                   features: [.products],
+                                   instructions: "Pay with cash upon delivery.")
     }
 }
diff --git a/Networking/NetworkingTests/Responses/payment-gateway-cod.json b/Networking/NetworkingTests/Responses/payment-gateway-cod.json
@@ -9,6 +9,61 @@
         "method_description": "Have your customers pay with cash (or by other means) upon delivery.",
         "method_supports": [
             "products"
-        ]
+        ],
+        "settings": {
+            "title": {
+                "id": "title",
+                "label": "Title",
+                "description": "Payment method description that the customer will see on your checkout.",
+                "type": "safe_text",
+                "value": "Cash on delivery",
+                "default": "Cash on delivery",
+                "tip": "Payment method description that the customer will see on your checkout.",
+                "placeholder": ""
+            },
+            "instructions": {
+                "id": "instructions",
+                "label": "Instructions",
+                "description": "Instructions that will be added to the thank you page.",
+                "type": "textarea",
+                "value": "Pay with cash upon delivery.",
+                "default": "Pay with cash upon delivery.",
+                "tip": "Instructions that will be added to the thank you page.",
+                "placeholder": ""
+            },
+            "enable_for_methods": {
+                "id": "enable_for_methods",
+                "label": "Enable for shipping methods",
+                "description": "If COD is only available for certain methods, set it up here. Leave blank to enable for all methods.",
+                "type": "multiselect",
+                "value": "",
+                "default": "",
+                "tip": "If COD is only available for certain methods, set it up here. Leave blank to enable for all methods.",
+                "placeholder": "",
+                "options": {
+                    "Flat rate": {
+                        "flat_rate": "Any &quot;Flat rate&quot; method",
+                        "flat_rate:1": "Other locations &ndash; Flat rate (#1)"
+                    },
+                    "Free shipping": {
+                        "free_shipping": "Any &quot;Free shipping&quot; method",
+                        "free_shipping:4": "Other locations &ndash; Free shipping (#4)"
+                    },
+                    "Local pickup": {
+                        "local_pickup": "Any &quot;Local pickup&quot; method"
+                    }
+                }
+            },
+            "enable_for_virtual": {
+                "id": "enable_for_virtual",
+                "label": "Accept COD if the order is virtual",
+                "description": "",
+                "type": "checkbox",
+                "value": "yes",
+                "default": "yes",
+                "tip": "",
+                "placeholder": ""
+            }
+        }
     }
 }
diff --git a/Networking/NetworkingTests/Responses/payment-gateway-list.json b/Networking/NetworkingTests/Responses/payment-gateway-list.json
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Orders/Issue Refund/RefundConfirmationViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Orders/Issue Refund/RefundConfirmationViewModelTests.swift
diff --git a/Yosemite/Yosemite/Model/Storage/PaymentGateway+ReadOnlyConvertible.swift b/Yosemite/Yosemite/Model/Storage/PaymentGateway+ReadOnlyConvertible.swift

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,8 @@ final class PaymentGatewayMapperTests: XCTestCase {`
`31`	`31`	`title: "Cash on delivery",`
`32`	`32`	`description: "Pay with cash upon delivery.",`
`33`	`33`	`enabled: true,`
`34`		`- features: [.products])`
	`34`	`+ features: [.products],`
	`35`	`+ instructions: "Pay with cash upon delivery.")`
`35`	`36`
`36`	`37`	`XCTAssertEqual(paymentGateway, expectedPaymentGateway)`
`37`	`38`	`}`