diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..066ed31d9 --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..21d6f1228 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,31 @@ 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 app.models.planet import Planet + + from .routes import solar_bp + app.register_blueprint(solar_bp) + return app + diff --git a/app/helper.py b/app/helper.py new file mode 100644 index 000000000..9b1afe93d --- /dev/null +++ b/app/helper.py @@ -0,0 +1,17 @@ +# Validate if GET by Planet ID does not exist +from flask import Blueprint, jsonify, request, make_response, abort +from app.models.planet import Planet + + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) + + planet = Planet.query.get(planet_id) + + if not planet: + abort(make_response({"message": f"planet {planet_id} not found"}, 404)) + + return planet diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/moons.py b/app/models/moons.py new file mode 100644 index 000000000..551f87d68 --- /dev/null +++ b/app/models/moons.py @@ -0,0 +1,10 @@ +from ctypes import sizeof +from app import db + +class Moon(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + size = db.Column(db.String) + description = db.Column(db.String) + color = db.Column(db.String) + planet_id = db.Column(db.Integer, db.ForeignKey('planet.id')) + planet = db.relationship("Planet", back_populates="moons") \ No newline at end of file diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..405511a2b --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,31 @@ +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) + color = db.Column(db.String) + moons = db.relationship("Moon", back_populates="planet") + + def to_json(self): + return {"id": self.id, + "name": self.name, + "description": self.description, + "color": self.color + } + + def update(self, req_body): + + self.name = req_body["name"] + self.description = req_body["description"] + self.color = req_body["color"] + + @classmethod + def create(cls, req_body): + new_planet = cls( + name=req_body['name'], + description=req_body['description'], + color=req_body['color'] + ) + + return new_planet diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..b844ea6ac 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,61 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, request, make_response, abort +from app import db +from app.models.planet import Planet +from .helper import validate_planet +solar_bp = Blueprint("planets", __name__, url_prefix="/planets") + +# GET and POST planets +@solar_bp.route("", methods=["POST", "GET"]) +def handle_planets(): + # Create a planet + if request.method== "POST": + request_body=request.get_json() + new_planet=Planet.create(request_body) + + db.session.add(new_planet) + db.session.commit() + + return make_response(jsonify(f"Planet {new_planet.name} successfully created"), 201) + + # Get all planets, or filter by planet name + elif request.method== "GET": + name_query=request.args.get('name') + if name_query: + planets=Planet.query.filter_by(name=name_query) + else: + planets=Planet.query.all() + planets_response=[] + for planet in planets: + planets_response.append(planet.to_json()) + + return jsonify(planets_response), 200 + + +# GET ONE Planet +@solar_bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = validate_planet(planet_id) + return jsonify(planet.to_json()), 200 + +# UPDATE Planet +@solar_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + planet.update(request_body) + + db.session.commit() + + return make_response(f"Planet #{planet.id} successfully updated") + +# DELETE Planet +@solar_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet #{planet.id} successfully deleted") \ No newline at end of file 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..bcf0db47d --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,38 @@ + +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): + planet_pluto = Planet(name="Pluto", + description="nobody loves me :(", + color="blue") + planet_sun = Planet(name="Sun", + description="im hot as heck son", + color="fiery red") + db.session.add_all([planet_pluto, planet_sun]) + db.session.commit() diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..d1cb4e0b3 --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,68 @@ + +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_all_planets(client, two_saved_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [ + { + "id": 1, + "name": "Pluto", + "description": "nobody loves me :(", + "color": "blue" + }, + { + "id": 2, + "name": "Sun", + "description": "im hot as heck son", + "color": "fiery red" + } + ] + +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": "Pluto", + "description": "nobody loves me :(", + "color": "blue" + } + +def test_get_one_planet_with_no_records(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_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Mars", + "description": "Is Bruno Mars counted as Mars?", + "color": "orange" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Mars successfully created" 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/a9e13cfaa413_adds_planet.py b/migrations/versions/a9e13cfaa413_adds_planet.py new file mode 100644 index 000000000..443443fbe --- /dev/null +++ b/migrations/versions/a9e13cfaa413_adds_planet.py @@ -0,0 +1,34 @@ +"""adds Planet + +Revision ID: a9e13cfaa413 +Revises: +Create Date: 2022-04-29 11:10:39.990080 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'a9e13cfaa413' +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('color', sa.String(), nullable=True), + sa.Column('description', sa.String(), 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/c3c886daf020_debugging.py b/migrations/versions/c3c886daf020_debugging.py new file mode 100644 index 000000000..f0c035d34 --- /dev/null +++ b/migrations/versions/c3c886daf020_debugging.py @@ -0,0 +1,34 @@ +"""debugging + +Revision ID: c3c886daf020 +Revises: a9e13cfaa413 +Create Date: 2022-05-01 20:22:48.382085 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'c3c886daf020' +down_revision = 'a9e13cfaa413' +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('color', sa.String(), 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/project-directions/wave_01.md b/project-directions/wave_01.md index a141cd6e2..17b4229bc 100644 --- a/project-directions/wave_01.md +++ b/project-directions/wave_01.md @@ -1,12 +1,9 @@ # Wave 01: Setup and Read -## Flask Setup -Perform following setup steps for the Solar System API repo to get started on this Flask project: -1. Create a virtual environment and activate it -1. Install the dependencies -1. Define a `Planet` class with the attributes `id`, `name`, and `description`, and one additional attribute -1. Create a list of `Planet` instances + + + ## RESTful Endpoints: Read Create the following endpoint(s), with similar functionality presented in the Hello Books API: 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