Merge pull request #151 from companieshouse/dcac-256-update-item

caismith-ch · web-flow · commit 02c158b6f262 · 2023-12-05T09:50:42.000Z
DCAC-256, DCAC-257 - PATCH order item method
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/controller/OrderController.java b/src/main/java/uk/gov/companieshouse/orders/api/controller/OrderController.java
@@ -17,13 +17,16 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 import uk.gov.companieshouse.logging.Logger;
 import uk.gov.companieshouse.logging.LoggerFactory;
+import uk.gov.companieshouse.orders.api.dto.PatchOrderedItemDTO;
 import uk.gov.companieshouse.orders.api.exception.ResourceNotFoundException;
 import uk.gov.companieshouse.orders.api.logging.LoggingUtils;
 import uk.gov.companieshouse.orders.api.model.Checkout;
@@ -32,6 +35,7 @@
 import uk.gov.companieshouse.orders.api.model.CheckoutSearchCriteria;
 import uk.gov.companieshouse.orders.api.model.CheckoutSearchResults;
 import uk.gov.companieshouse.orders.api.model.Item;
+import uk.gov.companieshouse.orders.api.model.ItemStatus;
 import uk.gov.companieshouse.orders.api.model.Order;
 import uk.gov.companieshouse.orders.api.model.OrderData;
 import uk.gov.companieshouse.orders.api.model.PageCriteria;
@@ -51,7 +55,7 @@ public class OrderController {
     public static final String GET_ORDER_URI =
             "${uk.gov.companieshouse.orders.api.orders}/{" + ORDER_ID_PATH_VARIABLE + "}";
 
-    public static final String GET_ORDER_ITEM_URI = "/orders/{id}/items/{itemId}";
+    public static final String ORDER_ITEM_URI = "/orders/{id}/items/{itemId}";
     public static final String GET_CHECKOUT_ITEM_URI = "/checkouts/{id}/items/{itemId}";
 
     /** <code>${uk.gov.companieshouse.orders.api.checkouts}/{id}</code> */
@@ -86,7 +90,7 @@ public ResponseEntity<OrderData> getOrder(final @PathVariable(ORDER_ID_PATH_VARI
         return ResponseEntity.ok().body(orderRetrieved.getData());
     }
 
-    @GetMapping(GET_ORDER_ITEM_URI)
+    @GetMapping(ORDER_ITEM_URI)
     public ResponseEntity<Item> getOrderItem(final @PathVariable("id") String orderId,
                                              final @PathVariable("itemId") String itemId,
                                              final @RequestHeader(REQUEST_ID_HEADER_NAME) String requestId) {
@@ -101,6 +105,22 @@ public ResponseEntity<Item> getOrderItem(final @PathVariable("id") String orderI
         return ResponseEntity.ok().body(item);
     }
 
+    @PatchMapping(ORDER_ITEM_URI)
+    public ResponseEntity<Item> patchOrderItem(final @PathVariable("id") String orderId,
+                                               final @PathVariable("itemId") String itemId,
+                                               final @RequestBody PatchOrderedItemDTO patchOrderedItemDTO,
+                                               final @RequestHeader(REQUEST_ID_HEADER_NAME) String requestId) {
+        Map<String, Object> logMap = createLogMapWithRequestId(requestId);
+        logIfNotNull(logMap, LoggingUtils.ORDER_ID, orderId);
+        logIfNotNull(logMap, LoggingUtils.ITEM_ID, itemId);
+        LOGGER.info("Patching order item", logMap);
+
+        final Item patchedItem = orderService.patchOrderItem(orderId, itemId, patchOrderedItemDTO)
+            .orElseThrow(ResourceNotFoundException::new);
+
+        return ResponseEntity.ok().body(patchedItem);
+    }
+
     @GetMapping(GET_CHECKOUT_ITEM_URI)
     public ResponseEntity<CheckoutData> getCheckoutItem(final @PathVariable("id") String checkoutId,
             final @PathVariable("itemId") String itemId,
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/dto/PatchOrderedItemDTO.java b/src/main/java/uk/gov/companieshouse/orders/api/dto/PatchOrderedItemDTO.java
@@ -0,0 +1,29 @@
+package uk.gov.companieshouse.orders.api.dto;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import uk.gov.companieshouse.orders.api.model.ItemStatus;
+
+public class PatchOrderedItemDTO {
+
+    @JsonProperty("digital_document_location")
+    private String digitalDocumentLocation;
+
+    @JsonProperty("status")
+    private ItemStatus status;
+
+    public String getDigitalDocumentLocation() {
+        return digitalDocumentLocation;
+    }
+
+    public void setDigitalDocumentLocation(String digitalDocumentLocation) {
+        this.digitalDocumentLocation = digitalDocumentLocation;
+    }
+
+    public ItemStatus getStatus() {
+        return status;
+    }
+
+    public void setStatus(ItemStatus status) {
+        this.status = status;
+    }
+}
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/interceptor/RequestUris.java b/src/main/java/uk/gov/companieshouse/orders/api/interceptor/RequestUris.java
@@ -3,7 +3,7 @@
 import static uk.gov.companieshouse.orders.api.controller.BasketController.*;
 import static uk.gov.companieshouse.orders.api.controller.OrderController.GET_CHECKOUT_ITEM_URI;
 import static uk.gov.companieshouse.orders.api.controller.OrderController.GET_CHECKOUT_URI;
-import static uk.gov.companieshouse.orders.api.controller.OrderController.GET_ORDER_ITEM_URI;
+import static uk.gov.companieshouse.orders.api.controller.OrderController.ORDER_ITEM_URI;
 import static uk.gov.companieshouse.orders.api.controller.OrderController.GET_ORDER_URI;
 import static uk.gov.companieshouse.orders.api.controller.OrderController.CHECKOUTS_SEARCH_URI;
 import static uk.gov.companieshouse.orders.api.controller.OrderController.POST_REPROCESS_ORDER_URI;
@@ -27,6 +27,7 @@ class RequestUris {
     static final String PATCH_PAYMENT_DETAILS = "patchPaymentDetails";
     static final String GET_ORDER = "getOrder";
     static final String GET_ORDER_ITEM = "getOrderItem";
+    static final String PATCH_ORDER_ITEM = "patchOrderItem";
     static final String SEARCH = "searchCheckouts";
     static final String GET_CHECKOUT = "getCheckout";
     static final String GET_CHECKOUT_ITEM = "getCheckoutItem";
@@ -44,8 +45,8 @@ class RequestUris {
     @Value(GET_PAYMENT_DETAILS_URI)
     private String getPaymentDetailsUri;
     @Value(GET_ORDER_URI)
-    private String getOrderUri;
-    @Value(GET_ORDER_ITEM_URI)
+    private String orderItemUri;
+    @Value(ORDER_ITEM_URI)
     private String getOrderItemUri;
     @Value(CHECKOUTS_SEARCH_URI)
     private String searchUri;
@@ -113,7 +114,7 @@ List<RequestMappingInfo> requestMappingInfoList() {
                 .build());
 
         knownRequests.add(RequestMappingInfo
-                .paths(getOrderUri)
+                .paths(orderItemUri)
                 .methods(RequestMethod.GET)
                 .mappingName(GET_ORDER)
                 .build());
@@ -124,6 +125,12 @@ List<RequestMappingInfo> requestMappingInfoList() {
                 .mappingName(GET_ORDER_ITEM)
                 .build());
 
+        knownRequests.add(RequestMappingInfo
+            .paths(getOrderItemUri)
+            .methods(RequestMethod.PATCH)
+            .mappingName(PATCH_ORDER_ITEM)
+            .build());
+
         knownRequests.add(RequestMappingInfo
                 .paths(getCheckoutItemUri)
                 .methods(RequestMethod.GET)
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/interceptor/UserAuthenticationInterceptor.java b/src/main/java/uk/gov/companieshouse/orders/api/interceptor/UserAuthenticationInterceptor.java
@@ -58,6 +58,7 @@ private boolean checkAuthenticated(HttpServletRequest request, HttpServletRespon
             case GET_ORDER:
                 return hasAuthenticatedClient(request, response);
             case GET_ORDER_ITEM:
+            case PATCH_ORDER_ITEM:
                 return securityManager.checkIdentity() || hasAuthenticatedClient(request, response);
             case GET_CHECKOUT:
             case SEARCH:
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/interceptor/UserAuthorisationInterceptor.java b/src/main/java/uk/gov/companieshouse/orders/api/interceptor/UserAuthorisationInterceptor.java
@@ -14,6 +14,7 @@
 import static uk.gov.companieshouse.orders.api.interceptor.RequestUris.GET_ORDER;
 import static uk.gov.companieshouse.orders.api.interceptor.RequestUris.GET_ORDER_ITEM;
 import static uk.gov.companieshouse.orders.api.interceptor.RequestUris.GET_PAYMENT_DETAILS;
+import static uk.gov.companieshouse.orders.api.interceptor.RequestUris.PATCH_ORDER_ITEM;
 import static uk.gov.companieshouse.orders.api.interceptor.RequestUris.PATCH_PAYMENT_DETAILS;
 import static uk.gov.companieshouse.orders.api.interceptor.RequestUris.POST_REPROCESS_ORDER;
 import static uk.gov.companieshouse.orders.api.interceptor.RequestUris.REMOVE_BASKET_ITEM;
@@ -90,6 +91,7 @@ private boolean checkAuthorised(HttpServletRequest request, HttpServletResponse
             case GET_ORDER:
                 return getRequestClientIsAuthorised(request, response, this::getOrderUserIsResourceOwner);
             case GET_ORDER_ITEM:
+            case PATCH_ORDER_ITEM:
                 return securityManager.checkPermission() || getRequestClientIsAuthorised(request, response, this::getOrderUserIsResourceOwner);
             case SEARCH:
             case GET_CHECKOUT_ITEM:
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/model/Item.java b/src/main/java/uk/gov/companieshouse/orders/api/model/Item.java
@@ -47,6 +47,8 @@ public class Item {
 
     private String totalItemCost;
 
+    private String digitalDocumentLocation;
+
     public String getId() {
         return id;
     }
@@ -198,4 +200,12 @@ public String getTotalItemCost() {
     public void setTotalItemCost(String totalItemCost) {
         this.totalItemCost = totalItemCost;
     }
+
+    public String getDigitalDocumentLocation() {
+        return digitalDocumentLocation;
+    }
+
+    public void setDigitalDocumentLocation(String digitalDocumentLocation) {
+        this.digitalDocumentLocation = digitalDocumentLocation;
+    }
 }
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/model/ItemStatus.java b/src/main/java/uk/gov/companieshouse/orders/api/model/ItemStatus.java
@@ -7,7 +7,9 @@
 public enum ItemStatus {
     UNKNOWN,
     PROCESSING,
-    SATISFIED;
+    SATISFIED,
+    CANCELLED,
+    FAILED;
 
     @JsonValue
     public String getJsonName() {
diff --git a/src/main/java/uk/gov/companieshouse/orders/api/service/OrderService.java b/src/main/java/uk/gov/companieshouse/orders/api/service/OrderService.java
@@ -1,17 +1,12 @@
 package uk.gov.companieshouse.orders.api.service;
 
-import static uk.gov.companieshouse.orders.api.logging.LoggingUtils.APPLICATION_NAMESPACE;
-
 import com.mongodb.MongoException;
-import java.time.LocalDateTime;
-import java.util.Map;
-import java.util.Optional;
-
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Service;
 import uk.gov.companieshouse.logging.Logger;
 import uk.gov.companieshouse.logging.LoggerFactory;
 import uk.gov.companieshouse.orders.OrderReceived;
+import uk.gov.companieshouse.orders.api.dto.PatchOrderedItemDTO;
 import uk.gov.companieshouse.orders.api.exception.ForbiddenException;
 import uk.gov.companieshouse.orders.api.exception.MongoOperationException;
 import uk.gov.companieshouse.orders.api.kafka.OrderReceivedMessageProducer;
@@ -23,6 +18,12 @@
 import uk.gov.companieshouse.orders.api.repository.CheckoutRepository;
 import uk.gov.companieshouse.orders.api.repository.OrderRepository;
 
+import java.time.LocalDateTime;
+import java.util.Map;
+import java.util.Optional;
+
+import static uk.gov.companieshouse.orders.api.logging.LoggingUtils.APPLICATION_NAMESPACE;
+
 @Service
 public class OrderService {
 
@@ -103,6 +104,37 @@ public Optional<Item> getOrderItem(String orderId, String itemId) {
 
     }
 
+    public Optional<Item> patchOrderItem(String orderId, String itemId, PatchOrderedItemDTO patchOrderedItemDTO) {
+            Map<String, Object> logMap = LoggingUtils.createLogMap();
+            LoggingUtils.logIfNotNull(logMap, LoggingUtils.ORDER_ID, orderId);
+            LoggingUtils.logIfNotNull(logMap, LoggingUtils.ITEM_ID, itemId);
+            LOGGER.info("Patching order item", logMap);
+
+            Optional<Order> orderToUpdate = orderRepository.findById(orderId);
+            return orderToUpdate.flatMap(o -> {
+                Optional<Item> updatedItem = o.getData()
+                    .getItems()
+                    .stream()
+                    .filter(item -> item.getId().equals(itemId))
+                    .findFirst();
+                updatedItem.ifPresent(item -> {
+                    item.setDigitalDocumentLocation(patchOrderedItemDTO.getDigitalDocumentLocation());
+                    item.setStatus(patchOrderedItemDTO.getStatus());
+                });
+
+                try {
+                    orderRepository.save(orderToUpdate.get());
+                } catch (MongoException ex) {
+                    String errorMessage = String.format(
+                        "Failed to update item with id %s within order %s",itemId, orderId
+                    );
+                    LOGGER.error(errorMessage, ex, logMap);
+                    throw new MongoOperationException(errorMessage, ex);
+                }
+                return updatedItem;
+            });
+        }
+
     public Optional<Checkout> getCheckout(String id) {
         return checkoutRepository.findById(id);
     }
diff --git a/src/test/java/uk/gov/companieshouse/orders/api/controller/OrderControllerIntegrationTest.java b/src/test/java/uk/gov/companieshouse/orders/api/controller/OrderControllerIntegrationTest.java
diff --git a/src/test/java/uk/gov/companieshouse/orders/api/interceptor/UserAuthenticationInterceptorTests.java b/src/test/java/uk/gov/companieshouse/orders/api/interceptor/UserAuthenticationInterceptorTests.java
diff --git a/src/test/java/uk/gov/companieshouse/orders/api/interceptor/UserAuthorisationInterceptorTests.java b/src/test/java/uk/gov/companieshouse/orders/api/interceptor/UserAuthorisationInterceptorTests.java
diff --git a/src/test/java/uk/gov/companieshouse/orders/api/service/OrderServiceTest.java b/src/test/java/uk/gov/companieshouse/orders/api/service/OrderServiceTest.java

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,8 @@ public class Item {`
`47`	`47`
`48`	`48`	`private String totalItemCost;`
`49`	`49`
	`50`	`+ private String digitalDocumentLocation;`
	`51`	`+`
`50`	`52`	`public String getId() {`
`51`	`53`	`return id;`
`52`	`54`	`}`
`@@ -198,4 +200,12 @@ public String getTotalItemCost() {`
`198`	`200`	`public void setTotalItemCost(String totalItemCost) {`
`199`	`201`	`this.totalItemCost = totalItemCost;`
`200`	`202`	`}`
	`203`	`+`
	`204`	`+ public String getDigitalDocumentLocation() {`
	`205`	`+ return digitalDocumentLocation;`
	`206`	`+ }`
	`207`	`+`
	`208`	`+ public void setDigitalDocumentLocation(String digitalDocumentLocation) {`
	`209`	`+ this.digitalDocumentLocation = digitalDocumentLocation;`
	`210`	`+ }`
`201`	`211`	`}`