Add BookingResource in Networking layer

Author: itsmeichigo

Modules/Sources/Fakes/Networking.generated.swift

@@ -344,6 +344,23 @@ extension Networking.Booking {
         )
     }
 }
+extension Networking.BookingResource {
+    /// Returns a "ready to use" type filled with fake values.
+    ///
+    public static func fake() -> Networking.BookingResource {
+        .init(
+            id: .fake(),
+            name: .fake(),
+            qty: .fake(),
+            role: .fake(),
+            email: .fake(),
+            phoneNumber: .fake(),
+            imageID: .fake(),
+            imageURL: .fake(),
+            description: .fake()
+        )
+    }
+}
 extension Networking.CompositeComponentOptionType {
     /// Returns a "ready to use" type filled with fake values.
     ///

Modules/Sources/Networking/Mapper/BookingResourceMapper.swift

@@ -0,0 +1,27 @@
+import Foundation
+
+/// Mapper: BookingResource
+///
+struct BookingResourceMapper: Mapper {
+    let siteID: Int64
+
+    func map(response: Data) throws -> BookingResource {
+        let decoder = JSONDecoder()
+        decoder.userInfo = [
+            .siteID: siteID
+        ]
+        if hasDataEnvelope(in: response) {
+            return try decoder.decode(BookingResourceEnvelope.self, from: response).bookingResource
+        } else {
+            return try decoder.decode(BookingResource.self, from: response)
+        }
+    }
+}
+
+private struct BookingResourceEnvelope: Decodable {
+    let bookingResource: BookingResource
+
+    private enum CodingKeys: String, CodingKey {
+        case bookingResource = "data"
+    }
+}

Modules/Sources/Networking/Model/Bookings/BookingResource.swift

@@ -0,0 +1,86 @@
+import Codegen
+import Foundation
+
+public struct BookingResource: Hashable, Decodable, GeneratedFakeable, GeneratedCopiable {
+    public let siteID: Int64
+    public let id: Int64
+    public let name: String
+    public let qty: Int64
+    public let role: String
+    public let email: String?
+    public let phoneNumber: String?
+    public let imageID: Int64
+    public let imageURL: String?
+    public let description: String?
+
+    public init(siteID: Int64,
+                id: Int64,
+                name: String,
+                qty: Int64,
+                role: String,
+                email: String?,
+                phoneNumber: String?,
+                imageID: Int64,
+                imageURL: String?,
+                description: String?) {
+        self.siteID = siteID
+        self.id = id
+        self.name = name
+        self.qty = qty
+        self.role = role
+        self.email = email
+        self.phoneNumber = phoneNumber
+        self.imageID = imageID
+        self.imageURL = imageURL
+        self.description = description
+    }
+
+    public init(from decoder: Decoder) throws {
+        guard let siteID = decoder.userInfo[.siteID] as? Int64 else {
+            throw BookingResourceDecodingError.missingSiteID
+        }
+
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        let id = try container.decode(Int64.self, forKey: .id)
+        let name = try container.decode(String.self, forKey: .name)
+        let qty = try container.decode(Int64.self, forKey: .qty)
+        let role = try container.decode(String.self, forKey: .role)
+        let email = try container.decodeIfPresent(String.self, forKey: .email)
+        let phoneNumber = try container.decodeIfPresent(String.self, forKey: .phoneNumber)
+        let imageID = try container.decode(Int64.self, forKey: .imageID)
+        let imageURL = try container.decodeIfPresent(String.self, forKey: .imageURL)
+        let description = try container.decodeIfPresent(String.self, forKey: .description)
+
+        self.init(siteID: siteID,
+                  id: id,
+                  name: name,
+                  qty: qty,
+                  role: role,
+                  email: email,
+                  phoneNumber: phoneNumber,
+                  imageID: imageID,
+                  imageURL: imageURL,
+                  description: description)
+    }
+}
+
+private extension BookingResource {
+    enum CodingKeys: String, CodingKey {
+        case id
+        case name
+        case qty
+        case role
+        case email
+        case phoneNumber = "phone_number"
+        case imageID = "image_id"
+        case imageURL = "image_url"
+        case description
+    }
+}
+
+// MARK: - Decoding Errors
+//
+enum BookingResourceDecodingError: Error {
+    case missingSiteID
+}

Modules/Sources/Networking/Model/Copiable/Models+Copiable.generated.swift

@@ -494,6 +494,42 @@ extension Networking.Booking {
     }
 }
 
+extension Networking.BookingResource {
+    public func copy(
+        id: CopiableProp<Int64> = .copy,
+        name: CopiableProp<String> = .copy,
+        qty: CopiableProp<Int64> = .copy,
+        role: CopiableProp<String> = .copy,
+        email: NullableCopiableProp<String> = .copy,
+        phoneNumber: NullableCopiableProp<String> = .copy,
+        imageID: CopiableProp<Int64> = .copy,
+        imageURL: NullableCopiableProp<String> = .copy,
+        description: NullableCopiableProp<String> = .copy
+    ) -> Networking.BookingResource {
+        let id = id ?? self.id
+        let name = name ?? self.name
+        let qty = qty ?? self.qty
+        let role = role ?? self.role
+        let email = email ?? self.email
+        let phoneNumber = phoneNumber ?? self.phoneNumber
+        let imageID = imageID ?? self.imageID
+        let imageURL = imageURL ?? self.imageURL
+        let description = description ?? self.description
+
+        return Networking.BookingResource(
+            id: id,
+            name: name,
+            qty: qty,
+            role: role,
+            email: email,
+            phoneNumber: phoneNumber,
+            imageID: imageID,
+            imageURL: imageURL,
+            description: description
+        )
+    }
+}
+
 extension Networking.Coupon {
     public func copy(
         siteID: CopiableProp<Int64> = .copy,

Modules/Sources/Networking/Remote/BookingsRemote.swift

@@ -16,6 +16,9 @@ public protocol BookingsRemoteProtocol {
 
     func loadBooking(bookingID: Int64,
                      siteID: Int64) async throws -> Booking?
+
+    func fetchResource(resourceID: Int64,
+                       siteID: Int64) async throws -> BookingResource?
 }
 
 /// Booking: Remote Endpoints
@@ -84,6 +87,24 @@ public final class BookingsRemote: Remote, BookingsRemoteProtocol {
 
         return try await enqueue(request, mapper: mapper)
     }
+
+    public func fetchResource(
+        resourceID: Int64,
+        siteID: Int64
+    ) async throws -> BookingResource? {
+        let path = "\(Path.resources)/\(resourceID)"
+        let request = JetpackRequest(
+            wooApiVersion: .wcBookings,
+            method: .get,
+            siteID: siteID,
+            path: path,
+            availableAsRESTRequest: true
+        )
+
+        let mapper = BookingResourceMapper(siteID: siteID)
+
+        return try await enqueue(request, mapper: mapper)
+    }
 }
 
 // MARK: - Constants
@@ -101,6 +122,7 @@ public extension BookingsRemote {
 
     private enum Path {
         static let bookings = "bookings"
+        static let resources = "resources"
     }
 
     private enum ParameterKey {

Modules/Tests/NetworkingTests/Remote/BookingsRemoteTests.swift

@@ -90,4 +90,37 @@ struct BookingsRemoteTests {
         #expect(parameters["per_page"] != nil)
         #expect(parameters["order"] != nil)
     }
+
+    @Test func test_fetchResource_properly_returns_parsed_resource() async throws {
+        // Given
+        let remote = BookingsRemote(network: network)
+        let resourceID: Int64 = 22
+        network.simulateResponse(requestUrlSuffix: "resources/\(resourceID)", filename: "booking-resource")
+
+        // When
+        let resource = try await remote.fetchResource(resourceID: resourceID, siteID: sampleSiteID)
+
+        // Then
+        let unwrappedResource = try #require(resource)
+        #expect(unwrappedResource.id == 22)
+        #expect(unwrappedResource.name == "Joel (Sample resource)")
+        #expect(unwrappedResource.qty == 1)
+        #expect(unwrappedResource.role == "")
+        #expect(unwrappedResource.email == "")
+        #expect(unwrappedResource.phoneNumber == "")
+        #expect(unwrappedResource.imageID == 0)
+        #expect(unwrappedResource.imageURL == "")
+        #expect(unwrappedResource.description == "")
+        #expect(unwrappedResource.siteID == sampleSiteID)
+    }
+
+    @Test func test_fetchResource_properly_relays_networking_errors() async {
+        // Given
+        let remote = BookingsRemote(network: network)
+
+        // Then
+        await #expect(throws: NetworkError.notFound()) {
+            _ = try await remote.fetchResource(resourceID: 22, siteID: sampleSiteID)
+        }
+    }
 }

Modules/Tests/NetworkingTests/Responses/booking-resource.json

@@ -0,0 +1,12 @@
+{
+    "id": 22,
+    "name": "Joel (Sample resource)",
+    "qty": 1,
+    "role": "",
+    "email": "",
+    "phone_number": "",
+    "image_id": 0,
+    "image_url": "",
+    "description": "",
+    "note": ""
+}