Merge branch 'main' into 9-feature-1-user-registration

Author: Madhavan7

.gitignore

@@ -1,14 +1,13 @@
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
-# entities.user_entities.User-specific stuff
+# entities.userEntities.User-specific stuff
 .idea/**/workspace.xml
 .idea/**/tasks.xml
 .idea/**/usage.statistics.xml
 .idea/**/dictionaries
 .idea/**/shelf
-
-# AWS entities.user_entities.User-specific
+# AWS entities.userEntities.User-specific
 .idea/**/aws.xml
 
 # Generated files

README.md

@@ -1,10 +1,23 @@
-# Project Template
+# SOLID Chat
 
+## Our Progress (Last Updated on Nov 20)
+
+Each of us have created one or more PRs and most of these have been merged into the main branch. Many members have functional UI's (and they are likely happy to demonstrate in tutorial) and others have a basic non-interactive UI and the inner layers of clean architecture. While they may not be able to do an interactive demo, screenshots of these user interfaces are included below.
+
+### Chat UI
+- By Nasim, James, and Amy
+- The UI is rendered by ChatView
+- This view will appear when a user creates a new chat or visits an existing chat
+
+![image](https://user-images.githubusercontent.com/18428059/202935072-ba09587d-c67d-4599-9986-9c652480356f.png)
+
+
+## Template Readme
 This is a template repository for CSC 207 projects. 
 This repository contains starter code for a gradle project.
 It also contains workflow documents that give instructions on how to manage your Github repository and how to use Github Projects for efficient collaboration.
 
-## Checklist For Your Project
+### Checklist For Your Project
 - [ ] Verify the correct settings for your project repository
 - [ ] Set up Github Projects
 - [ ] Create the implementation plan using issues and Github Projects
@@ -14,13 +27,13 @@ It also contains workflow documents that give instructions on how to manage your
 
 **If your team has trouble with any of these steps, please ask on Piazza. For example, with how GitHub Classroom works, your team *may* not have permissions to do some of the first few steps, in which case we'll post alternative instructions as needed.**
 
-## Workflow Documents
+### Workflow Documents
 
 * Github Workflow: Please refer to the workflow that was introduced in the first lab. You should follow this when working on your code. The following document provides additional details too.
 
 * [Project Planning and Development Guide](project_plan_dev.md): This document helps you to understand how to create and maintain a project plan for your class project. **This document helps you to complete the Implementation Plan Milestone.**
 
-## Gradle Project
+### Gradle Project
 Import this project into your Intellij editor. It should automatically recognise this as a gradle repository.
 The starter code was built using SDK version 11.0.1. Ensure that you are using this version for this project. (You can, of course, change the SDK version as per your requirement if your team has all agreed to use a different version)
 

src/main/java/TestUserDatabase2.csv

@@ -7,10 +7,17 @@
 import use_cases.user_login_use_case.UserCreator;
 import interface_adapters.UserRetriever;
 
+import interface_adapters.Chat.ConvHistGateway;
+import interface_adapters.Chat.MsgSenderGateway;
+import interface_adapters.Chat.UserChatGateway;
+import interface_adapters.User.*;
+
 import java.io.*;
 import java.util.ArrayList;
 import java.util.List;
-public class UserDatabase implements UserExists, UserRetriever, UserCreator, IRetrieveList {
+
+public class UserDatabase implements UserExists, UserRetriever, UserCreator, IRetrieveList, UserModificationGateway,
+        ConvHistGateway, MsgSenderGateway, UserChatGateway {
     File accounts;
     List<User> accountList;
     public UserDatabase(){
@@ -38,6 +45,16 @@ public boolean UserExists(String username, String email) {
         return false;
     }
 
+    @Override
+    public boolean UserExists(String username) {
+        for(User user: this.accountList){
+            if(user.getUsername().equals(username)){
+                return true;
+            }
+        }
+        return false;
+    }
+    
     // Creates a new user with a username and password, and an email address
     // The order is username, password, email address, verification status, status
     //
@@ -62,9 +79,9 @@ public void createUser(String username, String password, String email, String ty
 //  To be edited to get user from the array format rather than the serialized format.
     public User getUser(String username) {
         User ans = null;
-        for (int i = 0; i < (this.getList().size()); i++) {
-            if (this.getList().get(i).getUsername().equals(username)) {
-                ans = this.getList().get(i);
+        for (int i = 0; i < (this.accountList.size()); i++) {
+            if (this.accountList.get(i).getUsername().equals(username)) {
+                ans = this.accountList.get(i);
             }
         }
         return ans;
@@ -85,4 +102,72 @@ public List<User> getList() {
             throw new RuntimeException(ex);
         }
     }
+
+    @Override
+    public void modifyUser(String oldUsername, User modified){
+//        swap in modified user to accountList
+        this.accountList.remove(this.getUser(oldUsername));
+        this.accountList.add(modified);
+
+//        overwrite the serialized file
+        try(FileOutputStream fileOut = new FileOutputStream(accounts)){
+            try(ObjectOutputStream out = new ObjectOutputStream(fileOut)){
+                out.writeObject(this.accountList);
+                out.close();
+                fileOut.close();
+            }catch(Exception e){
+                System.out.println("Error");
+            }
+        }catch(Exception e){
+            System.out.println("Error");
+        }
+    }
+
+
+    // Below two methods are used by conversation history-related interactors
+    // (Commented as objects are not found)
+//    /**
+//     * Pushes a new message to a chat's conversation history (in memory not persisting storage)
+//     * @param dsRequestModel input data containing user ID, chat ID, message content
+//     */
+//    public void saveMessage(MsgSenderDsRequestModel dsRequestModel) {
+//        String userID = dsRequestModel.getUserID();
+//        String chatID = dsRequestModel.getChatID();
+//        Message message = dsRequestModel.getMessage();
+//
+//        // Find chat under specified entities.userEntities.User
+//        Chat chat = this.getUser(userID).getChat(chatID);
+//
+//        chat.addMessage(message);
+//    }
+//
+//    /**
+//     * Gets a chat's conversation history (from memory not persisting storage)
+//     * @param dsRequestModel input data containing user ID, chat ID
+//     * @return a chat's conversation history
+//     */
+//    public ArrayList<Message> getConversationHistory(ConvHistDsRequestModel dsRequestModel) {
+//        String userID = dsRequestModel.getUserID();
+//        String chatID = dsRequestModel.getChatID();
+//
+//        // Find chat under specified entities.userEntities.User
+//        Chat chat = this.getUser(userID).getChat(chatID);
+//
+//        return Chat.getConversationHistory();
+//    }
+
+
+
+
+// This method will get a user's chats; this will be used by AppScreenLoader to display chats and could
+// also be used by ChatInteractor  (Chat entity is undefined here and at the moment user doesn't have chats)
+//    @Override
+//    public ArrayList<Chat> getUserChats(String username) {
+//        for (entities.userEntities.User user: accountList){
+//            if (user.getUsername().equals(username)){
+//                return user.getChats();
+//            }
+//        }
+//        throw new RuntimeException("Invalid username: user does not exist");
+//    }
 }

src/main/java/UserAccounts.csv

@@ -0,0 +1,55 @@
+package entities.chat;
+import java.util.ArrayList;
+// Chat is an abstract class
+public class Chat {
+
+    protected String name;
+    protected String chatID;
+    protected String senderUsername;
+
+    // chat's conversation history
+    protected ArrayList<Message> convHist;
+
+
+    /**
+     * Get the chat's name
+     * @return name
+     */
+    public String getName(){
+        return this.name;
+    }
+
+    /**
+     * Get the chat's ID
+     * @return chatID
+     */
+    public String getChatID(){
+        return this.chatID;
+    }
+
+    /**
+     * Get the sender's username
+     * @return senderUsername
+     */
+    public String getSenderUsername(){
+        return this.senderUsername;
+    }
+
+    /**
+     * Return this conversation history of the chat
+     * @return convHist
+     */
+    public ArrayList<Message> getConvHist(){
+        return new ArrayList<Message>(this.convHist);
+    }
+
+    /**
+     * Add a message to the chat's conversation history when a message is sent or received
+     * @param message Message that is sent or received
+     */
+    public void addtoconvHist(Message message){
+        this.convHist.add(message);
+    }
+
+
+}

src/main/java/data_access/UserDatabase.java

@@ -0,0 +1,52 @@
+package entities.chat;
+
+import java.util.ArrayList;
+
+public class GroupChat extends Chat {
+
+    /*
+    From Chat, GroupChat has:
+       String name;
+        String chatID;
+        String senderUsername;
+        Arraylist<Message> convHist;
+     */
+    public ArrayList<String> groupMembers;
+
+    /**
+     * Create a private chat
+     * @param name The name of the chat
+     * @param chatID The ID of the chat
+     * @param senderUsername The username of the user sending the messages
+     */
+    public GroupChat(String name, String chatID, String senderUsername){
+        this.name = name;
+        this.chatID = chatID;
+        this.senderUsername = senderUsername;
+        this.convHist = new ArrayList<Message>();
+        this.groupMembers = new ArrayList<>();
+    }
+
+    /**
+     * Return an arraylist of all the usernames of group members (not including the sender) in a group chat
+     *
+     * @return groupMembers
+     */
+    public ArrayList<String> getGroupMembers(){
+        return new ArrayList<String>(this.groupMembers);
+    }
+
+    /**
+     * Add a member to a group chat
+     * @param user The user to be added
+     */
+    public void addMember(String user){
+        try {
+            this.groupMembers.add(user);
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+
+}

src/main/java/entities/chat/Chat.java

@@ -0,0 +1,54 @@
+package entities.chat;
+
+import java.util.ArrayList;
+
+public class PrivateChat extends Chat {
+
+    /*
+    From Chat, PrivateChat has:
+        String name;
+        String chatID;
+        String senderUsername;
+        Arraylist<Message> convHist;
+     */
+    protected String recipientUsername;
+
+    /**
+     * Create a private chat
+     *
+     * @param name  The name of the chat (also the username of the recipient)
+     * @param chatID The ID of the chat
+     * @param senderUsername    The user sending the messages
+     * @param recipientUsername The user receiving the messages
+     *
+     */
+    public PrivateChat(String name, String chatID, String senderUsername, String recipientUsername ){
+        this.name = name;
+        this.chatID = chatID;
+        this.senderUsername = senderUsername;
+        this.recipientUsername = recipientUsername;
+        this.convHist = new ArrayList<Message>();
+    }
+
+
+    /**
+     * Get the recipient's username
+     * @return senderRecipient
+     */
+    public String getRecipientUsername(){
+        return this.recipientUsername;
+    }
+
+    public void setRecipientUsername(String recipientUsername) {
+        this.recipientUsername= recipientUsername;
+    }
+
+    public String getSendertUsername(){
+        return this.senderUsername;
+    }
+    public String setSendertUsername(String recipientUsername){
+        this.recipientUsername = recipientUsername;
+    }
+
+
+}