Merge pull request #69 from cearps/feature/commenting

Add commenting to BoardService

api/src/main/java/com/backend/backend/config/ApplicationConfiguration.java

@@ -11,6 +11,18 @@
 import org.springframework.security.core.userdetails.UsernameNotFoundException;
 import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
 
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @Configuration
 public class ApplicationConfiguration {
     private final UserRepository userRepository;

api/src/main/java/com/backend/backend/config/SecurityConfiguration.java

@@ -17,7 +17,18 @@
 
 import java.util.List;
 
-// SecurityConfiguration.java
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @Configuration
 @EnableWebSecurity
 public class SecurityConfiguration {

api/src/main/java/com/backend/backend/controller/AuthenticationController.java

@@ -18,6 +18,18 @@
 
 import lombok.extern.slf4j.Slf4j;
 
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @RequestMapping("/auth")
 @RestController
 @Slf4j

api/src/main/java/com/backend/backend/controller/BoardController.java

@@ -55,7 +55,7 @@ public ResponseEntity<BoardResponse> getBoardById(@PathVariable Long id) {
         Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
         User currentUser = (User) authentication.getPrincipal();
         log.info("User {} is searching for kanban with id {} START", currentUser.getUserTag(), id);
-        BoardResponse boardResponse = boardService.getBoardByIdAndUserNew(id, currentUser.getId());
+        BoardResponse boardResponse = boardService.getBoardByIdAndUser(id, currentUser.getId());
         log.info("User {} is searching for kanban with id {} SUCCESS", currentUser.getUserTag(), id);
         return ResponseEntity.ok(boardResponse);
     }

api/src/main/java/com/backend/backend/controller/UserController.java

@@ -10,6 +10,18 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @RequestMapping("/user")
 @RestController
 @Slf4j

api/src/main/java/com/backend/backend/dto/LoginResponse.java

@@ -3,6 +3,18 @@
 import lombok.Data;
 import lombok.experimental.Accessors;
 
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @Data
 @Accessors(chain = true)
 public class LoginResponse {

api/src/main/java/com/backend/backend/dto/LoginUserDto.java

@@ -2,6 +2,18 @@
 
 import lombok.Data;
 
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @Data
 public class LoginUserDto {
     private String email;

api/src/main/java/com/backend/backend/dto/RegisterUserDto.java

@@ -2,6 +2,18 @@
 
 import lombok.Data;
 
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @Data
 public class RegisterUserDto {
     private String email;

api/src/main/java/com/backend/backend/exceptions/GlobalExceptionHandler.java

@@ -10,6 +10,18 @@
 import org.springframework.web.bind.annotation.ExceptionHandler;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @RestControllerAdvice
 public class GlobalExceptionHandler {
 

api/src/main/java/com/backend/backend/filter/JwtFilter.java

@@ -18,7 +18,18 @@
 
 import java.io.IOException;
 
-// JwtRequestFilter.java
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @Component
 public class JwtFilter extends OncePerRequestFilter {
     private final HandlerExceptionResolver handlerExceptionResolver;

api/src/main/java/com/backend/backend/model/User.java

@@ -10,6 +10,19 @@
 import java.util.List;
 import java.util.Set;
 
+
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @Table(name="users")
 @Entity
 @Data

api/src/main/java/com/backend/backend/repository/UserRepository.java

@@ -5,6 +5,18 @@
 
 import java.util.Optional;
 
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 public interface UserRepository extends JpaRepository<User, Long> {
     Optional<User> findByEmail(String email);
     Optional<User> findByUserTag(String userTag);

api/src/main/java/com/backend/backend/service/AuthenticationService.java

@@ -14,6 +14,18 @@
 
 import com.backend.backend.exceptions.UserAlreadyExistsException;
 
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @Service
 public class AuthenticationService {
     private final UserRepository userRepository;

api/src/main/java/com/backend/backend/service/BoardService.java

@@ -11,57 +11,86 @@
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+/**
+ * A service class that handles interactions with boards in the database. This layer is called by the controller
+ * classes and interacts directly with the repository interfaces to create, read, update and delete in the database.
+ */
 @Service
 public class BoardService {
-
+    /**
+     * Repository with CRUD methods on the Board table in the database
+     */
     private final BoardRepository boardRepository;
+    /**
+     * Repository with CRUD methods on the Userboard table in the database
+     */
     private final UserBoardRepository userBoardRepository;
 
-    public BoardService(UserRepository userRepository, BoardRepository boardRepository, UserBoardRepository userBoardRepository) {
+    /**
+     * Constructs a new Board service and injects the repositories
+     * @param boardRepository - Board repository
+     * @param userBoardRepository - Userboard repository
+     */
+    public BoardService(BoardRepository boardRepository, UserBoardRepository userBoardRepository) {
         this.boardRepository = boardRepository;
         this.userBoardRepository = userBoardRepository;
     }
 
+    /**
+     * Creates a blank board for a user
+     * @param user - User to create the new board for
+     * @return - BoardResponse with the details of the new board for the user
+     */
     public BoardResponse createBoardForUser(User user) {
         Board board = new Board();
-        boardRepository.save(board);
+        boardRepository.save(board); // saves board
         UserBoard userBoard = new UserBoard();
         userBoard.setUser(user);
         userBoard.setBoard(board);
-        userBoardRepository.save(userBoard);
+        userBoardRepository.save(userBoard); // links user to the board
         return new BoardResponse(board);
     }
 
+    /**
+     * Retrieves a board by its id for a specific user
+     * @param boardId - The ID of the board to find
+     * @param userId - The ID of the user who is searching for the board
+     * @return A BoardResponse with the details of the board found for the user
+     * @throws EntityNotFoundException if board id is not found for that user
+     */
     public BoardResponse getBoardByIdAndUser(Long boardId, Long userId) {
-        Board board = boardRepository.findByIdAndUserId(boardId, userId)
-                .orElseThrow(() -> new EntityNotFoundException("Board not found with id " + boardId.toString()));
-
-        BoardResponse response = new BoardResponse(board);
-        return response;
-
-    }
-
-    public BoardResponse getBoardByIdAndUserNew(Long boardId, Long userId) {
+        // Find board with id
         Board board = boardRepository.findById(boardId)
                 .orElseThrow(() -> new EntityNotFoundException("Board not found with id " + boardId.toString()));
 
+        // Check if user is a member of the board
         if ( board.getUserBoards().stream().anyMatch(userBoard -> userBoard.getUser().getId() == userId)) {
             return new BoardResponse(board);
         }
         else {
+            // User is not a member of the board so throw error
             throw new EntityNotFoundException("Board not found with id " + boardId.toString());
         }
 
     }
 
+    /**
+     * Deletes a board for a user
+     * @param user - User who is trying to delete the board
+     * @param boardId - ID of the board that will be deleted
+     * @throws EntityNotFoundException if boared with correct id and user not found
+     */
     @Transactional
     public void deleteBoard(User user, Long boardId) {
+        // Find board with board id for that user
         Board board = boardRepository.findByIdAndUserId(boardId, user.getId())
                 .orElseThrow(() -> new EntityNotFoundException("Board not found with id " + boardId.toString()));
 
+        // Cleanup userboards linking users to the board
         for (UserBoard userBoard : board.getUserBoards()) {
             userBoardRepository.delete(userBoard);
         }
+        // Delete the board
         boardRepository.delete(board);
     }
 

api/src/main/java/com/backend/backend/service/JwtService.java

@@ -18,6 +18,18 @@
 import java.util.Map;
 import java.util.function.Function;
 
+/**
+ * Acknowledgements:
+ * This class was written by following the instructions in the "Implement JWT authentication
+ * in a Spring Boot 3 application" tutorial on Medium published by Eric C. Togo.
+ * The tutorial was published on 20/03/2024.
+ *
+ * The full APA 7th reference is:
+ * Tiogo, E.C. (2024) Implement JWT authentication in a Spring Boot 3
+ *     application, Medium. Available at:
+ *     https://medium.com/@tericcabrel/implement-jwt-authentication-in-a-spring-boot-3-application-5839e4fd8fac
+ *     (Accessed: 22 June 2024).
+ */
 @Service
 @AllArgsConstructor
 @NoArgsConstructor

api/src/test/java/com/backend/backend/BackendApplicationTests.java

@@ -4,7 +4,12 @@
 import org.springframework.boot.test.context.SpringBootTest;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-
+/**
+ * Acknowledgements:
+ * ChatGPT (https://chatgpt.com/) was used to assist in writing test
+ * cases. The test cases were further edited manually for correctness, brevity and
+ * coverage of cases in the code
+ */
 @SpringBootTest
 class BackendApplicationTests {
 

api/src/test/java/com/backend/backend/controller/AuthenticationControllerTests.java

@@ -19,6 +19,12 @@
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.when;
 
+/**
+ * Acknowledgements:
+ * ChatGPT (https://chatgpt.com/) was used to assist in writing test
+ * cases. The test cases were further edited manually for correctness, brevity and
+ * coverage of cases in the code
+ */
 class AuthenticationControllerTests {
 
     @InjectMocks