Merge pull request #11 from companieshouse/pci-609-create-order-following-payment

PCI-609: Create order following payment

Author: VaughanJackson123

src/main/java/uk/gov/companieshouse/orders/api/controller/BasketController.java

@@ -1,5 +1,6 @@
 package uk.gov.companieshouse.orders.api.controller;
 
+import org.springframework.data.rest.webmvc.ResourceNotFoundException;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.PatchMapping;
@@ -17,15 +18,11 @@
 import uk.gov.companieshouse.orders.api.exception.ConflictException;
 import uk.gov.companieshouse.orders.api.mapper.BasketMapper;
 import uk.gov.companieshouse.orders.api.mapper.DeliveryDetailsMapper;
-import uk.gov.companieshouse.orders.api.model.ApiError;
-import uk.gov.companieshouse.orders.api.model.Basket;
-import uk.gov.companieshouse.orders.api.model.Checkout;
-import uk.gov.companieshouse.orders.api.model.DeliveryDetails;
-import uk.gov.companieshouse.orders.api.model.Item;
-import uk.gov.companieshouse.orders.api.model.PaymentStatus;
+import uk.gov.companieshouse.orders.api.model.*;
 import uk.gov.companieshouse.orders.api.service.ApiClientService;
 import uk.gov.companieshouse.orders.api.service.BasketService;
 import uk.gov.companieshouse.orders.api.service.CheckoutService;
+import uk.gov.companieshouse.orders.api.service.OrderService;
 import uk.gov.companieshouse.orders.api.util.EricHeaderHelper;
 import uk.gov.companieshouse.orders.api.validator.CheckoutBasketValidator;
 import uk.gov.companieshouse.orders.api.validator.DeliveryDetailsValidator;
@@ -55,21 +52,24 @@ public class BasketController {
     private final CheckoutBasketValidator checkoutBasketValidator;
     private final DeliveryDetailsValidator deliveryDetailsValidator;
     private final ApiClientService apiClientService;
+    private final OrderService orderService;
 
     public BasketController(final BasketMapper mapper,
                             final DeliveryDetailsMapper deliveryDetailsMapper,
                             final BasketService basketService,
                             final CheckoutService checkoutService,
                             final CheckoutBasketValidator checkoutBasketValidator,
+                            final ApiClientService apiClientService,
                             final DeliveryDetailsValidator deliveryDetailsValidator,
-                            final ApiClientService apiClientService){
+                            final OrderService orderService){
         this.mapper = mapper;
         this.deliveryDetailsMapper = deliveryDetailsMapper;
         this.basketService = basketService;
         this.checkoutService = checkoutService;
         this.checkoutBasketValidator = checkoutBasketValidator;
         this.deliveryDetailsValidator = deliveryDetailsValidator;
         this.apiClientService = apiClientService;
+        this.orderService = orderService;
     }
 
     @PostMapping("${uk.gov.companieshouse.orders.api.basket.items}")
@@ -166,12 +166,28 @@ public ResponseEntity<String> patchBasketPaymentDetails(final @RequestBody Baske
                                                             final @RequestHeader(REQUEST_ID_HEADER_NAME) String requestId) {
         trace("ENTERING patchBasketPaymentDetails(" + basketPaymentRequestDTO + ", " + id + ", " + requestId + ")", requestId);
         if(basketPaymentRequestDTO.getStatus().equals(PaymentStatus.PAID)) {
-            Basket basket = basketService.clearBasket(EricHeaderHelper.getIdentity(request));
-            trace("Cleared basket: " + basket, requestId);
+            processSuccessfulPayment(request, requestId, id);
         }
         return ResponseEntity.ok("");
     }
 
+    /**
+     * Performs the actions required to process a successful payment.
+     * @param request the request
+     * @param requestId the request ID
+     * @param checkoutId the checkout ID
+     */
+    private void processSuccessfulPayment(final HttpServletRequest request,
+                                          final String requestId,
+                                          final String checkoutId) {
+        final Checkout checkout = checkoutService.getCheckoutById(checkoutId)
+                .orElseThrow(ResourceNotFoundException::new);
+        final Order order = orderService.createOrder(checkout);
+        trace("Created order: " + order, requestId);
+        final Basket basket = basketService.clearBasket(EricHeaderHelper.getIdentity(request));
+        trace("Cleared basket: " + basket, requestId);
+    }
+
     /**
      * Utility method that logs each message with the request ID for log tracing/analysis.
      * @param message the message to log

src/main/java/uk/gov/companieshouse/orders/api/converter/StringToEnumConverterFactory.java

@@ -4,6 +4,8 @@
 import org.springframework.core.convert.converter.ConverterFactory;
 import org.springframework.data.convert.ReadingConverter;
 
+import static uk.gov.companieshouse.orders.api.converter.EnumValueNameConverter.convertEnumValueJsonToName;
+
 @ReadingConverter
 public final class StringToEnumConverterFactory implements ConverterFactory<String, Enum> {
 
@@ -19,8 +21,9 @@ public StringToEnumConverter(Class<T> enumType) {
             this.enumType = enumType;
         }
 
+        @SuppressWarnings("squid:S1905") // SonarQube false positive - cast is necessary.
         public T convert(String source) {
-            return (T) Enum.valueOf(this.enumType, source.trim());
+            return (T) Enum.valueOf(this.enumType, convertEnumValueJsonToName(source));
         }
     }
 }

src/main/java/uk/gov/companieshouse/orders/api/exception/ForbiddenException.java

@@ -0,0 +1,16 @@
+package uk.gov.companieshouse.orders.api.exception;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+@ResponseStatus(HttpStatus.FORBIDDEN)
+public class ForbiddenException extends RuntimeException {
+
+    public ForbiddenException(String message) {
+        this(message, null);
+    }
+
+    public ForbiddenException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

src/main/java/uk/gov/companieshouse/orders/api/mapper/CheckoutToOrderMapper.java

@@ -0,0 +1,15 @@
+package uk.gov.companieshouse.orders.api.mapper;
+
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import uk.gov.companieshouse.orders.api.model.Checkout;
+import uk.gov.companieshouse.orders.api.model.Order;
+
+@Mapper(componentModel = "spring")
+public interface CheckoutToOrderMapper {
+
+    @Mapping(source = "data.paidAt", target = "data.orderedAt")
+    @Mapping(source = "data.checkedOutBy", target = "data.orderedBy")
+    Order checkoutToOrder(Checkout checkout);
+
+}

src/main/java/uk/gov/companieshouse/orders/api/model/AbstractOrder.java

@@ -0,0 +1,55 @@
+package uk.gov.companieshouse.orders.api.model;
+
+import com.google.gson.Gson;
+import org.springframework.data.annotation.Id;
+
+import java.time.LocalDateTime;
+
+/**
+ * Factors out those data fields common to both {@link Checkout} and {@link Order}.
+ */
+public abstract class AbstractOrder {
+    @Id
+    private String id;
+
+    private LocalDateTime createdAt;
+
+    private LocalDateTime updatedAt;
+
+    private String userId;
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public LocalDateTime getCreatedAt() {
+        return createdAt;
+    }
+
+    public void setCreatedAt(LocalDateTime createdAt) {
+        this.createdAt = createdAt;
+    }
+
+    public LocalDateTime getUpdatedAt() {
+        return updatedAt;
+    }
+
+    public void setUpdatedAt(LocalDateTime updatedAt) {
+        this.updatedAt = updatedAt;
+    }
+
+    public String getUserId() {
+        return userId;
+    }
+
+    public void setUserId(String userId) {
+        this.userId = userId;
+    }
+
+    @Override
+    public String toString() { return new Gson().toJson(this); }
+}

src/main/java/uk/gov/companieshouse/orders/api/model/AbstractOrderData.java

@@ -0,0 +1,95 @@
+package uk.gov.companieshouse.orders.api.model;
+
+import com.google.gson.Gson;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Factors out those data fields common to both {@link CheckoutData} and {@link OrderData}.
+ */
+public abstract class AbstractOrderData {
+    private String paymentReference;
+
+    private String etag;
+
+    private DeliveryDetails deliveryDetails = new DeliveryDetails();
+
+    private List<Item> items = new ArrayList<>();
+
+    private String kind;
+
+    private Links links;
+
+    private String totalBasketCost;
+
+    private String reference;
+
+
+    public String getPaymentReference() {
+        return paymentReference;
+    }
+
+    public void setPaymentReference(String paymentReference) {
+        this.paymentReference = paymentReference;
+    }
+
+    public String getEtag() {
+        return etag;
+    }
+
+    public void setEtag(String etag) {
+        this.etag = etag;
+    }
+
+    public DeliveryDetails getDeliveryDetails() {
+        return deliveryDetails;
+    }
+
+    public void setDeliveryDetails(DeliveryDetails deliveryDetails) {
+        this.deliveryDetails = deliveryDetails;
+    }
+
+    public List<Item> getItems() {
+        return items;
+    }
+
+    public void setItems(List<Item> items) {
+        this.items = items;
+    }
+
+    public String getKind() {
+        return kind;
+    }
+
+    public void setKind(String kind) {
+        this.kind = kind;
+    }
+
+    public Links getLinks() {
+        return links;
+    }
+
+    public void setLinks(Links links) {
+        this.links = links;
+    }
+
+    public String getTotalBasketCost() {
+        return totalBasketCost;
+    }
+
+    public void setTotalBasketCost(String totalBasketCost) {
+        this.totalBasketCost = totalBasketCost;
+    }
+
+    public String getReference() {
+        return reference;
+    }
+
+    public void setReference(String reference) {
+        this.reference = reference;
+    }
+
+    @Override
+    public String toString() { return new Gson().toJson(this); }
+}

src/main/java/uk/gov/companieshouse/orders/api/model/ActionedBy.java

@@ -0,0 +1,22 @@
+package uk.gov.companieshouse.orders.api.model;
+
+public class ActionedBy {
+    private String email;
+    private String id;
+
+    public String getEmail() {
+        return email;
+    }
+
+    public void setEmail(String email) {
+        this.email = email;
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+}

src/main/java/uk/gov/companieshouse/orders/api/model/Checkout.java

@@ -1,47 +1,12 @@
 package uk.gov.companieshouse.orders.api.model;
 
-import org.springframework.data.annotation.Id;
 import org.springframework.data.mongodb.core.mapping.Document;
 
-import java.time.LocalDateTime;
-
 @Document(collection = "checkout")
-public class Checkout {
-    @Id
-    private String id;
-
-    private LocalDateTime createdAt;
-
-    private LocalDateTime updatedAt;
+public class Checkout extends AbstractOrder {
 
     private CheckoutData data = new CheckoutData();
 
-    private String userId;
-
-    public String getId() {
-        return id;
-    }
-
-    public void setId(String id) {
-        this.id = id;
-    }
-
-    public LocalDateTime getCreatedAt() {
-        return createdAt;
-    }
-
-    public void setCreatedAt(LocalDateTime createdAt) {
-        this.createdAt = createdAt;
-    }
-
-    public LocalDateTime getUpdatedAt() {
-        return updatedAt;
-    }
-
-    public void setUpdatedAt(LocalDateTime updatedAt) {
-        this.updatedAt = updatedAt;
-    }
-
     public CheckoutData getData() {
         return data;
     }
@@ -50,11 +15,4 @@ public void setData(CheckoutData data) {
         this.data = data;
     }
 
-    public String getUserId() {
-        return userId;
-    }
-
-    public void setUserId(String userId) {
-        this.userId = userId;
-    }
 }