From 2c018a820274e95901aa58cdc49226c0237decf3 Mon Sep 17 00:00:00 2001 From: Nicole Washington Date: Thu, 4 Nov 2021 09:04:44 -0700 Subject: [PATCH] Project setu-up and wave 01 complete and tested --- app/__init__.py | 2 + app/models/task.py | 5 +- app/routes.py | 89 ++++++++++++++++- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../versions/b2c3d03fede8_added_task_model.py | 39 ++++++++ 8 files changed, 299 insertions(+), 2 deletions(-) create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/b2c3d03fede8_added_task_model.py diff --git a/app/__init__.py b/app/__init__.py index 2764c4cc8..30052751d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -30,5 +30,7 @@ def create_app(test_config=None): migrate.init_app(app, db) # Register Blueprints here + from .routes import tasks_bp + app.register_blueprint(tasks_bp) return app diff --git a/app/models/task.py b/app/models/task.py index 39c89cd16..8bf3e9734 100644 --- a/app/models/task.py +++ b/app/models/task.py @@ -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) diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..47d2c096c 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,89 @@ -from flask import Blueprint +from flask import Blueprint , jsonify, request , make_response +from app import db +from app.models.task import Task +tasks_bp = Blueprint("tasks", __name__ , url_prefix="/tasks") + +@tasks_bp.route("", methods =["POST","GET"]) +def manage_tasks(): + if request.method == "POST": + request_body = request.get_json() + try: + new_task = Task( + title = request_body["title"], + description= request_body["description"], + completed_at = request_body["completed_at"] + ) + #add new task before response body to get an id value + db.session.add(new_task) + db.session.commit() + response_body = { + "task":{ + "id": new_task.task_id, + "title": new_task.title, + "description": new_task.description, + "is_complete": True if new_task.completed_at is not None else False + } + } + return jsonify(response_body), 201 + except KeyError: + return {"details":"Invalid data"}, 400 + + elif request.method == "GET": + request_title = request.args.get("title") + if request_title: #if request_title + tasks = Task.query.filter_by(title=request_title) + else: + tasks = Task.query.all() + response = [] + for task in tasks: + response.append({ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": False if task.completed_at is None else True + }) + return jsonify(response) + pass + + +@tasks_bp.route("/", methods =["GET","PUT", "DELETE"]) +def manage_task(task_id): + task = Task.query.get(task_id) + if task == None: + return make_response("", 404) + + if request.method == "GET": + response_body = { + "task":{ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": True if task.completed_at is not None else False + } + } + return jsonify(response_body), 200 + + 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"] + db.session.commit() + response_body = { + "task":{ + "id": task.task_id, + "title": task.title, + "description": task.description, + "is_complete": True if task.completed_at is not None else False + } + } + return jsonify(response_body), 200 + + elif request.method == "DELETE": + db.session.delete(task) + db.session.commit() + response_body = { + "details":f"Task {task.task_id} \"{task.title}\" successfully deleted" + } + return jsonify(response_body), 200 diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..f8ed4801f --- /dev/null +++ b/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 diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..8b3fb3353 --- /dev/null +++ b/migrations/env.py @@ -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() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /dev/null +++ b/migrations/script.py.mako @@ -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"} diff --git a/migrations/versions/b2c3d03fede8_added_task_model.py b/migrations/versions/b2c3d03fede8_added_task_model.py new file mode 100644 index 000000000..69f13a2a9 --- /dev/null +++ b/migrations/versions/b2c3d03fede8_added_task_model.py @@ -0,0 +1,39 @@ +"""Added Task Model + +Revision ID: b2c3d03fede8 +Revises: +Create Date: 2021-11-04 02:33:04.101905 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'b2c3d03fede8' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('goal', + sa.Column('goal_id', sa.Integer(), nullable=False), + sa.PrimaryKeyConstraint('goal_id') + ) + op.create_table('task', + sa.Column('task_id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('completed_at', sa.DateTime(), nullable=True), + sa.PrimaryKeyConstraint('task_id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('task') + op.drop_table('goal') + # ### end Alembic commands ###