diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..d8870145b 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,21 @@ from flask import Flask +from app.db import db, migrate +from app.routes.planet_routes import planets_bp +from app.models import planet +import os - -def create_app(test_config=None): +def create_app(config=None): app = Flask(__name__) - return app + 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(planets_bp) + + return app \ No newline at end of file diff --git a/app/db.py b/app/db.py new file mode 100644 index 000000000..24dc45f31 --- /dev/null +++ b/app/db.py @@ -0,0 +1,6 @@ +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from app.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..f75ec448b --- /dev/null +++ b/app/models/base.py @@ -0,0 +1,4 @@ +from sqlalchemy.orm import DeclarativeBase + +class Base(DeclarativeBase): + pass diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..ac2a81a64 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,17 @@ +from sqlalchemy.orm import Mapped, mapped_column +from app.db import db +from constants import ID, NAME, DESCRIPTION, NUMBER_OF_MOONS + +class Planet(db.Model): + id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + name: Mapped[str] + description: Mapped[str] + number_of_moons: Mapped[int] + + def to_dict(self): + return { + ID: self.id, + NAME: self.name, + DESCRIPTION: self.description, + NUMBER_OF_MOONS: self.number_of_moons + } \ 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/planet_routes.py b/app/routes/planet_routes.py new file mode 100644 index 000000000..cca1121a3 --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,117 @@ +from flask import Blueprint, abort, make_response, request, Response +from app.db import db +from app.models.planet import Planet +from constants import ID, NAME, DESCRIPTION, NUMBER_OF_MOONS, ORDER_BY, MESSAGE, MIMETYPE_JSON, INVALID, NOT_FOUND + +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +@planets_bp.post("") +def create_planet(): + request_body = request.get_json() + + new_planet = Planet( + name=request_body[NAME], + description=request_body[DESCRIPTION], + number_of_moons=request_body[NUMBER_OF_MOONS] + ) + + db.session.add(new_planet) + db.session.commit() + + return new_planet.to_dict(), 201 + +@planets_bp.get("") +def get_all_planets(): + query_params = get_query_params() + query = db.select(Planet) + query = filter_query(query, query_params) + query = get_order_by_param(query) + + planets = db.session.scalars(query) + + return [planet.to_dict() for planet in planets] + +@planets_bp.get("/") +def get_one_planet(planet_id): + return validate_planet(planet_id).to_dict() + +@planets_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.number_of_moons = request_body[NUMBER_OF_MOONS] + + db.session.commit() + + return Response(status=204, mimetype=MIMETYPE_JSON) + +@planets_bp.delete("/") +def delete_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return Response(status=204, mimetype=MIMETYPE_JSON) + +def filter_query(query, params): + if params[ID]: + query = query.where(Planet.id == validate_cast_type(params[ID], int, ID)) + + if params[NAME]: + query = query.where(Planet.name == params[NAME]) + + if params[DESCRIPTION]: + query = query.where(Planet.description.ilike(f"%{params[DESCRIPTION]}%")) + + if params[NUMBER_OF_MOONS]: + query = query.where(Planet.number_of_moons == validate_cast_type( + params[NUMBER_OF_MOONS], int, NUMBER_OF_MOONS)) + + return query + +def get_query_params(): + return { + ID: request.args.get(ID), + NAME: request.args.get(NAME), + DESCRIPTION: request.args.get(DESCRIPTION), + NUMBER_OF_MOONS: request.args.get(NUMBER_OF_MOONS) + } + +def get_order_by_param(query): + order_by_param = request.args.get(ORDER_BY) + if order_by_param: + query = validate_order_by_param(query, order_by_param) + else: + query = query.order_by(Planet.id) + + return query + +def validate_cast_type(value, target_type, param_name): + try: + return target_type(value) + except (ValueError, TypeError): + abort(make_response({MESSAGE: f"{param_name} '{value}' {INVALID}"}, 400)) + +def validate_order_by_param(query, order_by_param): + try: + return query.order_by(getattr(Planet, order_by_param)) + except AttributeError: + abort(make_response({MESSAGE: f"{ORDER_BY} '{order_by_param}' {INVALID}"}, 400)) + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except ValueError: + abort(make_response({MESSAGE: f"{ID} {planet_id} {INVALID}"}, 400)) + + query = db.select(Planet).where(Planet.id == planet_id) + planet = db.session.scalar(query) + + if not planet: + abort(make_response({MESSAGE: f"{ID} {planet_id} {NOT_FOUND}"}, 404)) + + return planet \ No newline at end of file diff --git a/constants.py b/constants.py new file mode 100644 index 000000000..84d25d68d --- /dev/null +++ b/constants.py @@ -0,0 +1,19 @@ +''' +Constants for the Solar System API +''' + +# Keys +MESSAGE = "message" +ID = "id" +NAME = "name" +DESCRIPTION = "description" +NUMBER_OF_MOONS = "number_of_moons" +FIELDS = "fields" +ORDER_BY = "order_by" + +# MIME Types +MIMETYPE_JSON = "application/json" + +# Error messages +NOT_FOUND = "not found" +INVALID = "invalid" \ 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/6e0689b72307_add_planets_class.py b/migrations/versions/6e0689b72307_add_planets_class.py new file mode 100644 index 000000000..f351f7648 --- /dev/null +++ b/migrations/versions/6e0689b72307_add_planets_class.py @@ -0,0 +1,34 @@ +"""Add planets class + +Revision ID: 6e0689b72307 +Revises: +Create Date: 2024-10-25 15:17:01.101835 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '6e0689b72307' +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('number_of_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 ### diff --git a/requirements.txt b/requirements.txt index 24c7e56f8..4eb8d9cb2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,6 +7,7 @@ click==8.1.7 Flask==3.0.2 Flask-Migrate==4.0.5 Flask-SQLAlchemy==3.1.1 +gunicorn==23.0.0 idna==2.10 itsdangerous==2.1.2 Jinja2==3.1.3 diff --git a/seed.py b/seed.py new file mode 100644 index 000000000..66ce474d9 --- /dev/null +++ b/seed.py @@ -0,0 +1,19 @@ +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="Mercury", description="The intelligent strategist, known for her analytical skills and love of books.", number_of_moons=0)), + db.session.add(Planet(name="Venus", description="The charming beauty who believes in love, often the peacemaker among her friends.", number_of_moons=0)), + db.session.add(Planet(name="Earth", description="The cheerful leader who fights for love and justice, often clumsy but always brave.", number_of_moons=1)), + db.session.add(Planet(name="Mars", description="The passionate warrior with a strong sense of justice and a fiery spirit.", number_of_moons=2)), + db.session.add(Planet(name="Jupiter", description="The tough protector with a big heart, skilled in combat and cooking.", number_of_moons=95)), + db.session.add(Planet(name="Saturn", description="The mysterious guardian with powerful abilities, often associated with destruction and rebirth.", number_of_moons=83)), + db.session.add(Planet(name="Uranus", description="The confident and adventurous rebel, known for her speed and agility.", number_of_moons=27)), + db.session.add(Planet(name="Neptune", description="The elegant and artistic fighter, with a deep connection to the ocean and intuition.", number_of_moons=14)), + db.session.add(Planet(name="Pluto", description="The wise time guardian, responsible for protecting the gates of time and space.", number_of_moons=5)), + db.session.add(Planet(name="Eris", description="The energetic and playful guardian, spreading warmth and positivity wherever she goes.", number_of_moons=1)), + db.session.add(Planet(name="Haumea", description="The strategic thinker who uses her intelligence to solve problems and protect her friends.", number_of_moons=2)), + db.session.add(Planet(name="Makemake", description="The fierce protector with strong instincts, known for her loyalty and bravery.", number_of_moons=1)), + db.session.add(Planet(name="Ceres", description="The nurturing spirit who brings harmony and balance, always caring for her friends.", number_of_moons=0)), + db.session.commit() \ No newline at end of file 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..55570ba3e --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,44 @@ +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 two_saved_planets(app): + pluto = Planet(name="Pluto", + description="The wise time guardian, responsible for protecting the gates of time and space.", + number_of_moons=5) + mercury = Planet(name="Mercury", + description="The intelligent strategist, known for her analytical skills and love of books.", + number_of_moons=0) + + db.session.add_all([pluto, mercury]) + 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..0b3972233 --- /dev/null +++ b/tests/test_planet_routes.py @@ -0,0 +1,61 @@ +def test_get_all_planets_with_no_records(client): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] + +def test_get_one_planet_found(client, two_saved_planets): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Pluto", + "description": "The wise time guardian, responsible for protecting the gates of time and space.", + "number_of_moons": 5 + } + +def test_get_one_planet_not_found(client): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + assert response_body == {"message": "id 1 not found"} + +def test_get_all_planets_succeeds_with_records(client, two_saved_planets): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [ + { + "id": 1, + "name": "Pluto", + "description": "The wise time guardian, responsible for protecting the gates of time and space.", + "number_of_moons": 5 + }, + { + "id": 2, + "name": "Mercury", + "description": "The intelligent strategist, known for her analytical skills and love of books.", + "number_of_moons": 0 + } + ] + +def test_create_one_planet(client): + response = client.post("/planets", json={ + "name": "Ceres", + "description": "The nurturing spirit who brings harmony and balance, always caring for her friends.", + "number_of_moons": 0 + }) + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == { + "id": 1, + "name": "Ceres", + "description": "The nurturing spirit who brings harmony and balance, always caring for her friends.", + "number_of_moons": 0 + } \ No newline at end of file