From 49d78f0d9af574ddf78c8096cd6f1d01d569c90f Mon Sep 17 00:00:00 2001 From: Geiselle Holt Date: Fri, 21 Oct 2022 12:08:14 -0600 Subject: [PATCH 01/15] Wave 1 --- app/__init__.py | 3 +++ app/routes.py | 29 ++++++++++++++++++++++++++++- 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..1123a559e 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,4 +4,7 @@ def create_app(test_config=None): app = Flask(__name__) + from .routes import bp + app.register_blueprint(bp) + return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..c9ea0d141 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,29 @@ -from flask import Blueprint +from flask import Blueprint, jasonify +class Planet: + def __init__(self, id, name, description): + self.id = id + self.name = name + self.description = description + +planets = [ + Planet(1, "Mercury", "closest to the sun"), + Planet(2, "Venus", "second closest to the sun"), + Planet(3, "Earth", "where we live") +] + +bp = Blueprint("planets", __name__, url_prefix = "/planets") + +@bp.route("", methods=["GET"]) + +def handle_planets(): + results_list = [] + for planet in planets: + results_list.append(dict( + id=planet.id, + name=planet.name, + description=planet.description + + )) + + return jasonify(results_list) \ No newline at end of file From a0e06c79aa6de5832642f57430f0d4388f0be0c0 Mon Sep 17 00:00:00 2001 From: Geiselle Holt Date: Fri, 21 Oct 2022 12:13:52 -0600 Subject: [PATCH 02/15] corrected spelling of jsonify --- app/routes.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index c9ea0d141..518f2dfc4 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,4 @@ -from flask import Blueprint, jasonify +from flask import Blueprint, jsonify class Planet: def __init__(self, id, name, description): @@ -26,4 +26,4 @@ def handle_planets(): )) - return jasonify(results_list) \ No newline at end of file + return jsonify(results_list) \ No newline at end of file From 8fe6e8dfb7371ccd613e3a6ab88c55e4016b8908 Mon Sep 17 00:00:00 2001 From: Geiselle Holt Date: Fri, 21 Oct 2022 12:20:41 -0600 Subject: [PATCH 03/15] added additional attribute moons --- app/routes.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/app/routes.py b/app/routes.py index 518f2dfc4..b6caa0be1 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,15 +1,16 @@ from flask import Blueprint, jsonify class Planet: - def __init__(self, id, name, description): + def __init__(self, id, name, description, moons): self.id = id self.name = name self.description = description + self.moons = moons planets = [ - Planet(1, "Mercury", "closest to the sun"), - Planet(2, "Venus", "second closest to the sun"), - Planet(3, "Earth", "where we live") + Planet(1, "Mercury", "closest to the sun", 0), + Planet(2, "Venus", "second closest to the sun", 0), + Planet(3, "Earth", "where we live", 1) ] bp = Blueprint("planets", __name__, url_prefix = "/planets") @@ -22,7 +23,8 @@ def handle_planets(): results_list.append(dict( id=planet.id, name=planet.name, - description=planet.description + description=planet.description, + moons=planet.moons )) From 07beac8d61d04865061d1e868eeda4e9025ddd98 Mon Sep 17 00:00:00 2001 From: Justina Date: Tue, 25 Oct 2022 13:59:03 -0400 Subject: [PATCH 04/15] Wave 2 --- app/routes.py | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/app/routes.py b/app/routes.py index b6caa0be1..112336f2a 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,4 @@ -from flask import Blueprint, jsonify +from flask import Blueprint, jsonify, abort, make_response class Planet: def __init__(self, id, name, description, moons): @@ -13,19 +13,41 @@ def __init__(self, id, name, description, moons): Planet(3, "Earth", "where we live", 1) ] +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) + + for planet in planets: + if planet.id == planet_id: + return planet + + abort(make_response({"message":f"planet {planet_id} not found"}, 404)) + bp = Blueprint("planets", __name__, url_prefix = "/planets") @bp.route("", methods=["GET"]) - def handle_planets(): results_list = [] + for planet in planets: results_list.append(dict( id=planet.id, name=planet.name, description=planet.description, moons=planet.moons - )) + + return jsonify(results_list) - return jsonify(results_list) \ No newline at end of file +@bp.route("/", methods=["GET"]) +def handle_one_planet(planet_id): + planet = validate_planet(planet_id) + + return dict( + id=planet.id, + name=planet.name, + description=planet.description, + moons=planet.moons + ) From a7e88cedf8805951a01b74d993d0851d94be8c42 Mon Sep 17 00:00:00 2001 From: Geiselle Holt Date: Tue, 25 Oct 2022 12:24:07 -0600 Subject: [PATCH 05/15] Added helper function for return dict --- app/routes.py | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/app/routes.py b/app/routes.py index 112336f2a..83be0e089 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,5 +1,6 @@ from flask import Blueprint, jsonify, abort, make_response + class Planet: def __init__(self, id, name, description, moons): self.id = id @@ -7,6 +8,15 @@ def __init__(self, id, name, description, moons): self.description = description self.moons = moons + def to_planet_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + moons=self.moons + ) + + planets = [ Planet(1, "Mercury", "closest to the sun", 0), Planet(2, "Venus", "second closest to the sun", 0), @@ -17,11 +27,11 @@ def validate_planet(planet_id): try: planet_id = int(planet_id) except: - abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) + abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) for planet in planets: - if planet.id == planet_id: - return planet + if planet.id == planet_id: + return planet abort(make_response({"message":f"planet {planet_id} not found"}, 404)) @@ -32,12 +42,7 @@ def handle_planets(): results_list = [] for planet in planets: - results_list.append(dict( - id=planet.id, - name=planet.name, - description=planet.description, - moons=planet.moons - )) + results_list.append(planet.to_planet_dict()) return jsonify(results_list) @@ -45,9 +50,4 @@ def handle_planets(): def handle_one_planet(planet_id): planet = validate_planet(planet_id) - return dict( - id=planet.id, - name=planet.name, - description=planet.description, - moons=planet.moons - ) + return jsonify(planet.to_planet_dict()) From 6340b31df8bea961e6242ba4d4b3ba19a1f22d62 Mon Sep 17 00:00:00 2001 From: Justina Date: Fri, 28 Oct 2022 14:25:12 -0400 Subject: [PATCH 06/15] Wave 3 --- app/__init__.py | 13 +++ app/models/__init__.py | 0 app/models/planet.py | 17 ++++ app/routes.py | 79 +++++++-------- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../ba34c22df00a_adds_planet_model.py | 34 +++++++ 9 files changed, 264 insertions(+), 45 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.py 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/ba34c22df00a_adds_planet_model.py diff --git a/app/__init__.py b/app/__init__.py index 1123a559e..6d55f1347 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,10 +1,23 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +db = SQLAlchemy() +migrate = Migrate() def create_app(test_config=None): app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_systems_development' + + db.init_app(app) + migrate.init_app(app, db) + + from .routes import bp app.register_blueprint(bp) + from app.models.planet import Planet + return app diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..290ffb465 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,17 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String, nullable=False) + description = db.Column(db.String, nullable=False) + moons = db.Column(db.Integer, nullable=False) + + def to_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + moons=self.moons + ) + + diff --git a/app/routes.py b/app/routes.py index 83be0e089..7bca03686 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,53 +1,42 @@ -from flask import Blueprint, jsonify, abort, make_response +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, abort, make_response, request +# def validate_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) -class Planet: - def __init__(self, id, name, description, moons): - self.id = id - self.name = name - self.description = description - self.moons = moons +# for planet in planets: +# if planet.id == planet_id: +# return planet - def to_planet_dict(self): - return dict( - id=self.id, - name=self.name, - description=self.description, - moons=self.moons - ) - - -planets = [ - Planet(1, "Mercury", "closest to the sun", 0), - Planet(2, "Venus", "second closest to the sun", 0), - Planet(3, "Earth", "where we live", 1) -] - -def validate_planet(planet_id): - try: - planet_id = int(planet_id) - except: - abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) - - for planet in planets: - if planet.id == planet_id: - return planet - - abort(make_response({"message":f"planet {planet_id} not found"}, 404)) +# abort(make_response({"message":f"planet {planet_id} not found"}, 404)) bp = Blueprint("planets", __name__, url_prefix = "/planets") @bp.route("", methods=["GET"]) -def handle_planets(): - results_list = [] - - for planet in planets: - results_list.append(planet.to_planet_dict()) - - return jsonify(results_list) - -@bp.route("/", methods=["GET"]) -def handle_one_planet(planet_id): - planet = validate_planet(planet_id) +def read_all_planets(): + planets = Planet.query.all() + planet_response = [planet.to_dict() for planet in planets] + return jsonify(planet_response) + +@bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + new_planet = Planet( + name=request_body["name"], + description=request_body["description"], + moons=request_body["moons"]) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} successfully created", 201) + +# @bp.route("/", methods=["GET"]) +# def handle_one_planet(planet_id): +# planet = validate_planet(planet_id) - return jsonify(planet.to_planet_dict()) +# return jsonify(planet.to_planet_dict()) 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/ba34c22df00a_adds_planet_model.py b/migrations/versions/ba34c22df00a_adds_planet_model.py new file mode 100644 index 000000000..0d54d431e --- /dev/null +++ b/migrations/versions/ba34c22df00a_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: ba34c22df00a +Revises: +Create Date: 2022-10-28 14:20:15.057013 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'ba34c22df00a' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('planet', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=False), + sa.Column('description', sa.String(), nullable=False), + sa.Column('moons', sa.Integer(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + # ### end Alembic commands ### From 639d4fe436846e9398779c00b812fbf9a203b65b Mon Sep 17 00:00:00 2001 From: Geiselle Holt Date: Tue, 1 Nov 2022 13:43:19 -0600 Subject: [PATCH 07/15] Wave 4 --- app/routes.py | 45 +++++++++++++++++++++++++++++++-------------- 1 file changed, 31 insertions(+), 14 deletions(-) diff --git a/app/routes.py b/app/routes.py index 7bca03686..cd3e025aa 100644 --- a/app/routes.py +++ b/app/routes.py @@ -2,20 +2,25 @@ from app.models.planet import Planet from flask import Blueprint, jsonify, abort, make_response, request -# def validate_planet(planet_id): -# try: -# planet_id = int(planet_id) -# except: -# abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) -# for planet in planets: -# if planet.id == planet_id: -# return planet + planet = Planet.query.get(planet_id) + if not planet: + abort(make_response({"message":f"planet {planet_id} not found"}, 404)) -# abort(make_response({"message":f"planet {planet_id} not found"}, 404)) + return planet bp = Blueprint("planets", __name__, url_prefix = "/planets") +@bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = validate_planet(planet_id) + return jsonify(planet.to_dict()), 200 + @bp.route("", methods=["GET"]) def read_all_planets(): planets = Planet.query.all() @@ -32,11 +37,23 @@ def create_planet(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.name} successfully created", 201) -# @bp.route("/", methods=["GET"]) -# def handle_one_planet(planet_id): -# planet = validate_planet(planet_id) +@bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() -# return jsonify(planet.to_planet_dict()) + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.moons = request_body["moons"] + + db.session.commit() + return make_response(f"Planet #{planet.id} successfully updated", 200) + +@bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = validate_planet(planet_id) + db.session.delete(planet) + db.session.commit() + return make_response(f"Planet #{planet.id} successfully deleted", 200) \ No newline at end of file From 0b62470fa99b6e95e4907809d02949e21f38c7dd Mon Sep 17 00:00:00 2001 From: Justina Date: Wed, 2 Nov 2022 13:52:17 -0400 Subject: [PATCH 08/15] created from_dict method for class Planets --- app/models/planet.py | 6 ++++++ app/routes.py | 5 +---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 290ffb465..0ec6733a7 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -14,4 +14,10 @@ def to_dict(self): moons=self.moons ) + @classmethod + def from_dict(cls, data_dict): + return cls(name=data_dict["name"], + description=data_dict["description"], + moons=data_dict["moons"]) + diff --git a/app/routes.py b/app/routes.py index cd3e025aa..132fd02e3 100644 --- a/app/routes.py +++ b/app/routes.py @@ -30,10 +30,7 @@ def read_all_planets(): @bp.route("", methods=["POST"]) def create_planet(): request_body = request.get_json() - new_planet = Planet( - name=request_body["name"], - description=request_body["description"], - moons=request_body["moons"]) + new_planet = Planet.from_dict(request_body) db.session.add(new_planet) db.session.commit() From 0967274ff62e132f193834569544642df0261b6e Mon Sep 17 00:00:00 2001 From: Justina Date: Wed, 2 Nov 2022 14:08:29 -0400 Subject: [PATCH 09/15] refactored validate planet to be validate model --- app/routes.py | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/app/routes.py b/app/routes.py index 132fd02e3..cce24518b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -2,23 +2,25 @@ from app.models.planet import Planet from flask import Blueprint, jsonify, abort, make_response, request -def validate_planet(planet_id): + +def validate_model(cls, model_id): try: - planet_id = int(planet_id) + model_id = int(model_id) except: - abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) + abort(make_response({"message":f"{cls.__name__} {model_id} invalid"}, 400)) + + model = cls.query.get(model_id) - planet = Planet.query.get(planet_id) - if not planet: - abort(make_response({"message":f"planet {planet_id} not found"}, 404)) + if not model: + abort(make_response({"message":f"{cls.__name__} {model_id} not found"}, 404)) - return planet + return model bp = Blueprint("planets", __name__, url_prefix = "/planets") @bp.route("/", methods=["GET"]) def read_one_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_model(Planet, planet_id) return jsonify(planet.to_dict()), 200 @bp.route("", methods=["GET"]) @@ -38,7 +40,7 @@ def create_planet(): @bp.route("/", methods=["PUT"]) def update_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_model(Planet, planet_id) request_body = request.get_json() planet.name = request_body["name"] @@ -50,7 +52,7 @@ def update_planet(planet_id): @bp.route("/", methods=["DELETE"]) def delete_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_model(Planet, planet_id) db.session.delete(planet) db.session.commit() return make_response(f"Planet #{planet.id} successfully deleted", 200) \ No newline at end of file From fd2fbcf8e364e6b64f95bb62b1680fc4262d7cf0 Mon Sep 17 00:00:00 2001 From: Geiselle Holt Date: Wed, 2 Nov 2022 12:49:41 -0600 Subject: [PATCH 10/15] Added query params to read_one_planet --- app/routes.py | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index cce24518b..5e263125c 100644 --- a/app/routes.py +++ b/app/routes.py @@ -25,8 +25,29 @@ def read_one_planet(planet_id): @bp.route("", methods=["GET"]) def read_all_planets(): - planets = Planet.query.all() + name_query = request.args.get("name") + description_query = request.args.get("description") + moons_query = request.args.get("moons") + limit_query = request.args.get("limit") + + planet_query = Planet.query + + if name_query: + planet_query = planet_query.filter_by(name=name_query) + + if description_query: + planet_query = planet_query.filter_by(description=description_query) + + if moons_query: + planet_query = planet_query.filter_by(moons=moons_query) + + if limit_query: + planet_query = planet_query.limit(limit_query) + + planets = planet_query.all() + planet_response = [planet.to_dict() for planet in planets] + return jsonify(planet_response) @bp.route("", methods=["POST"]) From f469fb08cc813d90cff82aa677e28d29990b3bd3 Mon Sep 17 00:00:00 2001 From: Geiselle Holt Date: Wed, 2 Nov 2022 13:01:25 -0600 Subject: [PATCH 11/15] Made helper function file, moved validate_model there --- app/routes.py | 17 ++--------------- app/routes_helper_functions.py | 14 ++++++++++++++ 2 files changed, 16 insertions(+), 15 deletions(-) create mode 100644 app/routes_helper_functions.py diff --git a/app/routes.py b/app/routes.py index 5e263125c..66c99f543 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,20 +1,7 @@ from app import db from app.models.planet import Planet -from flask import Blueprint, jsonify, abort, make_response, request - - -def validate_model(cls, model_id): - try: - model_id = int(model_id) - except: - abort(make_response({"message":f"{cls.__name__} {model_id} invalid"}, 400)) - - model = cls.query.get(model_id) - - if not model: - abort(make_response({"message":f"{cls.__name__} {model_id} not found"}, 404)) - - return model +from flask import Blueprint, jsonify, make_response, request +from app.routes_helper_functions import validate_model bp = Blueprint("planets", __name__, url_prefix = "/planets") diff --git a/app/routes_helper_functions.py b/app/routes_helper_functions.py new file mode 100644 index 000000000..9e9f3a9e4 --- /dev/null +++ b/app/routes_helper_functions.py @@ -0,0 +1,14 @@ +from flask import abort, make_response + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + abort(make_response({"message":f"{cls.__name__} {model_id} invalid"}, 400)) + + model = cls.query.get(model_id) + + if not model: + abort(make_response({"message":f"{cls.__name__} {model_id} not found"}, 404)) + + return model \ No newline at end of file From f200d01047918a1e0e6727f28c750f3be33ed8e6 Mon Sep 17 00:00:00 2001 From: Justina Date: Thu, 3 Nov 2022 14:24:18 -0400 Subject: [PATCH 12/15] Wave 6 --- app/__init__.py | 11 +++++++++- app/tests/__init__.py | 0 app/tests/conftest.py | 32 +++++++++++++++++++++++++++++ app/tests/test_routes.py | 44 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 86 insertions(+), 1 deletion(-) create mode 100644 app/tests/__init__.py create mode 100644 app/tests/conftest.py create mode 100644 app/tests/test_routes.py diff --git a/app/__init__.py b/app/__init__.py index 6d55f1347..635b57f2a 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,16 +1,25 @@ from flask import Flask from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate +from dotenv import load_dotenv +import os db = SQLAlchemy() migrate = Migrate() +load_dotenv() def create_app(test_config=None): app = Flask(__name__) app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_systems_development' + if not test_config: + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") + else: + app.config["TESTING"] = True + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + "SQLALCHEMY_TEST_DATABASE_URI") + db.init_app(app) migrate.init_app(app, db) diff --git a/app/tests/__init__.py b/app/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/tests/conftest.py b/app/tests/conftest.py new file mode 100644 index 000000000..b430136a8 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,32 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planet import Planet + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + @request_finished.connect_via(app) + def expire_session(sender, response, **extra): + db.session.remove() + + with app.app_context(): + db.create_all() + yield app + + with app.app_context(): + db.drop_all() + + +@pytest.fixture +def client(app): + return app.test_client() + +@pytest.fixture +def one_saved_planet(app): + planet = Planet(name="Earth", description="home", moons=1) + db.session.add(planet) + db.session.commit() + return planet \ No newline at end of file diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..2a337b0b7 --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,44 @@ +def test_get_all_planets_with_no_records(client): + #Act + response = client.get("/planets") + response_body = response.get_json() + #Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_one_planet(client, one_saved_planet): + #Act + response = client.get("/planets/1") + response_body = response.get_json() + #Assert + assert response.status_code == 200 + assert response_body["id"] == one_saved_planet.id + assert response_body["name"] == one_saved_planet.name + assert response_body["description"] == one_saved_planet.description + assert response_body["moons"] == one_saved_planet.moons + +def test_get_one_planet_no_data(client): + #Act + response = client.get("/planets/1") + response_body = response.get_json() + #Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 1 not found"} + +def test_get_planets_happy_path(client, one_saved_planet): + #Act + response = client.get("/planets") + response_body = response.get_json() + #Assert + assert response.status_code == 200 + assert response_body[0] == {"id": 1, "name": "Earth", "description": "home", "moons": 1} + +def test_create_planet_happy_path(client): + #Arrange + test_planet = {"name": "Mars", "description": "red", "moons": 0} + #Act + response = client.post("/planets", json={"name": "Mars", "description": "red", "moons": 0}) + response_body = response.get_data(as_text=True) + #Assert + assert response.status_code == 201 + assert response_body == "Planet Mars successfully created" From f714afad296fd402e6d3d6f3c3417c49c6ec2266 Mon Sep 17 00:00:00 2001 From: Geiselle Holt Date: Thu, 3 Nov 2022 12:35:35 -0600 Subject: [PATCH 13/15] moved test folder outside app folder --- tests/__init__.py | 0 tests/conftest.py | 32 ++++++++++++++++++++++++++++++++ tests/test_routes.py | 44 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 76 insertions(+) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_routes.py diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 000000000..b430136a8 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,32 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planet import Planet + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + @request_finished.connect_via(app) + def expire_session(sender, response, **extra): + db.session.remove() + + with app.app_context(): + db.create_all() + yield app + + with app.app_context(): + db.drop_all() + + +@pytest.fixture +def client(app): + return app.test_client() + +@pytest.fixture +def one_saved_planet(app): + planet = Planet(name="Earth", description="home", moons=1) + db.session.add(planet) + db.session.commit() + return planet \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..2a337b0b7 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,44 @@ +def test_get_all_planets_with_no_records(client): + #Act + response = client.get("/planets") + response_body = response.get_json() + #Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_one_planet(client, one_saved_planet): + #Act + response = client.get("/planets/1") + response_body = response.get_json() + #Assert + assert response.status_code == 200 + assert response_body["id"] == one_saved_planet.id + assert response_body["name"] == one_saved_planet.name + assert response_body["description"] == one_saved_planet.description + assert response_body["moons"] == one_saved_planet.moons + +def test_get_one_planet_no_data(client): + #Act + response = client.get("/planets/1") + response_body = response.get_json() + #Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 1 not found"} + +def test_get_planets_happy_path(client, one_saved_planet): + #Act + response = client.get("/planets") + response_body = response.get_json() + #Assert + assert response.status_code == 200 + assert response_body[0] == {"id": 1, "name": "Earth", "description": "home", "moons": 1} + +def test_create_planet_happy_path(client): + #Arrange + test_planet = {"name": "Mars", "description": "red", "moons": 0} + #Act + response = client.post("/planets", json={"name": "Mars", "description": "red", "moons": 0}) + response_body = response.get_data(as_text=True) + #Assert + assert response.status_code == 201 + assert response_body == "Planet Mars successfully created" From 4c671a187c3ca421cb3bc870a51f6b6835cf6c2f Mon Sep 17 00:00:00 2001 From: Geiselle Holt Date: Thu, 3 Nov 2022 12:37:54 -0600 Subject: [PATCH 14/15] Deleted test folder in app folder --- app/tests/__init__.py | 0 app/tests/conftest.py | 32 ----------------------------- app/tests/test_routes.py | 44 ---------------------------------------- 3 files changed, 76 deletions(-) delete mode 100644 app/tests/__init__.py delete mode 100644 app/tests/conftest.py delete mode 100644 app/tests/test_routes.py diff --git a/app/tests/__init__.py b/app/tests/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/app/tests/conftest.py b/app/tests/conftest.py deleted file mode 100644 index b430136a8..000000000 --- a/app/tests/conftest.py +++ /dev/null @@ -1,32 +0,0 @@ -import pytest -from app import create_app -from app import db -from flask.signals import request_finished -from app.models.planet import Planet - -@pytest.fixture -def app(): - app = create_app({"TESTING": True}) - - @request_finished.connect_via(app) - def expire_session(sender, response, **extra): - db.session.remove() - - with app.app_context(): - db.create_all() - yield app - - with app.app_context(): - db.drop_all() - - -@pytest.fixture -def client(app): - return app.test_client() - -@pytest.fixture -def one_saved_planet(app): - planet = Planet(name="Earth", description="home", moons=1) - db.session.add(planet) - db.session.commit() - return planet \ No newline at end of file diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py deleted file mode 100644 index 2a337b0b7..000000000 --- a/app/tests/test_routes.py +++ /dev/null @@ -1,44 +0,0 @@ -def test_get_all_planets_with_no_records(client): - #Act - response = client.get("/planets") - response_body = response.get_json() - #Assert - assert response.status_code == 200 - assert response_body == [] - -def test_get_one_planet(client, one_saved_planet): - #Act - response = client.get("/planets/1") - response_body = response.get_json() - #Assert - assert response.status_code == 200 - assert response_body["id"] == one_saved_planet.id - assert response_body["name"] == one_saved_planet.name - assert response_body["description"] == one_saved_planet.description - assert response_body["moons"] == one_saved_planet.moons - -def test_get_one_planet_no_data(client): - #Act - response = client.get("/planets/1") - response_body = response.get_json() - #Assert - assert response.status_code == 404 - assert response_body == {"message": "Planet 1 not found"} - -def test_get_planets_happy_path(client, one_saved_planet): - #Act - response = client.get("/planets") - response_body = response.get_json() - #Assert - assert response.status_code == 200 - assert response_body[0] == {"id": 1, "name": "Earth", "description": "home", "moons": 1} - -def test_create_planet_happy_path(client): - #Arrange - test_planet = {"name": "Mars", "description": "red", "moons": 0} - #Act - response = client.post("/planets", json={"name": "Mars", "description": "red", "moons": 0}) - response_body = response.get_data(as_text=True) - #Assert - assert response.status_code == 201 - assert response_body == "Planet Mars successfully created" From acccfd36d65eba6c5b4a918661ab1c326bbe949a Mon Sep 17 00:00:00 2001 From: Geiselle Holt Date: Fri, 4 Nov 2022 15:50:16 -0600 Subject: [PATCH 15/15] caretaker one to many relationship, routes folder --- app/__init__.py | 7 ++- app/models/fictional_caretaker.py | 16 ++++++ app/models/planet.py | 2 + app/routes/fictional_caretaker.py | 49 +++++++++++++++++++ .../helper_functions.py} | 0 app/{routes.py => routes/planet.py} | 2 +- .../b3e2f14f62df_added_fictional_caretaker.py | 36 ++++++++++++++ 7 files changed, 109 insertions(+), 3 deletions(-) create mode 100644 app/models/fictional_caretaker.py create mode 100644 app/routes/fictional_caretaker.py rename app/{routes_helper_functions.py => routes/helper_functions.py} (100%) rename app/{routes.py => routes/planet.py} (97%) create mode 100644 migrations/versions/b3e2f14f62df_added_fictional_caretaker.py diff --git a/app/__init__.py b/app/__init__.py index 635b57f2a..ab0842a97 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -24,9 +24,12 @@ def create_app(test_config=None): migrate.init_app(app, db) - from .routes import bp - app.register_blueprint(bp) + from .routes import planet + from .routes import fictional_caretaker + app.register_blueprint(planet.bp) + app.register_blueprint(fictional_caretaker.bp) from app.models.planet import Planet + from app.models.fictional_caretaker import Caretaker return app diff --git a/app/models/fictional_caretaker.py b/app/models/fictional_caretaker.py new file mode 100644 index 000000000..b258675ed --- /dev/null +++ b/app/models/fictional_caretaker.py @@ -0,0 +1,16 @@ +from app import db + +class Caretaker(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + planets = db.relationship("Planet", back_populates="caretaker") + + @classmethod + def from_dict(cls, data_dict): + return cls(name=data_dict["name"]) + + def to_dict(self): + return dict( + id=self.id, + name=self.name + ) \ No newline at end of file diff --git a/app/models/planet.py b/app/models/planet.py index 0ec6733a7..2cf56dae9 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -5,6 +5,8 @@ class Planet(db.Model): name = db.Column(db.String, nullable=False) description = db.Column(db.String, nullable=False) moons = db.Column(db.Integer, nullable=False) + caretaker_id = db.Column(db.Integer, db.ForeignKey("caretaker.id")) + caretaker = db.relationship("Caretaker", back_populates="planets") def to_dict(self): return dict( diff --git a/app/routes/fictional_caretaker.py b/app/routes/fictional_caretaker.py new file mode 100644 index 000000000..b320e8a30 --- /dev/null +++ b/app/routes/fictional_caretaker.py @@ -0,0 +1,49 @@ +from app import db +from app.models.fictional_caretaker import Caretaker +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request +from app.routes.helper_functions import validate_model + +bp = Blueprint("caretakers", __name__, url_prefix="/caretakers") + +@bp.route("", methods=["POST"]) +def create_caretaker(): + request_body = request.get_json() + new_caretaker = Caretaker.from_dict(request_body) + + db.session.add(new_caretaker) + db.session.commit() + + return make_response(f"Caretaker {new_caretaker.name} successfully created", 201) + + +@bp.route("", methods=["GET"]) +def read_all_caretakers(): + caretakers = Caretaker.query.all() + + caretakers_response = [caretaker.to_dict() for caretaker in caretakers] + + return jsonify(caretakers_response) + + +@bp.route("//planets", methods=["POST"]) +def create_planet(caretaker_id): + caretaker = validate_model(Caretaker, caretaker_id) + request_body = request.get_json() + new_planet = Planet.from_dict(request_body) + new_planet.caretaker = caretaker + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} cared for by {caretaker.name}", 201) + + +@bp.route("//planets", methods=["GET"]) +def read_one_planet(caretaker_id): + caretaker = validate_model(Caretaker, caretaker_id) + + planet_response = [planet.to_dict() for planet in caretaker.planets] + + + return(jsonify(planet_response)) \ No newline at end of file diff --git a/app/routes_helper_functions.py b/app/routes/helper_functions.py similarity index 100% rename from app/routes_helper_functions.py rename to app/routes/helper_functions.py diff --git a/app/routes.py b/app/routes/planet.py similarity index 97% rename from app/routes.py rename to app/routes/planet.py index 66c99f543..8297f55f8 100644 --- a/app/routes.py +++ b/app/routes/planet.py @@ -1,7 +1,7 @@ from app import db from app.models.planet import Planet from flask import Blueprint, jsonify, make_response, request -from app.routes_helper_functions import validate_model +from app.routes.helper_functions import validate_model bp = Blueprint("planets", __name__, url_prefix = "/planets") diff --git a/migrations/versions/b3e2f14f62df_added_fictional_caretaker.py b/migrations/versions/b3e2f14f62df_added_fictional_caretaker.py new file mode 100644 index 000000000..ea2f2dd03 --- /dev/null +++ b/migrations/versions/b3e2f14f62df_added_fictional_caretaker.py @@ -0,0 +1,36 @@ +"""added fictional caretaker + +Revision ID: b3e2f14f62df +Revises: ba34c22df00a +Create Date: 2022-11-04 13:01:29.400980 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'b3e2f14f62df' +down_revision = 'ba34c22df00a' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('caretaker', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.add_column('planet', sa.Column('caretaker_id', sa.Integer(), nullable=True)) + op.create_foreign_key(None, 'planet', 'caretaker', ['caretaker_id'], ['id']) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_constraint(None, 'planet', type_='foreignkey') + op.drop_column('planet', 'caretaker_id') + op.drop_table('caretaker') + # ### end Alembic commands ###