Renamed Again to Align with API Contract

MohammadIqbalAD · MohammadIqbalAD · commit bfe54d49e547 · 2022-11-25T16:45:16.000Z
RequestModelsProduct -&gt; ProductRequest

RequestModelsCategory -&gt; CategoryRequest

RequestModelsOrder -&gt; OrderRequest
diff --git a/src/main/java/com/answerdigital/answerking/controller/CategoryController.java b/src/main/java/com/answerdigital/answerking/controller/CategoryController.java
@@ -2,7 +2,7 @@
 
 import com.answerdigital.answerking.exception.util.ErrorResponse;
 import com.answerdigital.answerking.model.Category;
-import com.answerdigital.answerking.request.RequestModelsCategory;
+import com.answerdigital.answerking.request.CategoryRequest;
 import com.answerdigital.answerking.response.CategoryResponse;
 import com.answerdigital.answerking.service.CategoryService;
 import io.swagger.v3.oas.annotations.Operation;
@@ -49,7 +49,7 @@ public CategoryController(final CategoryService categoryService) {
                 content = { @Content(mediaType = "application/json", schema = @Schema(implementation = ErrorResponse.class)) })
     })
     @PostMapping
-    public ResponseEntity<CategoryResponse> addCategory(@Valid @RequestBody final RequestModelsCategory categoryRequest) {
+    public ResponseEntity<CategoryResponse> addCategory(@Valid @RequestBody final CategoryRequest categoryRequest) {
         return new ResponseEntity<>(categoryService.addCategory(categoryRequest), HttpStatus.CREATED);
     }
 
@@ -108,7 +108,7 @@ public ResponseEntity<Category> removeProductFromCategory(@PathVariable @NotNull
                 content = { @Content(mediaType = "application/json", schema = @Schema(implementation = ErrorResponse.class)) })
     })
     @PutMapping("/{categoryId}")
-    public ResponseEntity<Category> updateCategory(@Valid @RequestBody final RequestModelsCategory updateCategoryRequest,
+    public ResponseEntity<Category> updateCategory(@Valid @RequestBody final CategoryRequest updateCategoryRequest,
                                                    @PathVariable @NotNull final Long categoryId) {
         return new ResponseEntity<>(categoryService.updateCategory(updateCategoryRequest, categoryId), HttpStatus.OK);
     }
diff --git a/src/main/java/com/answerdigital/answerking/controller/OrderController.java b/src/main/java/com/answerdigital/answerking/controller/OrderController.java
@@ -1,7 +1,7 @@
 package com.answerdigital.answerking.controller;
 
 import com.answerdigital.answerking.model.Order;
-import com.answerdigital.answerking.request.RequestModelsOrder;
+import com.answerdigital.answerking.request.OrderRequest;
 import com.answerdigital.answerking.service.OrderService;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -35,7 +35,7 @@ public OrderController(final OrderService orderService) {
     }
 
     @PostMapping
-    public ResponseEntity<Order> addOrder(@Valid @RequestBody final RequestModelsOrder orderRequest) {
+    public ResponseEntity<Order> addOrder(@Valid @RequestBody final OrderRequest orderRequest) {
         return new ResponseEntity<>(orderService.addOrder(orderRequest), HttpStatus.CREATED);
     }
 
@@ -46,7 +46,7 @@ public ResponseEntity<Order> getOrder(@PathVariable @NotNull final Long orderId)
 
     @PutMapping("/{orderId}")
     public ResponseEntity<Order> updateOrder(@PathVariable @NotNull final Long orderId,
-                                             @Valid @RequestBody final RequestModelsOrder orderRequest) {
+                                             @Valid @RequestBody final OrderRequest orderRequest) {
         return new ResponseEntity<>(orderService.updateOrder(orderId, orderRequest), HttpStatus.OK);
     }
 
diff --git a/src/main/java/com/answerdigital/answerking/controller/ProductController.java b/src/main/java/com/answerdigital/answerking/controller/ProductController.java
@@ -2,7 +2,7 @@
 
 import com.answerdigital.answerking.exception.util.ErrorResponse;
 import com.answerdigital.answerking.model.Product;
-import com.answerdigital.answerking.request.RequestModelsProduct;
+import com.answerdigital.answerking.request.ProductRequest;
 import com.answerdigital.answerking.service.ProductService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.media.Content;
@@ -71,7 +71,7 @@ public ResponseEntity<Product> getProductById(@Valid @PathVariable @NotNull fina
                                     schema = @Schema(implementation = ErrorResponse.class)) })
     })
     @PostMapping
-    public ResponseEntity<Product> addProduct(@Valid @RequestBody final RequestModelsProduct productRequest) {
+    public ResponseEntity<Product> addProduct(@Valid @RequestBody final ProductRequest productRequest) {
         return new ResponseEntity<>(productService.addNewProduct(productRequest), HttpStatus.CREATED);
     }
 
@@ -88,7 +88,7 @@ public ResponseEntity<Product> addProduct(@Valid @RequestBody final RequestModel
     })
     @PutMapping("/{id}")
     public ResponseEntity<Product> updateProduct(@PathVariable @NotNull final Long id,
-                                              @Valid @RequestBody final RequestModelsProduct productRequest) {
+                                              @Valid @RequestBody final ProductRequest productRequest) {
         return new ResponseEntity<>(productService.updateProduct(id, productRequest), HttpStatus.OK);
     }
 
diff --git a/src/main/java/com/answerdigital/answerking/mapper/CategoryMapper.java b/src/main/java/com/answerdigital/answerking/mapper/CategoryMapper.java
@@ -1,7 +1,7 @@
 package com.answerdigital.answerking.mapper;
 
 import com.answerdigital.answerking.model.Category;
-import com.answerdigital.answerking.request.RequestModelsCategory;
+import com.answerdigital.answerking.request.CategoryRequest;
 import com.answerdigital.answerking.response.CategoryResponse;
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
@@ -21,12 +21,12 @@ public interface CategoryMapper {
     @Mapping(target = "lastUpdated", expression = "java( ZonedDateTime.now(ZoneOffset.UTC)" +
                                                         ".truncatedTo( ChronoUnit.SECONDS )" +
                                                         ".format( DateTimeFormatter.ofPattern( \"yyyy-MM-dd HH:mm:ss\" ) ) )")
-    Category addRequestToCategory(RequestModelsCategory addCategoryRequest);
+    Category addRequestToCategory(CategoryRequest addCategoryRequest);
 
     @Mapping(target = "lastUpdated", expression = "java( ZonedDateTime.now(ZoneOffset.UTC)" +
                                                     ".truncatedTo( ChronoUnit.SECONDS )" +
                                                     ".format( DateTimeFormatter.ofPattern( \"yyyy-MM-dd HH:mm:ss\" ) ) )")
-    Category updateRequestToCategory(@MappingTarget Category category, RequestModelsCategory updateCategoryRequest);
+    Category updateRequestToCategory(@MappingTarget Category category, CategoryRequest updateCategoryRequest);
 
     @Mapping(target = "productIds",
              expression = "java(category.getProducts().stream().map(product -> product.getId()).collect(Collectors.toList()) )")
diff --git a/src/main/java/com/answerdigital/answerking/mapper/OrderMapper.java b/src/main/java/com/answerdigital/answerking/mapper/OrderMapper.java
@@ -1,7 +1,7 @@
 package com.answerdigital.answerking.mapper;
 
 import com.answerdigital.answerking.model.Order;
-import com.answerdigital.answerking.request.RequestModelsOrder;
+import com.answerdigital.answerking.request.OrderRequest;
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
 import org.mapstruct.MappingTarget;
@@ -12,7 +12,7 @@ public interface OrderMapper {
 
     @Mapping(target = "orderStatus", constant = "IN_PROGRESS")
     @Mapping(target = "lineItems", expression = "java(Collections.EMPTY_SET)")
-    Order addRequestToOrder(RequestModelsOrder orderRequest);
+    Order addRequestToOrder(OrderRequest orderRequest);
 
-    Order updateOrderRequest(@MappingTarget Order order, RequestModelsOrder orderRequest);
+    Order updateOrderRequest(@MappingTarget Order order, OrderRequest orderRequest);
 }
diff --git a/src/main/java/com/answerdigital/answerking/mapper/ProductMapper.java b/src/main/java/com/answerdigital/answerking/mapper/ProductMapper.java
@@ -1,15 +1,15 @@
 package com.answerdigital.answerking.mapper;
 
 import com.answerdigital.answerking.model.Product;
-import com.answerdigital.answerking.request.RequestModelsProduct;
+import com.answerdigital.answerking.request.ProductRequest;
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
 import org.mapstruct.MappingTarget;
 
 @Mapper(componentModel = "spring")
 public interface ProductMapper {
     @Mapping(target = "retired", constant = "false")
-    Product addRequestToProduct(RequestModelsProduct productRequest);
+    Product addRequestToProduct(ProductRequest productRequest);
 
-    Product updateRequestToProduct(@MappingTarget Product product, RequestModelsProduct productRequest);
+    Product updateRequestToProduct(@MappingTarget Product product, ProductRequest productRequest);
 }
diff --git a/src/main/java/com/answerdigital/answerking/model/Category.java b/src/main/java/com/answerdigital/answerking/model/Category.java
@@ -1,6 +1,6 @@
 package com.answerdigital.answerking.model;
 
-import com.answerdigital.answerking.request.RequestModelsCategory;
+import com.answerdigital.answerking.request.CategoryRequest;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.AllArgsConstructor;
@@ -65,7 +65,7 @@ public class Category {
     @JsonIgnore
     private Set<Product> products = new HashSet<>();
 
-    public Category(final RequestModelsCategory categoryRequest) {
+    public Category(final CategoryRequest categoryRequest) {
         this.name = categoryRequest.name();
         this.description = categoryRequest.description();
         this.retired = false;
diff --git a/src/main/java/com/answerdigital/answerking/model/Product.java b/src/main/java/com/answerdigital/answerking/model/Product.java
@@ -1,6 +1,6 @@
 package com.answerdigital.answerking.model;
 
-import com.answerdigital.answerking.request.RequestModelsProduct;
+import com.answerdigital.answerking.request.ProductRequest;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -60,7 +60,7 @@ public class Product {
     @JsonIgnore
     private Set<LineItem> lineItems = new HashSet<>();
 
-    public Product(final RequestModelsProduct productRequest){
+    public Product(final ProductRequest productRequest){
         this.name = productRequest.name();
         this.description = productRequest.description();
         this.price = productRequest.price();
diff --git a/src/main/java/com/answerdigital/answerking/request/CategoryRequest.java b/src/main/java/com/answerdigital/answerking/request/CategoryRequest.java
@@ -3,7 +3,7 @@
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Pattern;
 
-public record RequestModelsCategory(
+public record CategoryRequest(
         @NotBlank
         @Pattern(regexp = "^[a-zA-Z\s-]*",
                 message = "Category name must only contain letters, spaces and dashes")
diff --git a/src/main/java/com/answerdigital/answerking/request/OrderRequest.java b/src/main/java/com/answerdigital/answerking/request/OrderRequest.java
@@ -2,5 +2,5 @@
 
 import javax.validation.constraints.NotBlank;
 
-public record RequestModelsOrder(@NotBlank String address) {
+public record OrderRequest(@NotBlank String address) {
 }
diff --git a/src/main/java/com/answerdigital/answerking/request/ProductRequest.java b/src/main/java/com/answerdigital/answerking/request/ProductRequest.java
@@ -9,7 +9,7 @@
 import javax.validation.constraints.NotNull;
 import java.math.BigDecimal;
 
-public record RequestModelsProduct(
+public record ProductRequest(
         @NotBlank
         @Pattern(regexp = "^[a-zA-Z\s-]*",
                 message = "Product name must only contain letters, spaces and dashes")
@@ -25,6 +25,6 @@ public record RequestModelsProduct(
         BigDecimal price
 ) {
     @Builder
-    public RequestModelsProduct {
+    public ProductRequest {
     }
 }
diff --git a/src/main/java/com/answerdigital/answerking/service/CategoryService.java b/src/main/java/com/answerdigital/answerking/service/CategoryService.java
@@ -8,7 +8,7 @@
 import com.answerdigital.answerking.model.Category;
 import com.answerdigital.answerking.model.Product;
 import com.answerdigital.answerking.repository.CategoryRepository;
-import com.answerdigital.answerking.request.RequestModelsCategory;
+import com.answerdigital.answerking.request.CategoryRequest;
 import com.answerdigital.answerking.response.CategoryResponse;
 import org.mapstruct.factory.Mappers;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -34,7 +34,7 @@ public CategoryService(final ProductService productService,
         this.categoryRepository = categoryRepository;
     }
 
-    public CategoryResponse addCategory(final RequestModelsCategory categoryRequest) {
+    public CategoryResponse addCategory(final CategoryRequest categoryRequest) {
         if (categoryRepository.existsByName(categoryRequest.name())) {
             throw new NameUnavailableException(String.format("A category named '%s' already exists", categoryRequest.name()));
         }
@@ -57,7 +57,7 @@ public Set<CategoryResponse> findAll() {
                 .collect(Collectors.toSet());
     }
 
-    public Category updateCategory(final RequestModelsCategory updateCategoryRequest, final Long id) {
+    public Category updateCategory(final CategoryRequest updateCategoryRequest, final Long id) {
         // check that the category isn't being renamed to a category name that already exists
         if (categoryRepository.existsByNameAndIdIsNot(updateCategoryRequest.name(), id)) {
             throw new NameUnavailableException(String.format("A category named %s already exists", updateCategoryRequest.name()));
diff --git a/src/main/java/com/answerdigital/answerking/service/OrderService.java b/src/main/java/com/answerdigital/answerking/service/OrderService.java
@@ -8,7 +8,7 @@
 import com.answerdigital.answerking.model.Product;
 import com.answerdigital.answerking.model.Order;
 import com.answerdigital.answerking.repository.OrderRepository;
-import com.answerdigital.answerking.request.RequestModelsOrder;
+import com.answerdigital.answerking.request.OrderRequest;
 import org.mapstruct.factory.Mappers;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
@@ -32,7 +32,7 @@ public OrderService(final OrderRepository orderRepository, final ProductService
         this.productService = productService;
     }
 
-    public Order addOrder(final RequestModelsOrder orderRequest) {
+    public Order addOrder(final OrderRequest orderRequest) {
         final Order newOrder = orderMapper.addRequestToOrder(orderRequest);
         return orderRepository.save(newOrder);
     }
@@ -48,7 +48,7 @@ public List<Order> findAll() {
         return this.orderRepository.findAll();
     }
 
-    public Order updateOrder(final Long orderId, final RequestModelsOrder orderRequest) {
+    public Order updateOrder(final Long orderId, final OrderRequest orderRequest) {
         final Order orderToUpdate = findById(orderId);
         final Order updatedOrder = orderMapper.updateOrderRequest(orderToUpdate, orderRequest);
 
diff --git a/src/main/java/com/answerdigital/answerking/service/ProductService.java b/src/main/java/com/answerdigital/answerking/service/ProductService.java
@@ -6,7 +6,7 @@
 import com.answerdigital.answerking.mapper.ProductMapper;
 import com.answerdigital.answerking.model.Product;
 import com.answerdigital.answerking.repository.ProductRepository;
-import com.answerdigital.answerking.request.RequestModelsProduct;
+import com.answerdigital.answerking.request.ProductRequest;
 import org.mapstruct.factory.Mappers;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
@@ -24,7 +24,7 @@ public ProductService(final ProductRepository productRepository) {
         this.productRepository = productRepository;
     }
 
-    public Product addNewProduct(final RequestModelsProduct productRequest) {
+    public Product addNewProduct(final ProductRequest productRequest) {
         if (productRepository.existsByName(productRequest.name())) {
             throw new NameUnavailableException(String.format("A Product named '%s' already exists", productRequest.name()));
         }
@@ -42,7 +42,7 @@ public List<Product> findAll() {
         return productRepository.findAll();
     }
 
-    public Product updateProduct(final Long productId, final RequestModelsProduct productRequest) {
+    public Product updateProduct(final Long productId, final ProductRequest productRequest) {
         productRepository.findById(productId)
                 .orElseThrow(() -> new NotFoundException(String.format("Product with ID %d does not exist.", productId)));
 
diff --git a/src/test/java/com/answerdigital/answerking/controller/CategoryControllerRequestValidatorTest.java b/src/test/java/com/answerdigital/answerking/controller/CategoryControllerRequestValidatorTest.java
@@ -1,6 +1,6 @@
 package com.answerdigital.answerking.controller;
 
-import com.answerdigital.answerking.request.RequestModelsCategory;
+import com.answerdigital.answerking.request.CategoryRequest;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -48,10 +48,10 @@ private static Stream<Arguments> provideInvalidStringsForAddCategory() {
     @MethodSource("provideInvalidStringsForAddCategory")
     void addCategoryWithInvalidRequest(String name, String description) {
         // given
-        RequestModelsCategory addCategoryRequest = new RequestModelsCategory(name, description);
+        CategoryRequest addCategoryRequest = new CategoryRequest(name, description);
 
         // when
-        Set<ConstraintViolation<RequestModelsCategory>> violations = validator.validate(addCategoryRequest);
+        Set<ConstraintViolation<CategoryRequest>> violations = validator.validate(addCategoryRequest);
 
         // then
         assertFalse(violations.isEmpty());
@@ -73,10 +73,10 @@ private static Stream<Arguments> provideInvalidStringsForUpdateCategory() {
     @MethodSource("provideInvalidStringsForUpdateCategory")
     void updateCategoryWithInvalidRequest(String name, String description) {
         // given
-        RequestModelsCategory updateCategoryRequest = new RequestModelsCategory(name, description);
+        CategoryRequest updateCategoryRequest = new CategoryRequest(name, description);
 
         // when
-        Set<ConstraintViolation<RequestModelsCategory>> violations = validator.validate(updateCategoryRequest);
+        Set<ConstraintViolation<CategoryRequest>> violations = validator.validate(updateCategoryRequest);
 
         // then
         assertFalse(violations.isEmpty());
diff --git a/src/test/java/com/answerdigital/answerking/controller/CategoryControllerTest.java b/src/test/java/com/answerdigital/answerking/controller/CategoryControllerTest.java
@@ -1,7 +1,7 @@
 package com.answerdigital.answerking.controller;
 
 import com.answerdigital.answerking.model.Category;
-import com.answerdigital.answerking.request.RequestModelsCategory;
+import com.answerdigital.answerking.request.CategoryRequest;
 import com.answerdigital.answerking.response.CategoryResponse;
 import com.answerdigital.answerking.service.CategoryService;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -68,7 +68,7 @@ void addCategoryTest() throws Exception {
         final String testDate = ZonedDateTime.now( ZoneId.of( "Etc/UTC" ) )
                                              .truncatedTo( ChronoUnit.SECONDS )
                                              .format( DateTimeFormatter.ofPattern( "yyyy-MM-dd HH:mm:ss" ) );
-        final var addCategoryRequest = new RequestModelsCategory("random name", "random description");
+        final var addCategoryRequest = new CategoryRequest("random name", "random description");
         final var categoryResponse = CategoryResponse.builder()
                                                      .name(addCategoryRequest.name())
                                                      .description(addCategoryRequest.description())
@@ -122,7 +122,7 @@ void addCategoryWithInvalidCategoryRequestDescTest() throws Exception {
     @Test
     void updateCategoryTest() throws Exception {
         ObjectMapper mapper = new ObjectMapper();
-        final var updateCategoryRequest = new RequestModelsCategory("random name", "random description");
+        final var updateCategoryRequest = new CategoryRequest("random name", "random description");
         final var newRandomName = "new random name";
         final var newRandomDesc = "new random description";
         final var category = new Category(newRandomName, newRandomDesc);
diff --git a/src/test/java/com/answerdigital/answerking/service/CategoryServiceTest.java b/src/test/java/com/answerdigital/answerking/service/CategoryServiceTest.java
diff --git a/src/test/java/com/answerdigital/answerking/service/OrderServiceTest.java b/src/test/java/com/answerdigital/answerking/service/OrderServiceTest.java
diff --git a/src/test/java/com/answerdigital/answerking/service/ProductServiceTest.java b/src/test/java/com/answerdigital/answerking/service/ProductServiceTest.java

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`
`3`	`3`	`import javax.validation.constraints.NotBlank;`
`4`	`4`
`5`		`-public record RequestModelsOrder(@NotBlank String address) {`
	`5`	`+public record OrderRequest(@NotBlank String address) {`
`6`	`6`	`}`