Merge pull request #28 from CSC207-2022F-UofT/conversation-history

Conversation History Interactor and Entities - Updated with Package Structure

Author: milkdromeda

src/main/java/entities/message/Message.java

@@ -0,0 +1,59 @@
+package entities.message;
+
+import java.time.LocalDateTime;
+
+/**
+ * Message (abstract class) containing the message content and associated metadata
+ * The type of the message content is dependent on which child(ren) of Message the message is
+ * The metadata is universal for all message types and includes the ID of the sender, timestamp, ID of message
+ */
+public abstract class Message {
+    /**
+     * ID of message sender (UUID)
+     */
+    private final String senderID;
+    /**
+     * Time message was sent
+     */
+    private final LocalDateTime timestamp;
+    /**
+     * ID of message (UUID)
+     */
+    private final String msgID;
+
+    /**
+     * Construct a new message
+     * @param senderID ID of sender
+     * @param timestamp time message was sent
+     * @param msgID ID of message
+     */
+    public Message(String senderID, LocalDateTime timestamp, String msgID) {
+        this.senderID = senderID;
+        this.timestamp = timestamp;
+        this.msgID = msgID;
+    }
+
+    /**
+     * Gets ID of sender
+     * @return ID of sender
+     */
+    public String getSenderID() {
+        return senderID;
+    }
+
+    /**
+     * Gets message timestamp
+     * @return message timestamp
+     */
+    public LocalDateTime getTimestamp() {
+        return timestamp;
+    }
+
+    /**
+     * Gets ID of message
+     * @return ID of message
+     */
+    public String getMsgID() {
+        return msgID;
+    }
+}

src/main/java/entities/message/MsgFactory.java

@@ -0,0 +1,23 @@
+package entities.message;
+
+import java.time.LocalDateTime;
+import java.util.UUID;
+
+public class MsgFactory {
+    private final String msgType;
+
+    public MsgFactory(String msgType) {
+        this.msgType = msgType;
+    }
+
+    public Message createMsg(String senderID, Object msgContent) {
+        if (msgType.equalsIgnoreCase("text")) {
+            return new TextMessage(senderID, (String) msgContent, LocalDateTime.now(), UUID.randomUUID().toString());
+            // ID of message's sender, message text/content, timestamp of message, ID of message
+        } else {
+            System.out.println("A " + msgType.toLowerCase() + " is an undefined message type for this program.");
+            // TODO: implement exception
+            return null;
+        }
+    }
+}

src/main/java/entities/message/TextMessage.java

@@ -0,0 +1,41 @@
+package entities.message;
+
+import java.time.LocalDateTime;
+
+/**
+ * A message with text as its content (child of Message)
+ */
+public class TextMessage extends Message {
+    /**
+     * Text content of message
+     */
+    private String msgContent;
+
+    /**
+     * Construct a text message
+     * @param senderID ID of sender
+     * @param msgContent text content
+     * @param timestamp message timestamp
+     * @param msgID ID of message
+     */
+    public TextMessage(String senderID, String msgContent, LocalDateTime timestamp, String msgID) {
+        super(senderID, timestamp, msgID);
+        this.msgContent = msgContent;
+    }
+
+    /**
+     * Gets text content of a message
+     * @return message content
+     */
+    public String getMsgContent() {
+        return msgContent;
+    }
+
+    /**
+     * Sets text content of a message
+     * @param msgContent updated message content
+     */
+    public void setMsgContent(String msgContent) {
+        this.msgContent = msgContent;
+    }
+}

src/main/java/use_cases/conversation_history_use_case/ConvHistDsRequestModel.java

@@ -0,0 +1,27 @@
+package use_cases.conversation_history_use_case;
+
+public class ConvHistDsRequestModel {
+    private String userID;
+    private String chatID;
+
+    public ConvHistDsRequestModel(String userID, String chatID) {
+        this.userID = userID;
+        this.chatID = chatID;
+    }
+
+    public String getUserID() {
+        return userID;
+    }
+
+    public void setUserID(String userID) {
+        this.userID = userID;
+    }
+
+    public String getChatID() {
+        return chatID;
+    }
+
+    public void setChatID(String chatID) {
+        this.chatID = chatID;
+    }
+}

src/main/java/use_cases/conversation_history_use_case/ConvHistInteractor.java

@@ -0,0 +1,60 @@
+package use_cases.conversation_history_use_case;
+
+import entities.message.Message;
+import entities.message.MsgFactory;
+import data_access.UserDatabase;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Interactor responsible for displaying this history upon opening a chat
+ */
+//public class ConvHistInteractor implements ConversationHistoryInputBoundary{
+public class ConvHistInteractor{
+    /**
+     * File and in-memory storage of users and their chats (incl. conversation history)
+     */
+    final UserDatabase userDatabase;
+    /**
+     * Factory for creating a new Message
+     */
+    final MsgFactory msgFactory;
+//    /**
+//     * Presenter with necessary information to display a chat's conversation history
+//     */
+//    final ConvHistPresenter convHistPresenter;
+
+    /**
+     * Construct ConvHistInteractor given storage, message factory, and presenter
+     * @param userDatabase storage
+     * @param msgFactory message factory
+     * //@param convHistPresenter presenter
+     */
+//    public ConvHistInteractor(UserDatabase userDatabase, MsgFactory msgFactory, ConvHistPresenter convHistPresenter) {
+    public ConvHistInteractor(UserDatabase userDatabase, MsgFactory msgFactory) {
+        this.userDatabase = userDatabase;
+        this.msgFactory = msgFactory;  // msgType of MsgFactory specified in Main
+//        this.convHistPresenter = convHistPresenter;
+    }
+
+    /**
+     * Displays conversation history upon opening a chat
+     * @param requestModel input data
+     * @return a response model for presenter
+     */
+//    @Override
+    public ConvHistResponseModel create(ConvHistRequestModel requestModel) {
+        String userID = requestModel.getUserID();
+        String chatID = requestModel.getChatID();
+
+        ConvHistDsRequestModel dsRequestModel = new ConvHistDsRequestModel(userID, chatID);
+
+        // Access database (code for database will become functional after PR for issue 15 is merged)
+//        List<Message> conversationHistory = userDatabase.getConversationHistory(dsRequestModel);
+
+        // Presenter show success view (code to be written); below is temporary
+        List<Message> conversationHistory = new ArrayList<>();
+        return new ConvHistResponseModel(conversationHistory);
+    }
+}

src/main/java/use_cases/conversation_history_use_case/ConvHistRequestModel.java

@@ -0,0 +1,27 @@
+package use_cases.conversation_history_use_case;
+
+public class ConvHistRequestModel {
+    private String userID;
+    private String chatID;
+
+    public ConvHistRequestModel(String userID, String chatID) {
+        this.userID = userID;
+        this.chatID = chatID;
+    }
+
+    public String getUserID() {
+        return userID;
+    }
+
+    public void setUserID(String userID) {
+        this.userID = userID;
+    }
+
+    public String getChatID() {
+        return chatID;
+    }
+
+    public void setChatID(String chatID) {
+        this.chatID = chatID;
+    }
+}

src/main/java/use_cases/conversation_history_use_case/ConvHistResponseModel.java

@@ -0,0 +1,20 @@
+package use_cases.conversation_history_use_case;
+
+import entities.message.Message;
+
+import java.util.List;
+
+public class ConvHistResponseModel {
+    private List<Message> conversationHistory;
+    public ConvHistResponseModel(List<Message> conversationHistory) {
+        this.conversationHistory = conversationHistory;
+    }
+
+    public List<Message> getConversationHistory() {
+        return conversationHistory;
+    }
+
+    public void setConversationHistory(List<Message> conversationHistory) {
+        this.conversationHistory = conversationHistory;
+    }
+}

src/main/java/use_cases/conversation_history_use_case/MsgSenderDsRequestModel.java

@@ -0,0 +1,39 @@
+package use_cases.conversation_history_use_case;
+
+import entities.message.Message;
+
+public class MsgSenderDsRequestModel {
+    private String userID;
+    private String chatID;
+    private Message message;
+
+    public MsgSenderDsRequestModel(String userID, String chatID, Message message) {
+        this.userID = userID;
+        this.chatID = chatID;
+        this.message = message;
+    }
+
+    public String getUserID() {
+        return userID;
+    }
+
+    public void setUserID(String userID) {
+        this.userID = userID;
+    }
+
+    public String getChatID() {
+        return chatID;
+    }
+
+    public void setChatID(String chatID) {
+        this.chatID = chatID;
+    }
+
+    public Message getMessage() {
+        return message;
+    }
+
+    public void setMessage(Message message) {
+        this.message = message;
+    }
+}

src/main/java/use_cases/conversation_history_use_case/MsgSenderInteractor.java

@@ -0,0 +1,64 @@
+package use_cases.conversation_history_use_case;
+
+import entities.message.Message;
+import entities.message.MsgFactory;
+import data_access.UserDatabase;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Interactor responsible for adding messages to a chat's conversation history
+ */
+//public class ConvHistInteractor implements ConversationHistoryInputBoundary{
+public class MsgSenderInteractor {
+    /**
+     * File and in-memory storage of users and their chats (incl. conversation history)
+     */
+    final UserDatabase userDatabase;
+    /**
+     * Factory for creating a new Message
+     */
+    final MsgFactory msgFactory;
+//    /**
+//     * Presenter with necessary information to display a chat's conversation history
+//     */
+//    final ConvHistPresenter convHistPresenter;
+
+    /**
+     * Construct ConvHistInteractor given storage, message factory, and presenter
+     * @param userDatabase storage
+     * @param msgFactory message factory
+     * //@param convHistPresenter presenter
+     */
+//    public ConvHistInteractor(UserDatabase userDatabase, MsgFactory msgFactory, ConvHistPresenter convHistPresenter) {
+    public MsgSenderInteractor(UserDatabase userDatabase, MsgFactory msgFactory) {
+        this.userDatabase = userDatabase;
+        this.msgFactory = msgFactory;  // msgType of MsgFactory specified in Main
+//        this.convHistPresenter = convHistPresenter;
+    }
+
+    /**
+     * Creates and adds message to a chat's conversation history
+     * @param requestModel input data
+     * @return a response model for presenter
+     */
+//    @Override
+    public ConvHistResponseModel create(MsgSenderRequestModel requestModel) {
+        // Create new message
+        Message message = msgFactory.createMsg(requestModel.getSenderID(), requestModel.getMsgContent());
+
+        // Add message to specified chat in user list
+        String userID = requestModel.getSenderID();  // need a user in the chat to get the chat
+        String chatID = requestModel.getChatID();
+
+        MsgSenderDsRequestModel dsRequestModel = new MsgSenderDsRequestModel(userID, chatID, message);
+
+        // Access database (code for database will become functional after PR for issue 15 is merged)
+//        List<Message> conversationHistory  = userDatabase.saveMessage(dsRequestModel);
+
+        // Presenter show success view (code to be written); below is temporary
+        List<Message> conversationHistory = new ArrayList<>();
+        return new ConvHistResponseModel(conversationHistory);
+    }
+}