Tigers - Neida

Procfile

@@ -0,0 +1 @@
+web: gunicorn 'app:create_app()'

ada-project-docs/wave_04.md

@@ -98,9 +98,13 @@ Visit https://api.slack.com/methods/chat.postMessage to read about the Slack API
 Answer the following questions. These questions will help you become familiar with the API, and make working with it easier.
 
 - What is the responsibility of this endpoint?
+This endpoint posts a message to a channel.
 - What is the URL and HTTP method for this endpoint?
+POST https://slack.com/api/chat.postMessage
 - What are the _two_ _required_ arguments for this endpoint?
+token and channel (string)
 - How does this endpoint relate to the Slackbot API key (token) we just created?
+The token we just made is one of the arguments we have to pass in to the endpoint
 
 Now, visit https://api.slack.com/methods/chat.postMessage/test.
 
@@ -119,8 +123,11 @@ Press the "Test Method" button!
 Scroll down to see the HTTP response. Answer the following questions:
 
 - Did we get a success message? If so, did we see the message in our actual Slack workspace?
+The actual text I put in the test did show up as a message in the slack workspace. There was also a response that came back on the test webpage that said the message had been successful.
 - Did we get an error emssage? If so, why?
+I did not get an error message.
 - What is the shape of this JSON? Is it a JSON object or array? What keys and values are there?
+The JSON is an object enclosed in {} and has many key value pairs such as "ok" : true and "deleted": false.
 
 ### Verify with Postman
 

app/__init__.py

@@ -30,5 +30,9 @@ def create_app(test_config=None):
     migrate.init_app(app, db)
 
     # Register Blueprints here
+    from .routes.task_routes import task_bp
+    from .routes.goal_routes import goal_bp
+    app.register_blueprint(task_bp)
+    app.register_blueprint(goal_bp)
 
     return app

app/models/goal.py

@@ -1,5 +1,20 @@
 from app import db
+from flask import abort, make_response
 
 
 class Goal(db.Model):
     goal_id = db.Column(db.Integer, primary_key=True)
+    title = db.Column(db.String)
+    tasks = db.relationship("Task", back_populates="goal", lazy=True)
+
+    def update(self,request_body):
+        try:
+            self.title = request_body["title"]
+        except KeyError as error:
+            abort(make_response({'message': f"Missing attribute: {error}"}))
+
+    def to_json(self):
+        return {
+            "id": self.goal_id,
+            "title": self.title,
+        }

app/models/task.py

@@ -1,5 +1,50 @@
 from app import db
+from flask import make_response, abort
 
 
 class Task(db.Model):
-    task_id = db.Column(db.Integer, primary_key=True)
+    task_id = db.Column(db.Integer, primary_key=True, autoincrement=True)
+    title = db.Column(db.String)
+    description = db.Column(db.String)
+    completed_at = db.Column(db.DateTime, nullable=True, default=None)
+    goal = db.relationship("Goal", back_populates="tasks")
+    goal_id = db.Column(db.Integer, db.ForeignKey("goal.goal_id"), nullable=True)
+
+    def to_json(self):
+        if self.completed_at:
+            is_complete = True
+        else:
+            is_complete = False
+
+        if self.goal_id:
+            return {
+                "id": self.task_id,
+                "title": self.title,
+                "description": self.description,
+                "is_complete": is_complete,
+                "goal_id": self.goal_id
+            }
+        else:
+            return {
+                "id": self.task_id,
+                "title": self.title,
+                "description": self.description,
+                "is_complete": is_complete
+            }
+
+    def update(self,request_body):
+        try:
+            self.title = request_body["title"]
+            self.description = request_body["description"]
+        except KeyError as error:
+            abort(make_response({'message': f"Missing attribute: {error}"}))
+
+    @classmethod
+    def create(cls, request_body):
+        new_task = cls(
+            title = request_body["title"],
+            description = request_body["description"], 
+        )
+        return new_task
+
+

app/routes/goal_routes.py

@@ -0,0 +1,96 @@
+from app import db
+from app.models.goal import Goal
+from app.models.task import Task
+from flask import Blueprint, request, jsonify, make_response
+from app.routes.task_routes import validate_id
+
+goal_bp = Blueprint("goals", __name__, url_prefix="/goals")
+
+# ================================
+# Create one goal 
+# ================================
+
+@goal_bp.route("", methods=["POST"])
+def create_goal():
+    request_body = request.get_json()
+
+    try:
+        new_goal = Goal(title=request_body["title"])
+    except KeyError:
+        return make_response({"details": "Invalid data"}, 400)
+
+    db.session.add(new_goal)
+    db.session.commit()
+
+    return jsonify({"goal": new_goal.to_json()}), 201
+
+# ==================================
+# Get all goals  
+# ==================================
+
+@goal_bp.route("", methods=["GET"])
+def get_all_goals():
+        all_goals = Goal.query.all()
+        results_list = []
+        for goal in all_goals:
+            results_list.append(goal.to_json())
+        return jsonify(results_list), 200
+
+# ==================================
+# Get one goal by id number
+# ==================================
+
+@goal_bp.route("/<goal_id>", methods=["GET"])
+def get_one_goal(goal_id):
+    return jsonify({"goal": validate_id(Goal, goal_id).to_json()}), 200
+
+# ==================================
+# Update one goal 
+# ==================================
+
+@goal_bp.route("/<goal_id>", methods=["PUT"])
+def update_one_goal(goal_id):
+    request_body = request.get_json()
+    goal = validate_id(Goal, goal_id)
+    goal.update(request_body)
+    db.session.commit()
+    return jsonify({"goal": goal.to_json()}), 200
+
+# ==================================
+# Delete one goal by id
+# ==================================
+
+@goal_bp.route("/<goal_id>", methods=["DELETE"])
+def delete_one_goal(goal_id):
+    goal = validate_id(Goal, goal_id)
+
+    db.session.delete(goal)
+    db.session.commit()
+
+    return make_response({"details":f'Goal {goal.goal_id} "{goal.title}" successfully deleted'}, 200)
+
+# ======================================
+# Get all tasks that are under one goal
+# ======================================
+@goal_bp.route("/<goal_id>/tasks", methods=["GET"])
+def get_all_tasks_for_one_goal(goal_id):
+    goal = validate_id(Goal, goal_id)
+    all_goal_tasks = []
+    for task in goal.tasks:
+        all_goal_tasks.append(Task.to_json(task))
+    return make_response({"id": goal.goal_id, "title": goal.title, "tasks": all_goal_tasks}, 200)
+
+# ======================================
+# Post tasks to one goal
+# ======================================
+@goal_bp.route("/<goal_id>/tasks", methods=["POST"])
+def associate_tasks_with_one_goal(goal_id):
+    request_body = request.get_json()
+    goal = validate_id(Goal,goal_id)
+    task_list = request_body["task_ids"]
+    for task_number in task_list:
+        task = validate_id(Task, task_number)
+        if task not in goal.tasks:
+            goal.tasks.append(task)
+    db.session.commit()
+    return make_response({"id": goal.goal_id, "task_ids": task_list}, 200)

app/routes/task_routes.py

@@ -0,0 +1,135 @@
+from flask import Blueprint, jsonify, abort, make_response, request
+from app import db
+from app.models.task import Task
+from datetime import datetime
+import os
+import requests
+
+task_bp = Blueprint("tasks", __name__, url_prefix="/tasks")
+
+# ================================
+# Create one task 
+# ================================
+@task_bp.route("", methods=["POST"])
+def create_task():
+    request_body = request.get_json()
+
+    try:
+        new_task = Task.create(request_body)
+    except KeyError:
+        return make_response({"details": "Invalid data"}, 400)
+
+    db.session.add(new_task)
+    db.session.commit()
+
+    return jsonify({"task": new_task.to_json()}), 201
+
+# ==================================
+# Get all tasks  
+# ==================================
+@task_bp.route("", methods=["GET"])
+def get_all_tasks():
+    sort_query = request.args.get("sort")
+    if sort_query == 'asc':
+        all_tasks = Task.query.order_by(Task.title.asc())
+    elif sort_query == 'desc':
+        all_tasks = Task.query.order_by(Task.title.desc())
+    else:
+        all_tasks = Task.query.all()
+
+    results_list = []
+    for task in all_tasks:
+        results_list.append(task.to_json())
+
+    return jsonify(results_list), 200
+
+# ==================================
+# Get one task by id number
+# ==================================
+@task_bp.route("/<task_id>", methods=["GET"])
+def get_one_task(task_id):
+    return jsonify({"task": validate_id(Task, task_id).to_json()}), 200
+
+# ==================================
+# Update one task 
+# ==================================
+@task_bp.route("/<task_id>", methods=["PUT"])
+def update_one_task(task_id):
+    request_body = request.get_json()
+    task = validate_id(Task, task_id)
+    task.update(request_body)
+
+    db.session.commit()
+
+    return jsonify({"task": task.to_json()}), 200
+
+# ==================================
+# Delete one task by id
+# ==================================
+@task_bp.route("/<task_id>", methods=["DELETE"])
+def delete_one_task(task_id):
+    task = validate_id(Task, task_id)
+
+    db.session.delete(task)
+    db.session.commit()
+
+    return make_response({"details":f'Task {task.task_id} "{task.title}" successfully deleted'}, 200)
+
+# ==================================
+# update one task's completeness
+# ==================================
+@task_bp.route("/<task_id>/<mark>", methods=["PATCH"])
+def mark_tasks_complete_or_incomplete(task_id, mark):
+    task = validate_id(Task, task_id)
+    task.completed_at = datetime.now() if mark == "mark_complete" else None
+    send_to_slack(task.title, "task-notifications", mark)
+    db.session.commit()
+    return jsonify({"task": task.to_json()}), 200
+
+# ==================================
+# Helper function to validate id
+# ==================================
+def validate_id(class_name,id):
+    try:
+        id = int(id)
+    except:
+        abort(make_response({"message":f"Id {id} is an invalid id"}, 400))
+
+    query_result = class_name.query.get(id)
+    if not query_result:
+        abort(make_response({"message":f"Id {id} not found"}, 404))
+
+    return query_result
+
+# ==================================
+# Helper function to send message to slack
+# ==================================
+def send_to_slack(title, channel_name, mark):
+    header_data = {'Authorization': f"Bearer {os.environ.get('SLACK_BOT_TOKEN')}"}
+    message_data = {'channel': channel_name, 'text': f"Someone just completed the task {title}"}
+    if mark == 'mark_complete':
+        requests.post('https://slack.com/api/chat.postMessage', data=message_data, headers=header_data)
+
+
+
+
+# original implementation using slack_sdk to make calls to slack API
+
+# import logging
+# from slack_sdk import WebClient
+# from slack_sdk.errors import SlackApiError
+
+# def send_to_slack(title, channel_name, mark):
+#     if mark == "mark_complete":
+#         client = WebClient(token=os.environ.get("SLACK_BOT_TOKEN"))
+#         logger = logging.getLogger(__name__)
+#         try:
+#     # Call the chat.postMessage method using the WebClient
+#             result = client.chat_postMessage(
+#                 channel=channel_name, 
+#                 text= f"Someone just completed the task '{title}'"
+#             )
+#             logger.info(result)
+
+#         except SlackApiError as e:
+#             logger.error(f"Error posting message: {e}")

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

migrations/alembic.ini

@@ -0,0 +1,45 @@
+# A generic, single database configuration.
+
+[alembic]
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S