diff --git a/Fakes/Fakes/Networking.generated.swift b/Fakes/Fakes/Networking.generated.swift index fc9365eab59..a4b3da1f9e0 100644 --- a/Fakes/Fakes/Networking.generated.swift +++ b/Fakes/Fakes/Networking.generated.swift @@ -2988,6 +2988,27 @@ extension Networking.WooShippingShipment { ) } } +extension Networking.WooShippingUpdateShipment { + /// Returns a "ready to use" type filled with fake values. + /// + public static func fake() -> Networking.WooShippingUpdateShipment { + .init( + shipmentIdsToUpdate: .fake(), + shipments: .fake() + ) + } +} +extension Networking.WooShippingUpdateShipmentResponse { + /// Returns a "ready to use" type filled with fake values. + /// + public static func fake() -> Networking.WooShippingUpdateShipmentResponse { + .init( + siteID: .fake(), + orderID: .fake(), + shipments: .fake() + ) + } +} extension Networking.WordPressMedia { /// Returns a "ready to use" type filled with fake values. /// diff --git a/Networking/Networking.xcodeproj/project.pbxproj b/Networking/Networking.xcodeproj/project.pbxproj index c3d539e7a3e..8998c559880 100644 --- a/Networking/Networking.xcodeproj/project.pbxproj +++ b/Networking/Networking.xcodeproj/project.pbxproj @@ -1291,6 +1291,12 @@ EEA658482966CBAD00112DF0 /* EntityIDMapperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEA658472966CBAD00112DF0 /* EntityIDMapperTests.swift */; }; EEA6584C2966CC4800112DF0 /* product-id-only-without-data.json in Resources */ = {isa = PBXBuildFile; fileRef = EEA6584B2966CC4800112DF0 /* product-id-only-without-data.json */; }; EEAB476A2A851AFD00E55B25 /* site-upload-profiler-answers-success.json in Resources */ = {isa = PBXBuildFile; fileRef = EEAB47692A851AFD00E55B25 /* site-upload-profiler-answers-success.json */; }; + EEBBDD842D943D2D008D6CE5 /* WooShippingUpdateShipment.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEBBDD832D943D25008D6CE5 /* WooShippingUpdateShipment.swift */; }; + EEBBDD862D9440DD008D6CE5 /* WooShippingUpdateShipmentMapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEBBDD852D9440BD008D6CE5 /* WooShippingUpdateShipmentMapper.swift */; }; + EEBBDD882D94419F008D6CE5 /* WooShippingUpdateShipmentResponse.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEBBDD872D944194008D6CE5 /* WooShippingUpdateShipmentResponse.swift */; }; + EEBBDD8B2D944380008D6CE5 /* shipping-label-update-shipment-without-data.json in Resources */ = {isa = PBXBuildFile; fileRef = EEBBDD8A2D944380008D6CE5 /* shipping-label-update-shipment-without-data.json */; }; + EEBBDD8C2D944380008D6CE5 /* shipping-label-update-shipment.json in Resources */ = {isa = PBXBuildFile; fileRef = EEBBDD892D944380008D6CE5 /* shipping-label-update-shipment.json */; }; + EEBBFEAC2D9532C6008D6CE5 /* WooShippingUpdateShipmentMapperTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEBBFEAB2D9532C3008D6CE5 /* WooShippingUpdateShipmentMapperTests.swift */; }; EEC312C32AFDF79E004369F7 /* ProductSubscriptionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEC312C22AFDF79E004369F7 /* ProductSubscriptionTests.swift */; }; EEC312C52AFE01BC004369F7 /* ProductEncoderTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = EEC312C42AFE01BC004369F7 /* ProductEncoderTests.swift */; }; EECB7EE8286555180028C888 /* media-update-product-id.json in Resources */ = {isa = PBXBuildFile; fileRef = EECB7EE7286555180028C888 /* media-update-product-id.json */; }; @@ -2528,6 +2534,12 @@ EEA658472966CBAD00112DF0 /* EntityIDMapperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EntityIDMapperTests.swift; sourceTree = ""; }; EEA6584B2966CC4800112DF0 /* product-id-only-without-data.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "product-id-only-without-data.json"; sourceTree = ""; }; EEAB47692A851AFD00E55B25 /* site-upload-profiler-answers-success.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "site-upload-profiler-answers-success.json"; sourceTree = ""; }; + EEBBDD832D943D25008D6CE5 /* WooShippingUpdateShipment.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WooShippingUpdateShipment.swift; sourceTree = ""; }; + EEBBDD852D9440BD008D6CE5 /* WooShippingUpdateShipmentMapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WooShippingUpdateShipmentMapper.swift; sourceTree = ""; }; + EEBBDD872D944194008D6CE5 /* WooShippingUpdateShipmentResponse.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WooShippingUpdateShipmentResponse.swift; sourceTree = ""; }; + EEBBDD892D944380008D6CE5 /* shipping-label-update-shipment.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "shipping-label-update-shipment.json"; sourceTree = ""; }; + EEBBDD8A2D944380008D6CE5 /* shipping-label-update-shipment-without-data.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; path = "shipping-label-update-shipment-without-data.json"; sourceTree = ""; }; + EEBBFEAB2D9532C3008D6CE5 /* WooShippingUpdateShipmentMapperTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = WooShippingUpdateShipmentMapperTests.swift; sourceTree = ""; }; EEC312C22AFDF79E004369F7 /* ProductSubscriptionTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProductSubscriptionTests.swift; sourceTree = ""; }; EEC312C42AFE01BC004369F7 /* ProductEncoderTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ProductEncoderTests.swift; sourceTree = ""; }; EECB7EE7286555180028C888 /* media-update-product-id.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = "media-update-product-id.json"; sourceTree = ""; }; @@ -3288,6 +3300,8 @@ DE66C55C2977C35A00DAA978 /* shipping-label-packages-success-without-data.json */, EE74B1EB2D895FA4000E4C56 /* shipping-label-config-success.json */, EE74B1EC2D895FA4000E4C56 /* shipping-label-config-success-without-data.json */, + EEBBDD892D944380008D6CE5 /* shipping-label-update-shipment.json */, + EEBBDD8A2D944380008D6CE5 /* shipping-label-update-shipment-without-data.json */, DE66C55A2977C1A000DAA978 /* order-shipping-labels-without-data.json */, DE66C558297799CF00DAA978 /* add-on-groups-without-data.json */, DE66C5542976662700DAA978 /* just-in-time-message-list-without-data.json */, @@ -3804,6 +3818,7 @@ EE105F402D671ED3005AB07F /* WooShippingDestinationAddressUpdateMapper.swift */, CED9BCC42D3EBD0D00C063B8 /* WooShippingAddressValidationSuccessMapper.swift */, EE1042AC2D65CE5E005AB07F /* WooShippingVerifyDestinationAddressMapper.swift */, + EEBBDD852D9440BD008D6CE5 /* WooShippingUpdateShipmentMapper.swift */, CE90E99D2CEFCB100068D852 /* WooShippingStatusMapper.swift */, EE7E80B72D84F18700E6FF5B /* WooShippingConfigMapper.swift */, CE606D8E2BE39426001CB424 /* ShippingMethodMapper.swift */, @@ -3982,6 +3997,7 @@ CC9A254926442D26005DE56E /* ShippingLabelCreationEligibilityMapperTests.swift */, CC07866426790B1100BA9AC1 /* ShippingLabelPurchaseMapperTests.swift */, EE74B1E92D895F00000E4C56 /* WooShippingConfigMapperTests.swift */, + EEBBFEAB2D9532C3008D6CE5 /* WooShippingUpdateShipmentMapperTests.swift */, CC0786C8267BB32800BA9AC1 /* ShippingLabelStatusMapperTests.swift */, CE606D922BE39889001CB424 /* ShippingMethodListMapperTests.swift */, 02C254D22563992900A04423 /* OrderShippingLabelListMapperTests.swift */, @@ -4228,8 +4244,10 @@ EE7E80BB2D84F4E900E6FF5B /* Shipments */ = { isa = PBXGroup; children = ( + EEBBDD832D943D25008D6CE5 /* WooShippingUpdateShipment.swift */, EE7E80BC2D84F54800E6FF5B /* WooShippingShipment.swift */, EE7E80B92D84F41500E6FF5B /* WooShippingConfigResponse.swift */, + EEBBDD872D944194008D6CE5 /* WooShippingUpdateShipmentResponse.swift */, ); path = Shipments; sourceTree = ""; @@ -4759,6 +4777,8 @@ 02698CFC24C1B0CE005337C4 /* product-variations-load-all-first-on-sale-empty-sale-price.json in Resources */, 31A451D427863A2E00FE81AA /* stripe-account-rejected-listed.json in Resources */, 74A1D265211898F000931DFA /* site-visits-month.json in Resources */, + EEBBDD8B2D944380008D6CE5 /* shipping-label-update-shipment-without-data.json in Resources */, + EEBBDD8C2D944380008D6CE5 /* shipping-label-update-shipment.json in Resources */, 31799AFC2705189200D78179 /* wcpay-location.json in Resources */, 028CB71E2902589E00331C09 /* create-account-error-email-exists.json in Resources */, 74159623224D2C86003C21CF /* settings-product.json in Resources */, @@ -5120,6 +5140,7 @@ 74ABA1CF213F1D1600FFAD30 /* TopEarnerStatsItem.swift in Sources */, FE28F6E6268429B6004465C7 /* UserRemote.swift in Sources */, 02AD47702A6EB71100E652D6 /* URLRequestConvertible+Path.swift in Sources */, + EEBBDD882D94419F008D6CE5 /* WooShippingUpdateShipmentResponse.swift in Sources */, 68BFF8FE2B676A9F00B15FF2 /* Receipt.swift in Sources */, 7452387421124B7700A973CD /* AnyDecodable.swift in Sources */, DE4D23B829B5F909003A4B5D /* Announcement.swift in Sources */, @@ -5285,6 +5306,7 @@ CC75108B29EFF1A90035FBA4 /* SubscriptionStatus.swift in Sources */, CC07865F267799EE00BA9AC1 /* ShippingLabelPurchase.swift in Sources */, 45A4B84E25D2E11300776FB4 /* ShippingLabelAddressValidationSuccessMapper.swift in Sources */, + EEBBDD842D943D2D008D6CE5 /* WooShippingUpdateShipment.swift in Sources */, CC851D0625E51ADF00249E9C /* Decimal+Extensions.swift in Sources */, 45D1CF4923BACA6500945A36 /* ProductTaxStatus.swift in Sources */, EE57C111297927C600BC31E7 /* ApplicationPasswordNameAndUUIDMapper.swift in Sources */, @@ -5345,6 +5367,7 @@ CED9BCC52D3EBD0D00C063B8 /* WooShippingAddressValidationSuccessMapper.swift in Sources */, B9CFF6522AB2118900C2F616 /* TaxRateMapper.swift in Sources */, DE2095BF279583A100171F1C /* CouponReportListMapper.swift in Sources */, + EEBBDD862D9440DD008D6CE5 /* WooShippingUpdateShipmentMapper.swift in Sources */, B557DA0320975500005962F4 /* Remote.swift in Sources */, B53EF53C21814900003E146F /* SuccessResultMapper.swift in Sources */, D8EDFE2625EE8A60003D2213 /* ReaderConnectionTokenMapper.swift in Sources */, @@ -5749,6 +5772,7 @@ CC851D1425E52AB500249E9C /* Decimal+ExtensionsTests.swift in Sources */, EE76762F2962B85E000066FA /* RequestProcessorTests.swift in Sources */, B554FA8B2180B1D500C54DFF /* NotificationsRemoteTests.swift in Sources */, + EEBBFEAC2D9532C6008D6CE5 /* WooShippingUpdateShipmentMapperTests.swift in Sources */, B518662A20A09C6F00037A38 /* OrdersRemoteTests.swift in Sources */, 02EF166E292F0C5800D90AD6 /* PaymentRemoteTests.swift in Sources */, B5969E1520A47F99005E9DF1 /* RemoteTests.swift in Sources */, diff --git a/Networking/Networking/Mapper/WooShippingUpdateShipmentMapper.swift b/Networking/Networking/Mapper/WooShippingUpdateShipmentMapper.swift new file mode 100644 index 00000000000..4432037b6ca --- /dev/null +++ b/Networking/Networking/Mapper/WooShippingUpdateShipmentMapper.swift @@ -0,0 +1,40 @@ +import Foundation + +/// Mapper: Shipping Label Update Shipments Response from WooCommerce Shipping extension +/// +struct WooShippingUpdateShipmentMapper: Mapper { + /// Site Identifier associated to the order that will be parsed. + /// + /// We're injecting this field via `JSONDecoder.userInfo` because SiteID is not returned by the update shipment endpoint. + /// + let siteID: Int64 + + /// Order ID associated to the shipping labels that will be parsed. + /// + /// We're injecting this field via `JSONDecoder.userInfo` because OrderID is not returned by the update shipment endpoint. + /// + let orderID: Int64 + + /// (Attempts) to convert a dictionary into WooShippingUpdateShipmentResponse. + /// + func map(response: Data) throws -> WooShippingUpdateShipmentResponse { + let decoder = JSONDecoder() + decoder.userInfo = [ + .siteID: siteID, + .orderID: orderID + ] + if hasDataEnvelope(in: response) { + return try decoder.decode(WooShippingUpdateShipmentResponseEnvelope.self, from: response).data + } else { + return try decoder.decode(WooShippingUpdateShipmentResponse.self, from: response) + } + } +} + +private struct WooShippingUpdateShipmentResponseEnvelope: Decodable { + let data: WooShippingUpdateShipmentResponse + + private enum CodingKeys: String, CodingKey { + case data = "data" + } +} diff --git a/Networking/Networking/Model/Copiable/Models+Copiable.generated.swift b/Networking/Networking/Model/Copiable/Models+Copiable.generated.swift index 867f6f5461e..1e08e0814f1 100644 --- a/Networking/Networking/Model/Copiable/Models+Copiable.generated.swift +++ b/Networking/Networking/Model/Copiable/Models+Copiable.generated.swift @@ -4437,6 +4437,39 @@ extension Networking.WooShippingShipment { } } +extension Networking.WooShippingUpdateShipment { + public func copy( + shipmentIdsToUpdate: CopiableProp<[String]> = .copy, + shipments: CopiableProp<[String: [WooShippingShipment]]> = .copy + ) -> Networking.WooShippingUpdateShipment { + let shipmentIdsToUpdate = shipmentIdsToUpdate ?? self.shipmentIdsToUpdate + let shipments = shipments ?? self.shipments + + return Networking.WooShippingUpdateShipment( + shipmentIdsToUpdate: shipmentIdsToUpdate, + shipments: shipments + ) + } +} + +extension Networking.WooShippingUpdateShipmentResponse { + public func copy( + siteID: CopiableProp = .copy, + orderID: CopiableProp = .copy, + shipments: CopiableProp<[String: [WooShippingShipment]]> = .copy + ) -> Networking.WooShippingUpdateShipmentResponse { + let siteID = siteID ?? self.siteID + let orderID = orderID ?? self.orderID + let shipments = shipments ?? self.shipments + + return Networking.WooShippingUpdateShipmentResponse( + siteID: siteID, + orderID: orderID, + shipments: shipments + ) + } +} + extension Networking.WordPressMedia { public func copy( mediaID: CopiableProp = .copy, diff --git a/Networking/Networking/Model/ShippingLabel/Shipments/WooShippingUpdateShipment.swift b/Networking/Networking/Model/ShippingLabel/Shipments/WooShippingUpdateShipment.swift new file mode 100644 index 00000000000..9f8cfe50afb --- /dev/null +++ b/Networking/Networking/Model/ShippingLabel/Shipments/WooShippingUpdateShipment.swift @@ -0,0 +1,15 @@ +import Foundation +import Codegen + +/// Model to update shipments on an order +/// +public struct WooShippingUpdateShipment: Equatable, Encodable, GeneratedFakeable, GeneratedCopiable { + public let shipmentIdsToUpdate: [String] + + public let shipments: [String: [WooShippingShipment]] + + public init(shipmentIdsToUpdate: [String], shipments: [String: [WooShippingShipment]]) { + self.shipmentIdsToUpdate = shipmentIdsToUpdate + self.shipments = shipments + } +} diff --git a/Networking/Networking/Model/ShippingLabel/Shipments/WooShippingUpdateShipmentResponse.swift b/Networking/Networking/Model/ShippingLabel/Shipments/WooShippingUpdateShipmentResponse.swift new file mode 100644 index 00000000000..141fd924928 --- /dev/null +++ b/Networking/Networking/Model/ShippingLabel/Shipments/WooShippingUpdateShipmentResponse.swift @@ -0,0 +1,53 @@ +import Foundation +import Codegen + +/// Response after updating shipments of an order +/// +public struct WooShippingUpdateShipmentResponse: Decodable, Equatable, GeneratedFakeable, GeneratedCopiable { + public let siteID: Int64 + public let orderID: Int64 + public let shipments: [String: [WooShippingShipment]] + + public init(siteID: Int64, + orderID: Int64, + shipments: [String: [WooShippingShipment]]) { + self.siteID = siteID + self.orderID = orderID + self.shipments = shipments + } + + private enum CodingKeys: String, CodingKey { + case data + } + + public init(from decoder: Decoder) throws { + guard let siteID = decoder.userInfo[.siteID] as? Int64 else { + throw WooShippingUpdateShipmentDecodingError.missingSiteID + } + + guard let orderID = decoder.userInfo[.orderID] as? Int64 else { + throw WooShippingUpdateShipmentDecodingError.missingOrderID + } + + let container = try decoder.container(keyedBy: CodingKeys.self) + let shipments: [String: [WooShippingShipment]] = { + guard let shipmentsString = try? container.decodeIfPresent(String.self, forKey: .data), + let data = shipmentsString.data(using: .utf8) else { + return [:] + } + + return (try? JSONDecoder().decode([String: [WooShippingShipment]].self, from: data)) ?? [:] + }() + + self.init(siteID: siteID, + orderID: orderID, + shipments: shipments) + } +} + +// MARK: - Decoding Errors +// +enum WooShippingUpdateShipmentDecodingError: Error { + case missingSiteID + case missingOrderID +} diff --git a/Networking/Networking/Remote/WooShippingRemote.swift b/Networking/Networking/Remote/WooShippingRemote.swift index ef81bacb0ce..894cfc5a664 100644 --- a/Networking/Networking/Remote/WooShippingRemote.swift +++ b/Networking/Networking/Remote/WooShippingRemote.swift @@ -52,6 +52,10 @@ public protocol WooShippingRemoteProtocol { func loadConfig(siteID: Int64, orderID: Int64, completion: @escaping (Result) -> Void) + func updateShipment(siteID: Int64, + orderID: Int64, + shipmentToUpdate: WooShippingUpdateShipment, + completion: @escaping (Result) -> Void) } /// Shipping Labels Remote Endpoints for the WooShipping Plugin. @@ -430,6 +434,32 @@ public final class WooShippingRemote: Remote, WooShippingRemoteProtocol { enqueue(request, mapper: mapper, completion: completion) } } + + /// Updates shipment for a given order + /// - Parameters: + /// - siteID: Remote ID of the site. + /// - orderID: Remote ID of the order. + /// - shipmentToUpdate: shipment info to send to remote + /// - completion: Closure to be executed upon completion. + public func updateShipment(siteID: Int64, + orderID: Int64, + shipmentToUpdate: WooShippingUpdateShipment, + completion: @escaping (Result) -> Void) { + do { + let parameters = try shipmentToUpdate.toDictionary() + let path = Path.updateShipment(orderID: orderID) + let request = JetpackRequest(wooApiVersion: .wooShipping, + method: .post, + siteID: siteID, + path: path, + parameters: parameters, + availableAsRESTRequest: true) + let mapper = WooShippingUpdateShipmentMapper(siteID: siteID, orderID: orderID) + enqueue(request, mapper: mapper, completion: completion) + } catch { + completion(.failure(error)) + } + } } // MARK: Constants @@ -453,6 +483,9 @@ private extension WooShippingRemote { static func config(orderID: Int64) -> String { "config/label-purchase/\(orderID)" } + static func updateShipment(orderID: Int64) -> String { + "shipments/\(orderID)" + } } enum ParameterKey { diff --git a/Networking/NetworkingTests/Mapper/WooShippingUpdateShipmentMapperTests.swift b/Networking/NetworkingTests/Mapper/WooShippingUpdateShipmentMapperTests.swift new file mode 100644 index 00000000000..4a18c286311 --- /dev/null +++ b/Networking/NetworkingTests/Mapper/WooShippingUpdateShipmentMapperTests.swift @@ -0,0 +1,64 @@ +import XCTest +@testable import Networking + +/// Unit Tests for `WooShippingUpdateShipmentMapper` +/// +final class WooShippingUpdateShipmentMapperTests: XCTestCase { + private let sampleSiteID: Int64 = 1234 + private let sampleOrderID: Int64 = 1234 + + func test_shipments_are_properly_parsed() throws { + guard let config = mapLoadShippingLabelConfig() else { + XCTFail() + return + } + + XCTAssertEqual(config.shipments.count, 3) + let shipment = try XCTUnwrap(config.shipments["0"]) + + let shipmentItem = try XCTUnwrap(shipment.first) + XCTAssertEqual(shipmentItem.id, 209) + XCTAssertEqual(shipmentItem.subItems, ["209-sub-0", "209-sub-1", "209-sub-2"]) + } + + func test_shipments_are_properly_parsed_when_response_has_no_data_envelope() throws { + guard let config = mapLoadShippingLabelConfig() else { + XCTFail() + return + } + + XCTAssertEqual(config.shipments.count, 3) + let shipment = try XCTUnwrap(config.shipments["1"]) + + let shipmentItem = try XCTUnwrap(shipment[safe: 2]) + XCTAssertEqual(shipmentItem.id, 212) + XCTAssertEqual(shipmentItem.subItems, ["212-sub-0", "212-sub-1", "212-sub-2"]) + } +} +/// Private Helpers +/// +private extension WooShippingUpdateShipmentMapperTests { + + /// Returns the `WooShippingUpdateShipmentMapper` output upon receiving `filename` (Data Encoded) + /// + func mapShippingLabelConfig(from filename: String) -> WooShippingUpdateShipmentResponse? { + guard let response = Loader.contentsOf(filename) else { + return nil + } + + return try! WooShippingUpdateShipmentMapper(siteID: sampleSiteID, + orderID: sampleOrderID).map(response: response) + } + + /// Returns the `WooShippingUpdateShipmentMapper` output upon receiving `shipping-label-update-shipment` + /// + func mapLoadShippingLabelConfig() -> WooShippingUpdateShipmentResponse? { + mapShippingLabelConfig(from: "shipping-label-update-shipment") + } + + /// Returns the `WooShippingUpdateShipmentMapper` output upon receiving `shipping-label-update-shipment-without-data` + /// + func mapLoadShippingLabelConfigWithoutDataEnvelope() -> WooShippingUpdateShipmentResponse? { + mapShippingLabelConfig(from: "shipping-label-update-shipment-without-data") + } +} diff --git a/Networking/NetworkingTests/Remote/WooShippingRemoteTests.swift b/Networking/NetworkingTests/Remote/WooShippingRemoteTests.swift index 21255a1afb8..dbfe62e50ab 100644 --- a/Networking/NetworkingTests/Remote/WooShippingRemoteTests.swift +++ b/Networking/NetworkingTests/Remote/WooShippingRemoteTests.swift @@ -673,6 +673,45 @@ final class WooShippingRemoteTests: XCTestCase { // Then XCTAssertNotNil(result.failure) } + + // MARK: Update shipment + + func test_updateShipment_parses_success_response() throws { + // Given + let remote = WooShippingRemote(network: network) + network.simulateResponse(requestUrlSuffix: "shipments/\(sampleOrderID)", filename: "shipping-label-update-shipment") + + // When + let result: Result = waitFor { promise in + remote.updateShipment(siteID: self.sampleSiteID, + orderID: self.sampleOrderID, + shipmentToUpdate: WooShippingUpdateShipment.fake()) { result in + promise(result) + } + } + + // Then + let config = try XCTUnwrap(result.get()) + XCTAssertEqual(config.shipments.count, 3) + } + + func test_updateShipment_returns_error_on_network_failure() { + // Given + let remote = WooShippingRemote(network: network) + network.simulateResponse(requestUrlSuffix: "shipments/\(sampleOrderID)", filename: "generic_error") + + // When + let result: Result = waitFor { promise in + remote.updateShipment(siteID: self.sampleSiteID, + orderID: self.sampleOrderID, + shipmentToUpdate: WooShippingUpdateShipment.fake()) { result in + promise(result) + } + } + + // Then + XCTAssertNotNil(result.failure) + } } private extension WooShippingRemoteTests { diff --git a/Networking/NetworkingTests/Responses/shipping-label-update-shipment-without-data.json b/Networking/NetworkingTests/Responses/shipping-label-update-shipment-without-data.json new file mode 100644 index 00000000000..07f8a199039 --- /dev/null +++ b/Networking/NetworkingTests/Responses/shipping-label-update-shipment-without-data.json @@ -0,0 +1,4 @@ +{ + "success": true, + "data": "{\"0\":[{\"id\":209,\"subItems\":[\"209-sub-0\",\"209-sub-1\",\"209-sub-2\"]},{\"id\":210,\"subItems\":[\"210-sub-0\",\"210-sub-1\"]},{\"id\":211,\"subItems\":[]},{\"id\":212,\"subItems\":[]}],\"1\":[{\"id\":210,\"subItems\":[]},{\"id\":211,\"subItems\":[]},{\"id\":212,\"subItems\":[\"212-sub-0\",\"212-sub-1\",\"212-sub-2\"]}],\"2\":[{\"id\":209,\"subItems\":[\"209-sub-0\",\"209-sub-1\"]}]}" +} diff --git a/Networking/NetworkingTests/Responses/shipping-label-update-shipment.json b/Networking/NetworkingTests/Responses/shipping-label-update-shipment.json new file mode 100644 index 00000000000..0efe9ab33b0 --- /dev/null +++ b/Networking/NetworkingTests/Responses/shipping-label-update-shipment.json @@ -0,0 +1,6 @@ +{ + "data": { + "success": true, + "data": "{\"0\":[{\"id\":209,\"subItems\":[\"209-sub-0\",\"209-sub-1\",\"209-sub-2\"]},{\"id\":210,\"subItems\":[\"210-sub-0\",\"210-sub-1\"]},{\"id\":211,\"subItems\":[]},{\"id\":212,\"subItems\":[]}],\"1\":[{\"id\":210,\"subItems\":[]},{\"id\":211,\"subItems\":[]},{\"id\":212,\"subItems\":[\"212-sub-0\",\"212-sub-1\",\"212-sub-2\"]}],\"2\":[{\"id\":209,\"subItems\":[\"209-sub-0\",\"209-sub-1\"]}]}" + } +} diff --git a/Yosemite/YosemiteTests/Mocks/Networking/Remote/MockWooShippingRemote.swift b/Yosemite/YosemiteTests/Mocks/Networking/Remote/MockWooShippingRemote.swift index 1359a5d64cb..962545ce9d3 100644 --- a/Yosemite/YosemiteTests/Mocks/Networking/Remote/MockWooShippingRemote.swift +++ b/Yosemite/YosemiteTests/Mocks/Networking/Remote/MockWooShippingRemote.swift @@ -54,6 +54,9 @@ final class MockWooShippingRemote { /// The results to return based on the given arguments in `loadConfig` private var loadConfig = [ResultKey: Result]() + /// The results to return based on the given arguments in `updateShipment` + private var updateShipment = [ResultKey: Result]() + /// Set the value passed to the `completion` block if `createPackage` is called. func whenCreatePackage(siteID: Int64, thenReturn result: Result) { @@ -151,6 +154,13 @@ final class MockWooShippingRemote { let key = ResultKey(siteID: siteID) loadConfig[key] = result } + + /// Set the value passed to the `completion` block if `updateShipment` is called. + func whenUpdatingShipment(siteID: Int64, + thenReturn result: Result) { + let key = ResultKey(siteID: siteID) + updateShipment[key] = result + } } // MARK: - WooShippingRemoteProtocol @@ -372,4 +382,20 @@ extension MockWooShippingRemote: WooShippingRemoteProtocol { } } } + + func updateShipment(siteID: Int64, + orderID: Int64, + shipmentToUpdate: WooShippingUpdateShipment, + completion: @escaping (Result) -> Void) { + DispatchQueue.main.async { [weak self] in + guard let self = self else { return } + + let key = ResultKey(siteID: siteID) + if let result = self.updateShipment[key] { + completion(result) + } else { + XCTFail("\(String(describing: self)) Could not find Result for \(key)") + } + } + } }