From 8fbd584417fcf76b3a7c9b93ec93241197250f94 Mon Sep 17 00:00:00 2001 From: Ericka Date: Thu, 20 Apr 2023 11:58:34 -0700 Subject: [PATCH 01/24] implemented init and routes --- app/__init__.py | 5 +++++ app/routes.py | 26 +++++++++++++++++++++++++- 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..b5813e27e 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,4 +4,9 @@ def create_app(test_config=None): app = Flask(__name__) + # from flask import Blueprint + from .routes import planets_bp + + app.register_blueprint(planets_bp) + return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..84e6aa8d9 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,26 @@ -from flask import Blueprint +from flask import Blueprint, jsonify +class Planet(): + def __init__(self, id, name, description, distance_from_sun): + self.id = id + self.name = name + self.description = description + self.distance_from_sun = distance_from_sun + +planet_list = [ + Planet(1, "Mercury", "blue", 0.39), + Planet(2, "Venus", "yellow", 0.72), + Planet(3, "Earth", "blue", 1), + Planet(4, "Mars", "orange", 1.52), + Planet(5, "Jupiter", "orange", 5.2), + Planet(6, "Saturn", "yellow", 9.54), + Planet(7, "Uranus", "blue", 19.2), + Planet(8, "Neptune", "blue", 30.06) +] + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + +@planets_bp.route("", methods=['GET']) +def handle_planets(): + planets_as_dict = [vars(planet) for planet in planet_list] + return jsonify(planets_as_dict), 200 From 3f04f96d067189e73e48f7bbba3f76acc29de4b1 Mon Sep 17 00:00:00 2001 From: Ericka Date: Fri, 21 Apr 2023 11:33:12 -0700 Subject: [PATCH 02/24] implemented helper function validate planet and created new route called /planet/id --- app/routes.py | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 84e6aa8d9..cf5145570 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,4 @@ -from flask import Blueprint, jsonify +from flask import Blueprint, jsonify, abort, make_response class Planet(): def __init__(self, id, name, description, distance_from_sun): @@ -18,9 +18,35 @@ def __init__(self, id, name, description, distance_from_sun): Planet(8, "Neptune", "blue", 30.06) ] +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response({'msg': f"Invalid id '{planet_id}'"}, 400)) + + for planet in planet_list: + if planet.id == planet_id: + return planet + return abort(make_response({'msg': f"No planet with id {planet_id}"}, 404)) + + + + planets_bp = Blueprint("planets", __name__, url_prefix="/planets") @planets_bp.route("", methods=['GET']) def handle_planets(): planets_as_dict = [vars(planet) for planet in planet_list] return jsonify(planets_as_dict), 200 + +@planets_bp.route("/", methods=["GET"]) +def handle_planet(planet_id): + planet = validate_planet(planet_id) + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "distance from sun": planet.distance_from_sun + }, 200 + + From 870045bb6142ad66bb0c71e521fa23af70ef304a Mon Sep 17 00:00:00 2001 From: Sophia Tran Date: Thu, 27 Apr 2023 13:48:30 -0700 Subject: [PATCH 03/24] configured sqlalchemy and migrate --- app/__init__.py | 10 ++++ migrations/README | 1 + migrations/alembic.ini | 45 ++++++++++++++++++ migrations/env.py | 96 +++++++++++++++++++++++++++++++++++++++ migrations/script.py.mako | 24 ++++++++++ 5 files changed, 176 insertions(+) create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako diff --git a/app/__init__.py b/app/__init__.py index b5813e27e..57538b1bc 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,9 +1,19 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +db = SQLAlchemy() +migrate = Migrate() def create_app(test_config=None): app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + + db.init_app(app) + migrate.init_app(app, db) + # from flask import Blueprint from .routes import planets_bp 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"} From 1c4680d41e4a2d9b7b79c1c474b1ad2810a8d110 Mon Sep 17 00:00:00 2001 From: Sophia Tran Date: Thu, 27 Apr 2023 14:19:47 -0700 Subject: [PATCH 04/24] created Planet model, added new migration --- app/__init__.py | 3 +- app/models/planet.py | 7 ++++ ...created_models_folder_and_added_planet_.py | 34 +++++++++++++++++++ 3 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 app/models/planet.py create mode 100644 migrations/versions/beefc1e65a76_created_models_folder_and_added_planet_.py diff --git a/app/__init__.py b/app/__init__.py index 57538b1bc..10345c458 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -13,9 +13,10 @@ def create_app(test_config=None): db.init_app(app) migrate.init_app(app, db) - + # from flask import Blueprint from .routes import planets_bp + from app.models.planet import Planet app.register_blueprint(planets_bp) diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..042a9de5f --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,7 @@ +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) + distance_from_sun = db.Column(db.Integer) \ No newline at end of file diff --git a/migrations/versions/beefc1e65a76_created_models_folder_and_added_planet_.py b/migrations/versions/beefc1e65a76_created_models_folder_and_added_planet_.py new file mode 100644 index 000000000..02d471620 --- /dev/null +++ b/migrations/versions/beefc1e65a76_created_models_folder_and_added_planet_.py @@ -0,0 +1,34 @@ +"""created models folder and added Planet model in planet.py + +Revision ID: beefc1e65a76 +Revises: +Create Date: 2023-04-27 14:14:25.328130 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'beefc1e65a76' +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_sun', sa.Integer(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + # ### end Alembic commands ### From 5ff20707e68a168d5f3bd189bbd061800fe6b42b Mon Sep 17 00:00:00 2001 From: Sophia Tran Date: Thu, 27 Apr 2023 14:38:43 -0700 Subject: [PATCH 05/24] implemented create_planet for POST method --- app/routes.py | 80 +++++++++++++++++++++++++++++---------------------- 1 file changed, 46 insertions(+), 34 deletions(-) diff --git a/app/routes.py b/app/routes.py index cf5145570..19b13baa1 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,22 +1,24 @@ -from flask import Blueprint, jsonify, abort, make_response - -class Planet(): - def __init__(self, id, name, description, distance_from_sun): - self.id = id - self.name = name - self.description = description - self.distance_from_sun = distance_from_sun - -planet_list = [ - Planet(1, "Mercury", "blue", 0.39), - Planet(2, "Venus", "yellow", 0.72), - Planet(3, "Earth", "blue", 1), - Planet(4, "Mars", "orange", 1.52), - Planet(5, "Jupiter", "orange", 5.2), - Planet(6, "Saturn", "yellow", 9.54), - Planet(7, "Uranus", "blue", 19.2), - Planet(8, "Neptune", "blue", 30.06) -] +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.planet import Planet + +# class Planet(): +# def __init__(self, id, name, description, distance_from_sun): +# self.id = id +# self.name = name +# self.description = description +# self.distance_from_sun = distance_from_sun + +# planet_list = [ +# Planet(1, "Mercury", "blue", 0.39), +# Planet(2, "Venus", "yellow", 0.72), +# Planet(3, "Earth", "blue", 1), +# Planet(4, "Mars", "orange", 1.52), +# Planet(5, "Jupiter", "orange", 5.2), +# Planet(6, "Saturn", "yellow", 9.54), +# Planet(7, "Uranus", "blue", 19.2), +# Planet(8, "Neptune", "blue", 30.06) +# ] def validate_planet(planet_id): try: @@ -30,23 +32,33 @@ def validate_planet(planet_id): return abort(make_response({'msg': f"No planet with id {planet_id}"}, 404)) +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") +@planets_bp.route("", methods=['POST']) +def create_planet(): + request_body = request.get_json() + new_planet = Planet(name=request_body["name"], + description=request_body["description"], + distance_from_sun=request_body["distance from sun"]) + + db.session.add(new_planet) + db.session.commit() -planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + return make_response(f"Planet {new_planet.name} successfully created", 201) + +# @planets_bp.route("", methods=['GET']) +# def handle_planets(): +# planets_as_dict = [vars(planet) for planet in planet_list] +# return jsonify(planets_as_dict), 200 -@planets_bp.route("", methods=['GET']) -def handle_planets(): - planets_as_dict = [vars(planet) for planet in planet_list] - return jsonify(planets_as_dict), 200 - -@planets_bp.route("/", methods=["GET"]) -def handle_planet(planet_id): - planet = validate_planet(planet_id) - return { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "distance from sun": planet.distance_from_sun - }, 200 +# @planets_bp.route("/", methods=["GET"]) +# def handle_planet(planet_id): +# planet = validate_planet(planet_id) +# return { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description, +# "distance from sun": planet.distance_from_sun +# }, 200 From 4e7e71447268c7948182ad4ee5b86d1505d7f16d Mon Sep 17 00:00:00 2001 From: Sophia Tran Date: Thu, 27 Apr 2023 14:53:08 -0700 Subject: [PATCH 06/24] implemented get_planets with GET method for /planets route --- app/routes.py | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/app/routes.py b/app/routes.py index 19b13baa1..fb93a2538 100644 --- a/app/routes.py +++ b/app/routes.py @@ -20,16 +20,16 @@ # Planet(8, "Neptune", "blue", 30.06) # ] -def validate_planet(planet_id): - try: - planet_id = int(planet_id) - except: - abort(make_response({'msg': f"Invalid id '{planet_id}'"}, 400)) +# def validate_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# abort(make_response({'msg': f"Invalid id '{planet_id}'"}, 400)) - for planet in planet_list: - if planet.id == planet_id: - return planet - return abort(make_response({'msg': f"No planet with id {planet_id}"}, 404)) +# for planet in planet_list: +# if planet.id == planet_id: +# return planet +# return abort(make_response({'msg': f"No planet with id {planet_id}"}, 404)) planets_bp = Blueprint("planets", __name__, url_prefix="/planets") @@ -46,6 +46,19 @@ def create_planet(): return make_response(f"Planet {new_planet.name} successfully created", 201) +@planets_bp.route("", methods=['GET']) +def get_planets(): + planets = Planet.query.all() + planets_response = [] + for planet in planets: + planets_response.append({ + "id": planet.id, + "name": planet.name, + "description": planet.description, + "distance from sun": planet.distance_from_sun + }) + return jsonify(planets_response) + # @planets_bp.route("", methods=['GET']) # def handle_planets(): # planets_as_dict = [vars(planet) for planet in planet_list] From ac2e36e0b127eac66b027ad13b23275eb3de37f0 Mon Sep 17 00:00:00 2001 From: Ericka Date: Mon, 1 May 2023 13:27:51 -0700 Subject: [PATCH 07/24] implemented GET route for one planet --- app/routes.py | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/app/routes.py b/app/routes.py index fb93a2538..db8bd187e 100644 --- a/app/routes.py +++ b/app/routes.py @@ -20,16 +20,19 @@ # Planet(8, "Neptune", "blue", 30.06) # ] -# def validate_planet(planet_id): -# try: -# planet_id = int(planet_id) -# except: -# abort(make_response({'msg': f"Invalid id '{planet_id}'"}, 400)) +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response({'msg': f"Invalid id '{planet_id}'"}, 400)) + + planet = Planet.query.get(planet_id) + + if planet: + return planet + else: + return abort(make_response({'msg': f"No planet with id {planet_id}"}, 404)) -# for planet in planet_list: -# if planet.id == planet_id: -# return planet -# return abort(make_response({'msg': f"No planet with id {planet_id}"}, 404)) planets_bp = Blueprint("planets", __name__, url_prefix="/planets") @@ -59,6 +62,19 @@ def get_planets(): }) return jsonify(planets_response) +@planets_bp.route("/", methods=["GET"]) +def get_one_planet(planet_id): + + planet = validate_planet(planet_id) + + return ({ + "id": planet.id, + "name": planet.name, + "description": planet.description, + "distance from sun": planet.distance_from_sun + }), 200 + + # @planets_bp.route("", methods=['GET']) # def handle_planets(): # planets_as_dict = [vars(planet) for planet in planet_list] From 8d21b30f576858cc0c0c392566df479aa20ddf5d Mon Sep 17 00:00:00 2001 From: Ericka Date: Mon, 1 May 2023 13:43:11 -0700 Subject: [PATCH 08/24] implemented PUT method to update one planet --- app/models/planet.py | 2 +- app/routes.py | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/app/models/planet.py b/app/models/planet.py index 042a9de5f..7c8b7cc47 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -4,4 +4,4 @@ class Planet(db.Model): id = db.Column(db.Integer, primary_key=True, autoincrement=True) name = db.Column(db.String) description = db.Column(db.String) - distance_from_sun = db.Column(db.Integer) \ No newline at end of file + distance_from_sun = db.Column(db.Integer) diff --git a/app/routes.py b/app/routes.py index db8bd187e..6593f92a6 100644 --- a/app/routes.py +++ b/app/routes.py @@ -75,6 +75,28 @@ def get_one_planet(planet_id): }), 200 +@planets_bp.route("/", methods=["PUT"]) +def update_one_planet(planet_id): + # Get the data from the request body + request_body = request.get_json() + + planet_to_update = validate_planet(planet_id) + + planet_to_update.name = request_body["name"] + planet_to_update.description = request_body["description"] + planet_to_update.distance_from_sun = request_body["distance from sun"] + + db.session.commit() + + return ({ + "id": planet_to_update.id, + "name": planet_to_update.name, + "description": planet_to_update.description, + "distance from sun": planet_to_update.distance_from_sun + }), 200 + + + # @planets_bp.route("", methods=['GET']) # def handle_planets(): # planets_as_dict = [vars(planet) for planet in planet_list] From b177034121d401cec108b9ffb5d1725414c371d5 Mon Sep 17 00:00:00 2001 From: Ericka Date: Mon, 1 May 2023 13:49:41 -0700 Subject: [PATCH 09/24] implemented DELETE route for single planet --- app/routes.py | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/app/routes.py b/app/routes.py index 6593f92a6..78ec31867 100644 --- a/app/routes.py +++ b/app/routes.py @@ -97,19 +97,13 @@ def update_one_planet(planet_id): -# @planets_bp.route("", methods=['GET']) -# def handle_planets(): -# planets_as_dict = [vars(planet) for planet in planet_list] -# return jsonify(planets_as_dict), 200 - -# @planets_bp.route("/", methods=["GET"]) -# def handle_planet(planet_id): -# planet = validate_planet(planet_id) -# return { -# "id": planet.id, -# "name": planet.name, -# "description": planet.description, -# "distance from sun": planet.distance_from_sun -# }, 200 +@planets_bp.route("/", methods=["DELETE"]) +def delete_one_planet(planet_id): + planet_to_delete = validate_planet(planet_id) + + db.session.delete(planet_to_delete) + db.session.commit() + + return f"Planet {planet_to_delete.name} is deleted!", 200 From 940022ab51695edebe12d1dd8620c16a952bd00d Mon Sep 17 00:00:00 2001 From: Sophia Tran Date: Tue, 2 May 2023 11:36:16 -0700 Subject: [PATCH 10/24] Added query param name for GET routes /planets --- app/routes.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 78ec31867..9c9004b20 100644 --- a/app/routes.py +++ b/app/routes.py @@ -51,7 +51,12 @@ def create_planet(): @planets_bp.route("", methods=['GET']) def get_planets(): - planets = Planet.query.all() + 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({ From a9e50159d0483b957f46c56303fada037775d201 Mon Sep 17 00:00:00 2001 From: Ericka Date: Wed, 3 May 2023 13:24:54 -0700 Subject: [PATCH 11/24] refactored create app for test database --- app/__init__.py | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 10345c458..b64e6a825 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,23 +1,38 @@ 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): +def create_app(testing=None): app = Flask(__name__) - - app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + + if testing is None: + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get('SQLALCHEMY_DATABASE_URI') + else: + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get('SQLALCHEMY_TEST_DATABASE_URIRI') + + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + db.init_app(app) + migrate.init_app(app, db) db.init_app(app) migrate.init_app(app, db) - # from flask import Blueprint - from .routes import planets_bp + from app.models.planet import Planet + from flask import Blueprint + from .routes import planets_bp + app.register_blueprint(planets_bp) return app + + + From 32e704e02c7b23448853b2ec1f786143f9d0d126 Mon Sep 17 00:00:00 2001 From: Ericka Date: Wed, 3 May 2023 13:30:19 -0700 Subject: [PATCH 12/24] fixed typo in create app --- app/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index b64e6a825..cdab5b069 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -15,7 +15,7 @@ def create_app(testing=None): if testing is None: app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get('SQLALCHEMY_DATABASE_URI') else: - app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get('SQLALCHEMY_TEST_DATABASE_URIRI') + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get('SQLALCHEMY_TEST_DATABASE_URI') app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False db.init_app(app) From 6c9eff8c2f110251b2e784797c2ea070e215c8ab Mon Sep 17 00:00:00 2001 From: Ericka Date: Wed, 3 May 2023 13:34:28 -0700 Subject: [PATCH 13/24] created tests folder with _init__.py conftest.py and test_routes.py --- tests/__init__.py | 0 tests/conftest.py | 32 ++++++++++++++++++++++++++++++++ tests/test_routes.py | 0 3 files changed, 32 insertions(+) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_routes.py 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..24304f8e2 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,32 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planet import Planet + + +# CREATE A NEW "TEST" APP +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + # CLOSE THE DATABASE SESSION + @request_finished.connect_via(app) + def expire_session(send, response, **extra): + db.session.remove() + + # AKA ARRANGE PORTION OF TESTING + # SET UP A DATABASE + with app.app_context(): + db.create_all() # RUN ALL THE MIGRATIONS + yield app + + # CLEAR DATABASE + with app.app_context(): + db.drop_all() + +# CREATE A NEW CLIENT TO SEND OUR REQUESTS +# AKA: creating a pytest version of Postman +@pytest.fixture +def client(app): + return app.test_client() \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..e69de29bb From c53075c4093678dcccc9fa5a16801d4e754c5eac Mon Sep 17 00:00:00 2001 From: Ericka Date: Wed, 3 May 2023 13:46:05 -0700 Subject: [PATCH 14/24] created test for empty database returns 200 --- app/__init__.py | 3 --- tests/test_routes.py | 9 +++++++++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index cdab5b069..41e45d59e 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -21,9 +21,6 @@ def create_app(testing=None): db.init_app(app) migrate.init_app(app, db) - db.init_app(app) - migrate.init_app(app, db) - from app.models.planet import Planet from flask import Blueprint diff --git a/tests/test_routes.py b/tests/test_routes.py index e69de29bb..b64f779f6 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -0,0 +1,9 @@ +def test_get_all_planets_with_empty_db_returns_empty_list(client): + # ARRANGE IS INSIDE CONFTEST + # ACT + response = client.get('/planets') + response_body = response.get_json() + + # ASSERT + assert response_body == [] + assert response.status_code == 200 \ No newline at end of file From b671ac7c06adcc543d50f7c687ec28e4e92d569a Mon Sep 17 00:00:00 2001 From: Ericka Date: Wed, 3 May 2023 14:00:17 -0700 Subject: [PATCH 15/24] created test for GET one planet --- tests/conftest.py | 16 +++++++++++++++- tests/test_routes.py | 21 ++++++++++++++++++++- 2 files changed, 35 insertions(+), 2 deletions(-) diff --git a/tests/conftest.py b/tests/conftest.py index 24304f8e2..480fa8a7f 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -29,4 +29,18 @@ def expire_session(send, response, **extra): # AKA: creating a pytest version of Postman @pytest.fixture def client(app): - return app.test_client() \ No newline at end of file + return app.test_client() + +@pytest.fixture +def two_planets(app): + planet_one = Planet(id=1, name="Furby", description="Purple", distance_from_sun=17) + planet_two = Planet(id=2, name="Squiggles", description="Orange", distance_from_sun=29) + + db.session.add(planet_one) + db.session.add(planet_two) + + + db.session.commit() + + + # we are working on writing tests portion of wave 6 of project. We need to create fixtures and unit tests \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py index b64f779f6..718e0e33a 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -6,4 +6,23 @@ def test_get_all_planets_with_empty_db_returns_empty_list(client): # ASSERT assert response_body == [] - assert response.status_code == 200 \ No newline at end of file + assert response.status_code == 200 + + + + +# GET /planets/1 returns a response body that matches our fixture +def test_get_one_planet_returns_correct_pkanet(client, two_planets): + # ACT + response = client.get('/planets/1') + response_body = response.get_json() + + # ASSERT + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Furby", + "description": "Purple", + "distance from sun": 17 + } + From 160d25abe2b3c8589da5bc3af1e7e6b760621420 Mon Sep 17 00:00:00 2001 From: Ericka Date: Wed, 3 May 2023 14:37:29 -0700 Subject: [PATCH 16/24] added test for empty db returns 404 --- tests/test_routes.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/tests/test_routes.py b/tests/test_routes.py index 718e0e33a..da79b4c75 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -11,7 +11,7 @@ def test_get_all_planets_with_empty_db_returns_empty_list(client): -# GET /planets/1 returns a response body that matches our fixture + def test_get_one_planet_returns_correct_pkanet(client, two_planets): # ACT response = client.get('/planets/1') @@ -26,3 +26,9 @@ def test_get_one_planet_returns_correct_pkanet(client, two_planets): "distance from sun": 17 } +def test_get_one_animal_empty_db_returns_404(client): + response = client.get("/planets/1") + assert response.status_code == 404 + + + \ No newline at end of file From 255c902866801cdd8095b59cd4eb00648a3c8748 Mon Sep 17 00:00:00 2001 From: Ericka Date: Wed, 3 May 2023 14:44:10 -0700 Subject: [PATCH 17/24] created test for GET/planets returns 200 --- tests/test_routes.py | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/tests/test_routes.py b/tests/test_routes.py index da79b4c75..7591ea37e 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -31,4 +31,23 @@ def test_get_one_animal_empty_db_returns_404(client): assert response.status_code == 404 - \ No newline at end of file +def test_get_all_planets_returns_200(client, two_planets): + # ACT + response = client.get('/planets') + response_body = response.get_json() + + # ASSERT + assert response.status_code == 200 + assert response_body == [ + { + "id": 1, + "name": "Furby", + "description": "Purple", + "distance from sun": 17 + }, + { + "id": 2, + "name": "Squiggles", + "description": "Orange", + "distance from sun": 29 + }] \ No newline at end of file From 41dab81548676d72615897c95ac90830174d8d44 Mon Sep 17 00:00:00 2001 From: Ericka Date: Wed, 3 May 2023 14:59:30 -0700 Subject: [PATCH 18/24] completed test for POST new planet --- app/routes.py | 10 +++++++++- tests/test_routes.py | 19 ++++++++++++++++++- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index 9c9004b20..00b1c30bb 100644 --- a/app/routes.py +++ b/app/routes.py @@ -47,7 +47,15 @@ def create_planet(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.name} successfully created", 201) + return ({ + "id": new_planet.id, + "name": new_planet.name, + "description": new_planet.description, + "distance from sun": new_planet.distance_from_sun, + "msg": "Successfully created" + }, 201) + + # return make_response(f"Planet {new_planet.name} successfully created", 201) @planets_bp.route("", methods=['GET']) def get_planets(): diff --git a/tests/test_routes.py b/tests/test_routes.py index 7591ea37e..af88b3bb0 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -50,4 +50,21 @@ def test_get_all_planets_returns_200(client, two_planets): "name": "Squiggles", "description": "Orange", "distance from sun": 29 - }] \ No newline at end of file + }] + +def test_post_one_planet_creates_planet_in_db(client): + response = client.post("/planets", json={ + "name": "Earth", + "description": "Blue", + "distance from sun": 2 + } + ) + print ("testing") + response_body = response.get_json() + print(response_body) + assert response.status_code == 201 + + # print(response_body["name"]) + # assert response_body["id"] == + # assert response_body["name"] == "Earth" + # assert "msg" in response_body \ No newline at end of file From a7e7ffc9c199c48043fe2c46869506e4f3c21f4c Mon Sep 17 00:00:00 2001 From: Ericka Date: Fri, 5 May 2023 14:33:18 -0700 Subject: [PATCH 19/24] Refactor: added to_dict function --- app/models/planet.py | 12 ++++++++++++ app/routes.py | 11 ++++------- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 7c8b7cc47..0766b530e 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -5,3 +5,15 @@ class Planet(db.Model): name = db.Column(db.String) description = db.Column(db.String) distance_from_sun = db.Column(db.Integer) + + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "distance from sun": self.distance_from_sun + } + + + diff --git a/app/routes.py b/app/routes.py index 00b1c30bb..196bde3fe 100644 --- a/app/routes.py +++ b/app/routes.py @@ -67,13 +67,10 @@ def get_planets(): planets_response = [] for planet in planets: - planets_response.append({ - "id": planet.id, - "name": planet.name, - "description": planet.description, - "distance from sun": planet.distance_from_sun - }) - return jsonify(planets_response) + planets_response.append(planet.to_dict()) + + return jsonify(planets_response), 200 + @planets_bp.route("/", methods=["GET"]) def get_one_planet(planet_id): From 3284626239a9fd034ea7c43607c1e2bb4c11ef1c Mon Sep 17 00:00:00 2001 From: Ericka Date: Fri, 5 May 2023 14:47:01 -0700 Subject: [PATCH 20/24] Refactor: implemented from_dict class method Co-authored-by: sophiat8832 --- app/models/planet.py | 9 ++++++++- app/routes.py | 5 +---- tests/test_routes.py | 5 +---- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 0766b530e..e8f2e6e01 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -15,5 +15,12 @@ def to_dict(self): "distance from sun": self.distance_from_sun } - + @classmethod + def from_dict(cls, planet_details): + new_planet = cls( + name=planet_details["name"], + description=planet_details["description"], + distance_from_sun=planet_details["distance from sun"] + ) + return new_planet diff --git a/app/routes.py b/app/routes.py index 196bde3fe..3cb3f770a 100644 --- a/app/routes.py +++ b/app/routes.py @@ -40,9 +40,7 @@ def validate_planet(planet_id): @planets_bp.route("", methods=['POST']) def create_planet(): request_body = request.get_json() - new_planet = Planet(name=request_body["name"], - description=request_body["description"], - distance_from_sun=request_body["distance from sun"]) + new_planet = Planet.from_dict(request_body) db.session.add(new_planet) db.session.commit() @@ -55,7 +53,6 @@ def create_planet(): "msg": "Successfully created" }, 201) - # return make_response(f"Planet {new_planet.name} successfully created", 201) @planets_bp.route("", methods=['GET']) def get_planets(): diff --git a/tests/test_routes.py b/tests/test_routes.py index af88b3bb0..d026a2923 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -9,9 +9,6 @@ def test_get_all_planets_with_empty_db_returns_empty_list(client): assert response.status_code == 200 - - - def test_get_one_planet_returns_correct_pkanet(client, two_planets): # ACT response = client.get('/planets/1') @@ -26,7 +23,7 @@ def test_get_one_planet_returns_correct_pkanet(client, two_planets): "distance from sun": 17 } -def test_get_one_animal_empty_db_returns_404(client): +def test_get_one_planet_empty_db_returns_404(client): response = client.get("/planets/1") assert response.status_code == 404 From 19a0a6c5081c2b46e1e6fda82d3b596687ddd71a Mon Sep 17 00:00:00 2001 From: Ericka Date: Fri, 5 May 2023 14:54:53 -0700 Subject: [PATCH 21/24] Refactor: added get_valid_item_by_id function --- app/routes.py | 21 +++++++++------------ tests/test_routes.py | 2 +- 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/app/routes.py b/app/routes.py index 3cb3f770a..62516870b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -20,18 +20,15 @@ # Planet(8, "Neptune", "blue", 30.06) # ] -def validate_planet(planet_id): +def get_valid_item_by_id(model, id): try: - planet_id = int(planet_id) + id = int(id) except: - abort(make_response({'msg': f"Invalid id '{planet_id}'"}, 400)) + abort(make_response({'msg': f"Invalid id '{id}'"}, 400)) - planet = Planet.query.get(planet_id) - - if planet: - return planet - else: - return abort(make_response({'msg': f"No planet with id {planet_id}"}, 404)) + item = model.query.get(id) + + return item if item else abort(make_response({'msg': f"No {model.__name__} with id {id}"}, 404)) @@ -72,7 +69,7 @@ def get_planets(): @planets_bp.route("/", methods=["GET"]) def get_one_planet(planet_id): - planet = validate_planet(planet_id) + planet = get_valid_item_by_id(Planet, planet_id) return ({ "id": planet.id, @@ -87,7 +84,7 @@ def update_one_planet(planet_id): # Get the data from the request body request_body = request.get_json() - planet_to_update = validate_planet(planet_id) + planet_to_update = get_valid_item_by_id(Planet, planet_id) planet_to_update.name = request_body["name"] planet_to_update.description = request_body["description"] @@ -106,7 +103,7 @@ def update_one_planet(planet_id): @planets_bp.route("/", methods=["DELETE"]) def delete_one_planet(planet_id): - planet_to_delete = validate_planet(planet_id) + planet_to_delete = get_valid_item_by_id(Planet, planet_id) db.session.delete(planet_to_delete) db.session.commit() diff --git a/tests/test_routes.py b/tests/test_routes.py index d026a2923..cc8e72e28 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -9,7 +9,7 @@ def test_get_all_planets_with_empty_db_returns_empty_list(client): assert response.status_code == 200 -def test_get_one_planet_returns_correct_pkanet(client, two_planets): +def test_get_one_planet_returns_correct_planet(client, two_planets): # ACT response = client.get('/planets/1') response_body = response.get_json() From d06b5f4a721cf3bf6ac7cbfb3018762103215b16 Mon Sep 17 00:00:00 2001 From: Ericka Date: Tue, 9 May 2023 11:07:26 -0700 Subject: [PATCH 22/24] added gunicorn --- requirements.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/requirements.txt b/requirements.txt index ae59e7b55..f4ff77124 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,14 +4,20 @@ blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==7.2.3 +exceptiongroup==1.1.1 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 +iniconfig==2.0.0 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==23.1 +pluggy==1.0.0 psycopg2-binary==2.9.5 pycodestyle==2.6.0 pytest==7.3.1 @@ -23,5 +29,6 @@ requests==2.25.1 six==1.15.0 SQLAlchemy==1.3.23 toml==0.10.2 +tomli==2.0.1 urllib3==1.26.4 Werkzeug==1.0.1 From ea6a7977b70d0c351808fdeba2292108326cc6dd Mon Sep 17 00:00:00 2001 From: Ericka Date: Tue, 9 May 2023 11:21:41 -0700 Subject: [PATCH 23/24] added render database uri --- app/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 41e45d59e..87a7ae245 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -13,7 +13,7 @@ def create_app(testing=None): app = Flask(__name__) if testing is None: - app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get('SQLALCHEMY_DATABASE_URI') + app.config["RENDER_DATABASE_URI"] = os.environ.get("RENDER_DATABASE_URI") else: app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get('SQLALCHEMY_TEST_DATABASE_URI') From ae52dafaf7792abcc7c9c6bfa1aaf7c297b526e2 Mon Sep 17 00:00:00 2001 From: Ericka Date: Tue, 9 May 2023 11:49:26 -0700 Subject: [PATCH 24/24] edited config SQLALchemy uri to render --- app/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 87a7ae245..f45009144 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -13,7 +13,7 @@ def create_app(testing=None): app = Flask(__name__) if testing is None: - app.config["RENDER_DATABASE_URI"] = os.environ.get("RENDER_DATABASE_URI") + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get("RENDER_DATABASE_URI") else: app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get('SQLALCHEMY_TEST_DATABASE_URI')