diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..ab0842a97 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,35 @@ 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") + 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 .routes import planet + from .routes import fictional_caretaker + app.register_blueprint(planet.bp) + app.register_blueprint(fictional_caretaker.bp) + + from app.models.planet import Planet + from app.models.fictional_caretaker import Caretaker + 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/fictional_caretaker.py b/app/models/fictional_caretaker.py new file mode 100644 index 000000000..b258675ed --- /dev/null +++ b/app/models/fictional_caretaker.py @@ -0,0 +1,16 @@ +from app import db + +class Caretaker(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + planets = db.relationship("Planet", back_populates="caretaker") + + @classmethod + def from_dict(cls, data_dict): + return cls(name=data_dict["name"]) + + def to_dict(self): + return dict( + id=self.id, + 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..2cf56dae9 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,25 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String, nullable=False) + description = db.Column(db.String, nullable=False) + moons = db.Column(db.Integer, nullable=False) + caretaker_id = db.Column(db.Integer, db.ForeignKey("caretaker.id")) + caretaker = db.relationship("Caretaker", back_populates="planets") + + def to_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + moons=self.moons + ) + + @classmethod + def from_dict(cls, data_dict): + return cls(name=data_dict["name"], + description=data_dict["description"], + moons=data_dict["moons"]) + + 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/fictional_caretaker.py b/app/routes/fictional_caretaker.py new file mode 100644 index 000000000..b320e8a30 --- /dev/null +++ b/app/routes/fictional_caretaker.py @@ -0,0 +1,49 @@ +from app import db +from app.models.fictional_caretaker import Caretaker +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request +from app.routes.helper_functions import validate_model + +bp = Blueprint("caretakers", __name__, url_prefix="/caretakers") + +@bp.route("", methods=["POST"]) +def create_caretaker(): + request_body = request.get_json() + new_caretaker = Caretaker.from_dict(request_body) + + db.session.add(new_caretaker) + db.session.commit() + + return make_response(f"Caretaker {new_caretaker.name} successfully created", 201) + + +@bp.route("", methods=["GET"]) +def read_all_caretakers(): + caretakers = Caretaker.query.all() + + caretakers_response = [caretaker.to_dict() for caretaker in caretakers] + + return jsonify(caretakers_response) + + +@bp.route("//planets", methods=["POST"]) +def create_planet(caretaker_id): + caretaker = validate_model(Caretaker, caretaker_id) + request_body = request.get_json() + new_planet = Planet.from_dict(request_body) + new_planet.caretaker = caretaker + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} cared for by {caretaker.name}", 201) + + +@bp.route("//planets", methods=["GET"]) +def read_one_planet(caretaker_id): + caretaker = validate_model(Caretaker, caretaker_id) + + planet_response = [planet.to_dict() for planet in caretaker.planets] + + + return(jsonify(planet_response)) \ No newline at end of file diff --git a/app/routes/helper_functions.py b/app/routes/helper_functions.py new file mode 100644 index 000000000..9e9f3a9e4 --- /dev/null +++ b/app/routes/helper_functions.py @@ -0,0 +1,14 @@ +from flask import abort, make_response + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + abort(make_response({"message":f"{cls.__name__} {model_id} invalid"}, 400)) + + model = cls.query.get(model_id) + + if not model: + abort(make_response({"message":f"{cls.__name__} {model_id} not found"}, 404)) + + return model \ No newline at end of file diff --git a/app/routes/planet.py b/app/routes/planet.py new file mode 100644 index 000000000..8297f55f8 --- /dev/null +++ b/app/routes/planet.py @@ -0,0 +1,66 @@ +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request +from app.routes.helper_functions import validate_model + +bp = Blueprint("planets", __name__, url_prefix = "/planets") + +@bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = validate_model(Planet, planet_id) + return jsonify(planet.to_dict()), 200 + +@bp.route("", methods=["GET"]) +def read_all_planets(): + name_query = request.args.get("name") + description_query = request.args.get("description") + moons_query = request.args.get("moons") + limit_query = request.args.get("limit") + + planet_query = Planet.query + + if name_query: + planet_query = planet_query.filter_by(name=name_query) + + if description_query: + planet_query = planet_query.filter_by(description=description_query) + + if moons_query: + planet_query = planet_query.filter_by(moons=moons_query) + + if limit_query: + planet_query = planet_query.limit(limit_query) + + planets = planet_query.all() + + planet_response = [planet.to_dict() for planet in planets] + + return jsonify(planet_response) + +@bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + new_planet = Planet.from_dict(request_body) + + db.session.add(new_planet) + db.session.commit() + return make_response(f"Planet {new_planet.name} successfully created", 201) + +@bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_model(Planet, planet_id) + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.moons = request_body["moons"] + + db.session.commit() + return make_response(f"Planet #{planet.id} successfully updated", 200) + +@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", 200) \ 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/b3e2f14f62df_added_fictional_caretaker.py b/migrations/versions/b3e2f14f62df_added_fictional_caretaker.py new file mode 100644 index 000000000..ea2f2dd03 --- /dev/null +++ b/migrations/versions/b3e2f14f62df_added_fictional_caretaker.py @@ -0,0 +1,36 @@ +"""added fictional caretaker + +Revision ID: b3e2f14f62df +Revises: ba34c22df00a +Create Date: 2022-11-04 13:01:29.400980 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'b3e2f14f62df' +down_revision = 'ba34c22df00a' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('caretaker', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.add_column('planet', sa.Column('caretaker_id', sa.Integer(), nullable=True)) + op.create_foreign_key(None, 'planet', 'caretaker', ['caretaker_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', 'caretaker_id') + op.drop_table('caretaker') + # ### end Alembic commands ### diff --git a/migrations/versions/ba34c22df00a_adds_planet_model.py b/migrations/versions/ba34c22df00a_adds_planet_model.py new file mode 100644 index 000000000..0d54d431e --- /dev/null +++ b/migrations/versions/ba34c22df00a_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: ba34c22df00a +Revises: +Create Date: 2022-10-28 14:20:15.057013 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'ba34c22df00a' +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('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/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..b430136a8 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,32 @@ +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 one_saved_planet(app): + planet = Planet(name="Earth", description="home", moons=1) + db.session.add(planet) + db.session.commit() + return planet \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..2a337b0b7 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,44 @@ +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, one_saved_planet): + #Act + response = client.get("/planets/1") + response_body = response.get_json() + #Assert + assert response.status_code == 200 + assert response_body["id"] == one_saved_planet.id + assert response_body["name"] == one_saved_planet.name + assert response_body["description"] == one_saved_planet.description + assert response_body["moons"] == one_saved_planet.moons + +def test_get_one_planet_no_data(client): + #Act + response = client.get("/planets/1") + response_body = response.get_json() + #Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 1 not found"} + +def test_get_planets_happy_path(client, one_saved_planet): + #Act + response = client.get("/planets") + response_body = response.get_json() + #Assert + assert response.status_code == 200 + assert response_body[0] == {"id": 1, "name": "Earth", "description": "home", "moons": 1} + +def test_create_planet_happy_path(client): + #Arrange + test_planet = {"name": "Mars", "description": "red", "moons": 0} + #Act + response = client.post("/planets", json={"name": "Mars", "description": "red", "moons": 0}) + response_body = response.get_data(as_text=True) + #Assert + assert response.status_code == 201 + assert response_body == "Planet Mars successfully created"