diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..9a110b148 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,39 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from dotenv import load_dotenv +import os +db = SQLAlchemy() +migrate = Migrate() +load_dotenv() def create_app(test_config=None): app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + + if not test_config: + + #app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + # "SQLALCHEMY_DATABASE_URI") + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + "RENDER_DATABASE_URI") + else: + app.config["TESTING"] = True + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( + "SQLALCHEMY_TEST_DATABASE_URI") + + db.init_app(app) + migrate.init_app(app, db) + + from app.models.planet import Planet + from app.models.moon import Moon + + from .routes.planet_routes import planets_bp + app.register_blueprint(planets_bp) + + from .routes.moon_routes import moons_bp + app.register_blueprint(moons_bp) + return app diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/moon.py b/app/models/moon.py new file mode 100644 index 000000000..67e6f3538 --- /dev/null +++ b/app/models/moon.py @@ -0,0 +1,17 @@ +from app import db + +class Moon(db.Model): + + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + planet= db.relationship("Planet", back_populates="moons") + planet_id= db.Column(db.Integer, db.ForeignKey('planet.id')) + + @classmethod + def dict_to_model(cls, data_dict): + return cls(name = data_dict["name"]) + + def make_moon_dict(self): + return dict( + name=self.name + ) \ No newline at end of file diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..7283ea2b5 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,22 @@ +from app import db + + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + description = db.Column(db.String) + moons= db.relationship("Moon", back_populates="planet") + + + @classmethod + def dict_to_model(cls, data_dict): + return cls(name = data_dict["name"], + description = data_dict["description"], + moons = data_dict["moons"]) + + def make_planet_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + ) \ 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/moon_routes.py b/app/routes/moon_routes.py new file mode 100644 index 000000000..a9cb1b08e --- /dev/null +++ b/app/routes/moon_routes.py @@ -0,0 +1,33 @@ +from app import db +from app.models.planet import Planet +from app.models.moon import Moon +from flask import Blueprint, jsonify, make_response, request, abort +from .routes_helpers import validate_model + +moons_bp = Blueprint("moons", __name__, url_prefix="/moons") + + +@moons_bp.route("", methods=["POST"]) +def make_new_moon(): + request_body = request.get_json() + + new_moon = Moon(name=request_body["name"]) + + db.session.add(new_moon) + db.session.commit() + + return make_response(f"Moon {new_moon.name} successfully created", 201) + +@moons_bp.route("", methods=["GET"]) +def get_all_moons(): + + name_param = request.args.get("name") + + if name_param: + moons = Moon.query.filter_by(name=name_param) + else: + moons = Moon.query.all() + + moons_list=[moon.make_moon_dict()for moon in moons] + + return jsonify(moons_list), 200 \ No newline at end of file diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py new file mode 100644 index 000000000..31cd50a67 --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,92 @@ +from app import db +from app.models.planet import Planet +from app.models.moon import Moon +from flask import Blueprint, jsonify, make_response, request, abort +from .routes_helpers import validate_model + + + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + + +@planets_bp.route("", methods=["POST"]) +def add_new_planet(): + request_body = request.get_json() + + new_planet = Planet.dict_to_model(request_body) + + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} successfully created", 201) + +@planets_bp.route("", methods=["GET"]) +def get_all_planets(): + + name_param = request.args.get("name") + + if name_param: + planets = Planet.query.filter_by(name=name_param) + else: + planets = Planet.query.all() + + planets_list=[planet.make_planet_dict()for planet in planets] + + return jsonify(planets_list), 200 + +@planets_bp.route("/", methods=["GET"]) +def get_one_planet(planet_id): + + planet = validate_model(Planet, planet_id) + + return planet.make_planet_dict(), 200 + + +@planets_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = validate_model(Planet, planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet#{planet.id} successfully deleted") + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet=validate_model(Planet, planet_id) + request_body=request.get_json() + + if request_body.get("name") is None or request_body.get("description") is None or request_body.get("moons") is None: + return make_response(f"some additional information needed to update planet {planet.name}",400) + + planet.name=request_body["name"] + planet.description=request_body["description"] + planet.moons=request_body["moons"] + + db.session.commit() + + return make_response(f"planet {planet.name} succesfully updated",200) + +@planets_bp.route("//moons", methods=["POST"]) +def create_moon(planet_id): + planet = validate_model(Planet, planet_id) + request_body = request.get_json() + + new_moon = Moon( + name=request_body["name"], + planet = planet + ) + db.session.add(new_moon) + db.session.commit() + return make_response(jsonify(f"Moon {new_moon.name} successfully created with Planet {planet.name}", 201)) + +@planets_bp.route("//moons", methods=["GET"]) +def get_moons_from_planets(planet_id): + planet = validate_model(Planet, planet_id) + + moons_response = [] + for moon in planet.moons: + moons_response.append(moon.make_moon_dict()) + + return jsonify(moons_response), 200 diff --git a/app/routes/routes_helpers.py b/app/routes/routes_helpers.py new file mode 100644 index 000000000..9a19e3c6f --- /dev/null +++ b/app/routes/routes_helpers.py @@ -0,0 +1,15 @@ +from flask import make_response, abort + +def validate_model(cls, id): + try: + id = int(id) + except: + abort(make_response({"message": f"{id} was invalid"}, 400)) + + model = cls.query.get(id) + + if not model: + abort(make_response( + {"message": f"{cls.__name__} with id {id} was not found"}, 404)) + + return model \ No newline at end of file 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/4c464e011370_changed_models.py b/migrations/versions/4c464e011370_changed_models.py new file mode 100644 index 000000000..3d6bf2d46 --- /dev/null +++ b/migrations/versions/4c464e011370_changed_models.py @@ -0,0 +1,30 @@ +"""changed models + +Revision ID: 4c464e011370 +Revises: c22dd8feb99f +Create Date: 2023-05-08 20:24:40.057545 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '4c464e011370' +down_revision = 'c22dd8feb99f' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('moon_id', sa.Integer(), nullable=True)) + op.create_foreign_key(None, 'planet', 'moon', ['moon_id'], ['id']) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_constraint(None, 'planet', type_='foreignkey') + op.drop_column('planet', 'moon_id') + # ### end Alembic commands ### diff --git a/migrations/versions/c22dd8feb99f_created_moon_model.py b/migrations/versions/c22dd8feb99f_created_moon_model.py new file mode 100644 index 000000000..a62a0fed1 --- /dev/null +++ b/migrations/versions/c22dd8feb99f_created_moon_model.py @@ -0,0 +1,36 @@ +"""created Moon model + +Revision ID: c22dd8feb99f +Revises: e6280fd69a02 +Create Date: 2023-05-08 15:17:02.930584 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'c22dd8feb99f' +down_revision = 'e6280fd69a02' +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('planet_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['planet_id'], ['planet.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.drop_column('planet', 'moons') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('moons', sa.INTEGER(), autoincrement=False, nullable=True)) + op.drop_table('moon') + # ### end Alembic commands ### diff --git a/migrations/versions/e6280fd69a02_adds_planet_model.py b/migrations/versions/e6280fd69a02_adds_planet_model.py new file mode 100644 index 000000000..3a39132d7 --- /dev/null +++ b/migrations/versions/e6280fd69a02_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: e6280fd69a02 +Revises: +Create Date: 2023-04-28 22:43:06.707509 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'e6280fd69a02' +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=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('moons', sa.Integer(), nullable=True), + 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/migrations/versions/ed6e0fca0d96_added_relationship_to_planet.py b/migrations/versions/ed6e0fca0d96_added_relationship_to_planet.py new file mode 100644 index 000000000..ad6f89dfe --- /dev/null +++ b/migrations/versions/ed6e0fca0d96_added_relationship_to_planet.py @@ -0,0 +1,30 @@ +"""added relationship to Planet + +Revision ID: ed6e0fca0d96 +Revises: 4c464e011370 +Create Date: 2023-05-08 20:33:44.207698 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'ed6e0fca0d96' +down_revision = '4c464e011370' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_constraint('planet_moon_id_fkey', 'planet', type_='foreignkey') + op.drop_column('planet', 'moon_id') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('moon_id', sa.INTEGER(), autoincrement=False, nullable=True)) + op.create_foreign_key('planet_moon_id_fkey', 'planet', 'moon', ['moon_id'], ['id']) + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt index ae59e7b55..b93d3b924 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,14 +4,19 @@ blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==7.2.4 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 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..256b063ab --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,33 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +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_saved_planets(app): + pluto = Planet(name= "pluto", description= "not a planet", moons= 79) + mercury = Planet(name="mercury", description= "is a planet", moons =5) + + db.session.add_all([pluto, mercury]) + 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..db215ae85 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,47 @@ +from flask import jsonify + +def test_get_empty_all_planets(client): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] + + + +def test_get_one_planet(client, two_saved_planets): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == {"name": "pluto", "description":"not a planet", "moons":79, "id":1} + +def test_get_non_existent_planet(client, two_saved_planets): + response = client.get("/planets/100") + response_body = response.get_json() + + assert response.status_code == 404 + +def test_invalid_planet_route(client, two_saved_planets): + response = client.get("/planets/ADA") + response_body = response.get_json() + + assert response.status_code == 400 + +def test_get_all_planets(client, two_saved_planets): + response = client.get("/planets") + response_body = response.get_json() + print(response_body) + + assert response.status_code == 200 + assert response_body == [{"name": "pluto", "description": "not a planet", "moons": 79, "id": 1}, + {"name": "mercury", "description": "is a planet", "moons" : 5, "id": 2}] + +def test_post_one_planet(client): + response =client.post ("/planets", json= {"name": "New Planet", + "description": "it's a new planet", + "moons": 0}) + response_body = response.get_data(as_text=True) + assert response.status_code == 201 + assert response_body == "Planet New Planet successfully created" +