Auditing and Comment code refactors.

Author: manirDev

src/main/java/com/manir/springbootecommercerestapi/SpringBootECommerceRestApiApplication.java

@@ -4,8 +4,10 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.context.annotation.Bean;
+import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
 
 @SpringBootApplication
+@EnableJpaAuditing(auditorAwareRef = "auditAwareImpl")
 public class SpringBootECommerceRestApiApplication {
 
 	public static void main(String[] args) {

src/main/java/com/manir/springbootecommercerestapi/audit/AuditAwareImpl.java

@@ -0,0 +1,15 @@
+package com.manir.springbootecommercerestapi.audit;
+
+import org.springframework.data.domain.AuditorAware;
+import org.springframework.security.core.context.SecurityContextHolder;
+import org.springframework.stereotype.Component;
+
+import java.util.Optional;
+
+@Component("auditAwareImpl")
+public class AuditAwareImpl implements AuditorAware<String> {
+    @Override
+    public Optional<String> getCurrentAuditor() {
+        return Optional.ofNullable(SecurityContextHolder.getContext().getAuthentication().getName());
+    }
+}

src/main/java/com/manir/springbootecommercerestapi/controller/CommentController.java

@@ -1,9 +1,15 @@
 package com.manir.springbootecommercerestapi.controller;
 
 import com.manir.springbootecommercerestapi.dto.CommentDto;
+import com.manir.springbootecommercerestapi.model.User;
 import com.manir.springbootecommercerestapi.service.CommentService;
+import com.manir.springbootecommercerestapi.service.CommonService;
+import com.manir.springbootecommercerestapi.utils.isAuthenticatedAsAdminOrUser;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
 import org.springframework.web.bind.annotation.*;
 
 import javax.annotation.Resource;
@@ -13,17 +19,30 @@
 @RequestMapping(value = "api/v1/products")
 public class CommentController {
 
-    @Resource
+    @Autowired
     private CommentService commentService;
+    @Autowired
+    private CommonService commonService;
 
     //create comment api
+    @isAuthenticatedAsAdminOrUser
     @PostMapping("/{productId}/createComment")
-    public ResponseEntity<CommentDto> createComment(@PathVariable Long productId,
+    public ResponseEntity<CommentDto> createComment(@AuthenticationPrincipal Authentication authentication,
+                                                    @PathVariable Long productId,
                                                     @RequestBody CommentDto commentDto){
-        CommentDto responseComment = commentService.createComment(productId, commentDto);
+        User customer = commonService.getCurrentAuthenticatedUser(authentication);
+        CommentDto responseComment = commentService.createComment(customer, productId, commentDto);
         return new ResponseEntity<>(responseComment, HttpStatus.CREATED);
     }
 
+    //get comment by user
+    @isAuthenticatedAsAdminOrUser
+    @GetMapping("/comment/findByUser")
+    public List<CommentDto> findByUser(@AuthenticationPrincipal Authentication authentication){
+        User customer = commonService.getCurrentAuthenticatedUser(authentication);
+        return commentService.findCommentByCustomer(customer);
+    }
+
     //get all comments api
     @GetMapping("/getAllComments")
     public List<CommentDto> getAllComments(){
@@ -58,4 +77,6 @@ public ResponseEntity<String> deleteComment(@PathVariable Long productId, @PathV
         commentService.deleteComment(productId, commentId);
         return ResponseEntity.ok("Comment with id: "+commentId+" is successfully:)");
     }
+
+
 }

src/main/java/com/manir/springbootecommercerestapi/model/BaseEntity.java

@@ -0,0 +1,38 @@
+package com.manir.springbootecommercerestapi.model;
+
+import lombok.Data;
+import org.springframework.data.annotation.CreatedBy;
+import org.springframework.data.annotation.CreatedDate;
+import org.springframework.data.annotation.LastModifiedBy;
+import org.springframework.data.annotation.LastModifiedDate;
+import org.springframework.data.jpa.domain.support.AuditingEntityListener;
+
+import javax.persistence.Column;
+import javax.persistence.EntityListeners;
+import javax.persistence.MappedSuperclass;
+import java.time.LocalDateTime;
+
+@Data
+@MappedSuperclass
+/**
+  Auditing allows us : to see who created data and who updated
+ then we should enable jpa auditing...
+ **/
+@EntityListeners(AuditingEntityListener.class)
+public abstract class BaseEntity {
+
+    @CreatedDate
+    @Column(name = "created_at", updatable = false)
+    private LocalDateTime createdAt;
+    @CreatedBy
+    @Column(updatable = false)
+    private String createdBy;
+
+    @LastModifiedDate
+    @Column(name = "updated_at", insertable = false)
+    private LocalDateTime updatedAt;
+    @LastModifiedBy
+    @Column(insertable = false)
+    private String updatedBy;
+
+}

src/main/java/com/manir/springbootecommercerestapi/model/CartItem.java

@@ -11,7 +11,7 @@
 @Data
 @Entity
 @Table(name = "cart_item")
-public class CartItem {
+public class CartItem extends BaseEntity{
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;

src/main/java/com/manir/springbootecommercerestapi/model/Category.java

@@ -14,7 +14,7 @@
 @Entity
 @Table(name = "categories")
 @JsonIgnoreProperties(value = {"children"})
-public class Category {
+public class Category extends BaseEntity{
 
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)

src/main/java/com/manir/springbootecommercerestapi/model/Comment.java

@@ -9,7 +9,7 @@
 @Getter
 @Entity
 @Table(name = "product_comments")
-public class Comment {
+public class Comment extends BaseEntity{
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;
@@ -23,4 +23,9 @@ public class Comment {
     @ManyToOne(fetch = FetchType.LAZY)
     @JoinColumn(name = "product_id")
     private Product product;
+
+    //relation with user
+    @ManyToOne()
+    @JoinColumn(name = "customer_id")
+    private User customer;
 }

src/main/java/com/manir/springbootecommercerestapi/model/ImageData.java

@@ -10,7 +10,7 @@
 @NoArgsConstructor
 @Entity
 @Table(name = "product_image_gallery")
-public class ImageData {
+public class ImageData extends BaseEntity{
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;

src/main/java/com/manir/springbootecommercerestapi/model/Order.java

@@ -11,7 +11,7 @@
 @Setter
 @Entity
 @Table(name = "orders")
-public class Order {
+public class Order extends BaseEntity{
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;

src/main/java/com/manir/springbootecommercerestapi/model/OrderProducts.java

@@ -11,7 +11,7 @@
 @Data
 @Entity
 @Table(name = "order_products")
-public class OrderProducts {
+public class OrderProducts extends BaseEntity{
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;

src/main/java/com/manir/springbootecommercerestapi/model/Product.java

@@ -12,7 +12,7 @@
 @Setter
 @Entity
 @Table(name = "products")
-public class Product {
+public class Product extends BaseEntity{
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;

src/main/java/com/manir/springbootecommercerestapi/model/Role.java

@@ -7,7 +7,7 @@
 @Data
 @Entity
 @Table(name = "roles")
-public class Role {
+public class Role extends BaseEntity{
 
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)

src/main/java/com/manir/springbootecommercerestapi/model/User.java

@@ -13,7 +13,7 @@
 @Table(name = "users", uniqueConstraints = {@UniqueConstraint(columnNames = {"userName"}),
         @UniqueConstraint(columnNames = {"email"})
 })
-public class User {
+public class User extends BaseEntity{
     @Id
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     private Long id;
@@ -46,4 +46,10 @@ public class User {
             fetch = FetchType.LAZY, orphanRemoval = true,
             mappedBy = "customer")
     private Set<OrderProducts> orderProducts;
+
+    //relation with comment or review
+    @OneToMany(cascade = CascadeType.ALL,
+            fetch = FetchType.LAZY, orphanRemoval = true,
+            mappedBy = "customer")
+    private Set<Comment> comments;
  }

src/main/java/com/manir/springbootecommercerestapi/repository/CommentRepository.java

@@ -1,10 +1,12 @@
 package com.manir.springbootecommercerestapi.repository;
 
 import com.manir.springbootecommercerestapi.model.Comment;
+import com.manir.springbootecommercerestapi.model.User;
 import org.springframework.data.jpa.repository.JpaRepository;
 
 import java.util.List;
 
 public interface CommentRepository extends JpaRepository<Comment, Long> {
     List<Comment> findByProductId(Long productId);
+    List<Comment> findByCustomer(User customer);
 }

src/main/java/com/manir/springbootecommercerestapi/service/CommentService.java

@@ -2,13 +2,15 @@
 
 
 import com.manir.springbootecommercerestapi.dto.CommentDto;
+import com.manir.springbootecommercerestapi.model.User;
 
 import java.util.List;
 
 public interface CommentService {
 
-    CommentDto createComment(Long productId, CommentDto commentDto);
+    CommentDto createComment(User customer, Long productId, CommentDto commentDto);
 
+    List<CommentDto> findCommentByCustomer(User customer);
     List<CommentDto> getAllComments();
     List<CommentDto> getAllCommentsByProductId(Long productId);
     CommentDto getCommentById(Long productId, Long commentId);

src/main/java/com/manir/springbootecommercerestapi/service/Impl/CommentServiceImpl.java

@@ -3,10 +3,12 @@
 import com.manir.springbootecommercerestapi.dto.CommentDto;
 import com.manir.springbootecommercerestapi.exception.EcommerceApiException;
 import com.manir.springbootecommercerestapi.exception.ResourceNotFoundException;
+import com.manir.springbootecommercerestapi.model.User;
 import com.manir.springbootecommercerestapi.repository.CommentRepository;
 import com.manir.springbootecommercerestapi.repository.ProductRepository;
 import com.manir.springbootecommercerestapi.model.Comment;
 import com.manir.springbootecommercerestapi.model.Product;
+import com.manir.springbootecommercerestapi.repository.UserRepository;
 import com.manir.springbootecommercerestapi.service.CommentService;
 import org.modelmapper.ModelMapper;
 import org.springframework.http.HttpStatus;
@@ -25,22 +27,37 @@ public class CommentServiceImpl implements CommentService {
     private CommentRepository commentRepository;
     @Resource
     private ProductRepository productRepository;
+    @Resource
+    private UserRepository userRepository;
 
     @Override
-    public CommentDto createComment(Long productId, CommentDto commentDto) {
-
+    public CommentDto createComment(User customer, Long productId, CommentDto commentDto) {
+        User user = findCustomerById(customer.getId());
         Product product = findProductById(productId);
         //convert to entity
         Comment comment = mapToEntity(commentDto);
         //save to db
         comment.setProduct(product);
+        comment.setCustomer(user);
         Comment createdComment = commentRepository.save(comment);
         //convert to dto
         CommentDto responseComment = mapToDto(createdComment);
 
         return responseComment;
     }
 
+    @Override
+    public List<CommentDto> findCommentByCustomer(User customer) {
+        List<Comment> comments = commentRepository.findByCustomer(customer);
+        if (comments.size() == 0){
+            throw new EcommerceApiException("User has no comment or review", HttpStatus.BAD_REQUEST);
+        }
+        List<CommentDto> commentDtoList = comments.stream()
+                                                            .map(comment -> mapToDto(comment))
+                                                            .collect(Collectors.toList());
+        return commentDtoList;
+    }
+
     @Override
     public List<CommentDto> getAllComments() {
         List<Comment> comments = commentRepository.findAll();
@@ -120,4 +137,8 @@ private Comment findCommentById(Long commentId){
         return comment;
     }
 
+    private User findCustomerById(Long customerId){
+        User customer = userRepository.findById(customerId).orElseThrow(()->new ResourceNotFoundException("Customer", customerId));
+        return customer;
+    }
 }

src/main/java/com/manir/springbootecommercerestapi/service/Impl/OrderServiceImpl.java

@@ -41,6 +41,7 @@ public class OrderServiceImpl implements OrderService {
     @Transactional
     public void placeOrder(User customer) {
         CartItemResponse cartItemDto = shoppingCartService.findByCustomer(customer);
+        //set order fields
         OrderDto orderDto = setFields(cartItemDto, customer);
         //save order to the db
         OrderDto savedOrder = saveOrder(orderDto);