diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..f081cb329 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,34 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +import os +from dotenv import load_dotenv +db = SQLAlchemy() +migrate = Migrate() -def create_app(test_config=None): +load_dotenv() + + +def create_app(testing=None): app = Flask(__name__) + + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + if not testing: + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get("RENDER_DATABASE_URI") + else: + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get("SQLALCHEMY_TEST_DATABASE_URI") + + from .models.moon import Moon + from .models.planet import Planet + + db.init_app(app) + migrate.init_app(app, db) + + from .routes.routes import solar_system_planet + app.register_blueprint(solar_system_planet) + + from .routes.routes import solar_system_moon + app.register_blueprint(solar_system_moon) return app diff --git a/app/models/moon.py b/app/models/moon.py new file mode 100644 index 000000000..83398b65a --- /dev/null +++ b/app/models/moon.py @@ -0,0 +1,24 @@ +from app import db + +class Moon(db.Model): + id = db.Column(db.Integer, primary_key = True, autoincrement = True) + name = db.Column(db.String) + radius = db.Column(db.Integer) + planet_id = db.Column(db.Integer) + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "radius": self.radius, + "planet_id": self.planet_id + } + + @classmethod + def from_dict(cls, moon_data): + return cls( + name = moon_data["name"], + radius = moon_data["radius"], + planet_id = moon_data["planet_id"], + ) + diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..389fa8576 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,24 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key = True, autoincrement = True) + name = db.Column(db.String) + radius = db.Column(db.Integer) + description = db.Column(db.Text) + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "radius": self.radius, + "description": self.description + } + + @classmethod + def from_dict(cls, planet_data): + return cls( + name = planet_data["name"], + radius = planet_data["radius"], + description = planet_data["description"], + ) + 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/routes.py b/app/routes/routes.py new file mode 100644 index 000000000..bdb078e2f --- /dev/null +++ b/app/routes/routes.py @@ -0,0 +1,148 @@ +from flask import Blueprint, jsonify, request, make_response, abort +from app import db +from app.models.moon import Moon +from app.models.planet import Planet + +solar_system_planet = Blueprint("solar_system_planet", __name__, url_prefix="/solar_system/planet") + +@solar_system_planet.route("", methods=["POST"]) +def add_planet(): + request_body = request.get_json() + new_planet = Planet.from_dict(request_body) + + db.session.add(new_planet) + db.session.commit() + + return make_response({"message": f"Planet {new_planet.name} has been added, with the id: {new_planet.id}"}, 201) + +@solar_system_planet.route("", methods=["GET"]) +def get_planets(): + return_list = [] + name_query = request.args.get("name") + radius_query = request.args.get("radius_min") + if not name_query and not radius_query: + all_planets = Planet.query.all() + elif name_query and radius_query: + all_planets = Planet.query.filter(Planet.name==name_query, Planet.radius>=radius_query) + elif radius_query: + all_planets = Planet.query.filter(Planet.radius>=radius_query) + elif name_query: + all_planets = Planet.query.filter(Planet.name==name_query) + for planet in all_planets: + return_list.append({ + "id": planet.id, + "name": planet.name, + "radius": planet.radius, + "description": planet.description + }) + return jsonify(return_list), 200 + +@solar_system_planet.route("/", methods=["GET"]) +def get_planet_by_id(planet_id): + planet = verify_item_id(Planet, planet_id) + return { + "id": planet.id, + "name": planet.name, + "radius": planet.radius, + "description": planet.description + } + +@solar_system_planet.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = verify_item_id(Planet, planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response({"message": f"Planet {planet.id} has been deleted"}, 200) + +@solar_system_planet.route("/", methods=["PUT"]) +def update(planet_id): + planet = verify_item_id(Planet, planet_id) + request_body = request.get_json() + + planet.name = request_body["name"] + planet.radius = request_body["radius"] + planet.description = request_body["description"] + + db.session.commit() + + return make_response({"message": f"Planet {planet.id} has been updated"}, 200) + +solar_system_moon = Blueprint("solar_system_moon", __name__, url_prefix="/solar_system/moon") + +@solar_system_moon.route("", methods=["POST"]) +def add_moon(): + request_body = request.get_json() + new_moon = Moon.from_dict(request_body) + + db.session.add(new_moon) + db.session.commit() + + return make_response({"message": f"Moon {new_moon.name} has been added, with the id: {new_moon.id}"}, 201) + +@solar_system_moon.route("", methods=["GET"]) +def get_moons(): + return_list = [] + name_query = request.args.get("name") + radius_query = request.args.get("radius_min") + if not name_query and not radius_query: + all_moons = Moon.query.all() + elif name_query and radius_query: + all_moons = Moon.query.filter(Moon.name==name_query, Moon.radius>=radius_query) + elif radius_query: + all_moons = Moon.query.filter(Moon.radius>=radius_query) + elif name_query: + all_moons = Moon.query.filter(Moon.name==name_query) + for moon in all_moons: + return_list.append({ + "id": moon.id, + "name": moon.name, + "radius": moon.radius, + "planet name": moon.planet_id + }) + return jsonify(return_list), 200 + +@solar_system_moon.route("/", methods=["GET"]) +def get_moon_by_id(moon_id): + moon = verify_item_id(Moon, moon_id) + return { + "id": moon.id, + "name": moon.name, + "radius": moon.radius, + "planet name": moon.planet_id + } + +@solar_system_moon.route("/", methods=["DELETE"]) +def delete_planet(moon_id): + moon = verify_item_id(Moon, moon_id) + + db.session.delete(moon) + db.session.commit() + + return make_response({"message": f"Moon {moon.id} has been deleted"}, 200) + +@solar_system_moon.route("/", methods=["PUT"]) +def update(moon_id): + moon = verify_item_id(Moon, moon_id) + request_body = request.get_json() + + moon.name = request_body["name"] + moon.radius = request_body["radius"] + moon.planet_id = request_body["planet_id"] + + db.session.commit() + + return make_response({"message": f"Moon {moon.id} has been updated"}, 200) + +def verify_item_id(model, item_id): + try: + item_id = int(item_id) + except ValueError: + abort(make_response({"message": f"Moon {item_id} is invalid"}, 400)) + all_items = model.query.all() + for item in all_items: + if item.id == item_id: + return item + abort(make_response({"message": f"Moon {item_id} is not found"}, 404)) + diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..f8ed4801f --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,45 @@ +# 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 + +[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 + +[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..8b3fb3353 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,96 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool +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') + +# 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', + str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) +target_metadata = current_app.extensions['migrate'].db.metadata + +# 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 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=target_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.') + + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_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/4d3bd2eba81a_adds_moon_and_planet_models.py b/migrations/versions/4d3bd2eba81a_adds_moon_and_planet_models.py new file mode 100644 index 000000000..69c805216 --- /dev/null +++ b/migrations/versions/4d3bd2eba81a_adds_moon_and_planet_models.py @@ -0,0 +1,42 @@ +"""adds Moon and Planet models + +Revision ID: 4d3bd2eba81a +Revises: +Create Date: 2023-04-27 14:13:06.328129 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '4d3bd2eba81a' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('moon', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('radius', sa.Integer(), nullable=True), + sa.Column('planet_id', sa.Integer(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('planet', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('radius', sa.Integer(), nullable=True), + sa.Column('description', sa.Text(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + op.drop_table('moon') + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt index ae59e7b55..f4ff77124 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,14 +4,20 @@ blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==7.2.3 +exceptiongroup==1.1.1 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 +iniconfig==2.0.0 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==23.1 +pluggy==1.0.0 psycopg2-binary==2.9.5 pycodestyle==2.6.0 pytest==7.3.1 @@ -23,5 +29,6 @@ requests==2.25.1 six==1.15.0 SQLAlchemy==1.3.23 toml==0.10.2 +tomli==2.0.1 urllib3==1.26.4 Werkzeug==1.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..993358e33 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,33 @@ +import pytest +from app import create_app, db +from flask.signals import request_finished +from app.models.moon import Moon +from app.models.planet import Planet + +@pytest.fixture +def app(): + app = create_app(testing = True) + + @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_planets(app): + mercury = Planet(name="mercury", radius=1516, description="I am the smallest planet in our solar system") + venus = Planet(name="venus", radius=3760, description="I spin in the opposite direction from Earth") + + db.session.add_all([mercury, venus]) + db.session.commit() + diff --git a/tests/test_route.py b/tests/test_route.py new file mode 100644 index 000000000..51d6e69d3 --- /dev/null +++ b/tests/test_route.py @@ -0,0 +1,35 @@ +import pytest + +def test_get_all_planets(client, two_planets): + response = client.get("/solar_system/planet") + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [ + {"id": 1, "name": "mercury", "radius": 1516, "description": "I am the smallest planet in our solar system"}, + {"id": 2, "name": "venus", "radius": 3760, "description": "I spin in the opposite direction from Earth"}] + +def test_post_creates_planet(client): + response = client.post("/solar_system/planet", json = {"name": "mercury", "radius": 1516, "description": "I am the smallest planet in our solar system"}) + + response_body = response.get_json() + + assert response.status_code == 201 + assert "Planet mercury has been added, with the id: 1" in response_body["message"] + +def test_get_one_planet(client, two_planets): + response = client.get("/solar_system/planet/1") + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == {"id": 1, "name": "mercury", "radius": 1516, "description": "I am the smallest planet in our solar system"} + +def test_delete_one_planet(client, two_planets): + response = client.delete("/solar_system/planet/1") + + response_body = response.get_json() + + assert response.status_code == 200 + assert "Planet 1 has been deleted" in response_body["message"] \ No newline at end of file