Merge release/22.7 into trunk (#15896)

Author: iamgabrielma

Modules/Sources/Networking/Mapper/WooShippingConfigMapper.swift

@@ -44,5 +44,10 @@ private struct WooShippingConfigMapperEnvelope: Decodable {
 extension WooShippingConfigMapper {
     /// Load only the relevant fields from remote
     ///
-    static let fieldsToLoad = "config.shipments, config.shippingLabelData.currentOrderLabels"
+    static let fieldsToLoad = [
+        "config.shipments",
+        "config.shippingLabelData.currentOrderLabels",
+        "config.shippingLabelData.storedData.selected_destination",
+        "config.shippingLabelData.storedData.selected_origin"
+    ].joined(separator: ", ")
 }

Modules/Sources/Networking/Model/ShippingLabel/Packages/WooShippingPackagePurchase.swift

@@ -73,6 +73,11 @@ extension WooShippingPackagePurchase {
 
         return rates
     }
+
+    /// shipment ID to set for hazmat and customs form
+    var formattedShipmentID: String {
+        return WooShippingShipmentIDFormatter.formattedShipmentID(shipmentID)
+    }
 }
 
 // MARK: Enodable
@@ -86,7 +91,11 @@ extension WooShippingPackagePurchase: Encodable {
         try container.encode(package.boxID, forKey: .boxID)
         try container.encode(package.length, forKey: .length)
         try container.encode(package.width, forKey: .width)
-        try container.encode(package.height, forKey: .height)
+
+        // workaround because 0 would cause an error for the API request
+        let packageHeight = package.height > 0 ? package.height : 0.25
+        try container.encode(packageHeight, forKey: .height)
+
         try container.encode(package.weight, forKey: .weight)
         try container.encode(package.isLetter, forKey: .isLetter)
         try container.encode(rate.shipmentID, forKey: .shipmentID)
@@ -96,6 +105,20 @@ extension WooShippingPackagePurchase: Encodable {
         try container.encode(rate.title, forKey: .serviceName)
         try container.encode(productIDs, forKey: .products)
 
+        if let hazmat = package.hazmatCategory {
+            try container.encode(hazmat, forKey: .hazmat)
+        }
+
+        if let form = package.customsForm {
+            try container.encode(form.contentsType.rawValue, forKey: .contentsType)
+            try container.encode(form.contentExplanation, forKey: .contentsExplanation)
+            try container.encode(form.restrictionType.rawValue, forKey: .restrictionType)
+            try container.encode(form.restrictionComments, forKey: .restrictionComments)
+            try container.encode(form.nonDeliveryOption.rawValue, forKey: .nonDeliveryOption)
+            try container.encode(form.itn, forKey: .itn)
+            try container.encode(form.items, forKey: .items)
+        }
+
         if selectedRate.signatureRate != nil {
             try container.encode(Values.yes, forKey: .signature)
         } else if selectedRate.adultSignatureRate != nil {
@@ -140,7 +163,7 @@ extension WooShippingPackagePurchase: Encodable {
     /// Converts the hazmat settings to a dictionary as the API expects it.
     /// Includes the shipment ID if there are hazmat settings to report.
     public func encodedHazmat() -> [String: Any] {
-        [shipmentID: [
+        [formattedShipmentID: [
             ParameterKeys.isHazmat: package.hazmatCategory != nil,
             ParameterKeys.category: package.hazmatCategory ?? String()
         ]]
@@ -150,9 +173,9 @@ extension WooShippingPackagePurchase: Encodable {
     /// Includes the shipment ID with the encoded customs form.
     public func encodedCustomsForm() throws -> [String: Any] {
         guard let form = package.customsForm else {
-            return [shipmentID: [:]]
+            return [formattedShipmentID: [:]]
         }
-        return [shipmentID: [
+        return [formattedShipmentID: [
             ParameterKeys.items: try form.items.map { try $0.toDictionary() },
             ParameterKeys.contentsType: form.contentsType.rawValue,
             ParameterKeys.contentsExplanation: form.contentExplanation,
@@ -181,6 +204,14 @@ extension WooShippingPackagePurchase: Encodable {
         case carbonNeutral = "carbon_neutral"
         case saturdayDelivery = "saturday_delivery"
         case additionalHandling = "additional_handling"
+        case hazmat
+        case contentsType = "contents_type"
+        case contentsExplanation = "contents_explanation"
+        case restrictionType = "restriction_type"
+        case restrictionComments = "restriction_comments"
+        case nonDeliveryOption = "non_delivery_option"
+        case itn
+        case items
     }
 
     private enum ParameterKeys {

Modules/Sources/Networking/Model/ShippingLabel/Shipments/WooShippingConfigResponse.swift

@@ -60,18 +60,74 @@ public struct WooShippingLabelData: Decodable, Equatable {
     /// Labels purchased for the current order
     public let currentOrderLabels: [ShippingLabel]
 
-    public init(currentOrderLabels: [ShippingLabel]) {
+    /// Contains destination addresses
+    public let storedData: StoredData?
+
+    public init(
+        currentOrderLabels: [ShippingLabel],
+        storedData: StoredData? = nil
+    ) {
         self.currentOrderLabels = currentOrderLabels
+        self.storedData = storedData
     }
 
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
-        let currentOrderLabels = try container.decodeIfPresent([ShippingLabel].self, forKey: .currentOrderLabels) ?? []
-        self.init(currentOrderLabels: currentOrderLabels)
+
+        let storedData = try container.decodeIfPresent(StoredData.self, forKey: .storedData)
+        let decodedOrderLabels = try container.decodeIfPresent([ShippingLabel].self, forKey: .currentOrderLabels) ?? []
+
+        /// Inject destination addresses into labels if present
+        let orderLabels: [ShippingLabel]
+
+        let destinations = storedData?.selectedDestinations
+        let origins = storedData?.selectedOrigins
+
+        if destinations?.isEmpty == false || origins?.isEmpty == false {
+            orderLabels = WooShippingLabelData.mapAddresses(
+                origins: origins,
+                destinations: destinations,
+                into: decodedOrderLabels
+            )
+        } else {
+            orderLabels = decodedOrderLabels
+        }
+
+        self.init(
+            currentOrderLabels: orderLabels,
+            storedData: storedData
+        )
     }
 
     private enum CodingKeys: String, CodingKey {
         case currentOrderLabels
+        case storedData
+    }
+}
+
+public extension WooShippingLabelData {
+    typealias WooShippingLabelAddressMap = [String: WooShippingAddress]
+
+    struct StoredData: Decodable, Equatable {
+        let selectedDestinations: WooShippingLabelAddressMap?
+        let selectedOrigins: WooShippingLabelAddressMap?
+
+        public enum CodingKeys: String, CodingKey {
+            case selectedDestination = "selected_destination"
+            case selectedOrigin = "selected_origin"
+        }
+
+        public init(from decoder: any Decoder) throws {
+            let container = try decoder.container(keyedBy: CodingKeys.self)
+            selectedDestinations = try? container.decodeIfPresent(
+                WooShippingLabelAddressMap.self,
+                forKey: CodingKeys.selectedDestination
+            )
+            selectedOrigins = try? container.decodeIfPresent(
+                WooShippingLabelAddressMap.self,
+                forKey: CodingKeys.selectedOrigin
+            )
+        }
     }
 }
 

Modules/Sources/Networking/Model/ShippingLabel/Shipments/WooShippingLabelData+mapDestinations.swift

@@ -0,0 +1,24 @@
+import Foundation
+
+extension WooShippingLabelData {
+    static func mapAddresses(
+        origins: WooShippingLabelAddressMap?,
+        destinations: WooShippingLabelAddressMap?,
+        into labels: [ShippingLabel]
+    ) -> [ShippingLabel] {
+        return labels.map { label in
+            guard let shipmentID = label.shipmentID else {
+                return label
+            }
+
+            let formattedID = WooShippingShipmentIDFormatter.formattedShipmentID(shipmentID)
+            let originAddress = origins?[formattedID] ?? origins?[shipmentID]
+            let destinationAddress = destinations?[formattedID] ?? destinations?[shipmentID]
+
+            return label.copy(
+                originAddress: originAddress?.toShippingLabelAddress() ?? .copy,
+                destinationAddress: destinationAddress?.toShippingLabelAddress() ?? .copy
+            )
+        }
+    }
+}

Modules/Sources/Networking/Model/ShippingLabel/WooShippingAddress.swift

@@ -59,12 +59,12 @@ extension WooShippingAddress: Codable {
         // If no name is sent to validation address request, no name will be received in response.
         // So make sure to decode it only if it's present.
         let name = try container.decodeIfPresent(String.self, forKey: .name) ?? ""
-        let company = try container.decode(String.self, forKey: .company)
-        let phone = try container.decode(String.self, forKey: .phone)
+        let company = try container.decodeIfPresent(String.self, forKey: .company) ?? ""
+        let phone = try container.decodeIfPresent(String.self, forKey: .phone) ?? ""
         let country = try container.decode(String.self, forKey: .country)
         let state = try container.decode(String.self, forKey: .state)
         let address1 = try container.decodeIfPresent(String.self, forKey: .address1) ?? container.decode(String.self, forKey: .alternateAddress1)
-        let address2 = try container.decode(String.self, forKey: .address2)
+        let address2 = try container.decodeIfPresent(String.self, forKey: .address2) ?? ""
         let city = try container.decode(String.self, forKey: .city)
         let postcode = try container.decode(String.self, forKey: .postcode)
 

Modules/Sources/Networking/Model/ShippingLabel/WooShippingShipmentIDFormatter.swift

@@ -0,0 +1,23 @@
+import Foundation
+
+enum WooShippingShipmentIDFormatter {
+    /// Turns numeric shipment ID into formatted as `shipment_<id>`
+    /// - Parameter shipmentID: numeric shipment id
+    /// - Returns: formated id string
+    static func formattedShipmentID(_ shipmentID: String) -> String {
+        return isArgumentIDValid(shipmentID) ?
+        Values.shipmentIDPrefix + shipmentID :
+        shipmentID
+    }
+}
+
+private extension WooShippingShipmentIDFormatter {
+    private enum Values {
+        static let shipmentIDPrefix = "shipment_"
+    }
+
+    /// Make sure we are formatting incoming numeric ID string
+    private static func isArgumentIDValid(_ argumentID: String) -> Bool {
+        return Int(argumentID) != nil
+    }
+}

Modules/Sources/NetworkingCore/Model/ShippingLabel/ShippingLabelAddress.swift

@@ -117,4 +117,16 @@ extension ShippingLabelAddress {
     init() {
         self.init(company: "", name: "", phone: "", country: "", state: "", address1: "", address2: "", city: "", postcode: "")
     }
+
+    var isEmpty: Bool {
+        return company.isEmpty &&
+        name.isEmpty &&
+        phone.isEmpty &&
+        country.isEmpty &&
+        state.isEmpty &&
+        address1.isEmpty &&
+        address2.isEmpty &&
+        city.isEmpty &&
+        postcode.isEmpty
+    }
 }

Modules/Tests/NetworkingTests/Model/WooShippingShipmentIDFormatterTests.swift

@@ -0,0 +1,44 @@
+import Foundation
+import XCTest
+@testable import Networking
+
+final class WooShippingShipmentIDFormatterTests: XCTestCase {
+
+    // MARK: - formattedShipmentID
+
+    func test_formatted_shipment_id_when_id_is_numeric_should_return_formatted_id() {
+        // Given
+        let sut = WooShippingShipmentIDFormatter.self
+        let id = "123456"
+
+        // When
+        let formattedID = sut.formattedShipmentID(id)
+
+        // Then
+        XCTAssertEqual(formattedID, "shipment_123456")
+    }
+
+    func test_formatted_shipment_id_when_id_is_already_formatted_should_return_same_id() {
+        // Given
+        let sut = WooShippingShipmentIDFormatter.self
+        let id = "shipment_123456"
+
+        // When
+        let formattedID = sut.formattedShipmentID(id)
+
+        // Then
+        XCTAssertEqual(formattedID, "shipment_123456")
+    }
+
+    func test_formatted_shipment_id_when_non_numeric_should_return_same_id() {
+        // Given
+        let sut = WooShippingShipmentIDFormatter.self
+        let id = "non-numeric-id"
+
+        // When
+        let formattedID = sut.formattedShipmentID(id)
+
+        // Then
+        XCTAssertEqual(formattedID, id)
+    }
+}