From c561e9a5b36bafbb5e6f277b04f112941c2231a5 Mon Sep 17 00:00:00 2001
From: Gunther6070 <haydenhartman10@yahoo.com>
Date: Wed, 2 Apr 2025 16:56:27 -0400
Subject: Implemented new endpoint to get total number of users

---
 .../api/ufundapi/controller/UserController.java    | 26 ++++++++++++++++++++++
 .../ufund/api/ufundapi/persistence/UserDAO.java    | 10 +++++++++
 .../api/ufundapi/persistence/UserFileDAO.java      |  7 ++++++
 .../ufund/api/ufundapi/service/UserService.java    | 10 +++++++++
 4 files changed, 53 insertions(+)

(limited to 'ufund-api')

diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/controller/UserController.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/controller/UserController.java
index a34e891..653a925 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/controller/UserController.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/controller/UserController.java
@@ -94,6 +94,32 @@ public class UserController {
 
     }
 
+    /**
+     * Responds to the GET request with the total number of users
+     *
+     * @param key      The authentication key of the user
+     * @return ResponseEntity with amount and HTTP status of OK<br>
+     *         ResponseEntity with HTTP status of UNAUTHORIZED if user is not aa manager<br>
+     *         ResponseEntity with HTTP status of INTERNAL_SERVER_ERROR otherwise
+     */
+    @GetMapping("/userCount")
+    public ResponseEntity<Object> getUserCount(@RequestHeader("jelly-api-key") String key) {
+        LOG.log(Level.INFO, "GET /userAmount");
+
+        try {
+            authService.keyHasAccessToCupboard(key);
+            int count = userService.getUserCount();
+            return new ResponseEntity<>(count, HttpStatus.OK);
+        } catch (IllegalAccessException ex) {
+            LOG.log(Level.WARNING, ex.getLocalizedMessage());
+            return new ResponseEntity<>(ex.getMessage(), HttpStatus.UNAUTHORIZED);
+        } catch (IOException ex) {
+            LOG.log(Level.SEVERE, ex.getLocalizedMessage());
+            return new ResponseEntity<>(ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);
+        }
+
+    }
+
     /**
      * Updates a User with the provided one
      * 
diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserDAO.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserDAO.java
index 29d46cf..27ba0b9 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserDAO.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserDAO.java
@@ -33,6 +33,16 @@ public interface UserDAO {
      */
     User getUser(String username) throws IOException;
 
+    /**
+     * Retrieves the total count of users
+     *
+     * @return a {@link int amount} number of users
+     *         <br>
+     *
+     * @throws IOException if an issue with underlying storage
+     */
+    int getUserCount() throws IOException;
+
     /**
      * Creates and saves a {@linkplain User user}
      * 
diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserFileDAO.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserFileDAO.java
index ec94da8..7f1fadd 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserFileDAO.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/persistence/UserFileDAO.java
@@ -57,6 +57,13 @@ public class UserFileDAO implements UserDAO {
         }
     }
 
+    @Override
+    public int getUserCount() {
+        synchronized (users) {
+            return users.size();
+        }
+    }
+
     @Override
     public User getUser(String username) {
         synchronized (users) {
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 6e27f50..8b34e68 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
@@ -55,6 +55,16 @@ public class UserService {
         return userDAO.getUser(username);
     }
 
+    /**
+     * Returns the total number of users
+     *
+     * @return The number of users
+     * @throws IOException If there was any problem saving the file
+     */
+    public int getUserCount() throws IOException {
+        return userDAO.getUserCount();
+    }
+
     /**
      * Updates a user
      *
-- 
cgit v1.2.3