Documentation/javadoc

.gitignore

@@ -40,5 +40,5 @@ build/
 .DS_Store
 
 ### data ###
-*.db
+givehope.db
 /data/

pom.xml

@@ -62,7 +62,7 @@
                 <artifactId>javafx-maven-plugin</artifactId>
                 <version>0.0.8</version>
                 <configuration>
-                    <mainClass>ui.GiveHopeGIU</mainClass>
+                    <mainClass>app.Main</mainClass>
                 </configuration>
             </plugin>
 

src/main/java/app/Main.java

@@ -1,63 +1,83 @@
 package app;
 
+import domain.organization.Organization;
+import integration.InnsamlingskontrollenClient;
 import application.security.PasswordHasher;
 import application.user.UserRegister;
 import domain.donation.Donation;
-import domain.organization.Organization;
 import domain.user.User;
-import integration.InnsamlingskontrollenClient;
 import integration.security.Sha256PasswordHasher;
 import java.math.BigDecimal;
+import java.sql.SQLException;
 import java.util.List;
 import persistence.DonationDao;
 import persistence.OrganizationDao;
 import persistence.UserDao;
 import persistence.UserRepository;
 import persistence.db.Database;
+import javafx.application.Application;
+import javafx.fxml.FXMLLoader;
+import javafx.scene.Parent;
+import javafx.scene.Scene;
+import javafx.stage.Stage;
 
-public class Main {
+public class Main extends Application{
   public static void main(String[] args) {
-    try {
-      Database.getConnection();
-      System.out.println("Database connected");
-
-      UserDao userDao = new UserDao();
-      OrganizationDao orgDao = new OrganizationDao();
-      DonationDao donationDao = new DonationDao();
-
-      PasswordHasher hasher = new Sha256PasswordHasher();
-      UserRepository userRepo = new UserDao();
-      UserRegister userReg = new UserRegister(hasher, userRepo);
-
-      // Test brukerregistrering
-      userReg.execute("testuser", "12345678", "passord123", "test@example.com");
-      System.out.println("Inserted user!");
-
-      User user = userDao.findByEmail("test@example.com").orElseThrow();
-      System.out.println("Hentet bruker: " + user.getUsername() + ", id=" + user.getID());
-
-      // Hent og lagre organisasjoner fra Innsamlingskontrollen
-      System.out.println("Henter organisasjoner fra Innsamlingskontrollen...");
-      Organization[] fetchedOrgs = InnsamlingskontrollenClient.fetchOrganizations();
-      for (Organization org : fetchedOrgs) {
-        orgDao.insert(org);
+    launch(args);
+  }
+
+  @Override
+  public void start(Stage stage) throws Exception {
+    Database.initializeDatabase();
+
+    OrganizationDao orgDao = new OrganizationDao();
+    Organization[] orgs = InnsamlingskontrollenClient.fetchOrganizations();
+    for (Organization org : orgs) {
+      orgDao.insert(org);
       }
-      System.out.println("Lastet inn " + fetchedOrgs.length + " organisasjoner");
 
-      List<Organization> orgs = orgDao.getAll();
-      System.out.println("Organisasjoner i DB: " + orgs.size());
-      System.out.println("Første org: " + orgs.get(0).getName() + ", org_number=" + orgs.get(0).getOrgNumber());
+    addTestdata();
 
-      // Test donasjon med første org fra DB
-      Donation donation = new Donation(new BigDecimal("100.00"), user, orgs.get(0));
-      donationDao.insert(donation);
-      System.out.println("Inserted donation, id=" + donation.getId());
+    Parent root = FXMLLoader.load(getClass().getResource("/view/MainView.fxml"));
+    Scene scene = new Scene(root, 1275, 725);
+
+    stage.setTitle("GiveHope");
+    stage.setScene(scene);
+    stage.show();
+  }
 
-      List<Donation> donations = donationDao.findByUser(user.getID());
-      System.out.println("Antall donasjoner for bruker: " + donations.size());
+  private void addTestdata() throws SQLException {
+    UserDao userDao = new UserDao();
+    DonationDao donationDao = new DonationDao();
+    OrganizationDao orgDao = new OrganizationDao();
 
-    } catch (Exception e) {
-      e.printStackTrace();
+    if (userDao.existsByEmail("test@test.no")) return;
+
+    PasswordHasher hasher = new Sha256PasswordHasher();
+    String hashedPassword = hasher.hash("test");
+    User user = new User("test", "12345678", hashedPassword, "test@test.no");
+    userDao.insert(user);
+
+    Organization org = orgDao.getAll().get(0);
+
+    donationDao.insert(new Donation(new BigDecimal(100), user, org));
+    donationDao.insert(new Donation(new BigDecimal(250), user, org));
+    donationDao.insert(new Donation(new BigDecimal(500), user, org));
+    donationDao.insert(new Donation(new BigDecimal(300), user, org));
+    donationDao.insert(new Donation(new BigDecimal(1000), user, org));
+    donationDao.insert(new Donation(new BigDecimal(700), user, org));
+    donationDao.insert(new Donation(new BigDecimal(250), user, org));
+
+    if (!userDao.existsByEmail("test2@test.no")) {
+      String hashedPassword2 = hasher.hash("test2");
+      User user2 = new User("test2", "87654321", hashedPassword2, "test2@test.no");
+      userDao.insert(user2);
+
+      Organization org2 = orgDao.getAll().get(1);
+
+      donationDao.insert(new Donation(new BigDecimal(150), user2, org2));
+      donationDao.insert(new Donation(new BigDecimal(400), user2, org2));
+      donationDao.insert(new Donation(new BigDecimal(600), user2, org2));
+    }
     }
-  }
 }

src/main/java/application/security/PasswordHasher.java

@@ -1,5 +1,9 @@
 package application.security;
 
+/**
+ * Interface that creates a "contract" for which methods the class that implements it, needs.
+ * Interface is created for SHA256PasswordHasher.
+ */
 public interface PasswordHasher {
 
     String hash(String password);

src/main/java/application/user/UserRegister.java

@@ -4,16 +4,40 @@
 import domain.user.User;
 import persistence.UserRepository;
 
+/**
+ * The UserRegister class is responsible for handling the user registration process.
+ * It ensures that the provided user details meet the necessary criteria and that
+ * the username and email are not already in use. It also hashes the user's password
+ * before saving the user information into the repository.
+ */
 public class UserRegister {
 
     private final PasswordHasher hasher;
     private final UserRepository repo;
 
-    public UserRegister(PasswordHasher hasher, UserRepository repo) {
+  /**
+   * Constructs a {@code UserRegister} instance responsible for handling the user registration process.
+   * It ensures user details meet validation criteria, such as uniqueness of username and email,
+   * and hashes passwords before saving user information into the repository.
+   *
+   * @param hasher a {@code PasswordHasher} implementation used to hash user passwords.
+   * @param repo a {@code UserRepository} implementation responsible for storing user data.
+   */
+  public UserRegister(PasswordHasher hasher, UserRepository repo) {
         this.hasher = hasher;
         this.repo = repo;
     }
 
+  /**
+   * Executes a user registration.
+   * Validation checks, checks if username or e-mail already exists.
+   * Hashes inputted password using PasswordHasher, that uses SHA256PasswordHasher.
+   * Creates user object, and inserts it into UserRepository using insert method.
+   * @param username
+   * @param phoneNumber
+   * @param password
+   * @param email
+   */
     public void execute(String username, String phoneNumber, String password, String email) {
         username = username.trim();
         email = email.trim().toLowerCase();

src/main/java/application/user/UserSignIn.java

@@ -0,0 +1,57 @@
+package application.user;
+
+import application.security.PasswordHasher;
+import domain.user.User;
+import persistence.UserRepository;
+
+/**
+ * The UserSignIn class handles the process of user authentication.
+ * It verifies the input credentials (login and password) against the stored user data.
+ * The password is validated through hashing and comparison with the stored hash.
+ */
+public class UserSignIn {
+
+    private final PasswordHasher hasher;
+    private final UserRepository repo;
+
+  /**
+   * Constructs a {@code UserSignIn} instance responsible for user authentication.
+   * It handles the process of verifying user credentials by comparing the provided
+   * input with stored data in the repository and validating the password through hashing.
+   *
+   * @param hasher a {@code PasswordHasher} implementation used to hash and validate user passwords.
+   * @param repo a {@code UserRepository} implementation that stores user authentication data.
+   */
+  public UserSignIn(PasswordHasher hasher, UserRepository repo) {
+        this.hasher = hasher;
+        this.repo = repo;
+    }
+
+  /**
+   * Execute methods, that takes in inputted login and password.
+   * Checks via UserRepository if login exists in database.
+   * Compares hashed input password with hashed password in database.
+   * @param login inputted login by user
+   * @param password inputted password by user
+   * @return user object, if it exists.
+   */
+    public User execute(String login, String password) {
+        // normalize (trim etc.)
+        login.trim().toLowerCase();
+
+        User user = repo.findByLogin(login)
+                .orElseThrow(() -> new IllegalArgumentException("Invalid credentials"));
+
+        // hash password (optional)
+        String hashedInput = hasher.hash(password);
+
+        // compare hashed input with stored hash
+        if (!hashedInput.equals(user.getPassword())) {
+            throw new IllegalArgumentException("Invalid password");
+        }
+
+        System.out.println("Loggin in");
+        // return user (if match)
+        return user;
+    }
+}

src/main/java/application/user/UserStatistics.java

@@ -8,9 +8,9 @@
 /**
  * Provides statistical information about a user's donation activity.
  * Acts as a service layer between the application and {@link DonationDao},
+ * showing relevant userstatistics to the user.
  * exposing user-friendly methods for retrieving donation history,
- * total amounts, and favorite organizations.
- */
+ */ total amounts, and favorite organizations.
 public class UserStatistics {
   private DonationDao donationDao;
 
@@ -23,22 +23,20 @@ public UserStatistics() {
 
   /**
    * Returns the top three organizations that the user has donated to most frequently.
-   *
-   * @param user the user whose favorite organizations are to be retrieved; must not be null
+   * @param user the user whose favorite organizations are going to be returned.
    * @return a list of up to three formatted strings, each representing an organization
-   *         and its donation count; empty list if the user has no donations
+   *         and its donation count. Returns empty list if the user has no donations.
    */
-  public List<String> userFavoriteOrganizations(User user) {
-    List<String> favoriteOrganizations = donationDao.getFavoriteOrganizations(user.getID());
-    return favoriteOrganizations;
+  public List<String> userFavoriteOrganization(User user) {
+    List<String> favoriteOrganization = donationDao.getFavoriteOrganization(user.getID());
+    return favoriteOrganization;
   }
 
   /**
    * Returns a formatted list of all donations made by the user.
    * Each entry contains the donation amount, date, and organization.
-   *
-   * @param user the user whose donation history is to be retrieved; must not be null
-   * @return a list of formatted donation strings; empty list if the user has no donations
+   * @param user the user whose donation history is returned.
+   * @return a list of formatted donation strings. Returns empty list if the user has no donations
    */
   public List<String> userDonations(User user) {
     List<String> userDonationList = donationDao.getUserDonations(user.getID());
@@ -47,9 +45,8 @@ public List<String> userDonations(User user) {
 
   /**
    * Returns the total amount donated by the user across all donations.
-   *
-   * @param user the user whose total donation amount is to be calculated; must not be null
-   * @return a string representation of the total donated amount; {@code "0"} if no donations exist
+   * @param user the user whose total donation amount is returned.
+   * @return a string representation of the total donated amount. Returns "0" if no donations exist
    */
   public String userTotalDonationAmount(User user) {
     String totalDonations = donationDao.getTotalDonationAmount(user.getID());
@@ -58,9 +55,8 @@ public String userTotalDonationAmount(User user) {
 
   /**
    * Returns the total number of donations made by the user.
-   *
-   * @param user the user whose donation count is to be retrieved; must not be null
-   * @return a string representation of the total number of donations; {@code "0"} if none exist
+   * @param user the user whose donation count is returned.
+   * @return a string representation of the total number of donations. Returns "0" if none exist.
    */
   public String getTotalDonationsMade(User user) {
     String totalDonationsMade = donationDao.getTotalDonationsMade(user.getID());

src/main/java/domain/donation/Cause.java

@@ -1,3 +1,6 @@
 package domain.donation;
 
+/**
+ * Enum class that contains 5 different cause types
+ */
 public enum Cause { HEALTH, EMERGENCY_RELIEF, CHILDREN, ENVIRONMENT, CONFLICTS; }