Sea Turtles - Christina W

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?
+    - post a message on a channel in slack
 - What is the URL and HTTP method for this endpoint?
+    - https://slack.com/api/chat.postMessage?channel=<channel_name>&text=<message_text>&<otherargs>
 - What are the _two_ _required_ arguments for this endpoint?
+    - token, channel
 - How does this endpoint relate to the Slackbot API key (token) we just created?
+    - I'm assuming we will use this endpoint to send messages about whether or not the tasks have been done
 
 Now, visit https://api.slack.com/methods/chat.postMessage/test.
 
@@ -119,8 +123,42 @@ 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?
+    - we got ok:True? And yes, we saw a message in our actual slack workspace
 - Did we get an error emssage? If so, why?
+    - No...
 - What is the shape of this JSON? Is it a JSON object or array? What keys and values are there?
+    - {"ok":<boolean>,
+    - "channel":<channel_string>,
+    - "ts": a string of numbers? Is this an IP?,
+    - "message"{
+      - "bot_id": string,
+      - "type": "message",
+      - "text": <textofmessage>,
+      - "user": string,
+      - "ts": same as before under ts?,
+      - "app_id": string of caps and nums,
+      - "team": another string of caps and nums,
+      - "bot_profile":{
+        - "id": same as bot_id,
+        - "app_id":same as app_id before,
+        - "name": <name_of_bot>,
+        - "icons": {
+          - "image_36": url,
+          - "image_48": url,
+          - "image_72": url
+          - },
+        - "deleted": boolean,
+        - "updated": a number,
+        - "team_id": same as team
+        - },
+      - "blocks":[
+        - {"type": "rich_text",
+        - "block_id": "PTh",
+        - "elements": [
+          - {"type":"rich_text_section",
+          - "elements":[
+            - {"type":"text",
+            - "text": text body}]}]}]}}
 
 ### Verify with Postman
 
@@ -139,6 +177,8 @@ Open Postman and make a request that mimics the API call to Slack that we just t
 - In "Headers," add this new key-value pair:
   - `Authorization`: `"Bearer xoxb-150..."`, where `xoxb-150...` is your full Slackbot token
 
+--> DO NOT INCLUDE ANY QUOTES <----
+
 ![](assets/postman_test_headers.png)
 
 Press "Send" and see the Slack message come through!

app/__init__.py

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

app/models/goal.py

@@ -2,4 +2,46 @@
 
 
 class Goal(db.Model):
+    __tablename__ = 'goals'
     goal_id = db.Column(db.Integer, primary_key=True)
+    title = db.Column(db.String)
+    tasks = db.relationship("Task", backref="goals")
+
+    def to_dict(self):
+        task_list = []
+        for task in self.tasks:
+            task_list.append(task.id)
+        if task_list:
+            return dict(
+                id=self.goal_id,
+                task_ids=task_list
+            )
+        return dict(
+            id=self.goal_id,
+            title=self.title)
+
+    def get_tasks(self):
+        from .task import Task
+        task_list = []
+        for task in self.tasks:
+            readable_task = task.task_to_dict()
+            task_list.append(readable_task)
+        return dict(
+            id=self.goal_id,
+            title=self.title,
+            tasks=task_list)
+
+    @classmethod
+    def from_dict(cls, data_dict):
+            return cls(title=data_dict["title"])
+
+    def replace_details(self, data_dict):
+        if "task_ids" in data_dict:
+            from .task import Task
+            for id in data_dict["task_ids"]:
+                task = Task.query.get(id)
+                if task not in self.tasks:
+                    self.tasks.append(task)
+        else:
+            self.title=data_dict["title"]
+        return self.to_dict()

app/models/task.py

@@ -1,5 +1,64 @@
+import datetime
 from app import db
+from app.models.goal import Goal
 
 
 class Task(db.Model):
-    task_id = db.Column(db.Integer, primary_key=True)
+    __tablename__ = 'tasks'
+    id = db.Column(db.Integer, primary_key=True)
+    title = db.Column(db.String)
+    description = db.Column(db.String)
+    is_complete = db.Column(db.Boolean, default=False)
+    completed_at = db.Column(db.DateTime)
+    goal_id = db.Column(db.Integer, db.ForeignKey(Goal.goal_id))
+
+    def task_to_dict(self):
+        if self.goal_id:
+            return dict(
+                id=self.id,
+                title=self.title,
+                description=self.description,
+                is_complete=self.is_complete,
+                goal_id = self.goal_id
+            )
+        else:
+            return dict(
+                id=self.id,
+                title=self.title,
+                description=self.description,
+                is_complete=self.is_complete)
+
+    @classmethod
+    def from_dict(cls, data_dict):
+        if "completed_at" in data_dict:
+            return cls(
+            title=data_dict["title"],
+            description=data_dict["description"],
+            is_complete=True,
+            completed_at=data_dict["completed_at"]
+            )
+        else:
+            return cls(
+            title=data_dict["title"],
+            description=data_dict["description"]
+            )
+
+    def replace_details(self, data_dict):
+        self.title=data_dict["title"]
+        self.description=data_dict["description"]
+        self.is_complete=False
+        if "completed_at" in data_dict:
+            self.completed_at=data_dict["completed_at"]
+            self.is_complete=True
+        return self
+
+    def mark_done(self):
+        self.is_complete = True
+        current_time = datetime.datetime.now()
+        self.completed_at = current_time
+        return self
+
+    def mark_not_done(self):
+        self.is_complete = False
+        self.completed_at = None
+        return self

app/routes/goal_routes.py

@@ -0,0 +1,95 @@
+from flask import Blueprint, jsonify, make_response, request, abort
+from app import db
+from app.models.goal import Goal
+from .task_routes import validate_task_id, Task
+
+goal_bp = Blueprint("goals", __name__, url_prefix="/goals")
+
+def error_message(message, status_code):
+    abort(make_response(jsonify(dict(details=message)), status_code))
+
+def make_goal_safely(data_dict):
+    try:
+        return Goal.from_dict(data_dict)
+    except KeyError as err:
+        error_message(f"Invalid data", 400)
+
+def update_goal_safely(goal, data_dict):
+    try:
+        return goal.replace_details(data_dict)
+    except KeyError as err:
+        error_message(f"Invalid data", 400)
+
+def validate_goal_id(id):
+    try:
+        id = int(id)
+    except ValueError:
+        error_message(f"Invalid id {id}", 400)
+    goal = Goal.query.get(id)
+    if goal:
+        return goal
+    error_message(f"No goal with ID {id}. SORRY.", 404)
+
+@goal_bp.route("", methods=["POST"])
+def add_goal():
+    request_body = request.get_json()
+    new_goal=make_goal_safely(request_body)
+
+    db.session.add(new_goal)
+    db.session.commit()
+
+    task_response = {"goal":new_goal.to_dict()}
+
+    return jsonify(task_response), 201
+
+@goal_bp.route("", methods=["GET"])
+def get_goals():
+    goals = Goal.query.all()
+
+    result_list = [goal.to_dict() for goal in goals]
+    return jsonify(result_list)
+
+@goal_bp.route("/<id>", methods=["GET"])
+def get_goal_by_id(id):
+    goal = validate_goal_id(id)
+    result = {"goal": goal.to_dict()}
+    return jsonify(result)
+
+@goal_bp.route("<id>", methods=["PUT"])
+def update_goal(id):
+    goal = validate_goal_id(id)
+    request_body = request.get_json()
+    updated_goal = update_goal_safely(goal, request_body)
+
+    db.session.commit()
+
+    return jsonify({"goal":updated_goal})
+
+@goal_bp.route("<id>", methods=["DELETE"])
+def delete_goal(id):
+    goal = validate_goal_id(id)
+    db.session.delete(goal)
+    db.session.commit()
+
+    return jsonify({"details":f'Goal {id} "{goal.title}" successfully deleted'})
+
+@goal_bp.route("/<id>/tasks", methods=["POST"])
+def add_task_to_goal(id):
+    goal = validate_goal_id(id)
+    request_body = request.get_json()
+    data_dict = {"task_ids": []}
+    for task in request_body["task_ids"]:
+        validate_task_id(task)
+        data_dict["task_ids"].append(task)
+    # updated_goal = update_goal_safely(goal, request_body)
+    update_tasks_in_goal = update_goal_safely(goal, data_dict)
+    db.session.commit()
+    # task_response = {"goal":update_tasks_in_goal}
+
+    return jsonify(update_tasks_in_goal), 200
+
+@goal_bp.route("/<id>/tasks", methods=["GET"])
+def get_tasks_from_goal(id):
+    goal = validate_goal_id(id)
+    result = goal.get_tasks()
+    return jsonify(result)