Merge branch 'main' of https://github.com/nehakale8/slackpoint into ritwik

Author: ritwik4690

.gitignore

@@ -70,6 +70,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+# Allow Sphinx documentation build
+!docs/build/
 
 # PyBuilder
 .pybuilder/

README.md

@@ -4,9 +4,9 @@
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7145407.svg)](https://doi.org/10.5281/zenodo.7145407)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Github](https://img.shields.io/badge/language-python-red.svg)](https://docs.python.org/3/)
-[![build](https://github.com/mithildani/se22-hw1-grp14/actions/workflows/test.yml/badge.svg)](https://github.com/mithildani/se22-hw1-grp14/actions)
+[![build](https://github.com/mithildani/se22-hw1-grp14/actions/workflows/test.yml/badge.svg)](https://github.com/nehakale8/slackpoint/actions)
 [![GitHub top language](https://img.shields.io/github/languages/top/mithildani/se22-hw1-grp14)](https://docs.python.org/3/)
-[![GitHub last commit](https://img.shields.io/github/last-commit/mithildani/se22-hw1-grp14)](https://github.com/mithildani/se22-hw1-grp14/commits/main)
+[![GitHub last commit](https://img.shields.io/github/last-commit/mithildani/se22-hw1-grp14)](https://github.com/nehakale8/slackpoint/commits/main)
 [![codecov](https://codecov.io/gh/nehakale8/slackpoint/branch/main/graph/badge.svg?token=1H92SAVB5S)](https://codecov.io/gh/nehakale8/slackpoint)
 
 

app.py

@@ -28,6 +28,16 @@
 
 @app.route("/slack/interactive-endpoint", methods=["POST"])
 def interactive_endpoint():
+    """
+    All interactive events like button click, input fields are received in this endpoint. We use this endpoint to handle the click event of 'Add task' button of create-task command.
+
+    :param:
+    :type:
+    :raise:
+    :return: Response object with 200 HTTP status
+    :rtype: Response
+
+    """
     payload = json.loads(request.form.get("payload"))
     if payload["type"] == "block_actions":
         actions = payload["actions"]
@@ -69,11 +79,31 @@ def interactive_endpoint():
 
 @app.route("/")
 def basic():
+    """
+    Health check endpoint
+
+    :param:
+    :type:
+    :raise:
+    :return: 'Hello World' - the official health check response text
+    :rtype: str
+
+    """
     return "Hello World"
 
 
 @app.route("/viewpending", methods=["POST"])
 def vpending():
+    """
+    Endpoint to view the pending tasks
+
+    :param:
+    :type:
+    :raise:
+    :return: Response object with payload object containing details of pending tasks
+    :rtype: Response
+
+    """
     data = request.form
     channel_id = data.get("channel_id")
     user_id = data.get("user_id")
@@ -87,6 +117,17 @@ def vpending():
 
 @app.route("/viewcompleted", methods=["POST"])
 def vcompleted():
+    """
+    Endpoint to view the completed tasks
+
+    :param:
+    :type:
+    :raise:
+    :return: Response object with payload object containing details of completed tasks
+    :rtype: Response
+
+    """
+
     data = request.form
     channel_id = data.get("channel_id")
     user_id = data.get("user_id")
@@ -100,6 +141,17 @@ def vcompleted():
 
 @app.route("/taskdone", methods=["POST"])
 def taskdone():
+    """
+    Endpoint to mark a task as completed
+
+    :param:
+    :type:
+    :raise:
+    :return: Response object with payload containing task completion message
+    :rtype: Response
+
+    """
+
     data = request.form
     td = TaskDone(data)
     payload = td.update_points()
@@ -108,25 +160,58 @@ def taskdone():
 
 @app.route("/create", methods=["POST"])
 def create():
+    """
+    Endpoint to create a new task, this endpoint triggers an ephemeral message for the user to enter task details for creation
+
+    :param:
+    :type:
+    :raise:
+    :return: Response object with 200 HTTP status
+    :rtype: Response
+
+    """
+
     ct = CreateTask()
     blocks = ct.create_task_input_blocks()
+
     data = request.form
     channel_id = data.get("channel_id")
     user_id = data.get("user_id")
     slack_client.chat_postEphemeral(channel=channel_id, user=user_id, blocks=blocks)
-
     return Response(), 200
 
 
 @app.route("/help", methods=["POST"])
 def help():
+    """
+    A helper endpoint to view all commands and how to use them
+
+    :param:
+    :type:
+    :raise:
+    :return: Response object with payload object containing details of all commands and how to use them
+    :rtype: Response
+
+    """
+
     h = Help()
     payload = h.help_all()
     return jsonify(payload)
 
 
 @app.route("/leaderboard", methods=["POST"])
 def leaderboard():
+    """
+    Endpoint to view the leaderboard
+
+    :param:
+    :type:
+    :raise:
+    :return: Response object with payload object containing details of champions leading the SlackPoint challenge
+    :rtype: Response
+
+    """
+
     l = Leaderboard()
     payload = l.view_leaderboard()
     return jsonify(payload)

commands/createtask.py

@@ -4,6 +4,10 @@
 
 
 class CreateTask:
+    """
+    This class handles the Create Task functionality.
+    """
+
     base_create_task_block_format = {
         "type": "section",
         "text": {
@@ -15,12 +19,29 @@ class CreateTask:
     greetings = ["Awesome", "Great", "Congratulations", "Well done", "Let's go"]
 
     def __init__(self):
-        self.payload = {
-            "response_type": "ephemeral", 
-            "blocks": []
-        }
+        """
+        Constructor to initialize payload object
+
+        :param:
+        :type:
+        :raise:
+        :return: None
+        :rtype: None
+
+        """
+        self.payload = {"response_type": "ephemeral", "blocks": []}
 
     def create_task_input_blocks(self):
+        """
+        Create blocks list containing input fields for description, deadline, points of a task, along with a button to create the task
+
+        :param:
+        :type:
+        :raise:
+        :return: Blocks list
+        :rtype: list
+
+        """
         block_description = {
             "type": "input",
             "element": {
@@ -76,10 +97,7 @@ def create_task_input_blocks(self):
         }
         block_actions_button = {
             "type": "button",
-            "text": {
-                "type": "plain_text", 
-                "text": "Create task"
-            },
+            "text": {"type": "plain_text", "text": "Create task"},
             "action_id": "create_action_button",
         }
         block_actions = {"type": "actions", "elements": []}
@@ -93,6 +111,20 @@ def create_task_input_blocks(self):
         return blocks
 
     def create_task(self, desc, points, deadline):
+        """
+        Creates a task in database and returns payload with success message along with the newly created Task ID
+
+        :param desc: Description of task
+        :type desc: str
+        :param points: Points of task
+        :type points: int
+        :param deadline: Deadline of task
+        :type deadline: Date
+        :raise:
+        :return: Blocks list of response payload
+        :rtype: list
+
+        """
         # DB call to add task, returns id
         task = Task()
         task.description = desc
@@ -113,6 +145,8 @@ def create_task(self, desc, points, deadline):
         db.session.commit()
 
         response = deepcopy(self.base_create_task_block_format)
-        response["text"]["text"] = response["text"]["text"].format(greeting=random.choice(self.greetings), id=id)
+        response["text"]["text"] = response["text"]["text"].format(
+            greeting=random.choice(self.greetings), id=id
+        )
         self.payload["blocks"].append(response)
         return self.payload["blocks"]

commands/help.py

@@ -2,6 +2,10 @@
 
 
 class Help:
+    """
+    This class handles the Help functionality.
+    """
+
     commands_dictionary = {}
 
     command_help = {
@@ -10,6 +14,16 @@ class Help:
     }
 
     def __init__(self):
+        """
+        Constructor to initialize command dictionary and payload object
+
+        :param:
+        :type:
+        :raise:
+        :return: None
+        :rtype: None
+
+        """
         self.commands_dictionary["createtask"] = [
             "*Create Task*",
             ">To create a task, just try the command */create-task* and you would receive a message from Slack to fill out the details of the task.\n>Enter the description, deadline and the points of the task.\n>For example:\n>*Description*: Hey! This is my new task\n>*Deadline*: 12/31/2022 (just select a date from the date picker)\n>*Points*: 5 (select a point from 1 to 5)\n>And that's it! You should receive a reply from Slack with the generated *Task ID*.",
@@ -38,13 +52,33 @@ def __init__(self):
         self.payload = {"response_type": "ephemeral", "blocks": []}
 
     def help_all(self):
+        """
+        Creates a payload with the help details for all commands
+
+        :param:
+        :type:
+        :raise:
+        :return: Payload object containing helper details of all commands
+        :rtype: dict[str, Any]
+
+        """
         response_payload = deepcopy(self.payload)
         for name in self.commands_dictionary.keys():
             blocks = self.help(name)
             response_payload["blocks"].extend(blocks)
         return response_payload
 
     def help(self, command_name):
+        """
+        Creates a payload blocks for particular command
+
+        :param command_name: Command name
+        :type command_name: str
+        :raise:
+        :return: Blocks list containing details of a particular command provided in parameter
+        :rtype: list
+
+        """
         blocks = []
         command_name_block = deepcopy(self.command_help)
         command_help_desc_block = deepcopy(self.command_help)

commands/leaderboard.py

@@ -5,15 +5,39 @@
 
 
 class Leaderboard:
+    """
+    This class handles the Create Leaderboard functionality.
+    """
+
     base_leaderboard_block_format = {
         "type": "section",
         "text": {"type": "mrkdwn", "text": "{pos}. <@{userid}> has {points} points!"},
     }
 
     def __init__(self):
+        """
+        Constructor to initialize payload object
+
+        :param:
+        :type:
+        :raise:
+        :return: None
+        :rtype: None
+
+        """
         self.payload = {"response_type": "ephemeral", "blocks": []}
 
     def view_leaderboard(self, top_k: int = 5) -> dict:
+        """
+        Generates leaderboard according to the highest points scorers, returns top five contenders from DB
+
+        :param top_k: Provision to generate top k contenders in leaderboard, default value: 5
+        :type top_k: int
+        :raise:
+        :return: Payload object containing details about the top 5 contenders of SlackPoint
+        :rtype: dict[str, Any]
+
+        """
         top_5_leaderboard = (
             Assignment.query.join(Task)
             .join(User)