Merge pull request #8 from companieshouse/PCI-608-clear-basket

Clear basket once payment has been patched

Author: nabeelamirch

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

@@ -19,6 +19,7 @@
 import uk.gov.companieshouse.orders.api.model.Basket;
 import uk.gov.companieshouse.orders.api.model.Checkout;
 import uk.gov.companieshouse.orders.api.model.Item;
+import uk.gov.companieshouse.orders.api.model.PaymentStatus;
 import uk.gov.companieshouse.orders.api.service.ApiClientService;
 import uk.gov.companieshouse.orders.api.service.BasketService;
 import uk.gov.companieshouse.orders.api.service.CheckoutService;
@@ -122,8 +123,13 @@ public ResponseEntity<?> checkoutBasket(@RequestBody(required = false) String js
     @PatchMapping("${uk.gov.companieshouse.orders.api.basket.payment}/{id}")
     public ResponseEntity<String> patchBasketPaymentDetails(final @RequestBody BasketPaymentRequestDTO basketPaymentRequestDTO,
                                                             final @PathVariable String id,
+                                                            HttpServletRequest request,
                                                             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);
+        }
         return ResponseEntity.ok("");
     }
 

src/main/java/uk/gov/companieshouse/orders/api/dto/BasketPaymentRequestDTO.java

@@ -1,6 +1,7 @@
 package uk.gov.companieshouse.orders.api.dto;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import uk.gov.companieshouse.orders.api.model.PaymentStatus;
 
 public class BasketPaymentRequestDTO {
 
@@ -11,7 +12,7 @@ public class BasketPaymentRequestDTO {
     private String paymentReference;
 
     @JsonProperty("status")
-    private String status;
+    private PaymentStatus status;
 
     public String getPaidAt() {
         return paidAt;
@@ -29,11 +30,11 @@ public void setPaymentReference(String paymentReference) {
         this.paymentReference = paymentReference;
     }
 
-    public String getStatus() {
+    public PaymentStatus getStatus() {
         return status;
     }
 
-    public void setStatus(String status) {
+    public void setStatus(PaymentStatus status) {
         this.status = status;
     }
 }

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

@@ -0,0 +1,19 @@
+package uk.gov.companieshouse.orders.api.model;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+
+import static uk.gov.companieshouse.orders.api.converter.EnumValueNameConverter.convertEnumValueNameToJson;
+
+public enum PaymentStatus {
+    PAID,
+    FAILED,
+    PENDING,
+    EXPIRED,
+    IN_PROGRESS,
+    NO_FUNDS;
+
+    @JsonValue
+    public String getJsonName() {
+        return convertEnumValueNameToJson(this);
+    }
+}

src/main/java/uk/gov/companieshouse/orders/api/repository/BasketRepository.java

@@ -5,4 +5,4 @@
 import uk.gov.companieshouse.orders.api.model.Basket;
 
 @RepositoryRestResource
-public interface BasketRepository extends MongoRepository<Basket, String> { }
+public interface BasketRepository extends MongoRepository<Basket, String>, BasketRepositoryCustom { }

src/main/java/uk/gov/companieshouse/orders/api/repository/BasketRepositoryCustom.java

@@ -0,0 +1,7 @@
+package uk.gov.companieshouse.orders.api.repository;
+
+import uk.gov.companieshouse.orders.api.model.Basket;
+
+public interface BasketRepositoryCustom {
+    Basket clearBasketDataById(String id);
+}

src/main/java/uk/gov/companieshouse/orders/api/repository/BasketRepositoryImpl.java

@@ -0,0 +1,29 @@
+package uk.gov.companieshouse.orders.api.repository;
+
+import org.springframework.data.mongodb.core.MongoTemplate;
+import org.springframework.data.mongodb.core.query.Query;
+import org.springframework.data.mongodb.core.query.Update;
+import uk.gov.companieshouse.orders.api.model.Basket;
+import uk.gov.companieshouse.orders.api.model.BasketData;
+
+import static org.springframework.data.mongodb.core.query.Criteria.where;
+
+
+public class BasketRepositoryImpl implements BasketRepositoryCustom {
+
+    private final MongoTemplate mongoTemplate;
+
+    public BasketRepositoryImpl(MongoTemplate mongoTemplate) {
+        this.mongoTemplate = mongoTemplate;
+    }
+
+    @Override
+    public Basket clearBasketDataById(String id) {
+        Query query = new Query().addCriteria(where("_id").is(id));
+
+        Update update = new Update();
+        update.set("data", new BasketData());
+
+        return mongoTemplate.findAndModify(query, update, Basket.class);
+    }
+}

src/main/java/uk/gov/companieshouse/orders/api/service/BasketService.java

@@ -31,4 +31,8 @@ public Basket saveBasket(Basket basket) {
     public Optional<Basket> getBasketById(String id) {
         return repository.findById(id);
     }
+
+    public Basket clearBasket(String id) {
+        return repository.clearBasketDataById(id);
+    }
 }

src/test/java/uk/gov/companieshouse/orders/api/controller/BasketControllerIntegrationTest.java

@@ -19,6 +19,7 @@
 import uk.gov.companieshouse.orders.api.model.Certificate;
 import uk.gov.companieshouse.orders.api.model.Checkout;
 import uk.gov.companieshouse.orders.api.model.Item;
+import uk.gov.companieshouse.orders.api.model.PaymentStatus;
 import uk.gov.companieshouse.orders.api.repository.BasketRepository;
 import uk.gov.companieshouse.orders.api.repository.CheckoutRepository;
 import uk.gov.companieshouse.orders.api.service.ApiClientService;
@@ -244,7 +245,7 @@ public void patchBasketPaymentDetailsReturnsOK() throws Exception {
         BasketPaymentRequestDTO basketPaymentRequestDTO = new BasketPaymentRequestDTO();
         basketPaymentRequestDTO.setPaidAt("paid-at");
         basketPaymentRequestDTO.setPaymentReference("reference");
-        basketPaymentRequestDTO.setStatus("status");
+        basketPaymentRequestDTO.setStatus(PaymentStatus.PAID);
 
         mockMvc.perform(patch("/basket/payment/1234")
                 .header(REQUEST_ID_HEADER_NAME, TOKEN_REQUEST_ID_VALUE)
@@ -253,4 +254,56 @@ public void patchBasketPaymentDetailsReturnsOK() throws Exception {
                 .content(mapper.writeValueAsString(basketPaymentRequestDTO)))
                 .andExpect(status().isOk());
     }
+
+    @Test
+    @DisplayName("Patch basket payment details clears basket is status is paid")
+    public void patchBasketPaymentDetailsClearsBasketStatusPaid() throws Exception {
+        Basket basket = new Basket();
+        basket.setId(ERIC_IDENTITY_VALUE);
+        BasketItem basketItem = new BasketItem();
+        basketItem.setItemUri(ITEM_URI);
+        basket.getData().getItems().add(basketItem);
+        basketRepository.save(basket);
+
+        BasketPaymentRequestDTO basketPaymentRequestDTO = new BasketPaymentRequestDTO();
+        basketPaymentRequestDTO.setPaidAt("paid-at");
+        basketPaymentRequestDTO.setPaymentReference("reference");
+        basketPaymentRequestDTO.setStatus(PaymentStatus.PAID);
+
+        mockMvc.perform(patch("/basket/payment/1234")
+                .header(REQUEST_ID_HEADER_NAME, TOKEN_REQUEST_ID_VALUE)
+                .header(ERIC_IDENTITY_HEADER_NAME, ERIC_IDENTITY_VALUE)
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(mapper.writeValueAsString(basketPaymentRequestDTO)))
+                .andExpect(status().isOk());
+
+        final Optional<Basket> retrievedBasket = basketRepository.findById(ERIC_IDENTITY_VALUE);
+        assertTrue(retrievedBasket.get().getData().getItems().isEmpty());
+    }
+
+    @Test
+    @DisplayName("Patch basket payment details does not clear basket is status is not paid")
+    public void patchBasketPaymentDetailsDoesNotClearBasketStatusNotPaid() throws Exception {
+        Basket basket = new Basket();
+        basket.setId(ERIC_IDENTITY_VALUE);
+        BasketItem basketItem = new BasketItem();
+        basketItem.setItemUri(ITEM_URI);
+        basket.getData().getItems().add(basketItem);
+        basketRepository.save(basket);
+
+        BasketPaymentRequestDTO basketPaymentRequestDTO = new BasketPaymentRequestDTO();
+        basketPaymentRequestDTO.setPaidAt("paid-at");
+        basketPaymentRequestDTO.setPaymentReference("reference");
+        basketPaymentRequestDTO.setStatus(PaymentStatus.FAILED);
+
+        mockMvc.perform(patch("/basket/payment/1234")
+                .header(REQUEST_ID_HEADER_NAME, TOKEN_REQUEST_ID_VALUE)
+                .header(ERIC_IDENTITY_HEADER_NAME, ERIC_IDENTITY_VALUE)
+                .contentType(MediaType.APPLICATION_JSON)
+                .content(mapper.writeValueAsString(basketPaymentRequestDTO)))
+                .andExpect(status().isOk());
+
+        final Optional<Basket> retrievedBasket = basketRepository.findById(ERIC_IDENTITY_VALUE);
+        assertFalse(retrievedBasket.get().getData().getItems().isEmpty());
+    }
 }

src/test/java/uk/gov/companieshouse/orders/api/repository/BasketRespositoryImplTest.java

@@ -0,0 +1,33 @@
+package uk.gov.companieshouse.orders.api.repository;
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.InjectMocks;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.springframework.data.mongodb.core.MongoTemplate;
+import org.springframework.data.mongodb.core.query.Query;
+import org.springframework.data.mongodb.core.query.Update;
+import uk.gov.companieshouse.orders.api.model.Basket;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+
+@ExtendWith(MockitoExtension.class)
+public class BasketRespositoryImplTest {
+
+    @InjectMocks
+    private BasketRepositoryImpl repositoryUnderTest;
+
+    @Mock
+    MongoTemplate mongoTemplate;
+
+    @Test
+    public void clearBasketDataByIdVerifyFindAndModifyCalledOnce() {
+        repositoryUnderTest.clearBasketDataById("ID");
+        verify(mongoTemplate, times(1)).findAndModify(any(Query.class), any(Update.class), eq(Basket.class));
+    }
+
+}