Skip to content

C15-Accelerate Naomi Quinones #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions app/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,9 @@ def create_app(test_config=None):

# Register Blueprints here

from .routes import tasks_bp
from .routes import goals_bp
app.register_blueprint(tasks_bp)
app.register_blueprint(goals_bp)

return app
3 changes: 2 additions & 1 deletion app/models/goal.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@


class Goal(db.Model):
goal_id = db.Column(db.Integer, primary_key=True)
goal_id = db.Column(db.Integer, primary_key=True,autoincrement=True)
title = db.Column(db.Text)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add tasks and use db.relationship to connect this model to the task model

6 changes: 5 additions & 1 deletion app/models/task.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,8 @@


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)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add goal_id with a foreign key goal.goal_id to finish the connection between the models

199 changes: 198 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,199 @@
from flask import Blueprint
from flask import Blueprint, request, make_response, jsonify
from sqlalchemy.orm import query
from sqlalchemy import desc
from app.models.task import Task
from app.models.goal import Goal
from app import db
from datetime import datetime
# below for Slackbot
import requests
import os

tasks_bp = Blueprint("tasks", __name__, url_prefix="/tasks")
goals_bp = Blueprint("goals", __name__, url_prefix="/goals")

# Get all tasks and create a task


@tasks_bp.route("", methods=["GET", "POST"])
def handle_tasks():
if request.method == "GET":
sort_order = request.args.get("sort")
if sort_order == "asc":
tasks = Task.query.order_by(Task.title)
elif sort_order == "desc":
tasks = Task.query.order_by(desc(Task.title))
else:
tasks = Task.query.all()

tasks_response = []
for task in tasks:
tasks_response.append({
"id": task.task_id,
"title": task.title,
"description": task.description,
"is_complete": False if not task.completed_at else True,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great way to add the check

})
return jsonify(tasks_response)
elif request.method == "POST":
request_body = request.get_json()

# check for missing items
if "title" not in request_body or "description" not in request_body or "completed_at" not in request_body:
return make_response({"details": "Invalid data"}, 400)

new_task = Task(title=request_body["title"],
description=request_body["description"],
completed_at=request_body["completed_at"])
db.session.add(new_task)
db.session.commit()

return make_response({
"task": {
"id": new_task.task_id,
"title": new_task.title,
"description": new_task.description,
"is_complete": False if not new_task.completed_at else True}}, 201)
Comment on lines +52 to +56
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just like we did in the review session, think about how you could create a helper function to call here instead of writing this every time.


# Get one task and manipulate it


@tasks_bp.route("/<task_id>", methods=["GET", "PUT", "DELETE"])
def handle_task(task_id):
task = Task.query.get(task_id)
if task is None:
return make_response("Task not found", 404)

if request.method == "GET":
return {"task": {
"id": task.task_id,
"title": task.title,
"description": task.description,
"is_complete": False if not task.completed_at else True
}}

elif request.method == "PUT":
form_data = request.get_json()
# check for missing items
if "title" not in form_data or "description" not in form_data or "completed_at" not in form_data:
return make_response({"details": "Invalid data"}, 400)

task.title = form_data["title"]
task.description = form_data["description"]
task.completed_at = form_data["completed_at"]
db.session.commit()
return make_response({
"task": {
"id": task.task_id,
"title": task.title,
"description": task.description,
"is_complete": False if not task.completed_at else True}}, 200)

elif request.method == "DELETE":
db.session.delete(task)
db.session.commit()
return make_response({"details": f'Task {task.task_id} "{task.title}" successfully deleted'})
Comment on lines +62 to +95
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃🏽



@tasks_bp.route("/<task_id>/mark_incomplete", methods=["PATCH"])
def mark_task_incomplete(task_id):
if request.method == "PATCH":
task = Task.query.get(task_id)
if task is None:
return make_response("", 404)

task.completed_at = None
db.session.commit()
return make_response({
"task": {
"id": task.task_id,
"title": task.title,
"description": task.description,
"is_complete": False if not task.completed_at else True}}, 200)
Comment on lines +99 to +112
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great job here

  • you could do the 404 check with .get_or_404
  • again you could do a helper function for the response so you don't have to retype it. You could also have the is_complete check in the helper function



@tasks_bp.route("/<task_id>/mark_complete", methods=["PATCH"])
def mark_task_complete(task_id):
if request.method == "PATCH":
task = Task.query.get(task_id)
if task is None:
return make_response("", 404)

task.completed_at = datetime.now()
db.session.commit()

slack_url = 'https://slack.com/api/chat.postMessage'
slack_tk = os.environ.get("SLACKBOT_TOKEN")

r = requests.post(slack_url,
data=f"channel=task-notifications&text=Someone just completed the task {task.title}",
headers={
"Content-type": "application/x-www-form-urlencoded", "Authorization": f"{slack_tk}"}
)
print(r.text)

return make_response({
"task": {
"id": task.task_id,
"title": task.title,
"description": task.description,
"is_complete": False if not task.completed_at else True}}, 200)

# Add a goal and get all goals


@goals_bp.route("", methods=["GET", "POST"])
def handle_goals():
if request.method == "GET":
goals = Goal.query.all()
goals_response = []
for goal in goals:
goals_response.append({
"id": goal.goal_id,
"title": goal.title,
})
return jsonify(goals_response)
elif request.method == "POST":
req_body = request.get_json()

# check for missing data
if "title" not in req_body:
return make_response({"details": "Invalid data"}, 400)
new_goal = Goal(title=req_body["title"])
db.session.add(new_goal)
db.session.commit()

return make_response({"goal": {
"id": new_goal.goal_id,
"title": new_goal.title
}}, 201)
Comment on lines +145 to +169
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃🏽



@goals_bp.route("/<goal_id>", methods=["GET", "PUT", "DELETE"])
def handle_goal(goal_id):
goal = Goal.query.get(goal_id)
if not goal:
return make_response("Item not found", 404)

if request.method == "GET":
return {"goal": {
"id": goal.goal_id,
"title": f"{goal.title}"
}}
elif request.method == "PUT":
form_data = request.get_json()
if "title" not in form_data:
return make_response({"details": "Invalid data"}, 400)
goal.title = form_data["title"]
db.session.commit()

return make_response({"goal": {
"id": goal.goal_id,
"title": f"{goal.title}"
}})

elif request.method == "DELETE":
db.session.delete(goal)
db.session.commit()

return make_response({"details": f'Goal {goal.goal_id} "{goal.title}" successfully deleted'})
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Go ahead and follow what you've been doing add the route here @goal_bp.route("/<goal_id>/tasks", methods=["GET", "POST"]) you want to get each Task to add it to the goal using the tasks field you created in the model.

1 change: 1 addition & 0 deletions migrations/README
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Generic single-database configuration.
45 changes: 45 additions & 0 deletions migrations/alembic.ini
Original file line number Diff line number Diff line change
@@ -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
96 changes: 96 additions & 0 deletions migrations/env.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
from __future__ import with_statement

import logging
from logging.config import fileConfig

from sqlalchemy import engine_from_config
from sqlalchemy import pool
from flask import current_app

from alembic import context

# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config

# Interpret the config file for Python logging.
# This line sets up loggers basically.
fileConfig(config.config_file_name)
logger = logging.getLogger('alembic.env')

# add your model's MetaData object here
# for 'autogenerate' support
# from myapp import mymodel
# target_metadata = mymodel.Base.metadata
config.set_main_option(
'sqlalchemy.url',
str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%'))
target_metadata = current_app.extensions['migrate'].db.metadata

# other values from the config, defined by the needs of env.py,
# can be acquired:
# my_important_option = config.get_main_option("my_important_option")
# ... etc.


def run_migrations_offline():
"""Run migrations in 'offline' mode.

This configures the context with just a URL
and not an Engine, though an Engine is acceptable
here as well. By skipping the Engine creation
we don't even need a DBAPI to be available.

Calls to context.execute() here emit the given string to the
script output.

"""
url = config.get_main_option("sqlalchemy.url")
context.configure(
url=url, target_metadata=target_metadata, literal_binds=True
)

with context.begin_transaction():
context.run_migrations()


def run_migrations_online():
"""Run migrations in 'online' mode.

In this scenario we need to create an Engine
and associate a connection with the context.

"""

# this callback is used to prevent an auto-migration from being generated
# when there are no changes to the schema
# reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html
def process_revision_directives(context, revision, directives):
if getattr(config.cmd_opts, 'autogenerate', False):
script = directives[0]
if script.upgrade_ops.is_empty():
directives[:] = []
logger.info('No changes in schema detected.')

connectable = engine_from_config(
config.get_section(config.config_ini_section),
prefix='sqlalchemy.',
poolclass=pool.NullPool,
)

with connectable.connect() as connection:
context.configure(
connection=connection,
target_metadata=target_metadata,
process_revision_directives=process_revision_directives,
**current_app.extensions['migrate'].configure_args
)

with context.begin_transaction():
context.run_migrations()


if context.is_offline_mode():
run_migrations_offline()
else:
run_migrations_online()
24 changes: 24 additions & 0 deletions migrations/script.py.mako
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
"""${message}

Revision ID: ${up_revision}
Revises: ${down_revision | comma,n}
Create Date: ${create_date}

"""
from alembic import op
import sqlalchemy as sa
${imports if imports else ""}

# revision identifiers, used by Alembic.
revision = ${repr(up_revision)}
down_revision = ${repr(down_revision)}
branch_labels = ${repr(branch_labels)}
depends_on = ${repr(depends_on)}


def upgrade():
${upgrades if upgrades else "pass"}


def downgrade():
${downgrades if downgrades else "pass"}
Loading