diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..4902ed5cf 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,23 @@ from flask import Flask +from .routes.planet_routes import planets_bp +from .db import db, migrate +from .models import planet +import os - -def create_app(test_config=None): +def create_app(config=None): + # __name__ stores the name of the module we're in 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..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..a99d81f21 --- /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..c3ae76188 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,16 @@ +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] + size_dia_km: Mapped[int] + + def to_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + size_dia_km=self.size_dia_km + ) 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..7842e02ae --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,89 @@ +from flask import Blueprint, abort, make_response, request, Response +from app.models.planet import Planet +from ..db import db + +# created blueprint +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +@planets_bp.post("") +def create_planet(): + request_body = request.get_json() + name = request_body["name"] + description= request_body["description"] + size_dia_km = request_body["size_dia_km"] + + new_planet = Planet(name=name, description=description, size_dia_km=size_dia_km) + db.session.add(new_planet) + db.session.commit() + + response = new_planet.to_dict() + return response, 201 + +@planets_bp.get("") +def get_all_planets(): + + query = db.select(Planet) + + name_param = request.args.get("name") + if name_param: + query = db.select(Planet).where(Planet.name == name_param) + + description_param = request.args.get("description") + if description_param: + query = query.where(Planet.description.ilike(f"%{description_param}%")) + + size_param = request.args.get("size_dia_km") + if size_param: + query = query.where(Planet.size_dia_km.ilike(f"%{size_param}%")) + + + query = query.order_by(Planet.id) + planets = db.session.scalars(query) + + planets_response = [planet.to_dict() for planet in planets] + return planets_response + + + +@planets_bp.get("/") +def get_single_planet(planet_id): + planet = validate_planet(planet_id) + + return planet.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.size_dia_km = request_body["size_dia_km"] + + db.session.commit() + + return Response(status=204, mimetype="application/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="application/json") + + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + + except ValueError: + abort(make_response({"message": f"planet {planet_id} is an invalid ID"}, 400)) + + query = db.select(Planet).where(Planet.id == planet_id) + planet = db.session.scalar(query) + + if not planet: + abort(make_response({"message": f"planet {planet_id} not found"}, 404)) + + return planet \ 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/a90a9f8f5398_adds_planet_model.py b/migrations/versions/a90a9f8f5398_adds_planet_model.py new file mode 100644 index 000000000..3e1e6de46 --- /dev/null +++ b/migrations/versions/a90a9f8f5398_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet Model + +Revision ID: a90a9f8f5398 +Revises: +Create Date: 2024-10-25 14:45:51.663314 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'a90a9f8f5398' +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('size', 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 ### diff --git a/project-directions/wave_03.md b/project-directions/wave_03.md index f4128d650..378ec25ee 100644 --- a/project-directions/wave_03.md +++ b/project-directions/wave_03.md @@ -4,10 +4,10 @@ Complete the following setup steps of the Solar System API repo: 1. Activate the virtual environment -1. Create the database `solar_system_development` + 1. Create the database `solar_system_development` * *Every member of the group must create the database on their computer* -1. Setup the `Planet` model with the attributes `id`, `name`, and `description`, and one additional attribute -1. Create a migration to add a table for the `Planet` model and then apply it. +2. Setup the `Planet` model with the attributes `id`, `name`, and `description`, and one additional attribute +3. Create a migration to add a table for the `Planet` model and then apply it. * *Confirm that the `planet` table has been created as expected in postgres*. ## RESTful Endpoints: Create and Read diff --git a/project-directions/wave_05.md b/project-directions/wave_05.md index fdabe6421..f7c5f6d55 100644 --- a/project-directions/wave_05.md +++ b/project-directions/wave_05.md @@ -11,4 +11,4 @@ As a client, I want to send a request... I should be able to combine the effects of the two filters in order to filter results by multiple properties at once. -If time allows, consider adding a non-filter query parameter, such as sorting by a specific attribute. Remember that sorting can be done by the database, so try not to sort the results in your application code. \ No newline at end of file +If time allows, consider adding a non-filter query parameter, such as sorting by a specific attribute. Remember that sorting can be done by the database, so try not to sort the results in your application code. 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..32e805697 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,43 @@ +import pytest +from app import create_app +from app.db import db +from flask.signals import request_finished +from dotenv import load_dotenv +from app.models.planet import Planet +import os + + +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 three_saved_planets(app): + planet1 = Planet(name="some_planet", description="rocky, no signs of life", size_dia_km=100) + planet2 = Planet(name="Earth", description="with lifeforms, water and land", size_dia_km=5000) + planet3 = Planet(name="Pluto", description="still a planet", size_dia_km=200) + + db.session.add_all([planet1, planet2, planet3]) + 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..44217b192 --- /dev/null +++ b/tests/test_planet_routes.py @@ -0,0 +1,72 @@ + + +def test_get_planets(client): + response = client.get("/planets") + response_body = response.get_json() + + # assert + assert response.status_code == 200 + assert response_body == [] + + + +def test_get_single_planet(client, three_saved_planets): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "some_planet", + "description": "rocky, no signs of life", + "size_dia_km": 100 + } + +def test_get_single_planet_no_records(client): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + +def test_get_all_planets(client, three_saved_planets): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{ + "id": 1, + "name": "some_planet", + "description": "rocky, no signs of life", + "size_dia_km": 100 + }, + { + "id": 2, + "name": "Earth", + "description": "with lifeforms, water and land", + "size_dia_km": 5000 + }, + { + "id": 3, + "name": "Pluto", + "description": "still a planet", + "size_dia_km": 200 + }, + ] + +def test_create_new_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Venus", + "description": "closest to the Earth", + "size_dia_km": 1244 + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == { + "id": 1, + "name": "Venus", + "description": "closest to the Earth", + "size_dia_km": 1244 + } \ No newline at end of file