Push current changes (working on documentation and tests)

3 files changed, 44 insertions, 15 deletions

diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/service/AuthService.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/service/AuthService.java
index 2e644ee..ac86ff1 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/service/AuthService.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/service/AuthService.java
@@ -17,17 +17,29 @@ public class AuthService {
         this.userService = userService;
     }
 
-    public UserAuth getUserAuth(String key) {
-        return userAuthDAO.getUserAuth(key);
-    }
-
+    /**
+     * Check if the provided key has access to the provided user.
+     *
+     * @param username The username of the user trying to be accessed.
+     * @param key The api key obtained by the client from logging in.
+     * @throws IllegalAccessException Thrown if access was denied to the user.
+     */
     public void authenticate(String username, String key) throws IllegalAccessException {
-        var userAuth = getUserAuth(key);
+        var userAuth = userAuthDAO.getUserAuth(key);
         if (userAuth == null || !userAuth.getUsername().equals(username)) {
             throw new IllegalAccessException("Unauthorized");
         }
     }
 
+    /**
+     * Attempt to log in with the provided credentials
+     *
+     * @param username The username of the user
+     * @param password The password of the user
+     * @return An API key if the authentication was successful.
+     * @throws IllegalAccessException Thrown if the username or password was incorrect
+     * @throws IOException If there was an issue saving the authentication
+     */
     public String login(String username, String password) throws IllegalAccessException, IOException {
         var usr = userService.getUser(username);
         if (usr == null || !usr.verifyPassword(password)) {
@@ -38,4 +50,14 @@ public class AuthService {
         return userAuth.getKey();
     }
 
+    /**
+     * Logs out the current user
+     *
+     * @param key The API key to of the client
+     * @throws IOException Thrown if there was an error saving the authentication
+     */
+    public void logout(String key) throws IOException {
+        userAuthDAO.removeUserAuth(key);
+    }
+
 }
diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java
index 860a2a8..6052e4f 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/service/CupboardService.java
@@ -5,17 +5,17 @@ import java.util.Arrays;
 
 import com.ufund.api.ufundapi.model.Need;
 import com.ufund.api.ufundapi.persistence.CupboardDAO;
+import org.springframework.stereotype.Component;
 
+@Component
 public class CupboardService {
 
     private final CupboardDAO cupboardDAO;
 
     public class DuplicateKeyException extends Exception {
-
         public DuplicateKeyException(String message) {
             super(message);
         }
-
     }
 
     public CupboardService(CupboardDAO cupboardDAO) {
@@ -57,27 +57,34 @@ public class CupboardService {
     }
 
     /**
-     * @param id
-     * @return
-     * @throws IOException
+     * Gets a need with the specified ID
+     *
+     * @param id the ID of the need
+     * @return The resulting Need or null if the need was not found
      */
     public Need getNeed(int id) throws IOException {
         return cupboardDAO.getNeed(id);
     }
 
     /**
-     * 
+     * Modify a need
+     *
      * @param need
      * @return
-     * @throws IOException
+     * @throws IOException Thrown if there was an issue saving the changes
      */
     public Need updateNeed(Need need) throws IOException {
         return cupboardDAO.updateNeed(need);
     }
 
+    /**
+     * Delete a need from the cupboard
+     *
+     * @param id the ID of the need
+     * @return True if the need was deleted
+     * @throws IOException Thrown on any problem removing the need
+     */
     public boolean deleteNeed(int id) throws IOException {
         return cupboardDAO.deleteNeed(id);
     }
-
-    
 }
diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/service/UserService.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/service/UserService.java
index a545029..6af3897 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/service/UserService.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/service/UserService.java
@@ -16,7 +16,7 @@ public class UserService {
      *
      * @param userDao The Data Access Object
      */
-    public UserService(UserDAO userDao, AuthService authService) {
+    public UserService(UserDAO userDao) {
         this.userDAO = userDao;
     }