diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..e36830076 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,29 @@ 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") - return app + else: + print("Testing is on") + 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 planets_bp + from app.models.planet import Planet + app.register_blueprint(planets_bp) + + return app \ No newline at end of file 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..7fb1c8fee --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,9 @@ +from app import db + + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + order_from_sun = db.Column(db.Integer) + name = db.Column(db.String) + description = db.Column(db.String) + gravity = db.Column(db.String) diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..273d3b5b7 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,101 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request, abort + + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + +@planets_bp.route("/teapot", methods=["GET", "POST"]) +def handle_teapot(): + return make_response("I'm a teapot!", 418) + +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 + +@planets_bp.route("/", methods = ["GET"]) +def read_one_planet(planet_id): + planet = validate_planet(planet_id) + return { + "id": planet.id, + "order_from_sun": planet.order_from_sun, + "name": planet.name, + "description": planet.description, + "gravity": planet.gravity + } + +@planets_bp.route("", methods=["GET"]) +def get_all_planets(): + name_query = request.args.get("name") + description_query = request.args.get("description") + order_from_sun_query = request.args.get("order_from_sun") + if name_query: + planets = Planet.query.filter_by(name=name_query) + elif description_query: + planets = Planet.query.filter(Planet.description.ilike("%" + description_query + "%")) + elif order_from_sun_query: + planets = Planet.query.filter_by(order_from_sun =order_from_sun_query) + else: + planets = Planet.query.all() + + planets_response = [] + for planet in planets: + planets_response.append({ + "id": planet.id, + "order_from_sun": planet.order_from_sun, + "name": planet.name, + "description": planet.description, + "gravity": planet.gravity + }) + return jsonify(planets_response) + +@planets_bp.route("", methods=["POST"]) +def add_planet(): + request_body = request.get_json() + new_planet = Planet( + name=request_body["name"], + order_from_sun=request_body["order_from_sun"], + description=request_body["description"], + gravity=request_body["gravity"]) + + db.session.add(new_planet) + db.session.commit() + + return make_response(jsonify(f"Planet {new_planet.name} successfully created"), 201) + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + request_body_keys = request_body.keys() + + if "name" in request_body_keys: + planet.name = request_body["name"] + if "description" in request_body_keys: + planet.description = request_body["description"] + if "gravity" in request_body_keys: + planet.gravity = request_body["gravity"] + if "order_from_sun" in request_body_keys: + planet.order_from_sun = request_body["order_from_sun"] + + db.session.commit() + return make_response(f"Planet #{planet.id} successfully updated", 200) + +@planets_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", 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/c5672b3cf4c5_updated_planet_model_to_include_order.py b/migrations/versions/c5672b3cf4c5_updated_planet_model_to_include_order.py new file mode 100644 index 000000000..f5af1602c --- /dev/null +++ b/migrations/versions/c5672b3cf4c5_updated_planet_model_to_include_order.py @@ -0,0 +1,28 @@ +"""updated planet model to include order + +Revision ID: c5672b3cf4c5 +Revises: f07136d1f4eb +Create Date: 2022-05-04 11:42:13.063620 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'c5672b3cf4c5' +down_revision = 'f07136d1f4eb' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('order_from_sun', sa.Integer(), nullable=True)) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column('planet', 'order_from_sun') + # ### end Alembic commands ### diff --git a/migrations/versions/f07136d1f4eb_created_planet_model.py b/migrations/versions/f07136d1f4eb_created_planet_model.py new file mode 100644 index 000000000..48e0388cd --- /dev/null +++ b/migrations/versions/f07136d1f4eb_created_planet_model.py @@ -0,0 +1,34 @@ +"""created planet model + +Revision ID: f07136d1f4eb +Revises: +Create Date: 2022-05-03 11:08:22.973995 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'f07136d1f4eb' +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('gravity', 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/planets.csv b/planets.csv new file mode 100644 index 000000000..9bc9dbfba --- /dev/null +++ b/planets.csv @@ -0,0 +1,5 @@ +order_from_sun, name, description, gravity +3, Earth, something about earth, 9.81 m/s2 +2, Venus, Very hot planet with a dense atmosphere, 8.87 m/s2 +1, Mercury, Closest planet to the sun, m/s2 +4, Mars, Thin atmosphere, m/s2 \ No newline at end of file diff --git a/project-directions/wave_02.md b/project-directions/wave_02.md index f0e1e175a..2c30f6ca2 100644 --- a/project-directions/wave_02.md +++ b/project-directions/wave_02.md @@ -8,4 +8,7 @@ As a client, I want to send a request... 1. ...to get one existing `planet`, so that I can see the `id`, `name`, `description`, and other data of the `planet`. 1. ... such that trying to get one non-existing `planet` responds with get a `404` response, so that I know the `planet` resource was not found. 1. ... such that trying to get one `planet` with an invalid `planet_id` responds with get a `400` response, so that I know the `planet_id` was invalid. + + + \ No newline at end of file diff --git a/solar-system-api.code-workspace b/solar-system-api.code-workspace new file mode 100644 index 000000000..876a1499c --- /dev/null +++ b/solar-system-api.code-workspace @@ -0,0 +1,8 @@ +{ + "folders": [ + { + "path": "." + } + ], + "settings": {} +} \ No newline at end of file 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..84d888420 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,37 @@ +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_planets(app): + Earth = Planet(id=3, order_from_sun= 3, name="Earth", description= "something about earth", gravity= "9.81 m/s2") + Venus = Planet(id=2, order_from_sun= 2, name="Venus", description= "Very hot planet with a dense atmosphere", gravity= "8.87 m/s2") + + + db.session.add(Earth) + db.session.add(Venus) + db.session.commit() diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..342ebf315 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,71 @@ +# from hello-books + +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_handle_teapot(client): + response = client.get("/planets/teapot") + + assert response.status_code == 418 + +def test_get_one_planet(client, two_planets): + # Act + response = client.get("/planets/3") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 3, + "name": "Earth", + "order_from_sun": 3, + "description": "something about earth", + "gravity": "9.81 m/s2" + } + +def test_get_all_planets(client, two_planets): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{ + "id": 3, + "name": "Earth", + "order_from_sun": 3, + "description": "something about earth", + "gravity": "9.81 m/s2"}, + {"id": 2, + "name": "Venus", + "order_from_sun":2, + "description":"Very hot planet with a dense atmosphere", + "gravity": "8.87 m/s2"} + ] + + + +def test_get_invalid_planet(client): + response = client.get("planets/12") + response_body = response.get_json() + + assert response.status_code == 404 + +def test_post_one_planet_to_database(client): + response = client.post("/planets", json = { + "name": "Pluto", + "order_from_sun": 9, + "description": "Pluto is smaller than Earth's moon", + "gravity": "0.62 m/s2" + }) + response_body = response.get_json() + + assert response.status_code == 201 + print(response_body) + assert response_body == b"Planet Pluto successfully created" + +