Merge pull request #3871 from woocommerce/issue/2970-networking-and-yosemite-layers-shipping-labels-packages

Shipping Labels: endpoint to fetch list of default and custom packages for a store

Author: pmusolino

Networking/Networking/Model/ShippingLabel/Packages/Custom package/ShippingLabelCustomPackage.swift

@@ -16,11 +16,11 @@ public struct ShippingLabelCustomPackage: Equatable, GeneratedFakeable {
     /// Will be a string formatted like this: `2 x 3 x 4`
     public let dimensions: String
 
-    public let boxWeight: Int
+    public let boxWeight: Double
 
-    public let maxWeight: Int
+    public let maxWeight: Double
 
-    public init(isUserDefined: Bool, title: String, isLetter: Bool, dimensions: String, boxWeight: Int, maxWeight: Int) {
+    public init(isUserDefined: Bool, title: String, isLetter: Bool, dimensions: String, boxWeight: Double, maxWeight: Double) {
         self.isUserDefined = isUserDefined
         self.title = title
         self.isLetter = isLetter
@@ -39,8 +39,8 @@ extension ShippingLabelCustomPackage: Decodable {
         let title = try container.decode(String.self, forKey: .title)
         let isLetter = try container.decodeIfPresent(Bool.self, forKey: .isLetter) ?? false
         let dimensions = try container.decode(String.self, forKey: .innerDimensions)
-        let boxWeight = try container.decode(Int.self, forKey: .boxWeight)
-        let maxWeight = try container.decode(Int.self, forKey: .maxWeight)
+        let boxWeight = try container.decode(Double.self, forKey: .boxWeight)
+        let maxWeight = try container.decode(Double.self, forKey: .maxWeight)
 
         self.init(isUserDefined: isUserDefined, title: title, isLetter: isLetter, dimensions: dimensions, boxWeight: boxWeight, maxWeight: maxWeight)
     }

Networking/Networking/Remote/ShippingLabelRemote.swift

@@ -14,6 +14,8 @@ public protocol ShippingLabelRemoteProtocol {
     func addressValidation(siteID: Int64,
                            address: ShippingLabelAddressVerification,
                            completion: @escaping (Result<ShippingLabelAddressValidationResponse, Error>) -> Void)
+    func packagesDetails(siteID: Int64,
+                         completion: @escaping (Result<ShippingLabelPackagesResponse, Error>) -> Void)
 }
 
 /// Shipping Labels Remote Endpoints.
@@ -84,13 +86,26 @@ public final class ShippingLabelRemote: Remote, ShippingLabelRemoteProtocol {
             completion(.failure(error))
         }
     }
+
+    /// Requests all the details for the packages (custom and predefined).
+    /// - Parameters:
+    ///   - siteID: Remote ID of the site that owns the shipping label.
+    ///   - completion: Closure to be executed upon completion.
+    public func packagesDetails(siteID: Int64,
+                                completion: @escaping (Result<ShippingLabelPackagesResponse, Error>) -> Void) {
+        let path = Path.packages
+        let request = JetpackRequest(wooApiVersion: .wcConnectV1, method: .get, siteID: siteID, path: path, parameters: nil)
+        let mapper = ShippingLabelPackagesMapper()
+        enqueue(request, mapper: mapper, completion: completion)
+    }
 }
 
 // MARK: Constant
 private extension ShippingLabelRemote {
     enum Path {
         static let shippingLabels = "label"
         static let normalizeAddress = "normalize-address"
+        static let packages = "packages"
     }
 
     enum ParameterKey {

Networking/NetworkingTests/Remote/ShippingLabelRemoteTests.swift

@@ -139,6 +139,38 @@ final class ShippingLabelRemoteTests: XCTestCase {
         XCTAssertEqual(errors.addressError, "House number is missing")
         XCTAssertEqual(errors.generalError, "Address not found")
     }
+
+    func test_packagesDetails_returns_packages_on_success() throws {
+        // Given
+        let remote = ShippingLabelRemote(network: network)
+        network.simulateResponse(requestUrlSuffix: "packages", filename: "shipping-label-packages-success")
+
+        // When
+        let result: Result<ShippingLabelPackagesResponse, Error> = waitFor { promise in
+            remote.packagesDetails(siteID: self.sampleSiteID) { result in
+                promise(result)
+            }
+        }
+
+        // Then
+        XCTAssertNotNil(try result.get())
+    }
+
+    func test_packagesDetails_returns_errors_on_failure() throws {
+        // Given
+        let remote = ShippingLabelRemote(network: network)
+        network.simulateResponse(requestUrlSuffix: "packages", filename: "generic_error")
+
+        // When
+        let result: Result<ShippingLabelPackagesResponse, Error> = waitFor { promise in
+            remote.packagesDetails(siteID: self.sampleSiteID) { result in
+                promise(result)
+            }
+        }
+
+        // Then
+        XCTAssertNotNil(result.failure)
+    }
 }
 
 private extension ShippingLabelRemoteTests {

Yosemite/Yosemite/Actions/ShippingLabelAction.swift

@@ -27,6 +27,11 @@ public enum ShippingLabelAction: Action {
                          address: ShippingLabelAddressVerification,
                          completion: (Result<ShippingLabelAddressValidationResponse, Error>) -> Void)
 
+    /// Requests all the details for the packages (custom and predefined).
+    ///
+    case packagesDetails(siteID: Int64,
+                         completion: (Result<ShippingLabelPackagesResponse, Error>) -> Void)
+
     /// Checks whether an order is eligible for shipping label creation.
     ///
     case checkCreationEligibility(siteID: Int64, orderID: Int64, isFeatureFlagEnabled: Bool, onCompletion: (_ isEligible: Bool) -> Void)

Yosemite/Yosemite/Model/Model.swift

@@ -72,6 +72,7 @@ public typealias ShipmentTrackingProviderGroup = Networking.ShipmentTrackingProv
 public typealias ShippingLabel = Networking.ShippingLabel
 public typealias ShippingLabelAddress = Networking.ShippingLabelAddress
 public typealias ShippingLabelAddressVerification = Networking.ShippingLabelAddressVerification
+public typealias ShippingLabelPackagesResponse = Networking.ShippingLabelPackagesResponse
 public typealias ShipType = Networking.ShippingLabelAddressVerification.ShipType
 public typealias ShippingLabelAddressValidationResponse = Networking.ShippingLabelAddressValidationResponse
 public typealias ShippingLabelAddressValidationError = Networking.ShippingLabelAddressValidationError

Yosemite/Yosemite/Stores/ShippingLabelStore.swift

@@ -47,6 +47,8 @@ public final class ShippingLabelStore: Store {
             loadShippingLabelSettings(shippingLabel: shippingLabel, completion: completion)
         case .validateAddress(let siteID, let address, let completion):
             validateAddress(siteID: siteID, address: address, completion: completion)
+        case .packagesDetails(let siteID, let completion):
+            packagesDetails(siteID: siteID, completion: completion)
         case .checkCreationEligibility(let siteID, let orderID, let isFeatureFlagEnabled, let onCompletion):
             checkCreationEligibility(siteID: siteID, orderID: orderID, isFeatureFlagEnabled: isFeatureFlagEnabled, onCompletion: onCompletion)
         }
@@ -107,6 +109,11 @@ private extension ShippingLabelStore {
         remote.addressValidation(siteID: siteID, address: address, completion: completion)
     }
 
+    func packagesDetails(siteID: Int64,
+                         completion: @escaping (Result<ShippingLabelPackagesResponse, Error>) -> Void) {
+        remote.packagesDetails(siteID: siteID, completion: completion)
+    }
+
     func checkCreationEligibility(siteID: Int64, orderID: Int64, isFeatureFlagEnabled: Bool, onCompletion: @escaping (_ isEligible: Bool) -> Void) {
         // TODO-2971: implement shipping label creation eligibility check, hopefully with the new `/creation_eligibility` endpoint.
         onCompletion(isFeatureFlagEnabled)

Yosemite/YosemiteTests/Mocks/Networking/Remote/MockShippingLabelRemote.swift

@@ -27,6 +27,10 @@ final class MockShippingLabelRemote {
         let siteID: Int64
     }
 
+    private struct PackagesDetailsResultKey: Hashable {
+        let siteID: Int64
+    }
+
     /// The results to return based on the given arguments in `loadShippingLabels`
     private var loadAllResults = [LoadAllResultKey: Result<OrderShippingLabelListResponse, Error>]()
 
@@ -39,6 +43,9 @@ final class MockShippingLabelRemote {
     /// The results to return based on the given arguments in `addressValidation`
     private var addressValidationResults = [AddressValidationResultKey: Result<ShippingLabelAddressValidationResponse, Error>]()
 
+    /// The results to return based on the given arguments in `packagesDetails`
+    private var packagesDetailsResults = [PackagesDetailsResultKey: Result<ShippingLabelPackagesResponse, Error>]()
+
     /// Set the value passed to the `completion` block if `loadShippingLabels` is called.
     func whenLoadingShippingLabels(siteID: Int64,
                                    orderID: Int64,
@@ -71,6 +78,13 @@ final class MockShippingLabelRemote {
         let key = AddressValidationResultKey(siteID: siteID)
         addressValidationResults[key] = result
     }
+
+    /// Set the value passed to the `completion` block if `packagesDetails` is called.
+    func whenPackagesDetails(siteID: Int64,
+                             thenReturn result: Result<ShippingLabelPackagesResponse, Error>) {
+        let key = PackagesDetailsResultKey(siteID: siteID)
+        packagesDetailsResults[key] = result
+    }
 }
 
 // MARK: - ShippingLabelRemoteProtocol
@@ -130,4 +144,17 @@ extension MockShippingLabelRemote: ShippingLabelRemoteProtocol {
             }
         }
     }
+
+    func packagesDetails(siteID: Int64, completion: @escaping (Result<ShippingLabelPackagesResponse, Error>) -> Void) {
+        DispatchQueue.main.async { [weak self] in
+            guard let self = self else { return }
+
+            let key = PackagesDetailsResultKey(siteID: siteID)
+            if let result = self.packagesDetailsResults[key] {
+                completion(result)
+            } else {
+                XCTFail("\(String(describing: self)) Could not find Result for \(key)")
+            }
+        }
+    }
 }

Yosemite/YosemiteTests/Stores/ShippingLabelStoreTests.swift

@@ -397,6 +397,50 @@ final class ShippingLabelStoreTests: XCTestCase {
         XCTAssertEqual(error as? NetworkError, expectedError)
     }
 
+    // MARK: `packagesDetails`
+
+    func test_packagesDetails_returns_ShippingLabelPackagesResponse_on_success() throws {
+        // Given
+        let remote = MockShippingLabelRemote()
+        let expectedResult = sampleShippingLabelPackagesResponse()
+        remote.whenPackagesDetails(siteID: sampleSiteID,
+                                   thenReturn: .success(expectedResult))
+        let store = ShippingLabelStore(dispatcher: dispatcher, storageManager: storageManager, network: network, remote: remote)
+
+        // When
+        let result: Result<ShippingLabelPackagesResponse, Error> = waitFor { promise in
+            let action = ShippingLabelAction.packagesDetails(siteID: self.sampleSiteID) { result in
+                promise(result)
+            }
+            store.onAction(action)
+        }
+
+        // Then
+        let printData = try XCTUnwrap(result.get())
+        XCTAssertEqual(printData, expectedResult)
+    }
+
+    func test_packagesDetails_returns_error_on_failure() throws {
+        // Given
+        let remote = MockShippingLabelRemote()
+        let expectedError = NetworkError.notFound
+        remote.whenPackagesDetails(siteID: sampleSiteID,
+                                   thenReturn: .failure(expectedError))
+        let store = ShippingLabelStore(dispatcher: dispatcher, storageManager: storageManager, network: network, remote: remote)
+
+        // When
+        let result: Result<ShippingLabelPackagesResponse, Error> = waitFor { promise in
+            let action = ShippingLabelAction.packagesDetails(siteID: self.sampleSiteID) { result in
+                promise(result)
+            }
+            store.onAction(action)
+        }
+
+        // Then
+        let error = try XCTUnwrap(result.failure)
+        XCTAssertEqual(error as? NetworkError, expectedError)
+    }
+
     // MARK: `checkCreationEligibility`
 
     func test_checkCreationEligibility_returns_feature_flag_value() throws {
@@ -455,4 +499,54 @@ private extension ShippingLabelStoreTests {
                                     city: "SAN FRANCISCO",
                                     postcode: "94110-4929")
     }
+
+    func sampleShippingLabelPackagesResponse() -> Yosemite.ShippingLabelPackagesResponse {
+        return ShippingLabelPackagesResponse(storeOptions: sampleShippingLabelStoreOptions(),
+                                             customPackages: sampleShippingLabelCustomPackages(),
+                                             predefinedOptions: sampleShippingLabelPredefinedOptions())
+
+    }
+
+    func sampleShippingLabelStoreOptions() -> ShippingLabelStoreOptions {
+        return ShippingLabelStoreOptions(currencySymbol: "$", dimensionUnit: "cm", weightUnit: "kg", originCountry: "US")
+    }
+
+    func sampleShippingLabelCustomPackages() -> [ShippingLabelCustomPackage] {
+        let customPackage1 = ShippingLabelCustomPackage(isUserDefined: true,
+                                                        title: "Krabica",
+                                                        isLetter: false,
+                                                        dimensions: "1 x 2 x 3",
+                                                        boxWeight: 1,
+                                                        maxWeight: 0)
+        let customPackage2 = ShippingLabelCustomPackage(isUserDefined: true,
+                                                        title: "Obalka",
+                                                        isLetter: true,
+                                                        dimensions: "2 x 3 x 4",
+                                                        boxWeight: 5,
+                                                        maxWeight: 0)
+
+        return [customPackage1, customPackage2]
+    }
+
+    func sampleShippingLabelPredefinedOptions() -> [ShippingLabelPredefinedOption] {
+        let predefinedPackages1 = [ShippingLabelPredefinedPackage(id: "small_flat_box",
+                                                                  title: "Small Flat Rate Box",
+                                                                  isLetter: false,
+                                                                  dimensions: "21.91 x 13.65 x 4.13"),
+                                  ShippingLabelPredefinedPackage(id: "medium_flat_box_top",
+                                                                 title: "Medium Flat Rate Box 1, Top Loading",
+                                                                 isLetter: false,
+                                                                 dimensions: "28.57 x 22.22 x 15.24")]
+        let predefinedOption1 = ShippingLabelPredefinedOption(title: "USPS Priority Mail Flat Rate Boxes",
+                                                              predefinedPackages: predefinedPackages1)
+
+        let predefinedPackages2 = [ShippingLabelPredefinedPackage(id: "LargePaddedPouch",
+                                                                  title: "Large Padded Pouch",
+                                                                  isLetter: true,
+                                                                  dimensions: "30.22 x 35.56 x 2.54")]
+        let predefinedOption2 = ShippingLabelPredefinedOption(title: "DHL Express",
+                                                              predefinedPackages: predefinedPackages2)
+
+        return [predefinedOption1, predefinedOption2]
+    }
 }