Merge pull request #6163 from woocommerce/issue/6026-shipping-fee-networking-layer

Order Creation: Add support for adding shipping lines on orders in Networking layer

Author: rachelmcr

Networking/Networking/Model/ShippingLine.swift

@@ -3,7 +3,7 @@ import Codegen
 
 /// Represents a Shipping Line Entity.
 ///
-public struct ShippingLine: Decodable, Equatable, GeneratedFakeable {
+public struct ShippingLine: Codable, Equatable, GeneratedFakeable {
     public let shippingID: Int64
     public let methodTitle: String
     public let methodID: String
@@ -29,6 +29,21 @@ public struct ShippingLine: Decodable, Equatable, GeneratedFakeable {
     }
 }
 
+// MARK: Codable
+extension ShippingLine {
+
+    /// Encodes ShippingLine writable fields.
+    ///
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+
+        try container.encode(shippingID, forKey: .shippingID)
+        try container.encode(methodTitle, forKey: .methodTitle)
+        try container.encode(methodID, forKey: .methodID)
+        try container.encode(total, forKey: .total)
+    }
+}
+
 
 /// Defines all of the Shipping Line CodingKeys
 ///

Networking/Networking/Remote/OrdersRemote.swift

@@ -147,6 +147,8 @@ public class OrdersRemote: Remote {
                         if let shippingAddress = order.shippingAddress {
                             params[Order.CodingKeys.shippingAddress.rawValue] = try shippingAddress.toDictionary()
                         }
+                    case .shippingLines:
+                        params[Order.CodingKeys.shippingLines.rawValue] = try order.shippingLines.compactMap { try $0.toDictionary() }
                     }
                 }
             }()
@@ -201,6 +203,9 @@ public class OrdersRemote: Remote {
                     case .fees:
                         let feesEncoded = try order.fees.map { try $0.toDictionary() }
                         params[Order.CodingKeys.feeLines.rawValue] = feesEncoded
+                    case .shippingLines:
+                        let shippingEncoded = try order.shippingLines.map { try $0.toDictionary() }
+                        params[Order.CodingKeys.shippingLines.rawValue] = shippingEncoded
                     }
                 }
             }()
@@ -283,6 +288,7 @@ public extension OrdersRemote {
         case shippingAddress
         case billingAddress
         case fees
+        case shippingLines
     }
 
     /// Order fields supported for create
@@ -293,5 +299,6 @@ public extension OrdersRemote {
         case items
         case billingAddress
         case shippingAddress
+        case shippingLines
     }
 }

Networking/NetworkingTests/Remote/OrdersRemoteTests.swift

@@ -264,6 +264,8 @@ final class OrdersRemoteTests: XCTestCase {
         wait(for: [expectation], timeout: Constants.expectationTimeout)
     }
 
+    // MARK: - Create Order Tests
+
     func test_create_order_properly_encodes_fee_lines() throws {
         // Given
         let remote = OrdersRemote(network: network)
@@ -376,6 +378,27 @@ final class OrdersRemoteTests: XCTestCase {
         ]
         assertEqual(received2, expected2)
     }
+
+    func test_create_order_properly_encodes_shipping_lines() throws {
+        // Given
+        let remote = OrdersRemote(network: network)
+        let shipping = ShippingLine(shippingID: 333, methodTitle: "Shipping", methodID: "other", total: "1.23", totalTax: "", taxes: [])
+        let order = Order.fake().copy(shippingLines: [shipping])
+
+        // When
+        remote.createOrder(siteID: 123, order: order, fields: [.shippingLines]) { result in }
+
+        // Then
+        let request = try XCTUnwrap(network.requestsForResponseData.last as? JetpackRequest)
+        let received = try XCTUnwrap(request.parameters["shipping_lines"] as? [[String: AnyHashable]]).first
+        let expected: [String: AnyHashable] = [
+            "id": shipping.shippingID,
+            "method_title": shipping.methodTitle,
+            "method_id": shipping.methodID,
+            "total": shipping.total
+        ]
+        assertEqual(received, expected)
+    }
 }
 
 private extension OrdersRemoteTests {