diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..62e430aca --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..47a8cce62 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__) + if not test_config: + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") + + else: + app.config["TESTING"] = True + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( + "SQLALCHEMY_TEST_DATABASE_URI") + + + from app.models.planet import Planet + + db.init_app(app) + migrate.init_app(app, db) + + from .routes.routes import planet_bp + app.register_blueprint(planet_bp) + return app + + diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..139597f9c --- /dev/null +++ b/app/models/__init__.py @@ -0,0 +1,2 @@ + + diff --git a/app/models/moon.py b/app/models/moon.py new file mode 100644 index 000000000..9fd7bf26e --- /dev/null +++ b/app/models/moon.py @@ -0,0 +1,13 @@ +from app import db + +class Moon(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + planet_id = db.Column(db.Integer, db.ForeignKey('planet.id')) + planet = db.relationship("Planet", back_populates="moons") + + def to_json(self): + return { + "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..365532744 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,15 @@ +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.Column(db.Integer) + + def to_json(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "moons": self.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/helper.py b/app/routes/helper.py new file mode 100644 index 000000000..3e73a3bd8 --- /dev/null +++ b/app/routes/helper.py @@ -0,0 +1,14 @@ +# Helper function: +from flask import abort, make_response, jsonify +from app.models.planet import Planet + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response(jsonify(f"planet {planet_id} invalid"), 400)) + + planet = Planet.query.get(planet_id) + if not planet: + abort(make_response(jsonify(f"planet {planet_id} not found"), 404)) + return planet \ No newline at end of file diff --git a/app/routes/moon_routes.py b/app/routes/moon_routes.py new file mode 100644 index 000000000..4f4f31707 --- /dev/null +++ b/app/routes/moon_routes.py @@ -0,0 +1,9 @@ +# from app import db +# from app.models.planet import Planet +# from app.models.moon import Moon +# from flask import Blueprint, jsonify, abort, make_response, request +# from .helper import validate_planet + +# moons_bp = Blueprint("moons", __name__, url_prefix="/moons") + +# do we even need this \ 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..c3e0a62cb --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,94 @@ +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, abort, make_response, request +from .helper import validate_planet +from app.models.moon import Moon + +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +@planets_bp.route("", methods=["POST"]) +def create_planets(): + request_body = request.get_json() + + try: + new_planet = Planet(name = request_body["name"], description = request_body["description"]) + db.session.add(new_planet) + db.session.commit() + except: + abort(make_response(jsonify({"message":f"invalid input"}), 400)) + return make_response(jsonify(f"Planet {new_planet.name} successfully created"), 201) + + +@planets_bp.route("", methods=["GET"]) +def read_all_planets(): + + + name_query = request.args.get("name") + # moons_query = request.args.get("moons") + if name_query: + planets = Planet.query.filter_by(name = name_query) + # elif moons_query: + # planets = Planet.query.filter_by(moons = moons_query) + else: + planets = Planet.query.all() + planets_response = [] + try: + for planet in planets: + planets_response.append(planet.to_json()) + + except: + abort(make_response(jsonify(f"planet not found"), 404)) + return make_response(jsonify(planets_response),200) + + + + +@planets_bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = validate_planet(planet_id) + return make_response(planet.to_json(), 200) + + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + + request_body = request.get_json() + try: + planet.name = request_body["name"] + planet.description = request_body["description"] + # planet.moons = request_body["moons"] + except: + abort(make_response(jsonify(f"invalid data"), 400)) + + db.session.commit() + + return jsonify(planet.to_json(), 200) + +@planets_bp.route("/", methods=["DELETE"]) +def delete_a_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(jsonify(f"planet{planet_id} successfully deleted"), 200) + +@planets_bp.route("//moons", methods=["GET"]) +def read_moons_for_planet(planet_id): + planet = validate_planet(planet_id) + moons_response = [] + for moon in planet.moons: + moons_response.append(moon.to_json()) + return make_response(jsonify(moons_response), 200) + +@planets_bp.route("//moons", methods=["POST"]) +def write_moon_to_planet(planet_id): + planet = validate_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} of the planet {new_moon.planet.name} successfully created"), 201) \ No newline at end of file diff --git a/app/routes/routes.py b/app/routes/routes.py new file mode 100644 index 000000000..e54110b27 --- /dev/null +++ b/app/routes/routes.py @@ -0,0 +1,75 @@ +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, abort, make_response, request +from .helper import validate_planet + +planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") + +@planet_bp.route("", methods=["POST"]) +def create_planets(): + request_body = request.get_json() + + try: + new_planet = Planet(name = request_body["name"], description = request_body["description"], moons = request_body["moons"]) + db.session.add(new_planet) + db.session.commit() + except: + abort(make_response(jsonify({"message":f"invalid input"}), 400)) + return make_response(jsonify(f"Planet {new_planet.name} successfully created"), 201) + + +@planet_bp.route("", methods=["GET"]) +def read_all_planets(): + + + name_query = request.args.get("name") + moons_query = request.args.get("moons") + if name_query: + planets = Planet.query.filter_by(name = name_query) + elif moons_query: + planets = Planet.query.filter_by(moons = moons_query) + else: + planets = Planet.query.all() + planets_response = [] + try: + for planet in planets: + planets_response.append(planet.to_json()) + + except: + abort(make_response(jsonify(f"planet not found"), 404)) + return make_response(jsonify(planets_response),200) + + + + +@planet_bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = validate_planet(planet_id) + return make_response(planet.to_json(), 200) + + +@planet_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + + request_body = request.get_json() + try: + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.moons = request_body["moons"] + except: + abort(make_response(jsonify(f"invalid data"), 400)) + + db.session.commit() + + return jsonify(planet.to_json(), 200) + +@planet_bp.route("/", methods=["DELETE"]) +def delete_a_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(jsonify(f"planet{planet_id} successfully deleted"), 200) + diff --git a/app/tests/__init__.py b/app/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/tests/conftest.py b/app/tests/conftest.py new file mode 100644 index 000000000..5108fda1f --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,34 @@ +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): + Mercury = Planet(name = "Mercury", description = "This is the first planet", moons = 2) + Venus = Planet(name = "Venus", description = "named after the Roman goddess of love and beauty", moons = 0) + + db.session.add_all([Mercury,Venus]) + db.session.commit() \ No newline at end of file diff --git a/app/tests/moon_routes.py b/app/tests/moon_routes.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/tests/routes.py b/app/tests/routes.py new file mode 100644 index 000000000..44f47f1c9 --- /dev/null +++ b/app/tests/routes.py @@ -0,0 +1,37 @@ + + +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_book_by_id(client, two_saved_planets): + + response = client.get('/planets/2') + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id": 2, + "name": "Venus", + "description": "named after the Roman goddess of love and beauty", + "moons" : 0 + } + + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Asimov", + "description": "This planet named after Isaac Asimov, the other of Lucky Starr book series", + "moons" : 4 + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Asimov successfully created" \ No newline at end of file diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..44f47f1c9 --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,37 @@ + + +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_book_by_id(client, two_saved_planets): + + response = client.get('/planets/2') + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id": 2, + "name": "Venus", + "description": "named after the Roman goddess of love and beauty", + "moons" : 0 + } + + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Asimov", + "description": "This planet named after Isaac Asimov, the other of Lucky Starr book series", + "moons" : 4 + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Asimov successfully created" \ 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/dbb234d9cc93_adds_planet_model.py b/migrations/versions/dbb234d9cc93_adds_planet_model.py new file mode 100644 index 000000000..f41c7597d --- /dev/null +++ b/migrations/versions/dbb234d9cc93_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: dbb234d9cc93 +Revises: +Create Date: 2022-04-30 00:06:20.141358 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'dbb234d9cc93' +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/procfile b/procfile new file mode 100644 index 000000000..62e430aca --- /dev/null +++ b/procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index a506b4d12..37b7c1d29 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,19 +1,27 @@ alembic==1.5.4 +attrs==21.4.0 autopep8==1.5.5 blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==6.3.2 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 +iniconfig==1.1.1 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==21.3 +pluggy==0.13.1 psycopg2-binary==2.8.6 +py==1.11.0 pycodestyle==2.6.0 +pyparsing==3.0.8 pytest==6.2.3 pytest-cov==2.12.1 python-dateutil==2.8.1 diff --git a/test_fixtures.py b/test_fixtures.py new file mode 100644 index 000000000..49ad418d9 --- /dev/null +++ b/test_fixtures.py @@ -0,0 +1,45 @@ +import pytest +from app import create_app +from app import db + +@pytest.fixture +def empty_list(): + return [] + +def test_len_of_empty_list(empty_list): + assert isinstance(empty_list, list) + assert len(empty_list) == 0 + +@pytest.fixture +def one_item(empty_list): + empty_list.append("item") + return empty_list + +def test_len_of_unary_list(one_item): + assert isinstance(one_item, list) + assert len(one_item) == 1 + assert one_item[0] == "item" + +class FancyObject: + def __init__(self): + self.fancy = True + print(f"\nFancyObject: {self.fancy}") + + def or_is_it(self): + self.fancy = not self.fancy + + def cleanup(self): + print(f"\ncleanup: {self.fancy}") + +@pytest.fixture +def so_fancy(): + fancy_object = FancyObject() + + yield fancy_object + + fancy_object.cleanup() + +def test_so_fancy(so_fancy): + assert so_fancy.fancy + so_fancy.or_is_it() + assert not so_fancy.fancy \ No newline at end of file