From 084030ddaa9cb8d15d0073cb8f51713c5e5a9b20 Mon Sep 17 00:00:00 2001 From: Jenny C Date: Fri, 22 Apr 2022 11:05:15 -0700 Subject: [PATCH 01/18] add blueprint --- app/__init__.py | 4 ++++ app/routes.py | 1 + 2 files changed, 5 insertions(+) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..8383342f5 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,4 +4,8 @@ def create_app(test_config=None): app = Flask(__name__) + from .routes import planets_bp + app.register_blueprint(planets_bp) + + return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..1746809c6 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,3 @@ from flask import Blueprint +planets_bp = Blueprint("planets", __name__, url_prefix)="planets") From 24657bcde3dd9f27d8a371dc5cd46f5ce7898273 Mon Sep 17 00:00:00 2001 From: cathos Date: Fri, 22 Apr 2022 11:05:28 -0700 Subject: [PATCH 02/18] Created planets class and three planets. --- app/routes.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..66d7eb5c7 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,14 @@ from flask import Blueprint +class Planet: + def __init__(self, id, name, description, gravity): + self.id = id + self.name = name + self.description = description + self.gravity = gravity + +planets = [ + Planet(1, 'Mercury', 'The closest planet to the sun! REALLY HOT!', '3.7 m/s2'), + Planet(2, 'Venus', 'Another hot planet', '8.87 m/s2'), + Planet(3, 'Earth', 'Third Planet from the Sun. Maybe a little special', '9.8 m/s2') +] From 4b2846049e0305c82427a2a466808fab22ff7a97 Mon Sep 17 00:00:00 2001 From: Jenny C Date: Fri, 22 Apr 2022 11:24:34 -0700 Subject: [PATCH 03/18] finish wave 1 --- app/__init__.py | 2 +- app/routes.py | 20 +++++++++++++++----- 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 8383342f5..1bec9012c 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -6,6 +6,6 @@ def create_app(test_config=None): from .routes import planets_bp app.register_blueprint(planets_bp) - + return app diff --git a/app/routes.py b/app/routes.py index db0ae5c21..9e4679646 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,8 +1,5 @@ -from flask import Blueprint +from flask import Blueprint, jsonify -<<<<<<< HEAD -planets_bp = Blueprint("planets", __name__, url_prefix)="planets") -======= class Planet: def __init__(self, id, name, description, gravity): self.id = id @@ -15,4 +12,17 @@ def __init__(self, id, name, description, gravity): Planet(2, 'Venus', 'Another hot planet', '8.87 m/s2'), Planet(3, 'Earth', 'Third Planet from the Sun. Maybe a little special', '9.8 m/s2') ] ->>>>>>> 24657bcde3dd9f27d8a371dc5cd46f5ce7898273 + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + +@planets_bp.route("", methods=["GET"]) +def handle_planets(): + planets_result = [] + for planet in planets: + planets_result.append(dict( + id = planet.id, + name = planet.name, + description = planet.description, + gravity = planet.gravity + )) + return jsonify(planets_result) \ No newline at end of file From 59817b91a6790952af51646773cb3b9ffe22a932 Mon Sep 17 00:00:00 2001 From: cathos Date: Fri, 22 Apr 2022 12:00:09 -0700 Subject: [PATCH 04/18] cleanup after wave 1 --- app/routes.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 9e4679646..205170f97 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,5 +1,6 @@ from flask import Blueprint, jsonify + class Planet: def __init__(self, id, name, description, gravity): self.id = id @@ -25,4 +26,4 @@ def handle_planets(): description = planet.description, gravity = planet.gravity )) - return jsonify(planets_result) \ No newline at end of file + return jsonify(planets_result) From 65f3d5e41f91705403571a30d4181d12331f26c4 Mon Sep 17 00:00:00 2001 From: Jenny C Date: Mon, 25 Apr 2022 12:20:23 -0700 Subject: [PATCH 05/18] finish wave 2 --- app/routes.py | 22 ++++++++++++++++++++-- project-directions/wave_02.md | 3 +++ 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index 9e4679646..aa5e3f0ef 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,4 @@ -from flask import Blueprint, jsonify +from flask import Blueprint, jsonify, make_response, abort class Planet: def __init__(self, id, name, description, gravity): @@ -25,4 +25,22 @@ def handle_planets(): description = planet.description, gravity = planet.gravity )) - return jsonify(planets_result) \ No newline at end of file + return jsonify(planets_result) + +@planets_bp.route("/", methods = ["GET"]) +def get_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response(jsonify(dict(details=f"planet id {planet_id} invalid")), 400)) + + for planet in planets: + if planet.id == planet_id: + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "gravity": planet.gravity + + } + abort(make_response(jsonify(dict(details=f"planet id {planet_id} not found")), 404)) \ 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 From dd8402bde3cd9517ced6a0281f018346471a81df Mon Sep 17 00:00:00 2001 From: Jenny C Date: Tue, 26 Apr 2022 13:10:28 -0700 Subject: [PATCH 06/18] finish wave 2 --- app/routes.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/app/routes.py b/app/routes.py index 297db2160..a439f88f0 100644 --- a/app/routes.py +++ b/app/routes.py @@ -27,7 +27,6 @@ def handle_planets(): gravity = planet.gravity )) return jsonify(planets_result) -<<<<<<< HEAD @planets_bp.route("/", methods = ["GET"]) def get_planet(planet_id): @@ -46,5 +45,3 @@ def get_planet(planet_id): } abort(make_response(jsonify(dict(details=f"planet id {planet_id} not found")), 404)) -======= ->>>>>>> 59817b91a6790952af51646773cb3b9ffe22a932 From 038b7905ceb5fcb654cad36334f18357dbc84b92 Mon Sep 17 00:00:00 2001 From: cathos Date: Tue, 26 Apr 2022 13:24:52 -0700 Subject: [PATCH 07/18] finished wave 1 and 2, submitting part 1 --- app/routes.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index a439f88f0..a8058f29d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -10,8 +10,8 @@ def __init__(self, id, name, description, gravity): planets = [ Planet(1, 'Mercury', 'The closest planet to the sun! REALLY HOT!', '3.7 m/s2'), - Planet(2, 'Venus', 'Another hot planet', '8.87 m/s2'), - Planet(3, 'Earth', 'Third Planet from the Sun. Maybe a little special', '9.8 m/s2') + Planet(2, 'Venus', 'Another hot planet! Actually hotter than Mercury!', '8.87 m/s2'), + Planet(3, 'Earth', 'Third Planet from the Sun. Maybe a little special. Much colder than the first two.', '9.8 m/s2') ] planets_bp = Blueprint("planets", __name__, url_prefix="/planets") From 9446e23c708b3f712b6cda0a2466561ee461b5de Mon Sep 17 00:00:00 2001 From: cathos Date: Tue, 3 May 2022 12:35:18 -0700 Subject: [PATCH 08/18] Finished wave 3, completed patch and single planet get for wave 4. TODO: complete wave 4 delete, test single planet get. --- app/__init__.py | 14 +- app/models/__init__.py | 0 app/models/planet.py | 8 + app/routes.py | 140 +++++++++++++----- migrations/README | 1 + migrations/alembic.ini | 45 ++++++ migrations/env.py | 96 ++++++++++++ migrations/script.py.mako | 24 +++ .../f07136d1f4eb_created_planet_model.py | 34 +++++ solar-system-api.code-workspace | 8 + 10 files changed, 331 insertions(+), 39 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.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/f07136d1f4eb_created_planet_model.py create mode 100644 solar-system-api.code-workspace diff --git a/app/__init__.py b/app/__init__.py index 1bec9012c..83efb502d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,11 +1,23 @@ 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 .routes import planets_bp app.register_blueprint(planets_bp) + from app.models.planet import Planet - return app + 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..ececc1e31 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,8 @@ +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) + gravity = db.Column(db.String) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index a8058f29d..37cb2a35a 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,47 +1,111 @@ -from flask import Blueprint, jsonify, make_response, abort +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request, abort +# class Planet: +# def __init__(self, id, name, description, gravity): +# self.id = id +# self.name = name +# self.description = description +# self.gravity = gravity -class Planet: - def __init__(self, id, name, description, gravity): - self.id = id - self.name = name - self.description = description - self.gravity = gravity - -planets = [ - Planet(1, 'Mercury', 'The closest planet to the sun! REALLY HOT!', '3.7 m/s2'), - Planet(2, 'Venus', 'Another hot planet! Actually hotter than Mercury!', '8.87 m/s2'), - Planet(3, 'Earth', 'Third Planet from the Sun. Maybe a little special. Much colder than the first two.', '9.8 m/s2') -] +# planets = [ +# Planet(1, 'Mercury', 'The closest planet to the sun! REALLY HOT!', '3.7 m/s2'), +# Planet(2, 'Venus', 'Another hot planet! Actually hotter than Mercury!', '8.87 m/s2'), +# Planet(3, 'Earth', 'Third Planet from the Sun. Maybe a little special. Much colder than the first two.', '9.8 m/s2') +# ] planets_bp = Blueprint("planets", __name__, url_prefix="/planets") -@planets_bp.route("", methods=["GET"]) -def handle_planets(): - planets_result = [] - for planet in planets: - planets_result.append(dict( - id = planet.id, - name = planet.name, - description = planet.description, - gravity = planet.gravity - )) - return jsonify(planets_result) - -@planets_bp.route("/", methods = ["GET"]) -def get_planet(planet_id): - try: +def validate_planet(planet_id): + try: planet_id = int(planet_id) except: - abort(make_response(jsonify(dict(details=f"planet id {planet_id} invalid")), 400)) + 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, + "name": planet.name, + "description": planet.description, + "gravity": planet.gravity + } + +@planets_bp.route("", methods=["GET"]) +def get_all_planets(): + # planets_result = [] + # for planet in planets: + # planets_result.append(dict( + # id = planet.id, + # name = planet.name, + # description = planet.description, + # gravity = planet.gravity + # )) + # return jsonify(planets_result) + planets = Planet.query.all() + planets_response = [] + for planet in planets: + planets_response.append({ + "id": planet.id, + "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"], description=request_body["description"], gravity=request_body["gravity"]) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} successfully created", 201) + +@planets_bp.route("/", methods=["PATCH"]) +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"] + + # planet.name = request_body["name"] + # planet.description = request_body["description"] + # planet.gravity = request_body["gravity"] + + db.session.commit() + return make_response(f"Planet #{planet.id} successfully updated", 200) + +# @planets_bp.route("/", methods = ["GET"]) +# def get_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# abort(make_response(jsonify(dict(details=f"planet id {planet_id} invalid")), 400)) - for planet in planets: - if planet.id == planet_id: - return { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "gravity": planet.gravity +# for planet in planets: +# if planet.id == planet_id: +# return { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description, +# "gravity": planet.gravity - } - abort(make_response(jsonify(dict(details=f"planet id {planet_id} not found")), 404)) +# } +# abort(make_response(jsonify(dict(details=f"planet id {planet_id} not found")), 404)) 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/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/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 From d7ad61ee7fbb942a5188ae9416aac32031975e2a Mon Sep 17 00:00:00 2001 From: cathos Date: Tue, 3 May 2022 15:25:31 -0700 Subject: [PATCH 09/18] added DELETE, changed PATCH to PUT. Wave 04 complete. --- app/routes.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 37cb2a35a..bb6441607 100644 --- a/app/routes.py +++ b/app/routes.py @@ -72,7 +72,7 @@ def add_planet(): return make_response(f"Planet {new_planet.name} successfully created", 201) -@planets_bp.route("/", methods=["PATCH"]) +@planets_bp.route("/", methods=["PUT"]) def update_planet(planet_id): planet = validate_planet(planet_id) request_body = request.get_json() @@ -92,6 +92,15 @@ def update_planet(planet_id): 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) + # @planets_bp.route("/", methods = ["GET"]) # def get_planet(planet_id): # try: From 477dfc440f423925d821656fca30ae5dd6432399 Mon Sep 17 00:00:00 2001 From: cathos Date: Wed, 4 May 2022 12:25:13 -0700 Subject: [PATCH 10/18] implemented some basic query parameters for wave 05. TODO: refactor planets, implement description field search --- app/models/planet.py | 3 +- app/routes.py | 19 +++++++++++-- ...5_updated_planet_model_to_include_order.py | 28 +++++++++++++++++++ 3 files changed, 47 insertions(+), 3 deletions(-) create mode 100644 migrations/versions/c5672b3cf4c5_updated_planet_model_to_include_order.py diff --git a/app/models/planet.py b/app/models/planet.py index ececc1e31..7fb1c8fee 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -3,6 +3,7 @@ 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) \ No newline at end of file + gravity = db.Column(db.String) diff --git a/app/routes.py b/app/routes.py index bb6441607..83137fcfa 100644 --- a/app/routes.py +++ b/app/routes.py @@ -35,6 +35,7 @@ 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 @@ -51,11 +52,23 @@ def get_all_planets(): # gravity = planet.gravity # )) # return jsonify(planets_result) - planets = Planet.query.all() + 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(description=(contains(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 @@ -65,7 +78,7 @@ def get_all_planets(): @planets_bp.route("", methods=["POST"]) def add_planet(): request_body = request.get_json() - new_planet = Planet(name=request_body["name"], description=request_body["description"], gravity=request_body["gravity"]) + 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() @@ -84,6 +97,8 @@ def update_planet(planet_id): 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"] # planet.name = request_body["name"] # planet.description = request_body["description"] 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 ### From 7d8e0e91f1a64cead8eea04638ecadde1ab7fd97 Mon Sep 17 00:00:00 2001 From: cathos Date: Wed, 4 May 2022 15:48:47 -0700 Subject: [PATCH 11/18] Fixed get by description to properly query partial descriptions, case-insensitive. --- app/routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 83137fcfa..a4ca64289 100644 --- a/app/routes.py +++ b/app/routes.py @@ -58,7 +58,7 @@ def get_all_planets(): if name_query: planets = Planet.query.filter_by(name=name_query) elif description_query: - planets = Planet.query.filter(description=(contains(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: From 08ca31728d8c9cf4a47adff0269f23afbebffa4e Mon Sep 17 00:00:00 2001 From: Jenny C Date: Thu, 5 May 2022 11:23:32 -0700 Subject: [PATCH 12/18] refactor and add test files --- app/__init__.py | 16 ++++++++++++---- tests/__init__.py | 0 tests/conftest.py | 0 tests/test_routes.py | 0 4 files changed, 12 insertions(+), 4 deletions(-) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_routes.py diff --git a/app/__init__.py b/app/__init__.py index 83efb502d..8e828539b 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,23 +1,31 @@ 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 - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + if not test_config: + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") + else: + app.config["TESTING"] = True + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + 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) - from app.models.planet import Planet return app \ 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..e69de29bb diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..e69de29bb From b5c36981963e1af3f47c1e15ce2efa9eaf80bc49 Mon Sep 17 00:00:00 2001 From: cathos Date: Thu, 5 May 2022 21:25:59 -0700 Subject: [PATCH 13/18] started tests, still need to complete json portion. --- app/__init__.py | 2 +- app/routes.py | 6 ++++ planets.csv | 5 +++ tests/conftest.py | 77 ++++++++++++++++++++++++++++++++++++++++++++ tests/test_routes.py | 38 ++++++++++++++++++++++ 5 files changed, 127 insertions(+), 1 deletion(-) create mode 100644 planets.csv diff --git a/app/__init__.py b/app/__init__.py index 8e828539b..6cdd39af2 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -16,6 +16,7 @@ def create_app(test_config=None): app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") else: + print("Testing is on") app.config["TESTING"] = True app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get("SQLALCHEMY_TEST_DATABASE_URI") @@ -27,5 +28,4 @@ def create_app(test_config=None): from app.models.planet import Planet app.register_blueprint(planets_bp) - return app \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index a4ca64289..504e52b0e 100644 --- a/app/routes.py +++ b/app/routes.py @@ -17,6 +17,10 @@ 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) @@ -116,6 +120,8 @@ def delete_planet(planet_id): return make_response(f"Planet #{planet.id} successfully deleted", 200) + + # @planets_bp.route("/", methods = ["GET"]) # def get_planet(planet_id): # try: 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/tests/conftest.py b/tests/conftest.py index e69de29bb..a780dccad 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -0,0 +1,77 @@ +# # from flasky: + +# from flask import request_finished +# from app import db +# import pytest +# from app.models.cat import Cat + +# from app import create_app + +# @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_cats(app): +# fluffy = Cat(id=1, name="fluffy", color="grey", personality="likes to cuddle") +# sleepy = Cat(id=2, name="sleepy", color="orange", personality="likes to take naps") + +# db.session.add(fluffy) +# db.session.add(sleepy) +# db.session.commit() + +# * * * + +# # from hello-books + +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 index e69de29bb..cb21f9684 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -0,0 +1,38 @@ +# 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_invalid_planet(client): + response = client.get("planets/12") + response_body = response.get_json() + + assert response.status_code == 404 + + From 8e8507a5e07c6581f80e5dde8daf5f02b3c76622 Mon Sep 17 00:00:00 2001 From: Jenny C Date: Thu, 5 May 2022 22:14:52 -0700 Subject: [PATCH 14/18] made change to conftest file --- tests/conftest.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/tests/conftest.py b/tests/conftest.py index e69de29bb..4f50e88ef 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -0,0 +1,10 @@ +from flask import request_finished +from app import db +import pytest +from app.models.cat import Cat + +from app import create_app + +@pytest.fixture +def app(): + app = create_app({"TESTING:True"}) \ No newline at end of file From 0d07b5ed2325d7770a24bf40c86b7a3114dee0ac Mon Sep 17 00:00:00 2001 From: Jenny C Date: Fri, 6 May 2022 09:11:57 -0700 Subject: [PATCH 15/18] add all planets test --- tests/conftest.py | 1 + tests/test_routes.py | 20 ++++++++++++++++++++ 2 files changed, 21 insertions(+) diff --git a/tests/conftest.py b/tests/conftest.py index a780dccad..538bfb25e 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -71,6 +71,7 @@ def client(app): 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) diff --git a/tests/test_routes.py b/tests/test_routes.py index 2c28a016c..80b0184d5 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -29,6 +29,26 @@ def test_get_one_planet(client, two_planets): "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() From a96a9388cf859eeb35e1638c9ffa2c25047ed053 Mon Sep 17 00:00:00 2001 From: cathos Date: Fri, 6 May 2022 09:25:43 -0700 Subject: [PATCH 16/18] finished wave 6, had weird binary response when posting --- tests/test_routes.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_routes.py b/tests/test_routes.py index 80b0184d5..d8a149480 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -61,11 +61,11 @@ def test_post_one_planet_to_database(client): "order_from_sun": 9, "description": "Pluto is smaller than Earth's moon", "gravity": "0.62 m/s2" - }) response_body = response.get_data() assert response.status_code == 201 - assert response_body == "Planet Pluto successfully created" + print(response_body) + assert response_body == b"Planet Pluto successfully created" From 455e34a1ebb0d5f08115033b6f5f5493e821e6de Mon Sep 17 00:00:00 2001 From: cathos Date: Fri, 6 May 2022 09:29:36 -0700 Subject: [PATCH 17/18] cleaned up after finishing wave 6. still could refactor to clean up models. --- app/routes.py | 50 +++++------------------------------------------ tests/conftest.py | 41 -------------------------------------- 2 files changed, 5 insertions(+), 86 deletions(-) diff --git a/app/routes.py b/app/routes.py index 504e52b0e..9d88e8d8d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -2,18 +2,6 @@ from app.models.planet import Planet from flask import Blueprint, jsonify, make_response, request, abort -# class Planet: -# def __init__(self, id, name, description, gravity): -# self.id = id -# self.name = name -# self.description = description -# self.gravity = gravity - -# planets = [ -# Planet(1, 'Mercury', 'The closest planet to the sun! REALLY HOT!', '3.7 m/s2'), -# Planet(2, 'Venus', 'Another hot planet! Actually hotter than Mercury!', '8.87 m/s2'), -# Planet(3, 'Earth', 'Third Planet from the Sun. Maybe a little special. Much colder than the first two.', '9.8 m/s2') -# ] planets_bp = Blueprint("planets", __name__, url_prefix="/planets") @@ -47,15 +35,6 @@ def read_one_planet(planet_id): @planets_bp.route("", methods=["GET"]) def get_all_planets(): - # planets_result = [] - # for planet in planets: - # planets_result.append(dict( - # id = planet.id, - # name = planet.name, - # description = planet.description, - # gravity = planet.gravity - # )) - # return jsonify(planets_result) name_query = request.args.get("name") description_query = request.args.get("description") order_from_sun_query = request.args.get("order_from_sun") @@ -82,7 +61,11 @@ def get_all_planets(): @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"]) + 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() @@ -104,10 +87,6 @@ def update_planet(planet_id): if "order_from_sun" in request_body_keys: planet.order_from_sun = request_body["order_from_sun"] - # planet.name = request_body["name"] - # planet.description = request_body["description"] - # planet.gravity = request_body["gravity"] - db.session.commit() return make_response(f"Planet #{planet.id} successfully updated", 200) @@ -120,22 +99,3 @@ def delete_planet(planet_id): return make_response(f"Planet #{planet.id} successfully deleted", 200) - - -# @planets_bp.route("/", methods = ["GET"]) -# def get_planet(planet_id): -# try: -# planet_id = int(planet_id) -# except: -# abort(make_response(jsonify(dict(details=f"planet id {planet_id} invalid")), 400)) - -# for planet in planets: -# if planet.id == planet_id: -# return { -# "id": planet.id, -# "name": planet.name, -# "description": planet.description, -# "gravity": planet.gravity - -# } -# abort(make_response(jsonify(dict(details=f"planet id {planet_id} not found")), 404)) diff --git a/tests/conftest.py b/tests/conftest.py index 538bfb25e..84d888420 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,44 +1,3 @@ -# # from flasky: - -# from flask import request_finished -# from app import db -# import pytest -# from app.models.cat import Cat - -# from app import create_app - -# @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_cats(app): -# fluffy = Cat(id=1, name="fluffy", color="grey", personality="likes to cuddle") -# sleepy = Cat(id=2, name="sleepy", color="orange", personality="likes to take naps") - -# db.session.add(fluffy) -# db.session.add(sleepy) -# db.session.commit() - -# * * * - -# # from hello-books - import pytest from app import create_app from app import db From 10690f297944c8e21dd0509b3d0118b109cc4548 Mon Sep 17 00:00:00 2001 From: Jenny C Date: Wed, 11 May 2022 10:09:03 -0700 Subject: [PATCH 18/18] finish the solar system --- app/routes.py | 2 +- tests/test_routes.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index 504e52b0e..5c9804586 100644 --- a/app/routes.py +++ b/app/routes.py @@ -87,7 +87,7 @@ def add_planet(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.name} successfully created", 201) + return make_response(jsonify(f"Planet {new_planet.name} successfully created"), 201) @planets_bp.route("/", methods=["PUT"]) def update_planet(planet_id): diff --git a/tests/test_routes.py b/tests/test_routes.py index 80b0184d5..153e75d9c 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -63,7 +63,7 @@ def test_post_one_planet_to_database(client): "gravity": "0.62 m/s2" }) - response_body = response.get_data() + response_body = response.get_json() assert response.status_code == 201 assert response_body == "Planet Pluto successfully created"