Update OrderLine Swagger examples (#61)

Update OrderLines with new status and fix Swagger examples
NationalLibraryOfNorway · Feb 3, 2025 · f9041a5 · f9041a5
1 parent f773ec8
commit f9041a5
Show file tree

Hide file tree

Showing 4 changed files with 86 additions and 14 deletions.
diff --git a/src/main/kotlin/no/nb/mlt/wls/application/hostapi/order/ApiCreateOrderPayload.kt b/src/main/kotlin/no/nb/mlt/wls/application/hostapi/order/ApiCreateOrderPayload.kt
@@ -16,8 +16,7 @@ import org.apache.commons.validator.routines.UrlValidator
       "hostOrderId": "mlt-12345-order",
       "orderLine": [
         {
-          "hostId": "mlt-12345",
-          "status": "NOT_STARTED"
+          "hostId": "mlt-12345"
         }
       ],
       "orderType": "LOAN",

diff --git a/src/main/kotlin/no/nb/mlt/wls/application/hostapi/order/ApiOrderPayload.kt b/src/main/kotlin/no/nb/mlt/wls/application/hostapi/order/ApiOrderPayload.kt
@@ -160,7 +160,8 @@ data class OrderLine(
     val hostId: String,
     @Schema(
         description = """Current status for the ordered item.""",
-        examples = ["NOT_STARTED", "PICKED", "FAILED"]
+        examples = ["NOT_STARTED", "PICKED", "RETURNED", "FAILED"],
+        accessMode = READ_ONLY
     )
     val status: Order.OrderItem.Status?
 ) {

diff --git a/src/main/kotlin/no/nb/mlt/wls/domain/model/Order.kt b/src/main/kotlin/no/nb/mlt/wls/domain/model/Order.kt
@@ -1,8 +1,6 @@
 package no.nb.mlt.wls.domain.model
 
 import no.nb.mlt.wls.domain.model.Order.Address
-import no.nb.mlt.wls.domain.model.Order.OrderItem.Status.FAILED
-import no.nb.mlt.wls.domain.model.Order.OrderItem.Status.PICKED
 import no.nb.mlt.wls.domain.ports.inbound.IllegalOrderStateException
 import no.nb.mlt.wls.domain.ports.inbound.ValidationException
 import java.net.URI
@@ -35,7 +33,7 @@ data class Order(
         hostIds: List<String>,
         status: OrderItem.Status
     ): Order {
-        if (isOrderClosed()) {
+        if (isOrderClosed() && status != OrderItem.Status.RETURNED) {
             throw IllegalOrderStateException("Order is already closed with status: $status")
         }
 
@@ -72,7 +70,16 @@ data class Order(
     }
 
     private fun updateOrderStatusFromOrderLines(): Order {
+        // This might benefit from a small refactor of sorts
         return when {
+            orderLine.all(OrderItem::isReturned) -> {
+                this.copy(status = Status.RETURNED)
+            }
+
+            orderLine.all(OrderItem::isComplete) -> {
+                this.copy(status = Status.COMPLETED)
+            }
+
             orderLine.all(OrderItem::isPickedOrFailed) -> {
                 this.copy(status = Status.COMPLETED)
             }
@@ -86,7 +93,7 @@ data class Order(
     }
 
     private fun isOrderClosed(): Boolean {
-        return listOf(Status.COMPLETED, Status.DELETED).contains(status)
+        return listOf(Status.COMPLETED, Status.DELETED, Status.RETURNED).contains(status)
     }
 
     private fun isOrderProcessingStarted(): Boolean {
@@ -106,7 +113,8 @@ data class Order(
     ): Order {
         throwIfInProgress()
 
-        return this.setOrderLines(itemIds)
+        return this
+            .setOrderLines(itemIds)
             .setCallbackUrl(callbackUrl)
             .setOrderType(orderType)
             .setAddress(address)
@@ -143,7 +151,7 @@ data class Order(
     }
 
     fun pickOrder(itemIds: List<String>): Order {
-        return this.setOrderLineStatus(itemIds, PICKED)
+        return this.setOrderLineStatus(itemIds, OrderItem.Status.PICKED)
     }
 
     private fun throwIfInvalidUrl(url: String) {
@@ -161,7 +169,33 @@ data class Order(
         enum class Status {
             NOT_STARTED,
             PICKED,
-            FAILED
+            FAILED,
+            RETURNED
+        }
+
+        fun isPickedOrFailed(): Boolean {
+            return when (this.status) {
+                Status.NOT_STARTED -> false
+                Status.PICKED -> true
+                Status.FAILED -> true
+                Status.RETURNED -> false
+            }
+        }
+
+        /**
+         * Used to infer from the OrderItems in OrderLines that the Order is complete
+         */
+        fun isComplete(): Boolean {
+            return when (this.status) {
+                Status.NOT_STARTED -> false
+                Status.PICKED -> true
+                Status.FAILED -> true
+                Status.RETURNED -> true
+            }
+        }
+
+        fun isReturned(): Boolean {
+            return this.status == Status.RETURNED
         }
     }
 
@@ -213,8 +247,4 @@ data class Order(
     }
 }
 
-fun Order.OrderItem.isPickedOrFailed(): Boolean {
-    return this.status == PICKED || this.status == FAILED
-}
-
 fun createOrderAddress(): Address = Address(null, null, null, null, null, null, null)
diff --git a/src/test/kotlin/no/nb/mlt/wls/order/controller/OrderControllerTest.kt b/src/test/kotlin/no/nb/mlt/wls/order/controller/OrderControllerTest.kt
@@ -353,6 +353,23 @@ class OrderControllerTest(
         }
     }
 
+    @Test
+    fun `updateOrder when order is complete returns 409`() {
+        val testPayload = completeOrder.toApiOrderPayload().copy(orderType = Order.Type.DIGITIZATION)
+        runTest {
+            repository.save(completeOrder.toMongoOrder()).awaitSingle()
+
+            webTestClient
+                .mutateWith(csrf())
+                .mutateWith(mockJwt().authorities(SimpleGrantedAuthority("ROLE_order"), SimpleGrantedAuthority(clientRole)))
+                .put()
+                .bodyValue(testPayload)
+                .accept(MediaType.APPLICATION_JSON)
+                .exchange()
+                .expectStatus().isEqualTo(HttpStatus.CONFLICT)
+        }
+    }
+
     @Test
     fun `deleteOrder with valid data deletes order`() =
         runTest {
@@ -529,6 +546,31 @@ class OrderControllerTest(
             callbackUrl = "https://callback-wls.no/order"
         )
 
+    private val completeOrder =
+        Order(
+            hostName = HostName.AXIELL,
+            hostOrderId = "order-completed",
+            status = Order.Status.COMPLETED,
+            orderLine =
+                listOf(
+                    Order.OrderItem("item-123", Order.OrderItem.Status.PICKED)
+                ),
+            orderType = Order.Type.LOAN,
+            address =
+                Order.Address(
+                    recipient = "recipient",
+                    addressLine1 = "addressLine1",
+                    addressLine2 = "addressLine2",
+                    postcode = "postcode",
+                    city = "city",
+                    region = "region",
+                    country = "country"
+                ),
+            contactPerson = "named person",
+            note = "note",
+            callbackUrl = "https://callback-wls.no/order"
+        )
+
     /**
      * Populate the database with items and orders for testing
      */