Merge pull request #3 from companieshouse/PCI-571-controller-method-and-dtos

Pci 318 add item to basket

Author: VaughanJackson123

pom.xml

@@ -14,7 +14,11 @@
 
 	<properties>
 		<java.version>1.8</java.version>
+		<structured-logging.version>1.9.0</structured-logging.version>
+		<commons.lang.version>2.6</commons.lang.version>
+		<commons.beanutils.version>1.9.4</commons.beanutils.version>
 		<org.mapstruct.version>1.3.0.Final</org.mapstruct.version>
+		<gson.version>2.8.0</gson.version>
 		<jacoco-maven-plugin.version>0.7.7.201606060606</jacoco-maven-plugin.version>
 		<junit-jupiter-engine-version>5.2.0</junit-jupiter-engine-version>
 		<mockito-junit-jupiter-version>2.18.0</mockito-junit-jupiter-version>
@@ -23,6 +27,10 @@
 	</properties>
 
 	<dependencies>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-data-mongodb</artifactId>
+		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter-data-rest</artifactId>
@@ -45,6 +53,23 @@
 			<version>${junit-jupiter-engine-version}</version>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>uk.gov.companieshouse</groupId>
+			<artifactId>structured-logging</artifactId>
+			<version>${structured-logging.version}</version>
+			<scope>compile</scope>
+		</dependency>
+		<dependency>
+			<groupId>commons-lang</groupId>
+			<artifactId>commons-lang</artifactId>
+			<version>${commons.lang.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>commons-beanutils</groupId>
+			<artifactId>commons-beanutils</artifactId>
+			<version>${commons.beanutils.version}</version>
+		</dependency>
+
 		<dependency>
 			<groupId>org.mockito</groupId>
 			<artifactId>mockito-junit-jupiter</artifactId>
@@ -57,6 +82,21 @@
 			<version>${hamcrest-all-version}</version>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.mapstruct</groupId>
+			<artifactId>mapstruct</artifactId>
+			<version>${org.mapstruct.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>com.google.code.gson</groupId>
+			<artifactId>gson</artifactId>
+			<version>${gson.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>de.flapdoodle.embed</groupId>
+			<artifactId>de.flapdoodle.embed.mongo</artifactId>
+			<scope>test</scope>
+		</dependency>
 	</dependencies>
 
 	<build>

routes.yaml

@@ -2,4 +2,4 @@ app_name: orders.api.ch.gov.uk
 group: api
 weight: 991
 routes:
-   1: ^/orders/healthcheck
+   1: ^/basket/items

src/main/java/uk/gov/companieshouse/orders/api/config/ApplicationConfig.java

@@ -0,0 +1,32 @@
+package uk.gov.companieshouse.orders.api.config;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.PropertyNamingStrategy;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+import uk.gov.companieshouse.orders.api.interceptor.LoggingInterceptor;
+
+@Configuration
+public class ApplicationConfig implements WebMvcConfigurer {
+
+    @Override
+    public void addInterceptors(final InterceptorRegistry registry) {
+        registry.addInterceptor(new LoggingInterceptor());
+    }
+
+    @Bean
+    public ObjectMapper objectMapper() {
+        return new ObjectMapper()
+                .setDefaultPropertyInclusion(JsonInclude.Include.NON_NULL)
+                .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
+                .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)
+                .setPropertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE)
+                .findAndRegisterModules();
+    }
+
+}

src/main/java/uk/gov/companieshouse/orders/api/config/MongoConfig.java

@@ -0,0 +1,33 @@
+package uk.gov.companieshouse.orders.api.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.mongodb.MongoDbFactory;
+import org.springframework.data.mongodb.core.convert.DbRefResolver;
+import org.springframework.data.mongodb.core.convert.DefaultDbRefResolver;
+import org.springframework.data.mongodb.core.convert.DefaultMongoTypeMapper;
+import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
+import org.springframework.data.mongodb.core.mapping.MongoMappingContext;
+
+@Configuration
+public class MongoConfig {
+    /**
+     * _class maps to the model class in mongoDB (e.g. _class : uk.gov.companieshouse.items.orders.api.model.CertificateItem)
+     * when using spring data mongo it by default adds a _class key to your collection to be able to
+     * handle inheritance. But if your domain model is simple and flat, you can remove it by overriding
+     * the default MappingMongoConverter.
+     * Copied from items.orders.api.ch.gov.uk
+     */
+
+    @Bean
+    public MappingMongoConverter mappingMongoConverter(final MongoDbFactory factory,
+                                                       final MongoMappingContext context) {
+        final DbRefResolver dbRefResolver = new DefaultDbRefResolver(factory);
+        final MappingMongoConverter mappingConverter = new MappingMongoConverter(dbRefResolver, context);
+
+        // Don't save _class to mongo
+        mappingConverter.setTypeMapper(new DefaultMongoTypeMapper(null));
+
+        return mappingConverter;
+    }
+}

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

@@ -0,0 +1,73 @@
+package uk.gov.companieshouse.orders.api.controller;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+import uk.gov.companieshouse.orders.api.dto.AddToBasketRequestDTO;
+import uk.gov.companieshouse.orders.api.dto.AddToBasketResponseDTO;
+import uk.gov.companieshouse.orders.api.mapper.BasketMapper;
+import uk.gov.companieshouse.orders.api.model.Basket;
+
+import uk.gov.companieshouse.logging.Logger;
+import uk.gov.companieshouse.logging.LoggerFactory;
+import uk.gov.companieshouse.orders.api.service.BasketService;
+import uk.gov.companieshouse.orders.api.util.EricHeaderHelper;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.validation.Valid;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Optional;
+
+import static uk.gov.companieshouse.orders.api.OrdersApiApplication.APPLICATION_NAMESPACE;
+
+@RestController
+public class BasketController {
+    private static final Logger LOGGER = LoggerFactory.getLogger(APPLICATION_NAMESPACE);
+
+    private static final String REQUEST_ID_HEADER_NAME = "X-Request-ID";
+    private static final String LOG_MESSAGE_DATA_KEY = "message";
+
+    private final BasketMapper mapper;
+    private final BasketService basketService;
+
+    public BasketController(final BasketMapper mapper, final BasketService basketService){
+        this.mapper = mapper;
+        this.basketService = basketService;
+    }
+
+    @PostMapping("${uk.gov.companieshouse.orders.api.basket.items}")
+    public ResponseEntity<AddToBasketResponseDTO> addItemToBasket(final @Valid @RequestBody AddToBasketRequestDTO addToBasketRequestDTO,
+                                                                  HttpServletRequest request,
+                                                                  final @RequestHeader(REQUEST_ID_HEADER_NAME) String requestId){
+        trace("ENTERING addItemToBasket(" + addToBasketRequestDTO + ")", requestId);
+
+        final Optional<Basket> retrievedBasket = basketService.getBasketById(EricHeaderHelper.getIdentity(request));
+
+        Basket mappedBasket = mapper.addToBasketRequestDTOToBasket(addToBasketRequestDTO);
+
+        Basket returnedBasket;
+        if(retrievedBasket.isPresent()) {
+            retrievedBasket.get().getData().setItems(mappedBasket.getData().getItems());
+            returnedBasket = basketService.saveBasket(retrievedBasket.get());
+        } else {
+            mappedBasket.setId(EricHeaderHelper.getIdentity(request));
+            returnedBasket = basketService.saveBasket(mappedBasket);
+        }
+
+        final AddToBasketResponseDTO addToBasketResponseDTO = mapper.basketToAddToBasketDTO(returnedBasket);
+        trace("EXITING addItemToBasket() with " + addToBasketRequestDTO, requestId);
+        return ResponseEntity.status(HttpStatus.OK).body(addToBasketResponseDTO);
+    }
+
+    /**
+     * Utility method that logs each message with the request ID for log tracing/analysis.
+     * @param message the message to log
+     * @param requestId the request ID
+     */
+    private void trace(final String message, final String requestId) {
+        final Map<String, Object> logData = new HashMap<>();
+        logData.put(LOG_MESSAGE_DATA_KEY, message);
+        LOGGER.traceContext(requestId, "X Request ID header", logData);
+    }
+}

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

@@ -0,0 +1,26 @@
+package uk.gov.companieshouse.orders.api.dto;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.google.gson.Gson;
+
+import javax.validation.constraints.NotBlank;
+import javax.validation.constraints.NotNull;
+
+public class AddToBasketRequestDTO {
+
+    @NotBlank
+    @JsonProperty("item_uri")
+    private String itemUri;
+
+    public String getItemUri() {
+        return itemUri;
+    }
+
+    public void setItemUri(String itemUri) {
+        this.itemUri = itemUri;
+    }
+
+    @Override
+    public String toString() { return new Gson().toJson(this); }
+}

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

@@ -0,0 +1,19 @@
+package uk.gov.companieshouse.orders.api.dto;
+
+import com.google.gson.Gson;
+
+public class AddToBasketResponseDTO {
+
+    private String itemUri;
+
+    public String getItemUri() {
+        return itemUri;
+    }
+
+    public void setItemUri(String itemUri) {
+        this.itemUri = itemUri;
+    }
+
+    @Override
+    public String toString() { return new Gson().toJson(this); }
+}

src/main/java/uk/gov/companieshouse/orders/api/interceptor/LoggingInterceptor.java

@@ -0,0 +1,35 @@
+package uk.gov.companieshouse.orders.api.interceptor;
+
+import org.springframework.lang.Nullable;
+import org.springframework.web.servlet.ModelAndView;
+import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
+import uk.gov.companieshouse.logging.Logger;
+import uk.gov.companieshouse.logging.LoggerFactory;
+import uk.gov.companieshouse.logging.util.RequestLogger;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import static uk.gov.companieshouse.orders.api.OrdersApiApplication.APPLICATION_NAMESPACE;
+
+public class LoggingInterceptor extends HandlerInterceptorAdapter implements RequestLogger {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(APPLICATION_NAMESPACE);
+
+    @Override
+    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
+
+        logStartRequestProcessing(request, LOGGER);
+        return true;
+    }
+
+    @Override
+    public void postHandle(HttpServletRequest request,
+                           HttpServletResponse response,
+                           Object handler,
+                           @Nullable ModelAndView modelAndView) {
+
+        logEndRequestProcessing(request, response, LOGGER);
+    }
+
+}

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

@@ -0,0 +1,27 @@
+package uk.gov.companieshouse.orders.api.mapper;
+
+import org.mapstruct.AfterMapping;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.MappingTarget;
+import uk.gov.companieshouse.orders.api.dto.AddToBasketRequestDTO;
+import uk.gov.companieshouse.orders.api.dto.AddToBasketResponseDTO;
+import uk.gov.companieshouse.orders.api.model.Basket;
+import uk.gov.companieshouse.orders.api.model.Item;
+
+import java.util.Arrays;
+
+@Mapper(componentModel = "spring")
+public interface BasketMapper {
+    Basket addToBasketRequestDTOToBasket(AddToBasketRequestDTO addToBasketRequestDTO);
+
+    @Mapping(target = "itemUri", expression = "java(basket.getData().getItems().get(0).getItemUri())")
+    AddToBasketResponseDTO basketToAddToBasketDTO(Basket basket);
+
+    @AfterMapping
+    default void fillBasket(AddToBasketRequestDTO addToBasketRequestDTO, @MappingTarget Basket basket) {
+        Item item = new Item();
+        item.setItemUri(addToBasketRequestDTO.getItemUri());
+        basket.getData().setItems(Arrays.asList(item));
+    }
+}

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

@@ -0,0 +1,65 @@
+package uk.gov.companieshouse.orders.api.model;
+
+import com.google.gson.Gson;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.mongodb.core.mapping.Document;
+
+import java.time.LocalDateTime;
+import java.util.List;
+
+@Document(collection = "basket")
+public class Basket {
+    @Id
+    private String id;
+
+    private LocalDateTime createdAt;
+
+    private LocalDateTime updatedAt;
+
+    private BasketData data = new BasketData();
+
+
+    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 BasketData getData() {
+        return data;
+    }
+
+    public void setData(BasketData data) {
+        this.data = data;
+    }
+
+    public void setItems(List<Item> items) {
+        data.setItems(items);
+    }
+
+    public List<Item> getItems() {
+        return data.getItems();
+    }
+
+    @Override
+    public String toString() { return new Gson().toJson(this); }
+
+}