diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..a0cca079e 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,32 @@ 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.planet_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..e69de29bb diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..a987a0772 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,30 @@ +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) + + def to_json(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "color": self.color + } + + def update(self, request_body): + self.name = request_body["name"] + self.description = request_body["description"] + self.color = request_body["color"] + + @classmethod + def create(cls, request_body): + new_planet = cls( + name=request_body['name'], + description=request_body['description'], + color=request_body['color'] + ) + return new_planet 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/helpers.py b/app/routes/helpers.py new file mode 100644 index 000000000..1a8c95640 --- /dev/null +++ b/app/routes/helpers.py @@ -0,0 +1,15 @@ +from app.models.planet import Planet +from flask import abort, make_response, jsonify + +# helper function to validate +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + return abort(make_response(jsonify(f"Planet {planet_id} is invalid"), 400)) + + planet = Planet.query.get(planet_id) + + if not planet: + return abort(make_response(jsonify(f"Planet {planet_id} does not exist"), 404)) + return planet diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py new file mode 100644 index 000000000..d4d614b33 --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,59 @@ +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, abort, make_response, request +from .helpers import validate_planet + +planet_bp = Blueprint("planet", __name__, url_prefix="/planets") + +@planet_bp.route("", methods=["POST"]) +def create_planet(): + 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} has been created"), 201) + +@ planet_bp.route("", methods=["GET"]) +def get_planets(): + planet_query = request.args.get("name") + color_query = request.args.get("color") + if planet_query: + planets = Planet.query.filter_by(name=planet_query) + elif color_query: + planets = Planet.query.filter_by(color=color_query) + else: + planets = Planet.query.all() + + planets_response = [planet.to_json() for planet in planets] + + return make_response(jsonify(planets_response), 200) + +@ planet_bp.route("/", methods=["GET"]) +def get_one_planet(planet_id): + planet = validate_planet(planet_id) + return make_response(jsonify(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.update(request_body) + db.session.commit() + except KeyError: + return abort(make_response(jsonify("Missing information")), 400) + + return make_response(jsonify(f"Planet #{planet.id} successfully updated"), 200) + +@ planet_bp.route("/", methods=["DELETE"]) +def delete_one_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(jsonify(f"Planet {planet.id} has been 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..c929f9560 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,39 @@ +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): + # Arrange + planet_one = Planet(name="Mars", + description="Close enough", + color="Red") + planet_two = Planet(name="Earth", + description="we out here", + color = "Green") + + db.session.add_all([planet_one, planet_two]) + db.session.commit() \ 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..6f1b8a919 --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,73 @@ +#`GET` `/planets` returns `200` and an empty array. +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 == [] + + +# GET /planets/1 returns a response body that matches our fixture +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": "Mars", + "description": "Close enough", + "color": "Red" + } + + +# GET /planets/1 with no data in test database (no fixture) returns a 404 +def test_get_one_planet_but_no_data(client): + # ACT + response = client.get("/planets/1") + response_body = response.get_json() + + # ASSERT + assert response.status_code == 404 + assert response_body == "Planet 1 does not exist" + + +# GET /planets with valid test data (fixtures) returns a 200 with +# an array including appropriate test data +def test_get_planets_with_records(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": "Mars", + "description": "Close enough", + "color": "Red"}, + { + "id" : 2, + "name": "Earth", + "description":"we out here", + "color" : "Green"}] + + +# POST /planets with a JSON request body returns a 201 +def test_create_one_planet(client): + #ACT + response = client.post("/planets", json={ + "name": "new planet", + "description": "with aliens", + "color": "rainbow" + }) + response_body = response.get_json() + + #ASSERT + assert response.status_code == 201 + assert response_body == "Planet new planet has been 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/08a85b38fecd_changed.py b/migrations/versions/08a85b38fecd_changed.py new file mode 100644 index 000000000..dd042b8b3 --- /dev/null +++ b/migrations/versions/08a85b38fecd_changed.py @@ -0,0 +1,30 @@ +"""changed + +Revision ID: 08a85b38fecd +Revises: 5b418a0c89d5 +Create Date: 2022-05-04 13:01:11.258180 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '08a85b38fecd' +down_revision = '5b418a0c89d5' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('color', sa.String(), nullable=True)) + op.drop_column('planet', 'distance_from_earth') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('distance_from_earth', sa.VARCHAR(), autoincrement=False, nullable=True)) + op.drop_column('planet', 'color') + # ### end Alembic commands ### diff --git a/migrations/versions/5b418a0c89d5_added_planet_model.py b/migrations/versions/5b418a0c89d5_added_planet_model.py new file mode 100644 index 000000000..187768642 --- /dev/null +++ b/migrations/versions/5b418a0c89d5_added_planet_model.py @@ -0,0 +1,34 @@ +"""added planet model + +Revision ID: 5b418a0c89d5 +Revises: +Create Date: 2022-04-29 13:02:45.187757 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '5b418a0c89d5' +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('distance_from_earth', 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/workspace.code-workspace b/project-directions/workspace.code-workspace new file mode 100644 index 000000000..4d21d97e9 --- /dev/null +++ b/project-directions/workspace.code-workspace @@ -0,0 +1,11 @@ +{ + "folders": [ + { + "path": "../../ada-hello-books-api" + }, + { + "path": ".." + } + ], + "settings": {} +} \ No newline at end of file