diff --git a/README.md b/README.md index f9d17f77c..729b29454 100644 --- a/README.md +++ b/README.md @@ -56,4 +56,4 @@ For Waves 04, 05, and 06, the new driver may need to setup or update their datab 1. Activate the virtual environment 1. Create the database `solar_system_development` 1. Run `flask db upgrade` -1. Run `flask run` to confirm that the API is running as expected +1. Run `flask run` to confirm that the API is running as expected \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..9bc4954fb 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,20 @@ from flask import Flask +from .db import db, migrate +from .models import planet +from .routes.routes import solar_system_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'] = os.environ.get('SQLALCHEMY_DATABASE_URI') + + if config: + app.config.update(config) + db.init_app(app) + migrate.init_app(app, db) + + app.register_blueprint(solar_system_bp) + return app 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/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb 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 new file mode 100644 index 000000000..8563ac547 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,26 @@ +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] + flag:Mapped[bool] + +# class Planet: +# def __init__(self, id, name, description, flag= False): +# self.id = id +# self.name = name +# self.description = description +# self.flag = flag + +# planets = [ +# Planet(1, "Mercury", "The smallest planet in our solar system.", False), +# Planet(2, "Venus", "The hottest planet in the solar system.", False), +# Planet(3, "Earth", "The only planet known to support life.", True ), +# Planet(4, "Mars", "Known as the Red Planet.", True ), +# Planet(5, "Jupiter", "The largest planet in our solar system.", False), +# Planet(6, "Saturn", "Famous for its ring system.", False), +# Planet(7, "Uranus", "An ice giant with a unique tilt.", False), +# Planet(8, "Neptune", "The farthest planet from the Sun.", False) +# ] \ No newline at end of file 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/routes.py b/app/routes/routes.py new file mode 100644 index 000000000..28053e1db --- /dev/null +++ b/app/routes/routes.py @@ -0,0 +1,148 @@ +from flask import Blueprint, abort, make_response, request, Response +from ..models.planet import Planet +from ..db import db + +solar_system_bp = Blueprint("solar_system_bp", __name__, url_prefix="/planets") + +@solar_system_bp.post("") +def create_planet(): + request_body = request.get_json() + name = request_body["name"] + description = request_body["description"] + flag = request_body["flag"] + + new_planet = Planet(name=name, description=description, flag=flag) + db.session.add(new_planet) + db.session.commit() + + response = { + "id": new_planet.id, + "name": new_planet.name, + "description": new_planet.description, + "flag": new_planet.flag + } + return response, 201 + +@solar_system_bp.get("") +def get_all_planets(): + query = db.select(Planet) + + description_param = request.args.get("description") + if description_param: + query = query.where(Planet.description.ilike(f"%{description_param}%")) + + + flag_param = request.args.get("flag") + if flag_param is not None: + # Convert flag_param to a boolean + flag_value = flag_param.lower() == "true" + query = query.where(Planet.flag == flag_value) + + sort_param = request.args.get("sort") + if sort_param == "name": + query = query.order_by(Planet.name) + elif sort_param == "description": + query = query.order_by(Planet.description) + elif sort_param == "flag": + query = query.order_by(Planet.flag) + else: + # Default sorting by id + query = query.order_by(Planet.id) + + planets = db.session.scalars(query.order_by(Planet.id)) + + planet_response = [] + for planet in planets: + planet_response.append( + { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "flag": planet.flag + } + ) + return planet_response + +@solar_system_bp.get("/") +def get_one_planet(planet_id): + planet = validate_planet(planet_id) + + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "flag": planet.flag + } + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + response = {"message": f"planet {planet_id} invalid"} + abort(make_response(response , 400)) + + query = db.select(Planet).where(Planet.id == planet_id) + planet = db.session.scalar(query) + + if not planet: + response = {"message": f"planet {planet_id} not found"} + abort(make_response(response, 404)) + return planet + +@solar_system_bp.put("/") +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + planet.name= request_body["name"] + planet.description = request_body["description"] + planet.flag = request_body["flag"] + db.session.commit() + + return Response(status=204, mimetype="application/json") + +@solar_system_bp.delete("/") +def delete_planet(planet_id): + planet = validate_planet(planet_id) + db.session.delete(planet) + db.session.commit() + + return Response(status=204, mimetype="application/json") + +# @solar_system_bp.get("") +# def get_all_planets(): +# results_list = [] +# for planet in planets: +# results_list.append(dict( +# id=planet.id, +# name=planet.name, +# description=planet.description, +# flag=planet.flag +# )) + +# return results_list + +# @solar_system_bp.get("/") +# def get_one_planet(planet_id): +# planet = validate_planet(planet_id) + +# return{ +# "id":planet.id, +# "name":planet.name, +# "description":planet.description, +# "flag":planet.flag +# } + +# def validate_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# response = {"message": f"planet {planet_id} invalid"} +# abort(make_response(response, 400)) + +# for planet in planets: +# if planet.id == planet_id: +# return planet + +# response = {"message": f"planet {planet_id} not found"} +# abort(make_response(response, 404)) \ No newline at end of file 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/9029d5f3c613_adds_planet_model.py b/migrations/versions/9029d5f3c613_adds_planet_model.py new file mode 100644 index 000000000..2e9f9df9d --- /dev/null +++ b/migrations/versions/9029d5f3c613_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: 9029d5f3c613 +Revises: +Create Date: 2024-10-26 21:53:24.916232 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '9029d5f3c613' +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('flag', sa.Boolean(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt index 24c7e56f8..b87519d9e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,17 +1,21 @@ alembic==1.13.1 autopep8==1.5.5 -blinker==1.7 +blinker==1.7.0 certifi==2020.12.5 chardet==4.0.0 click==8.1.7 +coverage==7.6.3 Flask==3.0.2 Flask-Migrate==4.0.5 Flask-SQLAlchemy==3.1.1 idna==2.10 +iniconfig==2.0.0 itsdangerous==2.1.2 Jinja2==3.1.3 Mako==1.1.4 MarkupSafe==2.1.5 +packaging==24.1 +pluggy==1.5.0 psycopg2-binary==2.9.9 pycodestyle==2.6.0 pytest==8.0.0 @@ -23,5 +27,6 @@ requests==2.25.1 six==1.15.0 SQLAlchemy==2.0.25 toml==0.10.2 +typing_extensions==4.12.2 urllib3==1.26.4 -Werkzeug==3.0.1 \ No newline at end of file +Werkzeug==3.0.1 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..8f0132118 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,41 @@ +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_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 two_saved_planets(app): + planet_1 = Planet(name="Mercury", description="First planet", flag=False) + planet_2 = Planet(name="Venus", description="Second planet", flag=False) + + db.session.add_all([planet_1, planet_2]) + + db.session.commit() \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..48887b2a9 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,45 @@ +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_planet_by_id_returns_404(client): + response = client.get("/planets/1") + assert response.status_code == 404 + +def test_get_one_book_succeeds(client, two_saved_planets): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Mercury", + "description": "First planet", + "flag": False + } + +def test_create_one_book(client): + # Act + response = client.post("/planets", json={ + "name": "Mercury", + "description": "First planet", + "flag": False + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == { + "id": 1, + "name": "Mercury", + "description": "First planet", + "flag": False + } \ No newline at end of file