diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..1350259a3 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,30 @@ 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(compare_type=True) +load_dotenv() def create_app(test_config=None): app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + + if test_config: + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_TEST_DATABASE_URI") + app.config['TESTING'] = True + else: + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") + + from app.models.planet import Planet + + db.init_app(app) + migrate.init_app(app, db) + + from .routes import planets_bp + app.register_blueprint(planets_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..26bc5261b --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,25 @@ +from app import db + +# planets = [Planet(1, "Neptune", "thick, windy", 1.024e26 ), +# Planet(2, "Mars", "dusty, cold desert",6.39e23), +# Planet(3, "Earth", "rocky, terrestrial, full of life",5.972e24) +# ] + +class Planet(db.Model): + __tablename__ = 'planets' + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String, nullable=False) + description = db.Column(db.String, nullable=False) + mass = db.Column(db.Float, nullable=False) + # gravity = db.Column(db.Float, nullable=False) + # dist_sun = db.Column(db.Float, nullable=False) + # n_moons = db.Column(db.Integer, nullable=False) + # water + # temperature + # atmosphere + + def get_all_attrs(): + """ + Returns all existing attributes (list) in Planet class + """ + return [attr for attr in dir(Planet) if not attr.startswith('__')] \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..33838b3e0 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,150 @@ -from flask import Blueprint +from app import db +from flask import Blueprint, jsonify, abort, make_response, request +from .models.planet import Planet + +planets_bp = Blueprint("planets", __name__, url_prefix = "/planets") + + +# ~~~~~~ Helper functions ~~~~~ +# TO DO: Create separate helper function module or add as class method # +def validate_id(planet_id): + """ + Checks if planet id is valid and returns error messages for invalid inputs + :params: + - planet_id (int) + :returns: + - planet (object) if valid planet id valid + """ + try: + planet_id_int = int(planet_id) + except: + # handling invalid planet id type + abort(make_response({"message": f"{planet_id} is an invalid planet id"}, 400)) + + # return planet data if id in db + planet = Planet.query.get(planet_id) + + # handle nonexistant planet id + if not planet: + abort(make_response({"message": f"{planet_id} not found"}, 404)) + return planet + +def process_kwargs(queries): + """ + Separate kwargs from HTTP request into separate dicts based on SQLAlchemy query method + :params: + - queries (dict) + :returns: + - attrs (dict): planet class attributes kwargs for filter_by + ** name, description, mass + - orderby (dict): method kwargs for order_by + ** sort_mass, sort_name + - sels (dict): selected number of results for limit + """ + planet_attrs = Planet.get_all_attrs() + order_methods = ["sort", "desc"] + attrs = {} + orderby = {} + sels = {} + for kwarg in queries: + if kwarg in planet_attrs: + attrs[kwarg] = queries[kwarg] + elif kwarg in order_methods: + orderby[kwarg] = queries[kwarg] + elif kwarg == "limit": + sels[kwarg] = queries[kwarg] + else: + abort(make_response( + {"message" : f"{kwarg} is an invalid query"}, 400 + )) + return attrs, orderby, sels + + +@planets_bp.route("",methods= ["GET"]) +def display_all_planets(): + # collect query & parse kwargs + planet_query = Planet.query + attrs, orderby, sels = process_kwargs(request.args.to_dict()) + if attrs: + # filter by attribute kwargs e.g name=Earth + planet_query = planet_query.filter_by(**attrs) + if "sort" in orderby: + # sort by given attribute e.g.sort=mass + clause = getattr(Planet, orderby["sort"]) + if "desc" in orderby: + # sort in descending order e.g.desc=True + planet_query = planet_query.order_by(clause.desc()) + else: + # default is asc=True + planet_query = planet_query.order_by(clause.asc()) + if sels: + # limit selection of planets to view + planet_query = planet_query.limit(**sels) + # perform query + planets = planet_query.all() + # fill http response + response_planets = [] + for planet in planets: + response_planets.append({ + "id": planet.id, + "name": planet.name, + "description": planet.description, + "mass": planet.mass + }) + return jsonify(response_planets) + + +# ~~~~~~ Single planet endpoint ~~~~~~ +@planets_bp.route("/",methods=["GET"]) +def display_planet(planet_id): + valid_planet = validate_id(planet_id) + return { + "id": valid_planet.id, + "name": valid_planet.name, + "description": valid_planet.description, + "mass": valid_planet.mass, + } + + +@planets_bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + + if "name" not in request_body or "description" not in request_body \ + or "mass" not in request_body: + abort(make_response({"message" : \ + "Failed to create a planet because the name and/or description \ + and/or mass are missing"}, 400)) + + new_planet = Planet( + name=request_body["name"], + description=request_body["description"], + mass=request_body["mass"]) + + db.session.add(new_planet) + db.session.commit() + + return make_response({"message":"planet has been created successfully"}, 201) + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + request_body = request.get_json() + planet = validate_id(planet_id) + planet.name = request_body["name"] if "name" in request_body else planet.name + planet.description = request_body["description"] if "description" in request_body else planet.description + planet.mass = request_body["mass"] if "mass" in request_body else planet.mass + db.session.commit() + return make_response( + {"message": f"planet #{planet_id} Updated Successfully"}, 200 + ) + + +@planets_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = validate_id(planet_id) + db.session.delete(planet) + db.session.commit() + return make_response( + {"message": f"planet #{planet_id} has been deleted successfully"}, 200 + ) 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/040c4f56aefe_.py b/migrations/versions/040c4f56aefe_.py new file mode 100644 index 000000000..048f67d14 --- /dev/null +++ b/migrations/versions/040c4f56aefe_.py @@ -0,0 +1,34 @@ +"""empty message + +Revision ID: 040c4f56aefe +Revises: +Create Date: 2022-12-21 18:58:13.305413 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '040c4f56aefe' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('planets', + 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('mass', sa.Float(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planets') + # ### end Alembic commands ### diff --git a/planets.csv b/planets.csv new file mode 100644 index 000000000..ad6c2ef2c --- /dev/null +++ b/planets.csv @@ -0,0 +1,8 @@ +1 Neptune thick, windy 1.0239999999999999e+26 +2 Earth rocky, terrestrial, full of life 5.972e+24 +3 Mars dusty, cold desert 6.39e+23 +6 Mercury small, solid & covered with craters 3.285e+23 +7 Venus Bright and solid surface with dome-like volcanoes, rifts, and mountains 4.867e+24 +8 Jupiter Cold, windy clouds of ammonia and water 1.89813e+27 +9 Saturn Massive ball made mostly of hydrogen and helium 5.683e+26 +10 Uranus Hot dense fluid of 'icy' materials - water, methane, and ammonia 8.681e+25 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..63d98d39c --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,39 @@ +import pytest +from app import create_app, db +from flask.signals import request_finished +from app.models.planet import Planet + +@pytest.fixture +def app(): + app = create_app(test_config=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): + earth = Planet(name="Earth", \ + description="rocky, terrestrial, full of life", mass=5.972e24) + mars = Planet(name="Mars", description="dusty, cold desert", \ + mass=6.39e23) + planets = [earth, mars] + db.session.add_all(planets) + db.session.commit() + + for planet in planets: + db.session.refresh(planet, ["id"]) + + return planets \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..359a02180 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,129 @@ +def test_get_all_planets_with_empty_db_returns_empty_list(client): + response = client.get("/planets") + + assert response.status_code == 200 + assert response.get_json() == [] + + +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": "Earth", + "description": "rocky, terrestrial, full of life", + "mass": 5.972e24 + } + +def test_create_one_planet(client): + #Act + response = client.post("/planets", json = { + "name": "Neptune", + "description": "thick, windy", + "mass":1.024e26 + }) + response_body = response.get_json() + + #Assert + assert response.status_code == 201 + assert response_body == {"message":"planet has been created successfully"} + +def test_create_one_planet_missing_mass_return_400(client): + #Act + response = client.post("/planets", json = { + "name": "Neptune", + "description": "thick, windy" + }) + response_body = response.get_json() + #Assert + assert response.status_code == 400 + assert response_body == {"message" : \ + "Failed to create a planet because the name and/or description \ + and/or mass are missing"} + + +def test_get_planet_by_id_with_empty_db_returns_404(client): + response = client.get("/planets/1") + + assert response.status_code == 404 + assert response.get_json() == {"message" : "1 not found"} + + +def test_update_planet_successfully(client, two_saved_planets): + test_data = {"name" : "earth", + "description" : "terrestrial, full of life", + "mass" : 5.97e24} + response = client.put("planets/1", json=test_data) + + assert response.status_code == 200 + assert response.get_json() == {"message": "planet #1 Updated Successfully"} + + +def test_get_planet_by_invalid_id_returns_400(client, two_saved_planets): + response = client.get("/planets/earth") + + assert response.status_code == 400 + assert response.get_json() == {"message": "earth is an invalid planet id"} + +def test_get_planet_by_valid_data_returns_data_and_200(client, two_saved_planets): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [ + {"name": "Earth", + "description": "rocky, terrestrial, full of life", + "mass": 5.972e24, + "id": 1}, + {"name": "Mars", + "description": "dusty, cold desert", + "mass": 6.39e23, + "id": 2} + ] + +def test_delete_planet_1_with_json_request_body_returns_200(client, two_saved_planets): + response = client.delete("/planets/1", json={ + "name": "Earth", + "description": "rocky, terrestrial, full of life", + "mass": 5.972e24, + "id": 1 + }) + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == {"message": f"planet #1 has been deleted successfully"}, 200 + +def test_get_mass_desc_and_limit_1_returns_data_and_200(client, two_saved_planets): + response = client.get("/planets?sort=mass&desc=True&limit=1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{ + "name": "Earth", + "description": "rocky, terrestrial, full of life", + "mass": 5.972e24, + "id": 1 + }] + +def test_get_name_desc_and_limit_1_returns_data_and_200(client, two_saved_planets): + response = client.get("/planets?sort=name&desc=True&limit=1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{ + "name": "Mars", + "description": "dusty, cold desert", + "mass": 6.39e23, + "id": 2 + }] + +def test_get_by_invalid_query_returns_error_message_and_400(client, two_saved_planets): + response = client.get("/planets?hamster=True") + response_body = response.get_json() + + assert response.status_code == 400 + assert response_body == {"message": "hamster is an invalid query"}