Skip to content

Accelerate - Andrea Valliere #4

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 7 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
4 changes: 4 additions & 0 deletions app/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,9 @@ def create_app(test_config=None):
migrate.init_app(app, db)

# 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
1 change: 1 addition & 0 deletions app/models/goal.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@

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

Choose a reason for hiding this comment

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

after this line go ahead and add the db.relationship for tasks

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


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)
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 adding a db.ForeignKey("goal.goal_id") to connect it to the Goal class

225 changes: 224 additions & 1 deletion app/routes.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,225 @@
from flask import Blueprint
from app import db
from app.models.task import Task
from app.models.goal import Goal
from flask import request, Blueprint, make_response, jsonify
from sqlalchemy import desc
from datetime import date
import requests, os

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

''''''''''''''''''''''''''''''''''''
# # # # # # TASK ROUTES # # # # # #
''''''''''''''''''''''''''''''''''''

@tasks_bp.route("", methods=["POST", "GET"])
def handle_tasks():
if request.method == "POST":
request_body = request.get_json()
title = request_body.get("title")
description = request_body.get("description")

if not title or not description or "completed_at" not in request_body:
return jsonify({"details": "Invalid data"}), 400

new_task = Task(title=request_body["title"],
description=request_body["description"],
completed_at=request_body["completed_at"])
Comment on lines +20 to +28
Copy link

Choose a reason for hiding this comment

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

Because you defined title and description on lines 20/21 you can just use title and description on lines 26/27
For example: Task(title = title)

db.session.add(new_task)
db.session.commit()
db_task = {
"task": {
"id": new_task.task_id,
"title": new_task.title,
"description": new_task.description,
"is_complete": bool(new_task.completed_at)
}
}
return db_task, 201

elif request.method == "GET":
if request.args.get("sort") == "asc":
tasks = Task.query.order_by(Task.title)
elif request.args.get("sort") == "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": bool(task.completed_at)
})
return jsonify(tasks_response)


@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("", 404)

if request.method == "GET":
selected_task = {
"task": {
"id": task.task_id,
"title": task.title,
"description": task.description,
"is_complete": bool(task.completed_at)
}
}
return selected_task

elif request.method == "PUT":
request_body = request.get_json()

task.title = request_body["title"]
task.description = request_body["description"]
task.completed_at = request_body["completed_at"]

updated_task = {
"task": {
"id": task.task_id,
"title": task.title,
"description": task.description,
"is_complete": bool(task.completed_at)
}
}

db.session.commit()
return make_response(updated_task, 200)

elif request.method == "DELETE":
response = {
"details":
f'Task {task.task_id} "{task.title}" successfully deleted'
}
db.session.delete(task)
db.session.commit()
return make_response(response, 200)
Comment on lines +60 to +103
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_complete", methods=["PATCH"])
def handle_complete_task(task_id):
task = Task.query.get(task_id)
if task is None:
return make_response("", 404)

task.completed_at = date.today()
db.session.commit()
response = {
"task": {
"id": task.task_id,
"title": task.title,
"description": task.description,
"is_complete": True
}
}

slack_path = "https://slack.com/api/chat.postMessage"
slack_token = os.environ.get("SLACK_API_TOKEN")
slack_headers = {
"Authorization": f"Bearer {slack_token}"
}
slack_query_params = {
"channel": "task-list-bot",
"text": f"Someone just completed the task {task.title}."
}
requests.post(slack_path, params=slack_query_params, headers=slack_headers)

return make_response(response, 200)

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

task.completed_at = None
db.session.commit()
response = {
"task": {
"id": task.task_id,
"title": task.title,
"description": task.description,
"is_complete": False
}
}
return make_response(response, 200)
Comment on lines +105 to +151
Copy link

Choose a reason for hiding this comment

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

💃🏽


''''''''''''''''''''''''''''''''''''
# # # # # # GOAL ROUTES # # # # # #
''''''''''''''''''''''''''''''''''''

@goals_bp.route("", methods=["POST", "GET"])
def handle_goals():
if request.method == "POST":
request_body = request.get_json()
title = request_body.get("title")

if not title:
response_body = {"details": "Invalid data"}
return make_response(response_body, 400)

new_goal = Goal(title=title)
db.session.add(new_goal)
db.session.commit()
db_goal = {
"goal": {
"id": new_goal.goal_id,
"title": new_goal.title
}
}
return db_goal, 201
elif request.method == "GET":
goals = Goal.query.all()

goals_response = []
for goal in goals:
goals_response.append({
"id": goal.goal_id,
"title": goal.title
})
goals_json_response = jsonify(goals_response)
return make_response(goals_json_response, 200)
Comment on lines +158 to +187
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 goal is None:
return make_response("", 404)

if request.method == "GET":
selected_goal = {
"goal": {
"id": goal.goal_id,
"title": goal.title}
}
return make_response(selected_goal, 200)

elif request.method == "PUT":
request_body = request.get_json()

goal.title = request_body["title"]

updated_goal = {
"goal": {
"id": goal.goal_id,
"title": goal.title
}
}

db.session.commit()
return make_response(updated_goal, 200)

elif request.method == "DELETE":
response = {
"details":
f'Goal {goal.goal_id} "{goal.title}" successfully deleted'
}
db.session.delete(goal)
db.session.commit()
return make_response(response, 200)
Copy link

Choose a reason for hiding this comment

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

To get Wave 6 passing start with:

  • setting up the route after this line @goal_bp.route("/<goal_id>/tasks", methods=["GET", "POST"])
  • make sure to implement the database relationship and goal_id in Models.py
  • you've done a great job with the previous methods. Follow what you've been doing and the ReadME to get it implemented.

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()
Loading