From 49250e60cf168ae9c5aab0e589a68b4c6c2bf800 Mon Sep 17 00:00:00 2001 From: Gunther6070 Date: Mon, 14 Apr 2025 20:56:32 -0400 Subject: Updated uml and Model tier in design doc --- docs/DesignDoc.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'docs/DesignDoc.md') diff --git a/docs/DesignDoc.md b/docs/DesignDoc.md index 0aaaa4b..41f519a 100644 --- a/docs/DesignDoc.md +++ b/docs/DesignDoc.md @@ -94,7 +94,6 @@ Users are able to login to the Ufund, either as a manager or helper. They can cr - AS a Developer I want api keys to be removed when expired SO THAT hundreds of expired keys do not pile up. - As a user I want to put in my password so that my account is secure. - AS a user I WANT to see a simple signup page SO THAT I can easily create an account without confusion. - - ### Enhancements @@ -223,9 +222,9 @@ Controllers - UserController: Handles http requests to interact with users, calling to the userService Services - - authService: Handles logging in and out, as well as authenticating users when they try and visit pages. - - cupboardService: Handles all logic dealing with needs, verifying inputs and throwing errors. - - userService: Handles all logic dealing with users, verifying inputs and throwing errors. + - AuthService: Handles logging in and out, as well as authenticating users when they try and visit pages. + - CupboardService: Handles all logic dealing with needs, verifying inputs and throwing errors. + - UserService: Handles all logic dealing with users, verifying inputs and throwing errors. > _**[Sprint 4]** Provide a summary of this tier of your architecture. This > section will follow the same instructions that are given for the View @@ -242,7 +241,10 @@ Requests are sent from the view tier and handled by controllers. For example, wh > _**[Sprint 1]** List the classes supporting this tier and provide a description of there purpose._ -The Model Tier contains the classes responsible for handling and serving Need data. In the model subsection is our Need.java, which handles the Need class itself and provides helper functions to get and set Need data. The persistence subjection handles stored data, using Data Access Objects (DAOs). The Controller section connects the two previous ones, handling the transfer of Needs to persistent storage. +Models + - Need: A need contains information pertaining to donating, such as a goal and current donations, as well as additional information to provide specifics for each need + - User: A user represents a single account on our website, containing info like a username and a hashed password as well as other fields for specifics + - UserAuth: A user auth is created whenever a user logs into the website, associating a username to a key. UserAuths are used to verify if a user has access to a CRUD operation > _**[Sprint 2, 3 & 4]** Provide a summary of this tier of your architecture. This > section will follow the same instructions that are given for the View -- cgit v1.2.3