Merge pull request #32 from CSC207-2022F-UofT/Implement-Friends-System

Implement friends system

Author: TonyKim02

.gitignore

@@ -81,8 +81,6 @@ fabric.properties
 **/build/
 !src/**/build/
 
-## Mongo-Related
-src/main/resources/application.properties
 
 # Ignore Gradle GUI config
 gradle-app.setting

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

@@ -0,0 +1,33 @@
+package com.backend.controller;
+
+
+import com.backend.usecases.facades.FriendSystemFacade;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+@RestController
+public class FriendController {
+
+    private final FriendSystemFacade friendSystemFacade;
+
+    @Autowired
+    public FriendController(FriendSystemFacade friendSystemFacade) {
+        this.friendSystemFacade = friendSystemFacade;
+    }
+
+    @GetMapping("/friends/getFriends")
+    public ResponseEntity<Object> getFriends(@RequestParam String sessionID) {
+        return this.friendSystemFacade.getUserFriends(sessionID);
+    }
+
+    @DeleteMapping("/friends/deleteFriend")
+    public ResponseEntity<Object> deleteFriend(@RequestParam String friendUserName, @RequestParam String sessionID) {
+        return this.friendSystemFacade.deleteFriend(friendUserName, sessionID);
+    }
+
+    @DeleteMapping("/friends/deleteAllCorrelatedFriends")
+    public ResponseEntity<Object> deleteAllCorrelatedFriends(@RequestParam String sessionID) {
+        return this.friendSystemFacade.deleteAllCorrelatedFriends(sessionID);
+    }
+}

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

@@ -0,0 +1,68 @@
+package com.backend.controller;
+
+import com.backend.usecases.facades.FriendSystemFacade;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.*;
+
+@RestController
+public class InvitationController {
+
+    private final FriendSystemFacade friendSystemFacade;
+
+    @Autowired
+    public InvitationController(FriendSystemFacade friendSystemFacade) {
+        this.friendSystemFacade = friendSystemFacade;
+    }
+
+    // create a get request to get invitations for a specific user
+    @GetMapping("/friends/getInviteAsReceiver")
+    public ResponseEntity<Object> getInvitationsAsReceiver(@RequestParam String sessionID) {
+        // get sessionID from request
+        // call getInvitations method from InvitationsManager
+        // return response
+        return this.friendSystemFacade.getInvitations(sessionID, true);
+    }
+
+    @GetMapping("/friends/getInviteAsSender")
+    public ResponseEntity<Object> getInvitationsAsSender(@RequestParam String sessionID) {
+        // get sessionID from request
+        // call getInvitations method from InvitationsManager
+        // return response
+        return this.friendSystemFacade.getInvitations(sessionID, false);
+    }
+
+    // create a post request to send an invitation
+    @PostMapping("/friends/sendInvite")
+    public ResponseEntity<Object> sendInvitation(@RequestParam String receiverUsername, String sessionID) {
+        // create invitation
+        // save invitation to the database
+        return this.friendSystemFacade.sendInvitation(receiverUsername, sessionID);
+    }
+
+    @DeleteMapping("/friends/withdrawInvite")
+    public ResponseEntity<Object> withdrawInvitation(@RequestParam String receiverUsername, String sessionID) {
+        return this.friendSystemFacade.withdrawInvitation(receiverUsername, sessionID);
+    }
+
+    // create a post request to accept an invitation
+    @PostMapping("/friends/acceptInvite")
+    public ResponseEntity<Object> acceptInvitation(@RequestParam String receiverUsername, String sessionID) {
+        return this.friendSystemFacade.handleInvitation(receiverUsername, sessionID, true);
+    }
+
+
+    // create a post request to decline an invitation
+    @DeleteMapping("/friends/declineInvite")
+    public ResponseEntity<Object> declineInvitation(@RequestParam String receiverUsername, @RequestParam String sessionID) {
+        // check if invitation exists
+        // delete invitation from the database
+        return this.friendSystemFacade.handleInvitation(receiverUsername, sessionID, false);
+    }
+
+    @DeleteMapping("/friends/deleteAllCorrelatedInvitations")
+    public ResponseEntity<Object> deleteAllCorrelatedInvitations(@RequestParam String sessionID) {
+
+        return this.friendSystemFacade.deleteAllCorrelatedInvitations(sessionID);
+    }
+}

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

@@ -0,0 +1,60 @@
+package com.backend.entities;
+
+import com.backend.entities.IDs.AccountID;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.annotation.PersistenceCreator;
+import org.springframework.data.annotation.Transient;
+import org.springframework.data.mongodb.core.mapping.Document;
+
+import java.util.ArrayList;
+
+/**
+ * Represents a Friend Entity (accountID, friendsList)
+ */
+@Document(collection = "FriendsCollection")
+public class Friend {
+    @Transient
+    private final AccountID accountIDObject;
+    @Id
+    private String accountID;
+
+    private final ArrayList<String> friends;
+
+    // fields, getters, setters
+    public Friend(AccountID accountIDObject, ArrayList<String> friends) {
+        this.accountIDObject = accountIDObject;
+        this.accountID = accountIDObject.getID();
+        this.friends = friends;
+    }
+
+    @PersistenceCreator
+    public Friend(String accountID, ArrayList<String> friends) {
+        this.accountIDObject = new AccountID(accountID);
+        this.accountID = accountID;
+        this.friends = friends;
+    }
+
+    /**
+     * Retrieve the AccountID as String for this given instance
+     * @return the AccountID as String for this given instance
+     */
+    @SuppressWarnings("unused")
+    public AccountID getAccountIDObject() {
+        return this.accountIDObject;
+    }
+
+    /**
+     * Retrieve the AccountID as String for this given instance
+     * @return the AccountID as String for this given instance
+     */
+    public String getAccountID() { return this.accountID; }
+
+    /**
+     * Retrieves an array of the user's friends
+     * @return an array of the user's friends
+     */
+    public ArrayList<String> getFriends() {
+        return this.friends;
+    }
+
+}

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

@@ -1,34 +1,96 @@
 package com.backend.entities;
 
 import com.backend.entities.IDs.AccountID;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.annotation.PersistenceCreator;
+import org.springframework.data.annotation.Transient;
+import org.springframework.data.mongodb.core.mapping.Document;
 
-import java.sql.Timestamp;
+import java.util.Date;
 
+/**
+ * Represents an Invitation entity
+ */
+@Document(collection = "InvitationsCollection")
 public class Invitation {
     // The value is generated by Account.java
-    private final AccountID senderID;
+    @Transient
+    @JsonIgnore
+    private final AccountID senderIDObject;
 
-    // The value is generated by Account.java
-    private final AccountID receiverID;
+    @Transient
+    @JsonIgnore
+    private final AccountID receiverIDObject;
+
+    @Id
+    private final String ID;
 
-    private final Timestamp timestamp;
+    private final String senderID;
+    private final String receiverID;
+    private final Date timestamp;
 
     // fields, getters
-    public Invitation(AccountID senderID, AccountID receiverID, Timestamp timestamp) {
+    public Invitation(AccountID senderIDObject, AccountID receiverIDObject, Date timestamp) {
+        this.ID = senderIDObject.getID() + receiverIDObject.getID();
+
+        this.senderIDObject = senderIDObject;
+        this.senderID = senderIDObject.getID();
+
+        this.receiverIDObject = receiverIDObject;
+        this.receiverID = receiverIDObject.getID();
+
+        this.timestamp = timestamp;
+    }
+    @PersistenceCreator
+    public Invitation(String ID, String senderID, String receiverID, Date timestamp) {
+        this.ID = ID;
+        this.senderIDObject = new AccountID(senderID);
+        this.receiverIDObject = new AccountID(receiverID);
         this.senderID = senderID;
         this.receiverID = receiverID;
         this.timestamp = timestamp;
     }
 
-    public AccountID getSenderID() {
+    // Getters
+
+    /**
+     * Retrieve the AccountID String as the sender
+     * @return the AccountID String as the sender
+     */
+    public String getSenderID() {
         return this.senderID;
     }
 
-    public AccountID getReceiverID() {
+    /**
+     * Retrieve the AccountID String as the receiver
+     * @return the AccountID String as the receiver
+     */
+    public String getReceiverID() {
         return this.receiverID;
     }
 
-    public Timestamp getTimestamp() {
+    /**
+     * Retrieve the AccountID Object as the sender
+     * @return the AccountID Object as the sender
+     */
+    public AccountID getSenderIDObject() {
+        return this.senderIDObject;
+    }
+
+    /**
+     * Retrieve the Account Object as the retriever
+     * @return the Account Object as the retriever
+     */
+    public AccountID getReceiverIDObject() {
+        return this.receiverIDObject;
+    }
+
+    /**
+     * Retrieve the TimeStamp as java.util.Date
+     * @return the TimeStamp as java.util.Date
+     */
+    public Date getTimestamp() {
         return this.timestamp;
     }
 }

src/main/java/com/backend/error/handlers/LogHandler.java

@@ -96,7 +96,6 @@ public void logError(Exception e) {
     public ResponseEntity<Object> logError(Exception exception, HttpStatus status) {
         this.logError(exception);
 
-
         JSONObject jsonObject = new JSONObject();
 
         jsonObject.put("Error", exception.getClass().getName());

src/main/java/com/backend/repositories/FriendsRepo.java

@@ -0,0 +1,19 @@
+package com.backend.repositories;
+
+import com.backend.entities.Friend;
+import org.springframework.data.mongodb.repository.MongoRepository;
+import org.springframework.data.mongodb.repository.Query;
+import java.util.List;
+
+/**
+ * Mongo Repository for custom queries on the Friends Collection
+ */
+public interface FriendsRepo extends MongoRepository<Friend, String> {
+    /**
+     * Find all associated Friends instance containing userID in friends list
+     * @param userID of type String, accountID to reference the desired Account
+     * @return the list of accounts that have the desired accountID in their friends list
+     */
+    @Query("{'friends':  {'$in': [?0]}}")
+    List<Friend> findAllContainingUserID(String userID);
+}

src/main/java/com/backend/repositories/InvitationsRepo.java

@@ -0,0 +1,36 @@
+package com.backend.repositories;
+import com.backend.entities.Invitation;
+import org.springframework.data.mongodb.repository.MongoRepository;
+import org.springframework.data.mongodb.repository.Query;
+
+import java.util.List;
+
+/**
+ * Mongo Repository for custom queries on the Invitations Collection
+ */
+public interface InvitationsRepo extends MongoRepository<Invitation, String> {
+    /**
+     * Find the specific Invitation with the given parameter (by senderID and receiverID)
+     * @param senderID of type String, accountID to reference the user as sender
+     * @param receiverID of type String, accountID to reference the user as receiver
+     * @return the retrieved Invitation object given valid parameters and exists (otherwise null)
+     */
+    @Query("{ 'senderID' : ?0, 'receiverID' : ?1 }")
+    Invitation findBySenderIDAndReceiverID(String senderID, String receiverID);
+
+    /**
+     * Find a list of associated Invitation with the given parameter(by receiverID)
+     * @param receiverID of type String, accountID to reference the user as the receiver
+     * @return the retrieved list of Invitation Objects given valid parameters and exists (otherwise null)
+     */
+    @Query("{ 'receiverID' : ?0 }")
+    List<Invitation> findAllByReceiverID(String receiverID);
+
+    /**
+     * Find a list of associated Invitation with the given parameter(by senderID)
+     * @param senderID of type String, accountID to reference the user as the senderID
+     * @return the retrieved list of Invitation Objects given valid parameters and exists (otherwise null)
+     */
+    @Query("{ 'senderID' : ?0 }")
+    List<Invitation> findAllBySenderID(String senderID);
+}