From cc34789ed34627c602d62c4884ef98ce5a17ed67 Mon Sep 17 00:00:00 2001 From: Jamie Date: Fri, 21 Apr 2023 12:43:02 -0600 Subject: [PATCH 1/9] Wave 01 --- app/__init__.py | 3 +++ app/routes.py | 33 ++++++++++++++++++++++++++++++++- 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..c86588ae1 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,4 +4,7 @@ def create_app(test_config=None): app = Flask(__name__) + from .routes import planet_bp + app.register_blueprint(planet_bp) + return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..7d835facf 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,33 @@ -from flask import Blueprint +from flask import Blueprint, jsonify +class Planet: + def __init__(self, id, name, description, distance_from_earth): + self.id = id + self.name = name + self.description = description + self.distance_from_earth = distance_from_earth + +planets = [Planet(1, "Mercury", "Mercury has zero moons", 3.5), + Planet(2, "Venus", "Venus has zero moons", 6.7), + Planet(3, "Earth", "Earth has one moon", 9.3), + Planet(4, "Mars", "Mars has two moons", 14.2), + Planet(5, "Jupiter", "Jupiter has sixty-seven moons", 48.4), + Planet(6, "Saturn", "Saturn has sixty-two moons", 88.9), + Planet(7, "Uranus", "Uranus has twenty-seven moons", 179), + Planet(8, "Neptune", "Neptune has fourteen moons", 288), + Planet(9, "Pluto", "Pluto has five moons", 367) +] + +planet_bp = Blueprint("planets", __name__, url_prefix="/planets") + +@planet_bp.route("", methods=["GET"]) +def get_all_planets(): + all_planets_response = [] + for planet in planets: + all_planets_response.append(dict( + id=planet.id, + name=planet.name, + description=planet.description, + distance_from_earth=planet.distance_from_earth + )) + return jsonify(all_planets_response) From c0b94be1c05006a49b18d67381772dd916cd9ad8 Mon Sep 17 00:00:00 2001 From: lulu Date: Mon, 24 Apr 2023 16:38:18 -0500 Subject: [PATCH 2/9] finish wave2 --- app/routes.py | 47 +++++++++++++++++++++++++++++++++++++---------- 1 file changed, 37 insertions(+), 10 deletions(-) diff --git a/app/routes.py b/app/routes.py index 7d835facf..461edefd0 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,5 @@ -from flask import Blueprint, jsonify +from flask import Blueprint, jsonify, abort, make_response + class Planet: def __init__(self, id, name, description, distance_from_earth): @@ -6,8 +7,17 @@ def __init__(self, id, name, description, distance_from_earth): self.name = name self.description = description self.distance_from_earth = distance_from_earth - -planets = [Planet(1, "Mercury", "Mercury has zero moons", 3.5), + + def to_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + distance_from_earth=self.distance_from_earth + ) + + +planets = [Planet(1, "Mercury", "Mercury has zero moons", 3.5), Planet(2, "Venus", "Venus has zero moons", 6.7), Planet(3, "Earth", "Earth has one moon", 9.3), Planet(4, "Mars", "Mars has two moons", 14.2), @@ -16,18 +26,35 @@ def __init__(self, id, name, description, distance_from_earth): Planet(7, "Uranus", "Uranus has twenty-seven moons", 179), Planet(8, "Neptune", "Neptune has fourteen moons", 288), Planet(9, "Pluto", "Pluto has five moons", 367) -] + ] planet_bp = Blueprint("planets", __name__, url_prefix="/planets") + @planet_bp.route("", methods=["GET"]) def get_all_planets(): all_planets_response = [] for planet in planets: - all_planets_response.append(dict( - id=planet.id, - name=planet.name, - description=planet.description, - distance_from_earth=planet.distance_from_earth - )) + all_planets_response.append(planet.to_dict()) + return jsonify(all_planets_response) + + +@planet_bp.route("/", methods=["GET"]) +def get_one_planet(id): + planet = validate_planet(id) + + return planet.to_dict() + + +def validate_planet(id): + try: + id = int(id) + except: + abort(make_response({"message": f"planet {id} is invalid"}, 400)) + + for planet in planets: + if planet.id == id: + return planet + + abort(make_response({"message": f"planet {id} not found"}, 404)) From ec96ee3a6faa0efb5fe6e3bb3562f39b9e131b79 Mon Sep 17 00:00:00 2001 From: Jamie Date: Fri, 28 Apr 2023 12:06:08 -0600 Subject: [PATCH 3/9] Added Planet Model --- app/__init__.py | 11 +++ app/models/__init__.py | 0 app/models/planet.py | 12 +++ app/routes.py | 9 +- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../versions/aef89d2434c7_add_planet_model.py | 34 +++++++ 9 files changed, 228 insertions(+), 4 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/aef89d2434c7_add_planet_model.py diff --git a/app/__init__.py b/app/__init__.py index c86588ae1..2f9b1f538 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,8 +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 app.models.planet import Planet from .routes import planet_bp app.register_blueprint(planet_bp) 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..5e74545d0 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,12 @@ +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) + distance_from_sun = db.Column(db.String, nullable=False) + + \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 461edefd0..152244799 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,19 +1,20 @@ from flask import Blueprint, jsonify, abort, make_response - +from app.models.planet import Planet +from app import db class Planet: - def __init__(self, id, name, description, distance_from_earth): + def __init__(self, id, name, description, distance_from_sun): self.id = id self.name = name self.description = description - self.distance_from_earth = distance_from_earth + self.distance_from_sun = distance_from_sun def to_dict(self): return dict( id=self.id, name=self.name, description=self.description, - distance_from_earth=self.distance_from_earth + distance_from_sun=self.distance_from_sun ) 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/aef89d2434c7_add_planet_model.py b/migrations/versions/aef89d2434c7_add_planet_model.py new file mode 100644 index 000000000..27110f8ae --- /dev/null +++ b/migrations/versions/aef89d2434c7_add_planet_model.py @@ -0,0 +1,34 @@ +"""add Planet model + +Revision ID: aef89d2434c7 +Revises: +Create Date: 2023-04-28 12:05:26.639025 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'aef89d2434c7' +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=False), + sa.Column('description', sa.String(), nullable=False), + sa.Column('distance_from_sun', sa.String(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + # ### end Alembic commands ### From c377bca21dee0787e8acfdaa7a0b3f928bcfd8c6 Mon Sep 17 00:00:00 2001 From: Jamie Date: Fri, 28 Apr 2023 15:43:59 -0600 Subject: [PATCH 4/9] wave 03 completed --- app/routes.py | 122 ++++++++++++++++++++++++++++++++------------------ 1 file changed, 78 insertions(+), 44 deletions(-) diff --git a/app/routes.py b/app/routes.py index 152244799..d3e9c850d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,61 +1,95 @@ -from flask import Blueprint, jsonify, abort, make_response +from flask import Blueprint, jsonify, abort, make_response,request from app.models.planet import Planet from app import db -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 - - def to_dict(self): - return dict( - id=self.id, - name=self.name, - description=self.description, - distance_from_sun=self.distance_from_sun - ) - - -planets = [Planet(1, "Mercury", "Mercury has zero moons", 3.5), - Planet(2, "Venus", "Venus has zero moons", 6.7), - Planet(3, "Earth", "Earth has one moon", 9.3), - Planet(4, "Mars", "Mars has two moons", 14.2), - Planet(5, "Jupiter", "Jupiter has sixty-seven moons", 48.4), - Planet(6, "Saturn", "Saturn has sixty-two moons", 88.9), - Planet(7, "Uranus", "Uranus has twenty-seven moons", 179), - Planet(8, "Neptune", "Neptune has fourteen moons", 288), - Planet(9, "Pluto", "Pluto has five moons", 367) - ] - planet_bp = Blueprint("planets", __name__, url_prefix="/planets") +# POST /planets +@planet_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() + + message = f"Planet {new_planet.name} successfully created" + return make_response(message, 201) + @planet_bp.route("", methods=["GET"]) def get_all_planets(): - all_planets_response = [] + planets = Planet.query.all() + results = [] for planet in planets: - all_planets_response.append(planet.to_dict()) + results.append( + dict( + id=planet.id, + name=planet.name, + description=planet.description, + distance_from_sun=planet.distance_from_sun + ) + ) + return jsonify(results) - return jsonify(all_planets_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_bp.route("/", methods=["GET"]) -def get_one_planet(id): - planet = validate_planet(id) +# def to_dict(self): +# return dict( +# id=self.id, +# name=self.name, +# description=self.description, +# distance_from_sun=self.distance_from_sun +# ) - return planet.to_dict() +# planets = [Planet(1, "Mercury", "Mercury has zero moons", 3.5), +# Planet(2, "Venus", "Venus has zero moons", 6.7), +# Planet(3, "Earth", "Earth has one moon", 9.3), +# Planet(4, "Mars", "Mars has two moons", 14.2), +# Planet(5, "Jupiter", "Jupiter has sixty-seven moons", 48.4), +# Planet(6, "Saturn", "Saturn has sixty-two moons", 88.9), +# Planet(7, "Uranus", "Uranus has twenty-seven moons", 179), +# Planet(8, "Neptune", "Neptune has fourteen moons", 288), +# Planet(9, "Pluto", "Pluto has five moons", 367) +# ] -def validate_planet(id): - try: - id = int(id) - except: - abort(make_response({"message": f"planet {id} is invalid"}, 400)) - for planet in planets: - if planet.id == id: - return planet - abort(make_response({"message": f"planet {id} not found"}, 404)) +# @planet_bp.route("", methods=["GET"]) +# def get_all_planets(): +# all_planets_response = [] +# for planet in planets: +# all_planets_response.append(planet.to_dict()) + +# return jsonify(all_planets_response) + + +# @planet_bp.route("/", methods=["GET"]) +# def get_one_planet(id): +# planet = validate_planet(id) + +# return planet.to_dict() + + +# def validate_planet(id): +# try: +# id = int(id) +# except: +# abort(make_response({"message": f"planet {id} is invalid"}, 400)) + +# for planet in planets: +# if planet.id == id: +# return planet + +# abort(make_response({"message": f"planet {id} not found"}, 404)) From bfdd350fcf533ff680e3928c5566a9d6e753354d Mon Sep 17 00:00:00 2001 From: Jamie Date: Tue, 2 May 2023 12:12:16 -0600 Subject: [PATCH 5/9] wave 4 completed and planets added to database --- app/routes.py | 87 ++++++++++++++++++++++++++------------------------- 1 file changed, 44 insertions(+), 43 deletions(-) diff --git a/app/routes.py b/app/routes.py index d3e9c850d..a5f53c123 100644 --- a/app/routes.py +++ b/app/routes.py @@ -36,21 +36,52 @@ def get_all_planets(): ) return jsonify(results) +def validate_planet(id): + try: + id = int(id) + except: + abort(make_response({"message": f"planet {id} is invalid"}, 400)) -# 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 = Planet.query.get(id) + + if not planet: + message = f"planet {id} not found" + abort(make_response({"message": message}, 404)) + + return planet + +@planet_bp.route("/", methods=["GET"]) +def get_one_planet(id): + planet = validate_planet(id) + planet_dict = dict( + id=planet.id, + name=planet.name, + description=planet.description, + distance_from_sun=planet.distance_from_sun + ) + + return planet_dict + +@planet_bp.route("/", methods = ["PUT"]) +def update_one_planet(id): + planet_data = request.get_json() + planet_to_update = validate_planet(id) + + planet_to_update.name = planet_data["name"] + planet_to_update.description = planet_data["description"] + planet_to_update.distance_from_sun = planet_data["distance_from_sun"] + db.session.commit() + + return make_response(f"Planet {planet_to_update.name} updated", 200) + +@planet_bp.route("/", methods = ["DELETE"]) +def delete_one_planet(id): + planet_to_delete = validate_planet(id) + db.session.delete(planet_to_delete) + db.session.commit() + + return make_response(f"Planet {planet_to_delete.name} deleted", 200) -# def to_dict(self): -# return dict( -# id=self.id, -# name=self.name, -# description=self.description, -# distance_from_sun=self.distance_from_sun -# ) # planets = [Planet(1, "Mercury", "Mercury has zero moons", 3.5), @@ -63,33 +94,3 @@ def get_all_planets(): # Planet(8, "Neptune", "Neptune has fourteen moons", 288), # Planet(9, "Pluto", "Pluto has five moons", 367) # ] - - - -# @planet_bp.route("", methods=["GET"]) -# def get_all_planets(): -# all_planets_response = [] -# for planet in planets: -# all_planets_response.append(planet.to_dict()) - -# return jsonify(all_planets_response) - - -# @planet_bp.route("/", methods=["GET"]) -# def get_one_planet(id): -# planet = validate_planet(id) - -# return planet.to_dict() - - -# def validate_planet(id): -# try: -# id = int(id) -# except: -# abort(make_response({"message": f"planet {id} is invalid"}, 400)) - -# for planet in planets: -# if planet.id == id: -# return planet - -# abort(make_response({"message": f"planet {id} not found"}, 404)) From 3da1eeedde27c170c31bc398adcd1209184f03e7 Mon Sep 17 00:00:00 2001 From: Jamie Date: Wed, 3 May 2023 12:50:52 -0600 Subject: [PATCH 6/9] wave 6 tests completed --- app/__init__.py | 10 ++++++- app/routes.py | 12 ++++----- tests/__init__.py | 0 tests/conftest.py | 40 ++++++++++++++++++++++++++++ tests/test_routes.py | 63 ++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 118 insertions(+), 7 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 2f9b1f538..be6e61c04 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,15 +1,23 @@ 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_DATABASE_URI'] = os.environ.get("SQLALCHEMY_DATABASE_URI") + else: + app.config['TESTING'] = True + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get("SQLALCHEMY_TEST_DATABASE_URI") + db.init_app(app) migrate.init_app(app, db) diff --git a/app/routes.py b/app/routes.py index a5f53c123..a304e8c0b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -17,7 +17,7 @@ def create_planet(): db.session.add(new_planet) db.session.commit() - message = f"Planet {new_planet.name} successfully created" + message = jsonify(f"Planet {new_planet.name} successfully created") return make_response(message, 201) @@ -40,13 +40,13 @@ def validate_planet(id): try: id = int(id) except: - abort(make_response({"message": f"planet {id} is invalid"}, 400)) + abort(make_response(jsonify({"message": f"planet {id} is invalid"}), 400)) planet = Planet.query.get(id) if not planet: - message = f"planet {id} not found" - abort(make_response({"message": message}, 404)) + message = jsonify(f"planet {id} not found") + abort(make_response(message, 404)) return planet @@ -72,7 +72,7 @@ def update_one_planet(id): planet_to_update.distance_from_sun = planet_data["distance_from_sun"] db.session.commit() - return make_response(f"Planet {planet_to_update.name} updated", 200) + return make_response(jsonify(f"Planet {planet_to_update.name} updated"), 200) @planet_bp.route("/", methods = ["DELETE"]) def delete_one_planet(id): @@ -80,7 +80,7 @@ def delete_one_planet(id): db.session.delete(planet_to_delete) db.session.commit() - return make_response(f"Planet {planet_to_delete.name} deleted", 200) + return make_response(jsonify(f"Planet {planet_to_delete.name} deleted"), 200) 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..7789a438c --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,40 @@ +import pytest +from app import create_app, db +from flask.signals import request_finished +from app.models.planet import Planet + +@pytest.fixture +def app(): + app = create_app({"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): + Jupiter = Planet( + name="Jupiter", + description="Jupiter has sixty-seven moons", + distance_from_sun= 48.4 + ) + Mercury = Planet( + name = "Mercury", + description = "Mercury has zero moons", + distance_from_sun = 3.5 + ) + db.session.add(Jupiter) + db.session.add(Mercury) + db.session.commit() + \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..305da4766 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,63 @@ +from app.models.planet import Planet + +def test_get_all_planets_returns_empty_list_when_db_is_empty(client): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] + +def test_all_planets_return_a_list_of_planets(client, two_planets): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [{ + "id": 1, + "name": "Jupiter", + "description": "Jupiter has sixty-seven moons", + "distance_from_sun": "48.4" + }, + { + "id": 2, + "name": "Mercury", + "description": "Mercury has zero moons", + "distance_from_sun": "3.5" + }] + + + +def test_get_one_planet_returns_seeded_planet(client, two_planets): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body["id"] == 1 + assert response_body["name"] == "Jupiter" + assert response_body["description"] == "Jupiter has sixty-seven moons" + assert response_body["distance_from_sun"] == "48.4" + +def test_get_one_planets_returns_no_data(client): + response = client.get("planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + assert response_body == "planet 1 not found" + +def test_create_planet_happy_path(client): + EXPECTED_PLANET = { + "name": "Earth", + "description": "Earth has one moon", + "distance_from_sun": "9.3" + } + + response = client.post("/planets", json=EXPECTED_PLANET) + response_body = response.get_json() + + actual_planet = Planet.query.get(1) + assert response.status_code == 201 + assert response_body == f"Planet {EXPECTED_PLANET['name']} successfully created" + assert actual_planet.name == EXPECTED_PLANET["name"] + assert actual_planet.description == EXPECTED_PLANET["description"] + assert actual_planet.distance_from_sun == EXPECTED_PLANET["distance_from_sun"] + \ No newline at end of file From 7694773141c4dbfe6036a896ebe6338fc0cf95d5 Mon Sep 17 00:00:00 2001 From: Jamie Date: Thu, 4 May 2023 15:10:30 -0600 Subject: [PATCH 7/9] solar system completed --- app/models/planet.py | 17 +++++++++++- app/routes.py | 65 ++++++++++++++------------------------------ tests/test_routes.py | 2 +- 3 files changed, 38 insertions(+), 46 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 5e74545d0..62103e0e8 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -9,4 +9,19 @@ class Planet(db.Model): description = db.Column(db.String, nullable=False) distance_from_sun = db.Column(db.String, nullable=False) - \ No newline at end of file + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "distance_from_sun": self.distance_from_sun + } + + @classmethod + def from_dict(cls, data_dict): + return cls( + name = data_dict["name"], + description = data_dict["description"], + distance_from_sun = data_dict["distance_from_sun"] + ) + diff --git a/app/routes.py b/app/routes.py index a304e8c0b..b3a670fe9 100644 --- a/app/routes.py +++ b/app/routes.py @@ -8,64 +8,52 @@ @planet_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"], - ) + try: + new_planet = Planet.from_dict(request_body) - db.session.add(new_planet) - db.session.commit() + db.session.add(new_planet) + db.session.commit() - message = jsonify(f"Planet {new_planet.name} successfully created") - return make_response(message, 201) + message = jsonify(f"Planet {new_planet.name} successfully created") + return make_response(message, 201) + except KeyError as e: + abort(make_response(jsonify(f"missing required value: {e}"), 400)) @planet_bp.route("", methods=["GET"]) def get_all_planets(): planets = Planet.query.all() results = [] for planet in planets: - results.append( - dict( - id=planet.id, - name=planet.name, - description=planet.description, - distance_from_sun=planet.distance_from_sun - ) - ) + results.append(planet.to_dict()) return jsonify(results) -def validate_planet(id): +def validate_model(cls, model_id): try: - id = int(id) + model_id = int(model_id) except: - abort(make_response(jsonify({"message": f"planet {id} is invalid"}), 400)) + message = jsonify(f"{cls.__name__} {model_id} is invalid") + abort(make_response(message, 400)) - planet = Planet.query.get(id) + model = cls.query.get(model_id) - if not planet: - message = jsonify(f"planet {id} not found") + if not model: + message = jsonify(f"{cls.__name__} {model_id} not found") abort(make_response(message, 404)) - return planet + return model @planet_bp.route("/", methods=["GET"]) def get_one_planet(id): - planet = validate_planet(id) - planet_dict = dict( - id=planet.id, - name=planet.name, - description=planet.description, - distance_from_sun=planet.distance_from_sun - ) + planet = validate_model(Planet, id) + planet_dict = planet.to_dict() return planet_dict @planet_bp.route("/", methods = ["PUT"]) def update_one_planet(id): planet_data = request.get_json() - planet_to_update = validate_planet(id) + planet_to_update = validate_model(Planet, id) planet_to_update.name = planet_data["name"] planet_to_update.description = planet_data["description"] @@ -76,21 +64,10 @@ def update_one_planet(id): @planet_bp.route("/", methods = ["DELETE"]) def delete_one_planet(id): - planet_to_delete = validate_planet(id) + planet_to_delete = validate_model(Planet, id) db.session.delete(planet_to_delete) db.session.commit() return make_response(jsonify(f"Planet {planet_to_delete.name} deleted"), 200) - -# planets = [Planet(1, "Mercury", "Mercury has zero moons", 3.5), -# Planet(2, "Venus", "Venus has zero moons", 6.7), -# Planet(3, "Earth", "Earth has one moon", 9.3), -# Planet(4, "Mars", "Mars has two moons", 14.2), -# Planet(5, "Jupiter", "Jupiter has sixty-seven moons", 48.4), -# Planet(6, "Saturn", "Saturn has sixty-two moons", 88.9), -# Planet(7, "Uranus", "Uranus has twenty-seven moons", 179), -# Planet(8, "Neptune", "Neptune has fourteen moons", 288), -# Planet(9, "Pluto", "Pluto has five moons", 367) -# ] diff --git a/tests/test_routes.py b/tests/test_routes.py index 305da4766..a3fb50df0 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -42,7 +42,7 @@ def test_get_one_planets_returns_no_data(client): response_body = response.get_json() assert response.status_code == 404 - assert response_body == "planet 1 not found" + assert response_body == "Planet 1 not found" def test_create_planet_happy_path(client): EXPECTED_PLANET = { From b81cfbecd30345a6b5a3be3d6eb83890aea814cb Mon Sep 17 00:00:00 2001 From: Jamie Date: Thu, 4 May 2023 15:13:23 -0600 Subject: [PATCH 8/9] solar system refactored --- app/routes.py | 1 - 1 file changed, 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index b3a670fe9..06cb8a8ca 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,7 +4,6 @@ planet_bp = Blueprint("planets", __name__, url_prefix="/planets") -# POST /planets @planet_bp.route("", methods=["POST"]) def create_planet(): request_body = request.get_json() From f449db2a5ec6dc10f34313e5a1425e00b2023b6d Mon Sep 17 00:00:00 2001 From: lulu Date: Thu, 4 May 2023 16:47:26 -0500 Subject: [PATCH 9/9] change some format to be consistent --- app/routes.py | 61 +++++++++++++++++++++++++++++++---------------- tests/conftest.py | 14 ++++++----- 2 files changed, 49 insertions(+), 26 deletions(-) diff --git a/app/routes.py b/app/routes.py index 06cb8a8ca..f90592229 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,32 +1,46 @@ -from flask import Blueprint, jsonify, abort, make_response,request +from flask import Blueprint, jsonify, abort, make_response, request from app.models.planet import Planet from app import db planet_bp = Blueprint("planets", __name__, url_prefix="/planets") +# POST /planets + + @planet_bp.route("", methods=["POST"]) def create_planet(): request_body = request.get_json() try: new_planet = Planet.from_dict(request_body) - db.session.add(new_planet) db.session.commit() - + message = jsonify(f"Planet {new_planet.name} successfully created") return make_response(message, 201) except KeyError as e: - abort(make_response(jsonify(f"missing required value: {e}"), 400)) + message = jsonify(f"missing required value: {e}") + abort(make_response(message, 400)) + +# GET /planets + @planet_bp.route("", methods=["GET"]) def get_all_planets(): - planets = Planet.query.all() - results = [] - for planet in planets: - results.append(planet.to_dict()) + name_query = request.args.get("name") + + if name_query: + planets = Planet.query.filter_by(name=name_query) + else: + planets = Planet.query.all() + + results = [planet.to_dict() for planet in planets] + return jsonify(results) + +# GET /planets/ + def validate_model(cls, model_id): try: model_id = int(model_id) @@ -35,13 +49,14 @@ def validate_model(cls, model_id): abort(make_response(message, 400)) model = cls.query.get(model_id) - + if not model: message = jsonify(f"{cls.__name__} {model_id} not found") abort(make_response(message, 404)) - - return model - + + return model + + @planet_bp.route("/", methods=["GET"]) def get_one_planet(id): planet = validate_model(Planet, id) @@ -49,24 +64,30 @@ def get_one_planet(id): return planet_dict -@planet_bp.route("/", methods = ["PUT"]) + +# PUT /planets/ + +@planet_bp.route("/", methods=["PUT"]) def update_one_planet(id): planet_data = request.get_json() planet_to_update = validate_model(Planet, id) - + planet_to_update.name = planet_data["name"] planet_to_update.description = planet_data["description"] planet_to_update.distance_from_sun = planet_data["distance_from_sun"] db.session.commit() - - return make_response(jsonify(f"Planet {planet_to_update.name} updated"), 200) -@planet_bp.route("/", methods = ["DELETE"]) + message = jsonify(f"Planet {planet_to_update.name} updated") + return make_response(message, 200) + + +# DELETE /planets/ + +@planet_bp.route("/", methods=["DELETE"]) def delete_one_planet(id): planet_to_delete = validate_model(Planet, id) db.session.delete(planet_to_delete) db.session.commit() - - return make_response(jsonify(f"Planet {planet_to_delete.name} deleted"), 200) - + message = jsonify(f"Planet {planet_to_delete.name} deleted") + return make_response(message, 200) diff --git a/tests/conftest.py b/tests/conftest.py index 7789a438c..e31b6152a 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -3,6 +3,7 @@ from flask.signals import request_finished from app.models.planet import Planet + @pytest.fixture def app(): app = create_app({"TESTING": True}) @@ -18,23 +19,24 @@ def expire_session(sender, response, **extra): with app.app_context(): db.drop_all() + @pytest.fixture def client(app): return app.test_client() + @pytest.fixture def two_planets(app): - Jupiter = Planet( + Jupiter = Planet( name="Jupiter", description="Jupiter has sixty-seven moons", - distance_from_sun= 48.4 + distance_from_sun=48.4 ) Mercury = Planet( - name = "Mercury", - description = "Mercury has zero moons", - distance_from_sun = 3.5 + name="Mercury", + description="Mercury has zero moons", + distance_from_sun=3.5 ) db.session.add(Jupiter) db.session.add(Mercury) db.session.commit() - \ No newline at end of file