diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..6bb0a32f0 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,21 @@ from flask import Flask +from .db import db, migrate +from .models import planet +from .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'] = 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 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..dd7cf4bf1 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,30 @@ +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] + surface_area: Mapped[int] + moons: Mapped[int] + distance_from_sun: Mapped[int] + namesake: Mapped[str] + + def to_dict(self): + return dict( + id=self.id, + name=self.name, + surface_area=self.surface_area, + moons=self.moons, + distance_from_sun=self.distance_from_sun, + namesake=self.namesake + ) + + @classmethod + def from_dict(cls, planet_data): + return cls( + name=planet_data["name"], + surface_area=planet_data["surface_area"], + moons=planet_data["moons"], + distance_from_sun=planet_data["distance_from_sun"], + namesake=planet_data["namesake"] + ) 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..ecc8b38e9 --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,80 @@ +from flask import Blueprint, abort, make_response, request, Response +from ..models.planet import Planet +from ..db import db +from sqlalchemy import asc, desc +from .routes_utilities import validate_model + +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +@planets_bp.post("") +def create_planet(): + request_body = request.get_json() + + try: + new_planet = Planet.from_dict(request_body) + except KeyError as e: + response = { + "message": f"Invalid request: missing {e.args[0]}" + } + abort(make_response(response, 400)) + db.session.add(new_planet) + db.session.commit() + + response = new_planet.to_dict() + return response, 201 + +@planets_bp.get("") +def get_all_planets(): + sort_param = request.args.get("sort") + order_param = request.args.get("order", "asc") # Default to ascending if not specified + + query = db.select(Planet) + + if sort_param: + sort_column = getattr(Planet, sort_param, None) + if sort_column: + query = query.order_by(asc(sort_column) if order_param == "asc" else desc(sort_column)) + + namesake_param = request.args.get("namesake") + if namesake_param: + query = query.where(Planet.namesake.ilike(f"%{namesake_param}%")) + + distance_from_sun_param = request.args.get("distance_from_sun") + if distance_from_sun_param: + query = query.where(Planet.distance_from_sun <= distance_from_sun_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_one_planet(planet_id): + planet = validate_model(Planet, planet_id) + planet_response = planet.to_dict() + return planet_response + +@planets_bp.put("/") +def update_one_planet(planet_id): + planet = validate_model(Planet, planet_id) + response_body = request.get_json() + + planet.name = response_body["name"] + planet.surface_area = response_body["surface_area"] + planet.moons = response_body["moons"] + planet.distance_from_sun = response_body["distance_from_sun"] + planet.namesake = response_body["namesake"] + + db.session.commit() + + return Response(status=204, mimetype="application/json") + +@planets_bp.delete("/") +def delete_one_planet(planet_id): + planet = validate_model(Planet, planet_id) + + db.session.delete(planet) + db.session.commit() + + return Response(status=204, mimetype="application/json") diff --git a/app/routes/routes_utilities.py b/app/routes/routes_utilities.py new file mode 100644 index 000000000..e38e126a8 --- /dev/null +++ b/app/routes/routes_utilities.py @@ -0,0 +1,16 @@ +from flask import abort, make_response +from ..db import db + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except ValueError: + abort(make_response({"message": f"{cls.__name__} with {model_id} is invalid"}, 400)) + + query = db.select(cls).where(cls.id == model_id) + model = db.session.scalar(query) + + if not model: + abort(make_response({"message": f"{cls.__name__} with {model_id} is not found"}, 404)) + + return model \ No newline at end of file diff --git a/coworking_agreement.md b/coworking_agreement.md index 463598c27..de9e4eb49 100644 --- a/coworking_agreement.md +++ b/coworking_agreement.md @@ -21,5 +21,5 @@ Talk through each section with your partner. Add notes on what you discussed and *Other co-working agreements that were not captured in the above sections.* ## Signatures -______________ _______________ -Date: _________ +Kristina Nguyen _______________ +Date: 10/21/2024 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/0feb668fd495_fixed_planet_model.py b/migrations/versions/0feb668fd495_fixed_planet_model.py new file mode 100644 index 000000000..f99278e82 --- /dev/null +++ b/migrations/versions/0feb668fd495_fixed_planet_model.py @@ -0,0 +1,40 @@ +"""fixed Planet model + +Revision ID: 0feb668fd495 +Revises: cb8050f41f95 +Create Date: 2024-10-25 12:07:03.022027 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '0feb668fd495' +down_revision = 'cb8050f41f95' +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('name', sa.String(), nullable=False)) + batch_op.add_column(sa.Column('surface_area', sa.Integer(), nullable=False)) + batch_op.add_column(sa.Column('moons', sa.Integer(), nullable=False)) + batch_op.add_column(sa.Column('distance_from_sun', sa.Integer(), nullable=False)) + batch_op.add_column(sa.Column('namesake', sa.String(), 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('namesake') + batch_op.drop_column('distance_from_sun') + batch_op.drop_column('moons') + batch_op.drop_column('surface_area') + batch_op.drop_column('name') + + # ### end Alembic commands ### diff --git a/migrations/versions/cb8050f41f95_adds_planet_model.py b/migrations/versions/cb8050f41f95_adds_planet_model.py new file mode 100644 index 000000000..c7a7e4465 --- /dev/null +++ b/migrations/versions/cb8050f41f95_adds_planet_model.py @@ -0,0 +1,31 @@ +"""adds Planet model + +Revision ID: cb8050f41f95 +Revises: +Create Date: 2024-10-25 12:03:43.298847 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'cb8050f41f95' +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.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_01.md b/project-directions/wave_01.md index a07cc6548..8fbb71a03 100644 --- a/project-directions/wave_01.md +++ b/project-directions/wave_01.md @@ -14,3 +14,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`. + diff --git a/requirements.txt b/requirements.txt index 24c7e56f8..42c0de760 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,27 +1,31 @@ alembic==1.13.1 -autopep8==1.5.5 -blinker==1.7 -certifi==2020.12.5 -chardet==4.0.0 +blinker==1.7.0 +certifi==2024.8.30 +charset-normalizer==3.3.2 click==8.1.7 +exceptiongroup==1.2.2 Flask==3.0.2 Flask-Migrate==4.0.5 Flask-SQLAlchemy==3.1.1 -idna==2.10 +greenlet==3.0.3 +gunicorn==21.2.0 +idna==3.10 +importlib_metadata==8.5.0 +iniconfig==2.0.0 itsdangerous==2.1.2 Jinja2==3.1.3 -Mako==1.1.4 +Mako==1.3.2 MarkupSafe==2.1.5 +packaging==23.2 +pluggy==1.4.0 psycopg2-binary==2.9.9 -pycodestyle==2.6.0 pytest==8.0.0 -pytest-cov==2.12.1 -python-dateutil==2.8.1 python-dotenv==1.0.1 -python-editor==1.0.4 -requests==2.25.1 -six==1.15.0 +requests==2.32.3 +slack_sdk==3.33.3 SQLAlchemy==2.0.25 -toml==0.10.2 -urllib3==1.26.4 -Werkzeug==3.0.1 \ No newline at end of file +tomli==2.0.2 +typing_extensions==4.9.0 +urllib3==2.2.3 +Werkzeug==3.0.1 +zipp==3.20.2 diff --git a/seed.py b/seed.py new file mode 100644 index 000000000..cc8025a57 --- /dev/null +++ b/seed.py @@ -0,0 +1,14 @@ +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',surface_area=28880,moons=0,distance_from_sun=35980,namesake='Roman god of travelers, aka Hermes.')), + db.session.add(Planet(name='Venus',surface_area=177700,moons=0,distance_from_sun=67240,namesake='Roman goddess of love, aka Aphrodite.')), + db.session.add(Planet(name='Earth',surface_area=196900,moons=1,distance_from_sun=92960,namesake='A variation on the word "ground" in several languages.')), + db.session.add(Planet(name='Mars',surface_area=55910,moons=2,distance_from_sun=141600,namesake='Roman god of war, aka Ares.')), + db.session.add(Planet(name='Jupiter',surface_area=23710000,moons=79,distance_from_sun=483300,namesake='King of the Roman gods, aka Zeus.')), + db.session.add(Planet(name='Saturn',surface_area=16490000,moons=62,distance_from_sun=890700,namesake='Jupiter''s father and titan, aka Chronos.')), + db.session.add(Planet(name='Uranus',surface_area=3121000,moons=27,distance_from_sun=1787000,namesake='Greek personification of the sky or heavens, aka Caelus.')), + db.session.add(Planet(name='Neptune',surface_area=2941000,moons=14,distance_from_sun=2798000,namesake='Roman god of the sea, aka Poseidon.')) + 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..132fd365a --- /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_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(): + # Arrange + planet_1 = Planet(name='Mercury',surface_area=28880,moons=0,distance_from_sun=35980,namesake='Roman god of travelers, aka Hermes.') + planet_2 = Planet(name='Venus',surface_area=177700,moons=0,distance_from_sun=67240,namesake='Roman goddess of love, aka Aphrodite.') + + db.session.add_all([planet_1, planet_2]) + db.session.commit() diff --git a/tests/test_planet_routes.py b/tests/test_planet_routes.py new file mode 100644 index 000000000..9cf007ad5 --- /dev/null +++ b/tests/test_planet_routes.py @@ -0,0 +1,69 @@ +def test_get_all_planets_with_no_records(client): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_one_planet(client, 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", + "moons": 0, + "surface_area": 28880, + "distance_from_sun": 35980, + "namesake": "Roman god of travelers, aka Hermes." + } + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Mercury", + "moons": 0, + "surface_area": 28880, + "distance_from_sun": 35980, + "namesake": "Roman god of travelers, aka Hermes." + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == { + "id": 1, + "name": "Mercury", + "moons": 0, + "surface_area": 28880, + "distance_from_sun": 35980, + "namesake": "Roman god of travelers, aka Hermes." + } + +def test_create_one_planet_with_two_planets_in_database(client, two_saved_planets): + # Act + response = client.post("/planets", json={ + "name": "Earth", + "moons": 1, + "surface_area": 196900, + "distance_from_sun": 92960, + "namesake": "A variation on the word \"ground\" in several languages." + }) + + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == { + "id": 3, + "name": "Earth", + "moons": 1, + "surface_area": 196900, + "distance_from_sun": 92960, + "namesake": "A variation on the word \"ground\" in several languages." + } \ No newline at end of file