Implement pet/shop/health system

Author: WoMingBoazCheung

src/main/java/com/backend/controller/PetController.java

@@ -11,7 +11,6 @@
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
-import java.util.ArrayList;
 
 @RestController
 public class PetController {
@@ -35,11 +34,11 @@ public ResponseEntity<Object> getPet(@RequestParam SessionID sessionID){
     /**
      * Post request to replace the current pet with the same pet with an updated outfit from the database
      * @param sessionID string that represents the current session and verifies the action
-     * @param newOutfit ArrayList of ShopItems that will be for the updated outfit
+     * @param shopItem ShopItem that will be for the updated outfit
      */
     @PostMapping("/updatePetOutfit")
-    public ResponseEntity<Object> updatePetOutfit(@RequestParam SessionID sessionID, ArrayList<ShopItem> newOutfit){
-        return this.petSystemFacade.updateCurrentOutfit(sessionID, newOutfit);
+    public ResponseEntity<Object> updatePetOutfit(@RequestParam SessionID sessionID, ShopItem shopItem){
+        return this.petSystemFacade.updateCurrentOutfit(sessionID, shopItem);
     }
 
     /**

src/main/java/com/backend/entities/ShopItem.java

@@ -19,15 +19,19 @@ public class ShopItem {
     private final Double cost;
     private final String name;
     private final String description;
+    private final String imageLink;
+    private final int location;
 
     // Contructor
     @PersistenceCreator
-    public ShopItem(String ID, Double cost, String name, String description){
+    public ShopItem(String ID, Double cost, String name, String description, String imageLink, int location){
         this.itemID = new ItemID(ID);
         this.ID = ID;
         this.cost = cost;
         this.name = name;
         this.description = description;
+        this.imageLink = imageLink;
+        this.location = location;
     }
 
     // Getters
@@ -58,4 +62,18 @@ public String getName(){
     public String getDescription(){
         return description;
     }
+
+    /**
+     * @return the link for the image
+     */
+    public String getImageLink(){
+        return imageLink;
+    }
+
+    /**
+     * @return the location
+     */
+    public int getLocation(){
+        return location;
+    }
 }

src/main/java/com/backend/usecases/facades/PetSystemFacade.java

@@ -12,7 +12,6 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.stereotype.Service;
 
-import java.util.ArrayList;
 
 @Service
 @Configurable
@@ -24,6 +23,14 @@ public class PetSystemFacade {
     private final BalanceManager balanceManager;
     private final IErrorHandler errorHandler;
 
+    /**
+     * Spring Boot Dependency Injection of the accountManager
+     * @param shopManager the dependency to be injected
+     * @param accountManager the dependency to be injected
+     * @param petManager the dependency to be injected
+     * @param balanceManager the dependency to be injected
+     * @param errorHandler the dependency to be injected
+     */
     @Autowired
     public PetSystemFacade(ShopManager shopManager, AccountManager accountManager, PetManager petManager, BalanceManager balanceManager, IErrorHandler errorHandler){
         this.shopManager = shopManager;
@@ -34,7 +41,7 @@ public PetSystemFacade(ShopManager shopManager, AccountManager accountManager, P
     }
 
     /**
-     * Post request of the pet owning the item and subtracting from its balance the cost of the item
+     * Post request of the allowing the pet owning the item and subtracting from its balance the cost of the item if it fulfills the requirements
      * @param sessionID string that represents the current session and verifies the action
      * @param itemID string that represents which item the pet is attempting to access
      */
@@ -69,19 +76,28 @@ public ResponseEntity<Object> purchaseItem(String sessionID, String itemID) {
         }
     }
 
-    public ResponseEntity<Object> updateCurrentOutfit(SessionID sessionID, ArrayList<ShopItem> newOutfit){
+    /**
+     * Post request of the allowing the pet to update the outfit
+     * @param sessionID string that represents the current session and verifies the action
+     * @param shopItem ShopItem of shopItem of outfit that the pet will wear
+     */
+    public ResponseEntity<Object> updateCurrentOutfit(SessionID sessionID, ShopItem shopItem){
         AccountID accountID = this.accountManager.verifySession(sessionID);
         if (accountID == null){
             return this.errorHandler.logError(new SessionException("Account ID is null since sessionID was invalid"), HttpStatus.BAD_REQUEST);
         }
-        boolean result = this.shopManager.updateCurrentOutfit(accountID, newOutfit);
+        boolean result = this.shopManager.updateCurrentOutfit(accountID, shopItem);
         if (!result){
             return this.errorHandler.logError(new SessionException("Account ID is null since sessionID was invalid"), HttpStatus.BAD_REQUEST);
         }
         return new ResponseEntity<>("Outfit successfully updated", HttpStatus.OK);
     }
 
 
+    /**
+     * Get request of the pet by the sessionID from the database
+     * @param sessionID string that represents the current session and verifies the action
+     */
     public ResponseEntity<Object> getPet(SessionID sessionID){
         AccountID accountID = this.accountManager.verifySession(sessionID);
         if (accountID == null){
@@ -90,6 +106,10 @@ public ResponseEntity<Object> getPet(SessionID sessionID){
         return new ResponseEntity<>(petManager.getPet(accountID.getID()), HttpStatus.OK);
     }
 
+    /**
+     * Get request of the pet's balance by the sessionID from the database
+     * @param sessionID string that represents the current session and verifies the action
+     */
     public ResponseEntity<Object> getBalance(SessionID sessionID){
         AccountID accountID = this.accountManager.verifySession(sessionID);
         if (accountID == null){
@@ -100,6 +120,9 @@ public ResponseEntity<Object> getBalance(SessionID sessionID){
         return new ResponseEntity<>(balance, HttpStatus.OK);
     }
 
+    /**
+     * Get request of all the shopItems from the database
+     */
     public ResponseEntity<Object> getShopItems(){
         return new ResponseEntity<>(this.shopManager.getShopItems(), HttpStatus.OK);
     }

src/main/java/com/backend/usecases/managers/BalanceManager.java

@@ -15,14 +15,19 @@ public class BalanceManager {
     private final PetRepo petRepo;
     private final IErrorHandler errorHandler;
 
+    /**
+     * Spring Boot Dependency Injection of the Accounts Repository
+     * @param petRepo the dependency to be injected
+     * @param errorHandler the dependency to be injected
+     */
     @Autowired
     public BalanceManager(PetRepo petRepo, IErrorHandler errorHandler) {
         this.petRepo = petRepo;
         this.errorHandler = errorHandler;
     }
 
     /**
-     * Get request of balance from the database through the pet object
+     * Get the balance from the database through the pet object by the accountID
      * @param accountID string that represents the current session and verifies the action
      */
     public Double getBalance(String accountID){
@@ -37,7 +42,7 @@ public Double getBalance(String accountID){
     }
 
     /**
-     * Post request of balance changed with the parameter amount
+     * Update balance changed with the parameter amount for the corresponding account
      * @param accountID string that represents the current session and verifies the action
      * @param amount the double that represents the amount added to the pet's balance
      */

src/main/java/com/backend/usecases/managers/HealthManager.java

@@ -20,14 +20,19 @@ public class HealthManager {
     private final PetRepo petRepo;
     private final IErrorHandler errorHandler;
 
+    /**
+     * Spring Boot Dependency Injection of the Accounts Repository
+     * @param petRepo the dependency to be injected
+     * @param errorHandler the dependency to be injected
+     */
     @Autowired
     public HealthManager(PetRepo petRepo, IErrorHandler errorHandler) {
         this.petRepo = petRepo;
         this.errorHandler = errorHandler;
     }
 
     /**
-     * Post request of health added with the parameter amount
+     * Changing health with the parameter amount for the corresponding account
      * @param accountID string that represents the current session and verifies the action
      * @param amount the double that represents the amount added to the pet's balance
      */
@@ -37,16 +42,17 @@ public void updateHealth(String accountID, double amount){
             this.errorHandler.logError(new SessionException("Pet is null since accountID was invalid"));
             return;
         }
-
         double updatedHealth = pet.get().getHealth() + amount;
+        if (updatedHealth > 100){
+            updatedHealth = 100;
+        }
 
         Pet updatedPet = new Pet(accountID, updatedHealth, pet.get().getBalance(), pet.get().getInventory(), pet.get().getCurrentOutfit());
         this.petRepo.save(updatedPet);
     }
 
     /**
      * Decay of health overtime if task have not been completed
-     *
      * @param accountID string that represents the current session and verifies the action
      */
     public void healthDecay(String accountID, List<TaskCompletionRecord> completionRecords){

src/main/java/com/backend/usecases/managers/PetManager.java

@@ -18,33 +18,45 @@ public class PetManager {
     private final PetRepo petRepo;
     private final IErrorHandler errorHandler;
 
+    /**
+     * Spring Boot Dependency Injection of the Accounts Repository
+     * @param petRepo the dependency to be injected
+     * @param errorHandler the dependency to be injected
+     */
     @Autowired
     public PetManager(PetRepo petRepo, IErrorHandler errorHandler) {
         this.petRepo = petRepo;
         this.errorHandler = errorHandler;
     }
 
     /**
-     * Get request to return the pet object and it's attributes
+     * Return the pet object and it's attributes
      * @param accountID string that represents the current session and verifies the action
      */
     public Pet getPet(String accountID){
         Optional<Pet> pet = petRepo.findById(accountID);
-        return pet.orElse(null);
+
+        if (pet.isEmpty()){
+            return null;
+        }
+        return pet.get();
     }
 
 
     /**
-     * Adds the default pet for an account
+     * Adds the default pet for an account into the database
      * @param id AccountId string that represents the pet linking to the account
      */
     public Pet initializePet(String id){
         if (id.isEmpty()){
             return null;
         }
         ArrayList<ShopItem> curInventory = new ArrayList<>();
-        curInventory.add(new ShopItem("1480775928", 19.9, "brown pants", "a pair of classic fit brown pants"));
-        Pet pet = new Pet(id, 85.00, 25.4, curInventory, new ArrayList<>());
+        ArrayList<ShopItem> curOutfit = new ArrayList<>();
+        ShopItem shopItem = new ShopItem("1480775928", 19.9, "brown pants", "a pair of classic fit brown pants", "", 2);
+        curInventory.add(shopItem);
+        curOutfit.add(shopItem);
+        Pet pet = new Pet(id, 85.00, 25.4, curInventory, curOutfit);
         this.petRepo.save(pet);
         return pet;
     }

src/main/java/com/backend/usecases/managers/ShopManager.java

@@ -24,6 +24,11 @@ public class ShopManager {
     private final PetRepo petRepo;
     private final IErrorHandler errorHandler;
 
+    /**
+     * Spring Boot Dependency Injection of the Accounts Repository
+     * @param petRepo the dependency to be injected
+     * @param errorHandler the dependency to be injected
+     */
     @Autowired
     public ShopManager(ShopItemRepo shopRepo, PetRepo petRepo, IErrorHandler errorHandler) {
         this.shopRepo = shopRepo;
@@ -33,15 +38,13 @@ public ShopManager(ShopItemRepo shopRepo, PetRepo petRepo, IErrorHandler errorHa
 
     /**
      * Returns all the shop items from the database through petRepo
-     *
      */
     public List<ShopItem> getShopItems() {
         return this.shopRepo.findAll();
     }
 
     /**
      * Returns a shop items from the database through petRepo
-     *
      * @param shopItemID string that represents the id of the shopItem
      */
     public ShopItem getShopItem(String shopItemID) {
@@ -54,17 +57,36 @@ public ShopItem getShopItem(String shopItemID) {
 
 
     /**
-     * Post request of the pet object after modifying it with the newOutfit
+     * Update the pet object after modifying it with the newOutfit
      * @param accountID string that represents the user and the pet's identity
-     * @param newOutfit ArrayList of shopItem that would represent which items the pet is wearing
+     * @param shopItem ShopItem that would represent which items the pet is wearing
      */
-    public boolean updateCurrentOutfit(AccountID accountID, ArrayList<ShopItem> newOutfit){
+    public boolean updateCurrentOutfit(AccountID accountID, ShopItem shopItem){
         Optional<Pet> pet = this.petRepo.findById(accountID.getID());
         if (pet.isEmpty()) {
             return false;
         }
 
-        Pet updatedPet = new Pet(accountID.getID(), pet.get().getHealth(), 0.0, pet.get().getInventory(), newOutfit);
+        ArrayList<ShopItem> curOutfit = pet.get().getCurrentOutfit();
+        ArrayList<ShopItem> newOutfit = new ArrayList<>();
+
+        boolean alreadyEquipped = false;
+
+        for(ShopItem s: curOutfit){
+            if (shopItem.getLocation() == s.getLocation()){
+                newOutfit.add(shopItem);
+                alreadyEquipped = true;
+            }
+            else{
+                newOutfit.add(s);
+            }
+        }
+
+        if(!alreadyEquipped){
+            newOutfit.add(shopItem);
+        }
+
+        Pet updatedPet = new Pet(accountID.getID(), pet.get().getHealth(), pet.get().getBalance(), pet.get().getInventory(), newOutfit);
         this.petRepo.save(updatedPet);
         return true;
     }