From ed54562bc1beb124909d5a1963ea29ffbb1fc823 Mon Sep 17 00:00:00 2001 From: Danqing Date: Tue, 25 Apr 2023 13:16:20 -0700 Subject: [PATCH 1/3] wave 1 and wave 2 --- app/__init__.py | 6 +++++- app/routes.py | 52 ++++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 56 insertions(+), 2 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..3d6726f3a 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,11 @@ from flask import Flask + def create_app(test_config=None): app = Flask(__name__) - return app + from .routes import bp + app.register_blueprint(bp) + + return app \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..b81ac6fa9 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,52 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, abort, make_response + +class Planet: + def __init__(self, id, name, description): + self.id = id + self.name = name + self.description = description + + def make_planet_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + ) + +planets = [ + Planet(1, "Apple Planet", "A planet that only grows Apple"), + Planet(2, "Orange Planet", "A planet that only grows orange"), + Planet(3, "Pear Planet", "A planet that only grows pear") +] + +bp = Blueprint("planets", __name__, url_prefix="/planets") + +def validate_planet(id): + try: + id = int(id) + except: + return abort(make_response({"message": f"{id} was invalid"}, 400)) + + for planet in planets: + if planet.id == id: + return planet + return abort(make_response({"message": f"Cat with id {id} was not found"}, 404)) + + +@bp.route("", methods=["GET"]) + +def get_all_planets(): + result_list = [] + + for planet in planets: + result_list.append(planet.make_planet_dict()) + + return jsonify(result_list) + + +@bp.route("/", methods=["GET"]) +def search_single_planet(id): + planet = validate_planet(id) + + return planet.make_planet_dict() From 7cc6cf0175dfe34821fbd39527f793dca13da0ca Mon Sep 17 00:00:00 2001 From: Danqing Date: Tue, 25 Apr 2023 13:47:48 -0700 Subject: [PATCH 2/3] minor change --- app/routes.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index b81ac6fa9..a84ef1010 100644 --- a/app/routes.py +++ b/app/routes.py @@ -25,12 +25,12 @@ def validate_planet(id): try: id = int(id) except: - return abort(make_response({"message": f"{id} was invalid"}, 400)) + abort(make_response({"message": f"{id} was invalid"}, 400)) for planet in planets: if planet.id == id: return planet - return abort(make_response({"message": f"Cat with id {id} was not found"}, 404)) + abort(make_response({"message": f"Cat with id {id} was not found"}, 404)) @bp.route("", methods=["GET"]) From 3b934859bab7c9ca699c6fece97a9ba400962375 Mon Sep 17 00:00:00 2001 From: celina-barron Date: Fri, 5 May 2023 14:56:09 -0700 Subject: [PATCH 3/3] all waves --- app/models/__init__.py | 0 app/models/planet.py | 24 +++++++ app/routes.py | 52 --------------- app/routes/__init__.py | 0 app/routes/planet_routes.py | 69 ++++++++++++++++++++ app/routes/routes_helpers.py | 13 ++++ migrations/README | 1 + migrations/alembic.ini | 45 +++++++++++++ migrations/env.py | 97 ++++++++++++++++++++++++++++ migrations/script.py.mako | 24 +++++++ migrations/versions/5857683fef96_.py | 34 ++++++++++ seed.py | 11 ++++ tests/__init__.py | 0 tests/conftest.py | 38 +++++++++++ tests/test_routes.py | 43 ++++++++++++ 15 files changed, 399 insertions(+), 52 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.py delete mode 100644 app/routes.py create mode 100644 app/routes/__init__.py create mode 100644 app/routes/planet_routes.py create mode 100644 app/routes/routes_helpers.py create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/5857683fef96_.py create mode 100644 seed.py create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_routes.py 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..3a3ee206c --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,24 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String, nullable=False) + description = db.Column(db.String, nullable=False) + rating = db.Column(db.Integer, nullable=False) + + @classmethod + def from_dict(cls, data_dict): + return cls( + id=data_dict["id"], + name=data_dict["name"], + description=data_dict["description"], + rating=data_dict["rating"] + ) + + def to_dictionary(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + rating=self.rating + ) diff --git a/app/routes.py b/app/routes.py deleted file mode 100644 index b81ac6fa9..000000000 --- a/app/routes.py +++ /dev/null @@ -1,52 +0,0 @@ -from flask import Blueprint, jsonify, abort, make_response - -class Planet: - def __init__(self, id, name, description): - self.id = id - self.name = name - self.description = description - - def make_planet_dict(self): - return dict( - id=self.id, - name=self.name, - description=self.description, - ) - -planets = [ - Planet(1, "Apple Planet", "A planet that only grows Apple"), - Planet(2, "Orange Planet", "A planet that only grows orange"), - Planet(3, "Pear Planet", "A planet that only grows pear") -] - -bp = Blueprint("planets", __name__, url_prefix="/planets") - -def validate_planet(id): - try: - id = int(id) - except: - return abort(make_response({"message": f"{id} was invalid"}, 400)) - - for planet in planets: - if planet.id == id: - return planet - return abort(make_response({"message": f"Cat with id {id} was not found"}, 404)) - - -@bp.route("", methods=["GET"]) - -def get_all_planets(): - result_list = [] - - for planet in planets: - result_list.append(planet.make_planet_dict()) - - return jsonify(result_list) - - -@bp.route("/", methods=["GET"]) -def search_single_planet(id): - planet = validate_planet(id) - - return planet.make_planet_dict() - diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py new file mode 100644 index 000000000..021d05445 --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,69 @@ +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.planet import Planet +from .routes_helpers import validate_model + + +bp = Blueprint("planets", __name__, url_prefix="/planets") + +#GET ALL ENDPOINT +@bp.route("", methods=["GET"]) +def get_all_planets(): + + rating_param = request.args.get("rating") + + planet_query = Planet.query + + if rating_param: + planet_query = planet_query.filter_by(rating=rating_param) + + planets_list = [planet.to_dict() for planet in planet_query] + + return jsonify(planets_list) + +# CREATE ENDPOINT +@bp.route("", methods=["POST"]) +def create_planet(): + request_body=request.get_json() + + new_planet = Planet.from_dict(request_body) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} successfully created!", 201) + +# GET ONE ENDPOINT +@bp.route("/", methods=["GET"]) +def handle_planet(id): + planet = validate_model(Planet, id) + + return jsonify(planet.to_dict()), 200 + +# UPDATE ONE ENDPOINT +@bp.route("/", methods=["PUT"]) +def update_planet(id): + planet = validate_model(Planet, id) + request_body = request.get_json() + + planet.id = request_body["id"] + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.rating = request_body["rating"] + + db.session.commit() + + return make_response(f"Planet {planet.name} successfully updated", 200) + +# DELETE ONE ENDPOINT +@bp.route("/", methods=["DELETE"]) +def delete_planet(id): + planet = validate_model(Planet, id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet {planet.name} successfully deleted", 200) + + + diff --git a/app/routes/routes_helpers.py b/app/routes/routes_helpers.py new file mode 100644 index 000000000..e67d2d9fe --- /dev/null +++ b/app/routes/routes_helpers.py @@ -0,0 +1,13 @@ +from flask import abort, make_response + +#HELPER FUNCTIONS +def validate_model(cls, id): + try: + id = int(id) + except: + abort(make_response({"message": f"{id} was invalid"}, 400)) + + model = cls.query.get(id) + + if not model: + abort(make_response({"message": f"{cls.__name__} with id {id} was not found"}, 404)) \ 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..ee1a65e3b --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,97 @@ +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/5857683fef96_.py b/migrations/versions/5857683fef96_.py new file mode 100644 index 000000000..e68fcd578 --- /dev/null +++ b/migrations/versions/5857683fef96_.py @@ -0,0 +1,34 @@ +"""empty message + +Revision ID: 5857683fef96 +Revises: +Create Date: 2023-04-28 11:08:47.978712 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '5857683fef96' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('cat', + 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('personality', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('cat') + # ### end Alembic commands ### diff --git a/seed.py b/seed.py new file mode 100644 index 000000000..0d6cf33d4 --- /dev/null +++ b/seed.py @@ -0,0 +1,11 @@ +from app import create_app, db +from app.models.planet import Planet + +my_app = create_app() +with my_app.app_context(): + db.session.add(Planet(id="1", name="Apple Planet", description="A planet that only grows apples.", rating="5")) + db.session.add(Planet(id="2", name="Orange Planet", description="A planet that only grows oranges.", rating="3")) + db.session.add(Planet(id="3", name="Pear Planet", description="A planet that only grows pears.", rating="1")) + db.session.commit() + + 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..5d783bd52 --- /dev/null +++ b/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 one_planet(app): + planet = Planet( + id="id", + name="name", + description="description", + rating="rating" + ) + db.session.add(planet) + db.session.commit() + return planet \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..d32201864 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,43 @@ +from app.models.planet import Planet + +def test_get_all_planetss_return_empty_list_when_db_is_empty(client): + # Act + response = client.get("/planets") + + # Assert + assert response.status_code == 200 + assert response.get_json() == [] + +def test_get_one_planet_returns_seeded_planet(client, one_planet): + # Act + response = client.get(f"/planets/{one_planet.id}") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body["id"] == one_planet.id + assert response_body["name"] == one_planet.name + assert response_body["description"] == one_planet.description + assert response_body["rating"] == one_planet.rating + +def test_create_planet_happy_path(client): + EXPECTED_PLANET = dict( + id="id", + name="name", + description="description", + rating="rating" + ) + # Act + response = client.post("/planets", json=EXPECTED_PLANET) + response_body = response.get_data(as_text=True) + + actual_planet = Planet.query.get(1) + + # Assert + assert response.status_code == 201 + assert response_body == f"Planet {EXPECTED_PLANET['name']} successfully created" + + assert EXPECTED_PLANET["id"] == actual_planet.id + assert EXPECTED_PLANET["name"] == actual_planet.name + assert EXPECTED_PLANET["description"] == actual_planet.description + assert EXPECTED_PLANET["color"] == actual_planet.rating \ No newline at end of file