Merge remote-tracking branch 'origin/main' into list-and-cupboard-component-refactor

# Conflicts:
#	ufund-api/src/main/java/com/ufund/api/ufundapi/controller/CupboardController.java
#	ufund-api/src/main/java/com/ufund/api/ufundapi/model/Need.java
#	ufund-ui/src/app/components/cupboard/cupboard.component.ts
#	ufund-ui/src/app/components/need-list/need-list.component.ts
#	ufund-ui/src/app/models/Need.ts

3 files changed, 45 insertions, 18 deletions

diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/model/Need.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/model/Need.java
index 45f1f9a..00cd38f 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/model/Need.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/model/Need.java
@@ -19,7 +19,7 @@ public class Need {
     @JsonProperty("current") private double current;
 
     /**
-     * Create a new need
+     * Create a new need, used by the controller
      *
      * @param name The name of the need
      * @param location The physical location of the need
@@ -28,7 +28,7 @@ public class Need {
      * @param type The type of need (monetary, physical)
      * @param urgent The urgency of the need
      */
-    public Need(@JsonProperty("name") String name, @JsonProperty("location") String location, @JsonProperty("id") int id, @JsonProperty("maxGoal") double maxGoal, GoalType type, @JsonProperty("urgent") boolean urgent) {
+    public Need(@JsonProperty("name") String name, @JsonProperty("location") String location, @JsonProperty("id") int id, @JsonProperty("maxGoal") double maxGoal, @JsonProperty("type") GoalType type, @JsonProperty("urgent") boolean urgent) {
         this.id = id;
         this.location = location;
         this.name = name;
@@ -44,7 +44,7 @@ public class Need {
      * @param location The location of the need
      * @param maxGoal The maximum goal for this need
      * @param type    The type of need (monetary, physical)
-     * @param urgency The urgency of the need
+     * @param urgent The urgency of the need
      */
     public Need(String name, String location, GoalType type, double maxGoal, boolean urgent) {
         this.name = name;
@@ -106,6 +106,10 @@ public class Need {
         this.current = current;
     }
 
+    public void incrementCurrent(double incrementAmount) {
+        this.current += incrementAmount;
+    }
+
     public void setFilterAttributes(String[] filterAttributes) {
         this.filterAttributes = filterAttributes;
     }
diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/model/User.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/model/User.java
index 6de1a8a..58b62df 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/model/User.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/model/User.java
@@ -12,18 +12,23 @@ public class User {
         MANAGER
     }
 
-    @JsonProperty("username") private final String username;
-    @JsonProperty("passwordHash") private int passwordHash;
-    @JsonProperty("basket") private final List<Integer> basket;
-    @JsonProperty("type") private final UserType type;
+    @JsonProperty("username")
+    private final String username;
+    @JsonProperty("passwordHash")
+    private int passwordHash;
+    @JsonProperty("basket")
+    private final List<Integer> basket;
+    @JsonProperty("type")
+    private final UserType type;
 
     /**
      * Create a new user
      * 
-     * @param username   The name of the user
-     * @param basket A basket to copy from
+     * @param username The name of the user
+     * @param basket   A basket to copy from
      */
-    public User(@JsonProperty("username") String username, @JsonProperty("passwordHash") int passwordHash, @JsonProperty("basket") List<Integer> basket, @JsonProperty("type") UserType userType) {
+    public User(@JsonProperty("username") String username, @JsonProperty("passwordHash") int passwordHash,
+            @JsonProperty("basket") List<Integer> basket, @JsonProperty("type") UserType userType) {
         this.username = username;
         this.basket = basket;
         this.passwordHash = passwordHash;
@@ -35,30 +40,46 @@ public class User {
                 username,
                 password.hashCode(),
                 new ArrayList<>(),
-                UserType.HELPER
-        );
+                UserType.HELPER);
     }
 
     public String getUsername() {
         return username;
     }
 
+    /**
+     * Verifies if the provided password's hash is the same as the user's actual
+     * hash
+     * 
+     * @param password The password to check if valid
+     * @return True or false depending on if it's equal
+     */
     public boolean verifyPassword(String password) {
         return password.hashCode() == passwordHash;
     }
 
+    /**
+     * Adds a need's ID to a user's basket
+     * 
+     * @param need The need to add
+     */
     public void addToBasket(Need need) {
         basket.add(need.getId());
     }
 
-    public Integer[] getNeeds() {
+    public Integer[] getBasket() {
         return basket.toArray(Integer[]::new);
     }
 
-    public boolean removeBasketNeed(Integer needID) {
-        return basket.remove(needID);
+    public void removeBasketNeed(Integer needID) {
+        basket.remove(needID);
     }
 
+    /**
+     * Returns a user without a password hash for security purposes
+     * 
+     * @return new User with empty password hash
+     */
     public User withoutPasswordHash() {
         return new User(this.username, 0, this.basket, this.type);
     }
@@ -71,6 +92,7 @@ public class User {
         this.passwordHash = other.passwordHash;
     }
 
+    @Override
     public String toString() {
         return this.username + "; basket: " + this.basket + "; type:" + this.type + "; hash: " + this.passwordHash;
     }
diff --git a/ufund-api/src/main/java/com/ufund/api/ufundapi/model/UserAuth.java b/ufund-api/src/main/java/com/ufund/api/ufundapi/model/UserAuth.java
index 1c11a28..78dccec 100644
--- a/ufund-api/src/main/java/com/ufund/api/ufundapi/model/UserAuth.java
+++ b/ufund-api/src/main/java/com/ufund/api/ufundapi/model/UserAuth.java
@@ -1,10 +1,10 @@
 package com.ufund.api.ufundapi.model;
 
-import com.fasterxml.jackson.annotation.JsonProperty;
-
 import java.time.LocalDateTime;
 import java.util.UUID;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 public class UserAuth {
     @JsonProperty("key") String key;
     @JsonProperty("username") String username;
@@ -12,12 +12,13 @@ public class UserAuth {
 
     public UserAuth(@JsonProperty("key") String key, @JsonProperty("username") String username, @JsonProperty("expiration") LocalDateTime expiration) {
         this.key = key;
-        this.expiration = expiration;
         this.username = username;
+        this.expiration = expiration;
     }
 
     /**
      * Generate a new user authentication profile
+     * 
      * @param username the username the key will belong to
      * @return The new user authentication profile
      */