feat: collection mapper introduced (#13)

 - Offloaded custom logic to collection voucher mapper from collection voucher service
 - Added request validation with jakarka
 - GSON dependency removed
 - Minor contract changes for pending-bill / collection voucher
---------

Signed-off-by: Rajdeep Roy Chowdhury <[email protected]>

Author: Razdeep

build.gradle.kts

@@ -41,7 +41,6 @@ dependencies {
     implementation(libs.jaxb.api)
     implementation(libs.spring.boot.starter.data.jpa)
     implementation(libs.postgres.connector)
-    implementation(libs.gson)
     implementation(libs.spring.boot.starter.freemarker)
     implementation(libs.openhtml)
     implementation(libs.spring.boot.starter.validation)

gradle/libs.versions.toml

@@ -3,7 +3,6 @@ springboot = "3.0.6"
 jjwt = "0.9.1"
 jaxb = "2.4.0-b180830.0359"
 postgres = "42.7.8"
-gson = "2.10"
 lombok = "1.18.30" # put actual version you use
 lombokmapstruct = "0.2.0"
 mapstruct = "1.6.3"
@@ -29,7 +28,6 @@ spring-boot-starter-validation = { module = "org.springframework.boot:spring-boo
 jjwt = { module = "io.jsonwebtoken:jjwt", version.ref = "jjwt" }
 jaxb-api = { module = "javax.xml.bind:jaxb-api", version.ref = "jaxb" }
 postgres-connector = { module = "org.postgresql:postgresql", version.ref = "postgres" }
-gson = { module = "com.google.code.gson:gson", version.ref = "gson" }
 lombok = { module = "org.projectlombok:lombok", version.ref = "lombok" }
 lombok-mapstruct-binding = { module = "org.projectlombok:lombok-mapstruct-binding", version.ref = "lombokmapstruct" }
 

src/main/java/com/razdeep/konsignapi/KonsignApiApplication.java

@@ -6,8 +6,6 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.autoconfigure.security.servlet.UserDetailsServiceAutoConfiguration;
 import org.springframework.cache.annotation.EnableCaching;
-import org.springframework.context.annotation.Bean;
-import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
 
 @SpringBootApplication(exclude = {UserDetailsServiceAutoConfiguration.class})
 @EnableCaching
@@ -18,11 +16,6 @@ public static void main(String[] args) {
         SpringApplication.run(KonsignApiApplication.class, args);
     }
 
-    @Bean
-    public BCryptPasswordEncoder bCryptPasswordEncoder() {
-        return new BCryptPasswordEncoder();
-    }
-
     @Override
     public void run(String... args) {}
 }

src/main/java/com/razdeep/konsignapi/config/SecurityConfig.java

@@ -13,6 +13,7 @@
 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
 import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
 import org.springframework.security.config.http.SessionCreationPolicy;
+import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
 import org.springframework.security.web.SecurityFilterChain;
 import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
 import org.springframework.web.cors.CorsConfiguration;
@@ -49,6 +50,11 @@ public AuthenticationManager authenticationManager(AuthenticationConfiguration a
         return authenticationConfiguration.getAuthenticationManager();
     }
 
+    @Bean
+    public BCryptPasswordEncoder bCryptPasswordEncoder() {
+        return new BCryptPasswordEncoder();
+    }
+
     @Bean
     public CorsConfigurationSource corsConfigurationSource() {
         CorsConfiguration configuration = new CorsConfiguration();

src/main/java/com/razdeep/konsignapi/controller/CollectionVoucherController.java

@@ -1,110 +1,67 @@
 package com.razdeep.konsignapi.controller;
 
-import com.google.gson.Gson;
 import com.razdeep.konsignapi.constant.KonsignConstant;
-import com.razdeep.konsignapi.entity.BuyerEntity;
 import com.razdeep.konsignapi.model.CollectionVoucher;
+import com.razdeep.konsignapi.model.KonsignApiResponse;
 import com.razdeep.konsignapi.model.PendingBill;
-import com.razdeep.konsignapi.service.BuyerService;
 import com.razdeep.konsignapi.service.CollectionVoucherService;
 import io.micrometer.core.annotation.Timed;
-import java.util.HashMap;
+import jakarta.validation.Valid;
 import java.util.List;
-import java.util.Map;
-import org.springframework.http.HttpStatus;
-import org.springframework.http.MediaType;
+import org.apache.coyote.BadRequestException;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
 
 @RestController
 @RequestMapping(KonsignConstant.CONTROLLER_API_PREFIX + "/collection-vouchers")
 public class CollectionVoucherController {
 
-    private final Gson gson;
-
     private final CollectionVoucherService collectionVoucherService;
-    private final BuyerService buyerService;
 
-    public CollectionVoucherController(
-            Gson gson, CollectionVoucherService collectionVoucherService, BuyerService buyerService) {
-        this.gson = gson;
+    public CollectionVoucherController(CollectionVoucherService collectionVoucherService) {
         this.collectionVoucherService = collectionVoucherService;
-        this.buyerService = buyerService;
     }
 
     @Timed
     @GetMapping("/{voucherNo}")
-    public ResponseEntity<String> getCollectionVoucher(@PathVariable String voucherNo) {
-        ResponseEntity<String> response;
+    public ResponseEntity<KonsignApiResponse> getCollectionVoucher(@PathVariable String voucherNo) {
         CollectionVoucher collectionVoucher = collectionVoucherService.getVoucherByVoucherNo(voucherNo);
-        if (collectionVoucher == null) {
-            return new ResponseEntity<>("{}", HttpStatus.NOT_FOUND);
-        }
-
-        response = new ResponseEntity<>(gson.toJson(collectionVoucher), HttpStatus.OK);
-        return response;
+        return ResponseEntity.ok(KonsignApiResponse.builder()
+                .data(collectionVoucher)
+                .success(true)
+                .build());
     }
 
     @Timed
     @PostMapping
-    public ResponseEntity<String> addCollectionVoucher(@RequestBody CollectionVoucher collectionVoucher) {
-        Map<String, String> body = new HashMap<>();
-        ResponseEntity<String> response;
-        if (collectionVoucherService.addCollectionVoucher(collectionVoucher)) {
-            body.put("message", "Successfully added collection voucher");
-            response = new ResponseEntity<>(gson.toJson(body), HttpStatus.OK);
-        } else {
-            body.put("message", "Saving collection voucher failed");
-            response = new ResponseEntity<>(gson.toJson(body), HttpStatus.NOT_ACCEPTABLE);
-        }
-        return response;
+    public ResponseEntity<KonsignApiResponse> addCollectionVoucher(
+            @Valid @RequestBody CollectionVoucher collectionVoucher) {
+        collectionVoucherService.addCollectionVoucher(collectionVoucher);
+        return ResponseEntity.ok(KonsignApiResponse.builder()
+                .success(true)
+                .message("Successfully added collection voucher")
+                .build());
     }
 
     @Timed
     @DeleteMapping("/{voucherNo}")
-    ResponseEntity<String> deleteBuyer(@PathVariable String voucherNo) {
-        String message;
-        if (collectionVoucherService.deleteVoucher(voucherNo)) {
-            message = "Successfully deleted Collection Voucher Id: " + voucherNo;
-        } else {
-            message = voucherNo + " is already deleted";
-        }
-        Map<String, String> responseMap = new HashMap<>();
-        responseMap.put("message", message);
-        return new ResponseEntity<>(gson.toJson(responseMap), HttpStatus.OK);
+    ResponseEntity<KonsignApiResponse> deleteBuyer(@PathVariable String voucherNo) {
+        String message = collectionVoucherService.deleteVoucher(voucherNo)
+                ? "Successfully deleted Collection Voucher Id: " + voucherNo
+                : voucherNo + " is already deleted";
+
+        return ResponseEntity.ok(
+                KonsignApiResponse.builder().message(message).success(true).build());
     }
 
     @Timed
-    @GetMapping(value = "/pending-bills", produces = MediaType.APPLICATION_JSON_VALUE)
-    ResponseEntity<Map<String, Object>> getPendingBillsToBeCollected(
-            @RequestParam(required = false) String buyerId, @RequestParam(required = false) String buyerName) {
-        List<PendingBill> pendingBills;
-        if (buyerId != null && !buyerId.isEmpty()) {
-            pendingBills = collectionVoucherService.getPendingBillsToBeCollected(buyerId);
-        } else if (buyerName != null && !buyerName.isEmpty()) {
-            BuyerEntity retrievedBuyerEntity = buyerService.getBuyerByBuyerName(buyerName);
-            if (retrievedBuyerEntity == null) {
-                String message = "Buyer name not found in database";
-                Map<String, Object> responseMap = new HashMap<>();
-                responseMap.put("message", message);
-                return new ResponseEntity<>(responseMap, HttpStatus.BAD_REQUEST);
-            }
-            String retriedBuyerId = retrievedBuyerEntity.getBuyerId();
-            if (retriedBuyerId == null) {
-                String message = "Buyer name not found in database";
-                Map<String, Object> responseMap = new HashMap<>();
-                responseMap.put("message", message);
-                return new ResponseEntity<>(responseMap, HttpStatus.BAD_REQUEST);
-            }
-            pendingBills = collectionVoucherService.getPendingBillsToBeCollected(retriedBuyerId);
-        } else {
-            String message = "Either buyerId or buyerName must be present the request param";
-            Map<String, Object> responseMap = new HashMap<>();
-            responseMap.put("message", message);
-            return new ResponseEntity<>(responseMap, HttpStatus.BAD_REQUEST);
-        }
-        Map<String, Object> responseMap = new HashMap<>();
-        responseMap.put("pendingBills", pendingBills);
-        return new ResponseEntity<>(responseMap, HttpStatus.OK);
+    @GetMapping(value = "/pending-bills")
+    ResponseEntity<KonsignApiResponse> getPendingBillsToBeCollected(
+            @RequestParam(required = false) String buyerId, @RequestParam(required = false) String buyerName)
+            throws BadRequestException {
+        List<PendingBill> pendingBills = collectionVoucherService.getPendingBillsToBeCollected(buyerId, buyerName);
+
+        return ResponseEntity.ok(
+                KonsignApiResponse.builder().success(true).data(pendingBills).build());
     }
 }

src/main/java/com/razdeep/konsignapi/exception/GlobalExceptionHandler.java

@@ -3,6 +3,7 @@
 import com.razdeep.konsignapi.model.KonsignApiResponse;
 import java.util.ArrayList;
 import java.util.List;
+import org.apache.coyote.BadRequestException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.http.HttpStatus;
@@ -91,4 +92,12 @@ public ResponseEntity<KonsignApiResponse> handleValidationErrors(SaveResourceExc
 
         return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(new KonsignApiResponse(false, ex.getMessage(), null));
     }
+
+    @ExceptionHandler(BadRequestException.class)
+    public ResponseEntity<KonsignApiResponse> handleValidationErrors(BadRequestException ex) {
+
+        LOG.info("Bad request exception", ex);
+
+        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(new KonsignApiResponse(false, ex.getMessage(), null));
+    }
 }

src/main/java/com/razdeep/konsignapi/mapper/CollectionVoucherItemMapper.java

@@ -0,0 +1,24 @@
+package com.razdeep.konsignapi.mapper;
+
+import com.razdeep.konsignapi.entity.CollectionVoucherItemEntity;
+import com.razdeep.konsignapi.model.CollectionVoucherItem;
+import java.util.List;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+
+@Mapper(
+        componentModel = "spring",
+        uses = {LrPmMapper.class})
+public interface CollectionVoucherItemMapper {
+
+    @Mapping(source = "bill.billNo", target = "billNo")
+    @Mapping(source = "bill.supplierEntity.supplierName", target = "supplierName")
+    @Mapping(source = "bill.billAmount", target = "billAmount")
+    CollectionVoucherItem toModel(CollectionVoucherItemEntity entity);
+
+    List<CollectionVoucherItem> toModelList(List<CollectionVoucherItemEntity> entities);
+
+    CollectionVoucherItemEntity toEntity(CollectionVoucherItem model);
+
+    List<CollectionVoucherItemEntity> toEntityList(List<CollectionVoucherItem> model);
+}

src/main/java/com/razdeep/konsignapi/mapper/CollectionVoucherMapper.java

@@ -0,0 +1,40 @@
+package com.razdeep.konsignapi.mapper;
+
+import com.razdeep.konsignapi.entity.CollectionVoucherEntity;
+import com.razdeep.konsignapi.model.CollectionVoucher;
+import com.razdeep.konsignapi.tenant.TenantContext;
+import java.util.concurrent.atomic.AtomicInteger;
+import org.mapstruct.AfterMapping;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.MappingTarget;
+
+@Mapper(
+        componentModel = "spring",
+        uses = {CollectionVoucherItemMapper.class})
+public interface CollectionVoucherMapper {
+
+    @Mapping(source = "buyer.buyerName", target = "buyerName")
+    @Mapping(source = "collectionVoucherItemEntityList", target = "collectionVoucherItemList")
+    CollectionVoucher toModel(CollectionVoucherEntity entity);
+
+    @Mapping(source = "collectionVoucherItemList", target = "collectionVoucherItemEntityList")
+    CollectionVoucherEntity toEntity(CollectionVoucher model);
+
+    @AfterMapping
+    default void linkChildren(@MappingTarget CollectionVoucherEntity collectionVoucherEntity) {
+
+        // TODO make sure the tenant id is set using an EntityListener
+        collectionVoucherEntity.setTenantId(TenantContext.getTenantId());
+
+        if (collectionVoucherEntity.getCollectionVoucherItemEntityList() == null) return;
+
+        AtomicInteger collectionVoucherItemIndex = new AtomicInteger();
+        collectionVoucherEntity.getCollectionVoucherItemEntityList().forEach(item -> {
+            item.setCollectionVoucher(collectionVoucherEntity);
+            item.setCollectionVoucherItemId(
+                    collectionVoucherEntity.getVoucherNo() + "_" + collectionVoucherItemIndex.getAndIncrement());
+            item.setTenantId(TenantContext.getTenantId());
+        });
+    }
+}

src/main/java/com/razdeep/konsignapi/model/CollectionVoucher.java

@@ -1,20 +1,33 @@
 package com.razdeep.konsignapi.model;
 
+import jakarta.validation.Valid;
+import jakarta.validation.constraints.NotBlank;
+import jakarta.validation.constraints.NotEmpty;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Size;
+import java.time.LocalDate;
 import java.util.List;
 import lombok.Builder;
-import lombok.Data;
+import lombok.Getter;
+import lombok.Setter;
 
-@Data
+@Getter
+@Setter
 @Builder
 public class CollectionVoucher {
 
+    @NotBlank(message = "Voucher number must not be blank")
+    @Size(max = 10, message = "Voucher number must be at most 10 characters")
     private String voucherNo;
 
-    // TODO find a way to use LocalDate here
-    //    @JsonFormat(pattern="yyyy-MM-dd")
-    private String voucherDate;
+    @NotNull(message = "Voucher date is required")
+    private LocalDate voucherDate;
 
+    @NotBlank(message = "Buyer name must not be blank")
+    @Size(max = 30, message = "Buyer name must be at most 30 characters")
     private String buyerName;
 
+    @NotEmpty(message = "At least one voucher item is required")
+    @Valid
     private List<CollectionVoucherItem> collectionVoucherItemList;
 }

src/main/java/com/razdeep/konsignapi/model/CollectionVoucherItem.java

@@ -1,27 +1,41 @@
 package com.razdeep.konsignapi.model;
 
+import jakarta.validation.constraints.*;
 import java.math.BigDecimal;
+import java.time.LocalDate;
 import lombok.Builder;
-import lombok.Data;
+import lombok.Getter;
+import lombok.Setter;
 
-@Data
+@Setter
+@Getter
 @Builder
 public class CollectionVoucherItem {
 
-    String billNo;
+    @NotBlank(message = "Bill number must not be blank")
+    @Size(max = 10, message = "Bill number must be at most 10 characters")
+    private String billNo;
 
-    String supplierName;
+    @NotBlank(message = "Supplier name must not be blank")
+    @Size(max = 30, message = "Supplier name must be at most 30 characters")
+    private String supplierName;
 
-    BigDecimal billAmount;
+    @NotNull(message = "Bill amount is required")
+    @Positive(message = "Bill amount must be greater than zero")
+    private BigDecimal billAmount;
 
-    BigDecimal pendingBillAmount;
+    private BigDecimal pendingBillAmount;
 
-    BigDecimal amountCollected;
+    @NotNull(message = "Collected amount is required")
+    @PositiveOrZero(message = "Collected amount cannot be negative")
+    private BigDecimal amountCollected;
 
-    String bank;
+    @Size(max = 10, message = "Bank name must be at most 10 characters")
+    private String bank;
 
-    String ddNo;
+    @Size(max = 10, message = "DD number must be at most 10 characters")
+    private String ddNo;
 
-    //    @JsonFormat(pattern="yyyy-MM-dd")
-    String ddDate;
+    @NotNull(message = "dd date is required")
+    private LocalDate ddDate;
 }