From 8840a99fc86e4a1ab1dd60e5f0036d4da544013f Mon Sep 17 00:00:00 2001 From: Amber <110812972+Msambere@users.noreply.github.com> Date: Fri, 18 Oct 2024 13:37:17 -0500 Subject: [PATCH 01/11] Complete Wave 01 Added an endpoint to return a lis of all planet_routes --- app/__init__.py | 4 ++++ app/models/__init__.py | 0 app/models/planet.py | 12 ++++++++++++ app/routes.py | 2 -- app/routes/__init__.py | 0 app/routes/planet_routes.py | 14 ++++++++++++++ project-directions/wave_01.md | 6 +++--- 7 files changed, 33 insertions(+), 5 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.py delete mode 100644 app/routes.py create mode 100644 app/routes/__init__.py create mode 100644 app/routes/planet_routes.py diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..f056df3db 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,11 @@ from flask import Flask +from app.routes.planet_routes import planets_bp def create_app(test_config=None): app = Flask(__name__) + # Register blueprints here + app.register_blueprint(planets_bp) + 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..4b91e5c1e --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,12 @@ +class Planet: + def __init__(self, id, name, description): + self.id = id + self.name = name + self.description = description + + +Planets = [ + Planet(1, "RongRong", "medium sized black planet with storming seas"), + Planet(2, "BerBer", "small yellow planet with 2 moons"), + Planet(3, "GT-23", "giant purple planet with rings"), +] diff --git a/app/routes.py b/app/routes.py deleted file mode 100644 index 8e9dfe684..000000000 --- a/app/routes.py +++ /dev/null @@ -1,2 +0,0 @@ -from flask import Blueprint - diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py new file mode 100644 index 000000000..241d326ca --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,14 @@ +from flask import Blueprint +from app.models.planet import Planets + +planets_bp = Blueprint("planets_bp", __name__, url_prefix=("/planets")) + + +@planets_bp.get("") +def get_all_planets(): + planet_list = [] + for planet in Planets: + planet_list.append( + {"id": planet.id, "name": planet.name, "description": planet.description} + ) + return planet_list diff --git a/project-directions/wave_01.md b/project-directions/wave_01.md index a07cc6548..6412de5ca 100644 --- a/project-directions/wave_01.md +++ b/project-directions/wave_01.md @@ -4,8 +4,8 @@ Perform following setup steps for the Solar System API repo to get started on this Flask project: 1. Create a virtual environment and activate it -1. Install the dependencies -1. Define a `Planet` class with the attributes `id`, `name`, and `description`, and one additional attribute +2. Install the dependencies +3. Define a `Planet` class with the attributes `id`, `name`, and `description`, and one additional attribute 1. Create a list of `Planet` instances ## RESTful Endpoints: Read @@ -13,4 +13,4 @@ Create the following endpoint(s), with similar functionality presented in the He As a client, I want to send a request... -1. ...to get all existing `planets`, so that I can see a list of `planets`, with their `id`, `name`, `description`, and other data of the `planet`. +1. ...to get all existing `planets`, so that I can see a list of `planets`, with their `id`, `name`, `description`, and other data of the `planet`.` From e56b9180aee5c1da53e3ff81458806cba612df9d Mon Sep 17 00:00:00 2001 From: Amber <110812972+Msambere@users.noreply.github.com> Date: Fri, 18 Oct 2024 13:50:30 -0500 Subject: [PATCH 02/11] Complete Wave 02 Created endpoints for a specific planet and handled errors for non-integer input and invalid integers. --- app/routes/planet_routes.py | 16 ++++++++++++++++ project-directions/wave_02.md | 4 ++-- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 241d326ca..5deea610b 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -12,3 +12,19 @@ def get_all_planets(): {"id": planet.id, "name": planet.name, "description": planet.description} ) return planet_list + + +@planets_bp.get("/") +def get_one_planet(planet_id): + try: + planet_id = int(planet_id) + except: + return {"message": f"{planet_id} is not a invalid id"}, 400 + for planet in Planets: + if planet.id == planet_id: + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + } + return {"success": False, "msg": "Planet id not valid"}, 404 diff --git a/project-directions/wave_02.md b/project-directions/wave_02.md index 7ae9ac268..14c90803b 100644 --- a/project-directions/wave_02.md +++ b/project-directions/wave_02.md @@ -6,6 +6,6 @@ Create the following endpoint(s), with similar functionality presented in the He As a client, I want to send a request... 1. ...to get one existing `planet`, so that I can see the `id`, `name`, `description`, and other data of the `planet`. -1. ... such that trying to get one non-existing `planet` responds with get a `404` response, so that I know the `planet` resource was not found. -1. ... such that trying to get one `planet` with an invalid `planet_id` responds with get a `400` response, so that I know the `planet_id` was invalid. +2. ... such that trying to get one non-existing `planet` responds with get a `404` response, so that I know the `planet` resource was not found. +3. ... such that trying to get one `planet` with an invalid `planet_id` responds with get a `400` response, so that I know the `planet_id` was invalid. From 88c9305886b6ca83150d9bb050739e105d72ecf6 Mon Sep 17 00:00:00 2001 From: Corntto9 <> Date: Mon, 21 Oct 2024 11:27:15 -0700 Subject: [PATCH 03/11] change the error handling method --- app/models/planet.py | 7 +++++++ app/routes/planet_routes.py | 24 +++++++++++++----------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 4b91e5c1e..47105a042 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -4,6 +4,13 @@ def __init__(self, id, name, description): self.name = name self.description = description + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + } + Planets = [ Planet(1, "RongRong", "medium sized black planet with storming seas"), diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 5deea610b..fed497f7c 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -1,4 +1,4 @@ -from flask import Blueprint +from flask import Blueprint, abort, make_response from app.models.planet import Planets planets_bp = Blueprint("planets_bp", __name__, url_prefix=("/planets")) @@ -8,23 +8,25 @@ def get_all_planets(): planet_list = [] for planet in Planets: - planet_list.append( - {"id": planet.id, "name": planet.name, "description": planet.description} - ) + planet_list.append(planet.to_dict()) return planet_list @planets_bp.get("/") def get_one_planet(planet_id): + planet = validate_planet(planet_id) + + return planet.to_dict(), 200 + +def validate_planet(planet_id): try: planet_id = int(planet_id) except: - return {"message": f"{planet_id} is not a invalid id"}, 400 + abort(make_response({"message": f"{planet_id} is not a invalid id"}, 400)) + for planet in Planets: if planet.id == planet_id: - return { - "id": planet.id, - "name": planet.name, - "description": planet.description, - } - return {"success": False, "msg": "Planet id not valid"}, 404 + return planet + abort(make_response({"msg": "Planet id not found"}, 404)) + + From fa76c7bb012760a96fefc6e1dfb86080cbde8cd9 Mon Sep 17 00:00:00 2001 From: Amber <110812972+Msambere@users.noreply.github.com> Date: Fri, 25 Oct 2024 13:38:29 -0500 Subject: [PATCH 04/11] Connect Flask and database with SQLAlchemy --- app/__init__.py | 10 ++ app/db.py | 6 + app/models/base.py | 4 + app/models/planet.py | 18 +-- app/routes/planet_routes.py | 40 +++---- migrations/README | 1 + migrations/alembic.ini | 50 ++++++++ migrations/env.py | 113 ++++++++++++++++++ migrations/script.py.mako | 24 ++++ .../versions/cb9e9f40cfb5_add_planet_model.py | 33 +++++ 10 files changed, 267 insertions(+), 32 deletions(-) create mode 100644 app/db.py create mode 100644 app/models/base.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/cb9e9f40cfb5_add_planet_model.py diff --git a/app/__init__.py b/app/__init__.py index f056df3db..3ae8198b9 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,10 +1,20 @@ from flask import Flask +from .db import db, migrate +from .models.planet import Planet from app.routes.planet_routes import planets_bp 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_system_development" + ) + + db.init_app(app) + migrate.init_app(app, db) + # Register blueprints here app.register_blueprint(planets_bp) diff --git a/app/db.py b/app/db.py new file mode 100644 index 000000000..3ada8d10c --- /dev/null +++ b/app/db.py @@ -0,0 +1,6 @@ +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from .models.base import Base + +db = SQLAlchemy(model_class=Base) +migrate = Migrate() \ No newline at end of file diff --git a/app/models/base.py b/app/models/base.py new file mode 100644 index 000000000..227841686 --- /dev/null +++ b/app/models/base.py @@ -0,0 +1,4 @@ +from sqlalchemy.orm import DeclarativeBase + +class Base(DeclarativeBase): + pass \ No newline at end of file diff --git a/app/models/planet.py b/app/models/planet.py index 47105a042..b6076d75f 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -1,8 +1,9 @@ -class Planet: - def __init__(self, id, name, description): - self.id = id - self.name = name - self.description = description +from sqlalchemy.orm import Mapped, mapped_column +from ..db import db +class Planet(db.Model): + id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + name: Mapped[str] + description: Mapped[str] def to_dict(self): return { @@ -10,10 +11,3 @@ def to_dict(self): "name": self.name, "description": self.description, } - - -Planets = [ - Planet(1, "RongRong", "medium sized black planet with storming seas"), - Planet(2, "BerBer", "small yellow planet with 2 moons"), - Planet(3, "GT-23", "giant purple planet with rings"), -] diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index fed497f7c..57c77af25 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -1,32 +1,32 @@ from flask import Blueprint, abort, make_response -from app.models.planet import Planets +# from app.models.planet import Planet planets_bp = Blueprint("planets_bp", __name__, url_prefix=("/planets")) -@planets_bp.get("") -def get_all_planets(): - planet_list = [] - for planet in Planets: - planet_list.append(planet.to_dict()) - return planet_list +# @planets_bp.get("") +# def get_all_planets(): +# planet_list = [] +# for planet in Planets: +# planet_list.append(planet.to_dict()) +# return planet_list -@planets_bp.get("/") -def get_one_planet(planet_id): - planet = validate_planet(planet_id) +# @planets_bp.get("/") +# def get_one_planet(planet_id): +# planet = validate_planet(planet_id) - return planet.to_dict(), 200 +# return planet.to_dict(), 200 -def validate_planet(planet_id): - try: - planet_id = int(planet_id) - except: - abort(make_response({"message": f"{planet_id} is not a invalid id"}, 400)) +# def validate_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# abort(make_response({"message": f"{planet_id} is not a invalid id"}, 400)) - for planet in Planets: - if planet.id == planet_id: - return planet - abort(make_response({"msg": "Planet id not found"}, 404)) +# for planet in Planets: +# if planet.id == planet_id: +# return planet +# abort(make_response({"msg": "Planet id not found"}, 404)) diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..0e0484415 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..ec9d45c26 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# 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,flask_migrate + +[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 + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[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..4c9709271 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,113 @@ +import logging +from logging.config import fileConfig + +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') + + +def get_engine(): + try: + # this works with Flask-SQLAlchemy<3 and Alchemical + return current_app.extensions['migrate'].db.get_engine() + except (TypeError, AttributeError): + # this works with Flask-SQLAlchemy>=3 + return current_app.extensions['migrate'].db.engine + + +def get_engine_url(): + try: + return get_engine().url.render_as_string(hide_password=False).replace( + '%', '%%') + except AttributeError: + return str(get_engine().url).replace('%', '%%') + + +# 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', get_engine_url()) +target_db = current_app.extensions['migrate'].db + +# 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 get_metadata(): + if hasattr(target_db, 'metadatas'): + return target_db.metadatas[None] + return target_db.metadata + + +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=get_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.') + + conf_args = current_app.extensions['migrate'].configure_args + if conf_args.get("process_revision_directives") is None: + conf_args["process_revision_directives"] = process_revision_directives + + connectable = get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=get_metadata(), + **conf_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/cb9e9f40cfb5_add_planet_model.py b/migrations/versions/cb9e9f40cfb5_add_planet_model.py new file mode 100644 index 000000000..ed1d9c626 --- /dev/null +++ b/migrations/versions/cb9e9f40cfb5_add_planet_model.py @@ -0,0 +1,33 @@ +"""add Planet Model + +Revision ID: cb9e9f40cfb5 +Revises: +Create Date: 2024-10-25 13:37:55.489596 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'cb9e9f40cfb5' +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.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + # ### end Alembic commands ### From 69ab28b0cc4bb9a92e773987dbe2089e75c572c9 Mon Sep 17 00:00:00 2001 From: Amber <110812972+Msambere@users.noreply.github.com> Date: Fri, 25 Oct 2024 19:39:50 -0500 Subject: [PATCH 05/11] Complete wave_03 Add create_new_planet() and get_all_planets() with their corresponding routes and HTTP methods. Additonally created get_one_planet() --- app/routes/planet_routes.py | 60 +++++++++++++++++++++++-------------- 1 file changed, 37 insertions(+), 23 deletions(-) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 57c77af25..bb3793aa3 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -1,32 +1,46 @@ -from flask import Blueprint, abort, make_response -# from app.models.planet import Planet +from flask import Blueprint, abort, make_response, request +from app.models.planet import Planet +from app.db import db +from sqlalchemy import select planets_bp = Blueprint("planets_bp", __name__, url_prefix=("/planets")) -# @planets_bp.get("") -# def get_all_planets(): -# planet_list = [] -# for planet in Planets: -# planet_list.append(planet.to_dict()) -# return planet_list +@planets_bp.post("") +def create_planet(): + request_body = request.get_json() + name = request_body['name'] + description = request_body['description'] + new_planet = Planet(name=name, description=description) + db.session.add(new_planet) + db.session.commit() -# @planets_bp.get("/") -# def get_one_planet(planet_id): -# planet = validate_planet(planet_id) - -# return planet.to_dict(), 200 + response_body = new_planet.to_dict() + + return response_body, 201 + +@planets_bp.get("") +def get_all_planets(): + query = db.select(Planet).order_by(Planet.id) + planets = db.session.scalars(query) -# def validate_planet(planet_id): -# try: -# planet_id = int(planet_id) -# except: -# abort(make_response({"message": f"{planet_id} is not a invalid id"}, 400)) + response_body=[] + for planet in planets: + response_body.append(planet.to_dict()) -# for planet in Planets: -# if planet.id == planet_id: -# return planet -# abort(make_response({"msg": "Planet id not found"}, 404)) - + return response_body, 200 + +@planets_bp.get("/") +def get_one_planet(planet_id): + query = db.select(Planet).where(Planet.id == planet_id) + planet = db.session.scalar(query) + + return planet.to_dict(), 200 + + +# Helper Functions + + + From ad1fa323d35e9b0ed9537349798b63d38c380ac1 Mon Sep 17 00:00:00 2001 From: Corntto9 <> Date: Tue, 29 Oct 2024 11:23:12 -0700 Subject: [PATCH 06/11] complete wave 4 --- app/routes/planet_routes.py | 36 +++++++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index bb3793aa3..4c0e764c3 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -1,4 +1,4 @@ -from flask import Blueprint, abort, make_response, request +from flask import Blueprint, abort, make_response, request, Response from app.models.planet import Planet from app.db import db from sqlalchemy import select @@ -33,14 +33,44 @@ def get_all_planets(): @planets_bp.get("/") def get_one_planet(planet_id): - query = db.select(Planet).where(Planet.id == planet_id) - planet = db.session.scalar(query) + planet = validate_planet_id(planet_id) return planet.to_dict(), 200 # Helper Functions +def validate_planet_id(planet_id): + try: + planet_id = int(planet_id) + except: + response = {"msg": f"Planet id {planet_id} is invalid."} + abort(make_response(response,400)) + + query = db.select(Planet).where(Planet.id == planet_id) + planet = db.session.scalar(query) + + if not planet: + response = {"msg": f"Planet id {planet_id} not found."} + abort(make_response(response,404)) + return planet +@planets_bp.put("/") +def update_planet(planet_id): + planet = validate_planet_id(planet_id) + request_body = request.get_json() + + planet.name = request_body['name'] + planet.description = request_body['description'] + db.session.commit() + + return Response(status=204, mimetype="application/json") + +@planets_bp.delete("/") +def delete_planet(planet_id): + planet = validate_planet_id(planet_id) + db.session.delete(planet) + db.session.commit() + return Response(status=204, mimetype="application/json") From 71b77dc9c73e6da12dcb143ff58c19eaaed97840 Mon Sep 17 00:00:00 2001 From: Amber <110812972+Msambere@users.noreply.github.com> Date: Tue, 29 Oct 2024 13:23:55 -0500 Subject: [PATCH 07/11] Move helper function to bottom of file --- app/routes/planet_routes.py | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 4c0e764c3..18db9029a 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -38,22 +38,6 @@ def get_one_planet(planet_id): return planet.to_dict(), 200 -# Helper Functions -def validate_planet_id(planet_id): - try: - planet_id = int(planet_id) - except: - response = {"msg": f"Planet id {planet_id} is invalid."} - abort(make_response(response,400)) - - query = db.select(Planet).where(Planet.id == planet_id) - planet = db.session.scalar(query) - - if not planet: - response = {"msg": f"Planet id {planet_id} not found."} - abort(make_response(response,404)) - - return planet @planets_bp.put("/") def update_planet(planet_id): @@ -74,3 +58,20 @@ def delete_planet(planet_id): return Response(status=204, mimetype="application/json") + +# Helper Functions +def validate_planet_id(planet_id): + try: + planet_id = int(planet_id) + except: + response = {"msg": f"Planet id {planet_id} is invalid."} + abort(make_response(response,400)) + + query = db.select(Planet).where(Planet.id == planet_id) + planet = db.session.scalar(query) + + if not planet: + response = {"msg": f"Planet id {planet_id} not found."} + abort(make_response(response,404)) + + return planet \ No newline at end of file From ca5874be04afb96b93bb316aa5fcfdc67820a05b Mon Sep 17 00:00:00 2001 From: Amber <110812972+Msambere@users.noreply.github.com> Date: Wed, 30 Oct 2024 14:22:35 -0500 Subject: [PATCH 08/11] Complete wave 5 --- app/models/planet.py | 13 +++++++--- app/routes/planet_routes.py | 37 ++++++++++++++++++++++++++-- migrations/versions/dd78a18ec750_.py | 36 +++++++++++++++++++++++++++ seed.py | 23 +++++++++++++++++ 4 files changed, 104 insertions(+), 5 deletions(-) create mode 100644 migrations/versions/dd78a18ec750_.py create mode 100644 seed.py diff --git a/app/models/planet.py b/app/models/planet.py index b6076d75f..94d458b4f 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -4,10 +4,17 @@ class Planet(db.Model): id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) name: Mapped[str] description: Mapped[str] + size: Mapped[str] + moons: Mapped[int] + has_flag: Mapped[bool] + def to_dict(self): return { - "id": self.id, - "name": self.name, - "description": self.description, + "id" : self.id, + "name" : self.name, + "description" : self.description, + "size" : self.size, + "moons" :self.moons, + "has_flag" : self.has_flag } diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 18db9029a..2b667a10b 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -1,7 +1,7 @@ from flask import Blueprint, abort, make_response, request, Response from app.models.planet import Planet from app.db import db -from sqlalchemy import select +from sqlalchemy import select, desc planets_bp = Blueprint("planets_bp", __name__, url_prefix=("/planets")) @@ -22,7 +22,40 @@ def create_planet(): @planets_bp.get("") def get_all_planets(): - query = db.select(Planet).order_by(Planet.id) + all_params = request.args + query = db.select(Planet) + + if all_params.get("name"): + query = query.where(Planet.name.ilike(f"%{all_params.get("name")}%")) + + if all_params.get("description"): + query = query.where(Planet.description.ilike(f"%{all_params.get("description")}%")) + + if all_params.get("size"): + query = query.where(Planet.size.ilike(f"%{all_params.get("size")}%")) + + if all_params.get("moons"): + # query = query.where(Planet.moons == all_params.get("moons")) + query = query.filter(Planet.moons >= all_params.get("moons")) + + if all_params.get("has_flag"): + query =query.where(Planet.has_flag == all_params.get("has_flag")) + + if all_params.get("order"): + attribute = all_params.get("order") + if attribute == "size": + query = query.order_by(Planet.size) + if attribute == "name": + query = query.order_by(Planet.name) + if attribute == "moons": + query = query.order_by(Planet.moons) + if attribute == "has_flag": + query = query.order_by(Planet.has_flag) + if attribute == "description": + query = query.order_by(Planet.description) + else: + query = query.order_by(Planet.id) + planets = db.session.scalars(query) response_body=[] diff --git a/migrations/versions/dd78a18ec750_.py b/migrations/versions/dd78a18ec750_.py new file mode 100644 index 000000000..a353604fd --- /dev/null +++ b/migrations/versions/dd78a18ec750_.py @@ -0,0 +1,36 @@ +"""empty message + +Revision ID: dd78a18ec750 +Revises: cb9e9f40cfb5 +Create Date: 2024-10-30 13:09:41.797436 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'dd78a18ec750' +down_revision = 'cb9e9f40cfb5' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('planet', schema=None) as batch_op: + batch_op.add_column(sa.Column('size', sa.String(), nullable=False)) + batch_op.add_column(sa.Column('moons', sa.Integer(), nullable=False)) + batch_op.add_column(sa.Column('has_flag', sa.Boolean(), nullable=False)) + + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + with op.batch_alter_table('planet', schema=None) as batch_op: + batch_op.drop_column('has_flag') + batch_op.drop_column('moons') + batch_op.drop_column('size') + + # ### end Alembic commands ### diff --git a/seed.py b/seed.py new file mode 100644 index 000000000..464976a98 --- /dev/null +++ b/seed.py @@ -0,0 +1,23 @@ +from app import create_app, db +from app.models.planet import Planet + + +my_app = create_app() +with my_app.app_context(): + db.session.add(Planet(name="Earth", description=" third planet from the sun", size = "medium", moons=1, has_flag=True)) + db.session.add(Planet(name="Jupiter", description="the largest planet", size = "large", moons=4, has_flag=False)) + db.session.add(Planet(name="Mars", description="Red and hot", size = "medium", moons= 2, has_flag=False)) + db.session.add(Planet(name="Mercury", description="closet to the sun", size = "small", moons=0, has_flag=True)) + db.session.add(Planet(name="Venus", description="Hottest planet", size = "small", moons=0, has_flag=False)) + db.session.commit() + + +# | Planet | Description | Size | Moons | Has Flag? | +# |------------|----------------------------------|--------|-------|-----------| +# | Mercury | Closest to the Sun, very hot | Small | 0 | No | +# | Venus | Thick atmosphere, hottest planet | Small | 0 | No | +# | Earth | Home to life, oceans and land | Medium | 1 | Yes | +# | Mars | Known as the Red Planet | Small | 2 | Yes | +# | Jupiter | Largest planet, gas giant | Large | 79 | No | +# | Saturn | Known for its rings | Large | 83 | No | +# | Uranus | Icy gas giant, tilted axis | Large | 27 | No | From 3c14446acae0439aefb9d4ce174550e6f794002f Mon Sep 17 00:00:00 2001 From: Amber <110812972+Msambere@users.noreply.github.com> Date: Wed, 30 Oct 2024 14:37:57 -0500 Subject: [PATCH 09/11] Update seed.py to include all planets --- seed.py | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/seed.py b/seed.py index 464976a98..345ef7d6e 100644 --- a/seed.py +++ b/seed.py @@ -4,20 +4,20 @@ my_app = create_app() with my_app.app_context(): - db.session.add(Planet(name="Earth", description=" third planet from the sun", size = "medium", moons=1, has_flag=True)) - db.session.add(Planet(name="Jupiter", description="the largest planet", size = "large", moons=4, has_flag=False)) - db.session.add(Planet(name="Mars", description="Red and hot", size = "medium", moons= 2, has_flag=False)) - db.session.add(Planet(name="Mercury", description="closet to the sun", size = "small", moons=0, has_flag=True)) + db.session.add(Planet(name="43-HT3", description=" found in neighboring solar system", size = "medium", moons=12, has_flag=False)) + db.session.add(Planet(name="X65", description="Bigger than Jupiter", size = "large", moons=9, has_flag=False)) + db.session.add(Planet(name="33-UV2", description="purple with 3 rings", size = "medium", moons= 0, has_flag=False)) + db.session.add(Planet(name="9ND-87", description="black, almost invisible", size = "small", moons=42, has_flag=False)) + db.session.add(Planet(name="Venus", description="Hottest planet", size = "small", moons=0, has_flag=False)) + db.session.add(Planet(name="Mercury", description="Closest to the Sun, very hot", size="Small", moons=0, has_flag=False)) + db.session.add(Planet(name="Venus", description="Thick atmosphere, hottest planet", size="Small", moons=0, has_flag=False)) + db.session.add(Planet(name="Earth", description="Home to life, oceans and land", size="Medium", moons=1, has_flag=True)) + db.session.add(Planet(name="Mars", description="Known as the Red Planet", size="Small", moons=2, has_flag=True)) + db.session.add(Planet(name="Jupiter", description="Largest planet, gas giant", size="Large", moons=79, has_flag=False)) + db.session.add(Planet(name="Saturn", description="Known for its rings", size="Large", moons=83, has_flag=False)) + db.session.add(Planet(name="Uranus", description="Icy gas giant, tilted axis", size="Large", moons=27, has_flag=False)) db.session.commit() -# | Planet | Description | Size | Moons | Has Flag? | -# |------------|----------------------------------|--------|-------|-----------| -# | Mercury | Closest to the Sun, very hot | Small | 0 | No | -# | Venus | Thick atmosphere, hottest planet | Small | 0 | No | -# | Earth | Home to life, oceans and land | Medium | 1 | Yes | -# | Mars | Known as the Red Planet | Small | 2 | Yes | -# | Jupiter | Largest planet, gas giant | Large | 79 | No | -# | Saturn | Known for its rings | Large | 83 | No | -# | Uranus | Icy gas giant, tilted axis | Large | 27 | No | + From 0c11bce2159f65e9704c12ea7541d88316b6e271 Mon Sep 17 00:00:00 2001 From: Amber <110812972+Msambere@users.noreply.github.com> Date: Wed, 30 Oct 2024 15:05:42 -0500 Subject: [PATCH 10/11] Add order_by functionality --- app/routes/planet_routes.py | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 2b667a10b..9661413b9 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -1,11 +1,22 @@ from flask import Blueprint, abort, make_response, request, Response from app.models.planet import Planet from app.db import db -from sqlalchemy import select, desc +from sqlalchemy import desc planets_bp = Blueprint("planets_bp", __name__, url_prefix=("/planets")) +ORDER_BY_MAP = { +'id': Planet.id, +'name': Planet.name, +'description': Planet.description, +'moons': Planet.moons, +"size": Planet.size, +"has_flag": Planet.has_flag +} + + + @planets_bp.post("") def create_planet(): request_body = request.get_json() @@ -41,20 +52,14 @@ def get_all_planets(): if all_params.get("has_flag"): query =query.where(Planet.has_flag == all_params.get("has_flag")) - if all_params.get("order"): - attribute = all_params.get("order") - if attribute == "size": - query = query.order_by(Planet.size) - if attribute == "name": - query = query.order_by(Planet.name) - if attribute == "moons": - query = query.order_by(Planet.moons) - if attribute == "has_flag": - query = query.order_by(Planet.has_flag) - if attribute == "description": - query = query.order_by(Planet.description) + if all_params.get("order_by"): + attribute = all_params.get("order_by") + if all_params.get("dir") == "desc": + query = query.order_by(desc(ORDER_BY_MAP[attribute])) else: - query = query.order_by(Planet.id) + query = query.order_by(ORDER_BY_MAP[attribute]) + else: + query = query.order_by(Planet.id) planets = db.session.scalars(query) @@ -64,6 +69,9 @@ def get_all_planets(): return response_body, 200 +# all of the query param logic needs validation + + @planets_bp.get("/") def get_one_planet(planet_id): planet = validate_planet_id(planet_id) From cfabdda2e7a1ec4dc367b0353493570628162c5d Mon Sep 17 00:00:00 2001 From: Amber <110812972+Msambere@users.noreply.github.com> Date: Thu, 31 Oct 2024 14:12:39 -0500 Subject: [PATCH 11/11] Complete wave 6 --- app/__init__.py | 10 +-- app/routes/planet_routes.py | 5 +- tests/__init__.py | 0 tests/conftest.py | 45 ++++++++++++ tests/test_planet_routes.py | 134 ++++++++++++++++++++++++++++++++++++ 5 files changed, 189 insertions(+), 5 deletions(-) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_planet_routes.py diff --git a/app/__init__.py b/app/__init__.py index 3ae8198b9..b354db35a 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -2,16 +2,18 @@ from .db import db, migrate from .models.planet import Planet from app.routes.planet_routes import planets_bp +import os -def create_app(test_config=None): +def create_app(config=None): app = Flask(__name__) app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False - app.config["SQLALCHEMY_DATABASE_URI"] = ( - "postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development" - ) + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get('SQLALCHEMY_DATABASE_URI') + if config: + app.config.update(config) + db.init_app(app) migrate.init_app(app, db) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 9661413b9..234f72cad 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -22,8 +22,11 @@ def create_planet(): request_body = request.get_json() name = request_body['name'] description = request_body['description'] + size = request_body['size'] + moons = request_body['moons'] + has_flag = request_body['has_flag'] - new_planet = Planet(name=name, description=description) + new_planet = Planet(name=name, description=description, size = size, moons = moons, has_flag = has_flag) db.session.add(new_planet) db.session.commit() 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..5c5c8a7d4 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,45 @@ +import pytest +from app import create_app +from app.db import db +from flask.signals import request_finished +from dotenv import load_dotenv +import os +from app.models.planet import Planet + +load_dotenv() + +@pytest.fixture +def app(): + test_config = { + "TESTING": True, + "SQLALCHEMY_DATABASE_URI": os.environ.get('SQLALCHEMY_TEST_DATABASE_URI') + } + app = create_app(test_config) + + @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 saved_all_planets(): + db.session.add(Planet(name="Venus", description="Hottest planet", size = "small", moons=0, has_flag=False)) + db.session.add(Planet(name="Mercury", description="Closest to the Sun, very hot", size="Small", moons=0, has_flag=False)) + db.session.add(Planet(name="Venus", description="Thick atmosphere, hottest planet", size="Small", moons=0, has_flag=False)) + db.session.add(Planet(name="Earth", description="Home to life, oceans and land", size="Medium", moons=1, has_flag=True)) + db.session.add(Planet(name="Mars", description="Known as the Red Planet", size="Small", moons=2, has_flag=True)) + db.session.add(Planet(name="Jupiter", description="Largest planet, gas giant", size="Large", moons=79, has_flag=False)) + db.session.add(Planet(name="Saturn", description="Known for its rings", size="Large", moons=83, has_flag=False)) + db.session.add(Planet(name="Uranus", description="Icy gas giant, tilted axis", size="Large", moons=27, has_flag=False)) + db.session.commit() \ No newline at end of file diff --git a/tests/test_planet_routes.py b/tests/test_planet_routes.py new file mode 100644 index 000000000..8978fffb6 --- /dev/null +++ b/tests/test_planet_routes.py @@ -0,0 +1,134 @@ +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_all_planets(client, saved_all_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [ { + "description": "Hottest planet", + "has_flag": False, + "id": 1, + "moons": 0, + "name": "Venus", + "size": "small" + }, + { + "description": "Closest to the Sun, very hot", + "has_flag": False, + "id": 2, + "moons": 0, + "name": "Mercury", + "size": "Small" + }, + { + "description": "Thick atmosphere, hottest planet", + "has_flag": False, + "id": 3, + "moons": 0, + "name": "Venus", + "size": "Small" + }, + { + "description": "Home to life, oceans and land", + "has_flag": True, + "id": 4, + "moons": 1, + "name": "Earth", + "size": "Medium" + }, + { + "description": "Known as the Red Planet", + "has_flag": True, + "id": 5, + "moons": 2, + "name": "Mars", + "size": "Small" + }, + { + "description": "Largest planet, gas giant", + "has_flag": False, + "id": 6, + "moons": 79, + "name": "Jupiter", + "size": "Large" + }, + { + "description": "Known for its rings", + "has_flag": False, + "id": 7, + "moons": 83, + "name": "Saturn", + "size": "Large" + }, + { + "description": "Icy gas giant, tilted axis", + "has_flag": False, + "id": 8, + "moons": 27, + "name": "Uranus", + "size": "Large" + } + ] + +def test_get_one_planet_with_records(client, saved_all_planets): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "description": "Hottest planet", + "has_flag": False, + "id": 1, + "moons": 0, + "name": "Venus", + "size": "small" + } + +def test_get_one_planet_with_no_records(client): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"msg": "Planet id 1 not found."} + +def test_get_one_planet_with_no_matching_id(client, saved_all_planets): + # Act + response = client.get("/planets/125") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"msg": "Planet id 125 not found."} + +def test_create_planet_with_valid_data(client): + # Act + response = client.post("/planets", json={"name":"9ND-87", "description":"black, almost invisible", "size":"small", "moons":42, "has_flag":False}) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == { + "id":1, + "name":"9ND-87", + "description":"black, almost invisible", + "size":"small", + "moons":42, + "has_flag":False + } + + +