From ff392d58369648755735af313d6ea978f7b17052 Mon Sep 17 00:00:00 2001 From: Sunny <1sunnymuniz@gmail.com> Date: Fri, 21 Oct 2022 12:02:39 -0600 Subject: [PATCH 01/14] begun wave 1, have created one instance of planets --- app/__init__.py | 3 +++ app/routes.py | 9 +++++++++ 2 files changed, 12 insertions(+) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..104ca2cd5 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,4 +4,7 @@ def create_app(test_config=None): app = Flask(__name__) + + return app + diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..af2dd6abe 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,11 @@ from flask import Blueprint + +class Planets(): + def __init__(self, id, name, description, diameter): + self.id = id + self.name = name + self.description = description + self.diameter = diameter + +PLANETS = [Planets(1, "Earth", "round and trashy", "unknown")] \ No newline at end of file From 73f1859868cc3cd8becfb89e6bb1eb9a83cac707 Mon Sep 17 00:00:00 2001 From: Kat Date: Fri, 21 Oct 2022 12:27:50 -0600 Subject: [PATCH 02/14] Added all PLANETS data to the instance. --- app/routes.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index af2dd6abe..0eeec1cba 100644 --- a/app/routes.py +++ b/app/routes.py @@ -8,4 +8,13 @@ def __init__(self, id, name, description, diameter): self.description = description self.diameter = diameter -PLANETS = [Planets(1, "Earth", "round and trashy", "unknown")] \ No newline at end of file +PLANETS = [ + Planets(1, "Mercury", "closest planet to the sun", "3032 miles"), + Planets(1, "Venus", "hottest planet", "7521 miles"), + Planets(1, "Earth", "round and trashy", "7917 miles"), + Planets(1, "Mars", "reddish hue", "4212 miles"), + Planets(1, "Jupiter", "largest planet", "86881 miles"), + Planets(1, "Saturn", "surrounded by rings", "72367 miles"), + Planets(1, "Uranus", "coldest planet", "31518 miles"), + Planets(1, "Neptune", "most windy planet", "30599 miles"), +] \ No newline at end of file From 6b69c6a4a664b762d5e6c3caa4df3f43b290c5a1 Mon Sep 17 00:00:00 2001 From: Kat Date: Sun, 23 Oct 2022 14:19:35 -0600 Subject: [PATCH 03/14] added planets read planets and read one planet endpoints plus error handling --- app/__init__.py | 3 ++- app/routes.py | 53 ++++++++++++++++++++++++++++++++++++++++--------- 2 files changed, 46 insertions(+), 10 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 104ca2cd5..d20ff68b7 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,7 +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 0eeec1cba..fb4c4d2e0 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,4 @@ -from flask import Blueprint +from flask import Blueprint, jsonify class Planets(): @@ -10,11 +10,46 @@ def __init__(self, id, name, description, diameter): PLANETS = [ Planets(1, "Mercury", "closest planet to the sun", "3032 miles"), - Planets(1, "Venus", "hottest planet", "7521 miles"), - Planets(1, "Earth", "round and trashy", "7917 miles"), - Planets(1, "Mars", "reddish hue", "4212 miles"), - Planets(1, "Jupiter", "largest planet", "86881 miles"), - Planets(1, "Saturn", "surrounded by rings", "72367 miles"), - Planets(1, "Uranus", "coldest planet", "31518 miles"), - Planets(1, "Neptune", "most windy planet", "30599 miles"), -] \ No newline at end of file + Planets(2, "Venus", "hottest planet", "7521 miles"), + Planets(3, "Earth", "round and trashy", "7917 miles"), + Planets(4, "Mars", "reddish hue", "4212 miles"), + Planets(5, "Jupiter", "largest planet", "86881 miles"), + Planets(6, "Saturn", "surrounded by rings", "72367 miles"), + Planets(7, "Uranus", "coldest planet", "31518 miles"), + Planets(8, "Neptune", "most windy planet", "30599 miles"), +] + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + +@planets_bp.route("", methods=["GET"]) +def handle_planets(): + planets_response = [] + for planet in PLANETS: + planets_response.append({ + "id": planet.id, + "name": planet.name, + "description": planet.description, + "diameter": planet.diameter + }) + return jsonify(planets_response) + +@planets_bp.route("/", methods = ["GET"]) +def handle_one_planet(planet_id): + try: + planet_id = int(planet_id) + except: + return {"message":f"planet {planet_id} invalid"}, 400 + for planet in PLANETS: + if planet.id == planet_id: + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "diameter": planet.diameter + } + + return {"message":f"planet {planet_id} not found"}, 404 + + + + From 57d860ad867fdd074dd6e4a6cab07fc98ddbe160 Mon Sep 17 00:00:00 2001 From: Sunny <1sunnymuniz@gmail.com> Date: Mon, 24 Oct 2022 12:52:14 -0600 Subject: [PATCH 04/14] created helper function validate planet --- app/routes.py | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/app/routes.py b/app/routes.py index fb4c4d2e0..647ae9190 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 Planets(): @@ -35,20 +35,33 @@ def handle_planets(): @planets_bp.route("/", methods = ["GET"]) def handle_one_planet(planet_id): - try: + planet = validate_planet(planet_id) + + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "diameter": planet.diameter + } + + + + +def validate_planet(planet_id): + try: planet_id = int(planet_id) except: - return {"message":f"planet {planet_id} invalid"}, 400 - for planet in PLANETS: + abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) + + for planet in PLANETS: if planet.id == planet_id: - return { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "diameter": planet.diameter - } - - return {"message":f"planet {planet_id} not found"}, 404 + return planet + + abort(make_response({"message": f"planet {planet_id} not found"}, 404)) + + + + From 158844e1f8f82e426074d79c264fd711296a18ce Mon Sep 17 00:00:00 2001 From: Sunny <1sunnymuniz@gmail.com> Date: Sun, 30 Oct 2022 17:16:22 -0600 Subject: [PATCH 05/14] set up a models folder, and a constructor and planet file within --- app/__init__.py | 15 +++++++++++++++ app/models/__init__.py | 0 app/models/planet.py | 10 ++++++++++ 3 files changed, 25 insertions(+) create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.py diff --git a/app/__init__.py b/app/__init__.py index d20ff68b7..def35bb1d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,11 +1,26 @@ 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 planets_bp app.register_blueprint(planets_bp) + return app 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..3bf85fe6b --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,10 @@ +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) + diameter = db.Column(db.String) + + + From d8cc2b0e38d0d377f24de5d00ff49abb7036b2b3 Mon Sep 17 00:00:00 2001 From: Sunny <1sunnymuniz@gmail.com> Date: Sun, 30 Oct 2022 17:24:35 -0600 Subject: [PATCH 06/14] created migrations folder --- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../fed570941042_adds_planet_model.py | 34 +++++++ 5 files changed, 200 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 create mode 100644 migrations/versions/fed570941042_adds_planet_model.py 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/fed570941042_adds_planet_model.py b/migrations/versions/fed570941042_adds_planet_model.py new file mode 100644 index 000000000..74ed5bfff --- /dev/null +++ b/migrations/versions/fed570941042_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: fed570941042 +Revises: +Create Date: 2022-10-30 17:17:55.566428 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'fed570941042' +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('diameter', 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 ### From ba16cc04edc5accce2a1117fb413fde4079b964d Mon Sep 17 00:00:00 2001 From: Sunny <1sunnymuniz@gmail.com> Date: Sun, 30 Oct 2022 18:03:52 -0600 Subject: [PATCH 07/14] created end point to read all planets --- app/routes.py | 129 +++++++++++++++++++++++++++++++------------------- 1 file changed, 81 insertions(+), 48 deletions(-) diff --git a/app/routes.py b/app/routes.py index 647ae9190..bd16f2e0f 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,63 +1,96 @@ -from flask import Blueprint, jsonify, abort, make_response - - -class Planets(): - def __init__(self, id, name, description, diameter): - self.id = id - self.name = name - self.description = description - self.diameter = diameter - -PLANETS = [ - Planets(1, "Mercury", "closest planet to the sun", "3032 miles"), - Planets(2, "Venus", "hottest planet", "7521 miles"), - Planets(3, "Earth", "round and trashy", "7917 miles"), - Planets(4, "Mars", "reddish hue", "4212 miles"), - Planets(5, "Jupiter", "largest planet", "86881 miles"), - Planets(6, "Saturn", "surrounded by rings", "72367 miles"), - Planets(7, "Uranus", "coldest planet", "31518 miles"), - Planets(8, "Neptune", "most windy planet", "30599 miles"), -] +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request + planets_bp = Blueprint("planets", __name__, url_prefix="/planets") -@planets_bp.route("", methods=["GET"]) +@planets_bp.route("", methods=["POST"]) def handle_planets(): + request_body = request.get_json() + new_planet = Planet(id=request_body["id"], + name=request_body["name"], + description=request_body["description"], + diameter=request_body["diameter"] + ) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} successfully created", 201) + +@planets_bp.route("", methods=["GET"]) +def read_all_planet(): planets_response = [] - for planet in PLANETS: - planets_response.append({ - "id": planet.id, - "name": planet.name, - "description": planet.description, - "diameter": planet.diameter - }) - return jsonify(planets_response) - -@planets_bp.route("/", methods = ["GET"]) -def handle_one_planet(planet_id): - planet = validate_planet(planet_id) + planets = Planet.query.all() + for planet in planets: + planets_response.append( + { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "diameter": planet.diameter + } + ) + return jsonify(planets_response) + + +# class Planets(): +# def __init__(self, id, name, description, diameter): +# self.id = id +# self.name = name +# self.description = description +# self.diameter = diameter + +# PLANETS = [ +# Planets(1, "Mercury", "closest planet to the sun", "3032 miles"), +# Planets(2, "Venus", "hottest planet", "7521 miles"), +# Planets(3, "Earth", "round and trashy", "7917 miles"), +# Planets(4, "Mars", "reddish hue", "4212 miles"), +# Planets(5, "Jupiter", "largest planet", "86881 miles"), +# Planets(6, "Saturn", "surrounded by rings", "72367 miles"), +# Planets(7, "Uranus", "coldest planet", "31518 miles"), +# Planets(8, "Neptune", "most windy planet", "30599 miles"), +# ] + + +# @planets_bp.route("", methods=["GET"]) +# def handle_planets(): +# planets_response = [] +# for planet in PLANETS: +# planets_response.append({ +# "id": planet.id, +# "name": planet.name, +# "description": planet.description, +# "diameter": planet.diameter +# }) +# return jsonify(planets_response) + +# @planets_bp.route("/", methods = ["GET"]) +# def handle_one_planet(planet_id): +# planet = validate_planet(planet_id) - return { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "diameter": planet.diameter - } +# return { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description, +# "diameter": planet.diameter +# } -def validate_planet(planet_id): - try: - planet_id = int(planet_id) - except: - abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) +# def validate_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) - for planet in PLANETS: - if planet.id == planet_id: - return planet +# for planet in PLANETS: +# if planet.id == planet_id: +# return planet - abort(make_response({"message": f"planet {planet_id} not found"}, 404)) +# abort(make_response({"message": f"planet {planet_id} not found"}, 404)) From 34e539efa8ce0ca9e66095777c4eb1e15c2b53ca Mon Sep 17 00:00:00 2001 From: Kat Date: Tue, 1 Nov 2022 12:44:48 -0600 Subject: [PATCH 08/14] Added Read, Update, Delete functionality --- app/routes.py | 90 +++++++++++++++++++++++++++++---------------------- 1 file changed, 52 insertions(+), 38 deletions(-) diff --git a/app/routes.py b/app/routes.py index bd16f2e0f..67d9766c9 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,15 +1,14 @@ from app import db from app.models.planet import Planet -from flask import Blueprint, jsonify, make_response, request +from flask import Blueprint, jsonify, make_response, request, abort planets_bp = Blueprint("planets", __name__, url_prefix="/planets") @planets_bp.route("", methods=["POST"]) -def handle_planets(): +def add_planet(): request_body = request.get_json() - new_planet = Planet(id=request_body["id"], - name=request_body["name"], + new_planet = Planet(name=request_body["name"], description=request_body["description"], diameter=request_body["diameter"] ) @@ -20,7 +19,7 @@ def handle_planets(): return make_response(f"Planet {new_planet.name} successfully created", 201) @planets_bp.route("", methods=["GET"]) -def read_all_planet(): +def read_all_planets(): planets_response = [] planets = Planet.query.all() for planet in planets: @@ -34,6 +33,53 @@ def read_all_planet(): ) return jsonify(planets_response) +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) + + planet = Planet.query.get(planet_id) + + if not planet: + abort(make_response({"message": f"planet {planet_id} not found"}, 404)) + + return planet + +@planets_bp.route("/", methods = ["GET"]) +def read_one_planet(planet_id): + planet = validate_planet(planet_id) + + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "diameter": planet.diameter + } + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.diameter = request_body["diameter"] + + + db.session.commit() + + return make_response(f"Planet #{planet.id} successfully updated") + +@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") # class Planets(): # def __init__(self, id, name, description, diameter): @@ -54,43 +100,11 @@ def read_all_planet(): # ] -# @planets_bp.route("", methods=["GET"]) -# def handle_planets(): -# planets_response = [] -# for planet in PLANETS: -# planets_response.append({ -# "id": planet.id, -# "name": planet.name, -# "description": planet.description, -# "diameter": planet.diameter -# }) -# return jsonify(planets_response) - -# @planets_bp.route("/", methods = ["GET"]) -# def handle_one_planet(planet_id): -# planet = validate_planet(planet_id) - -# return { -# "id": planet.id, -# "name": planet.name, -# "description": planet.description, -# "diameter": planet.diameter -# } - + -# def validate_planet(planet_id): -# try: -# planet_id = int(planet_id) -# except: -# abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) -# for planet in PLANETS: -# if planet.id == planet_id: -# return planet - -# abort(make_response({"message": f"planet {planet_id} not found"}, 404)) From 914af00af617b79dbe70a00392126016ae1b0ad0 Mon Sep 17 00:00:00 2001 From: Kat Date: Tue, 1 Nov 2022 12:45:49 -0600 Subject: [PATCH 09/14] Added Read, Update, Delete functionality2 --- app/routes.py | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/app/routes.py b/app/routes.py index 67d9766c9..fb5c9f48d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -102,14 +102,3 @@ def delete_planet(planet_id): - - - - - - - - - - - From 80a4a0b412d1b0f8d2564253806f2512012cc9c4 Mon Sep 17 00:00:00 2001 From: Sunny <1sunnymuniz@gmail.com> Date: Wed, 2 Nov 2022 13:06:56 -0600 Subject: [PATCH 10/14] created class method from dict as well as instance method to dict and refactored code for updating, reading one planet, read all planets, add planet and validate model routes file --- app/models/planet.py | 25 +++++++++++++- app/routes.py | 80 ++++++++++++++------------------------------ 2 files changed, 50 insertions(+), 55 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 3bf85fe6b..f7a503ab6 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -1,4 +1,5 @@ -from app import db +from app import db +from flask import abort, make_response class Planet(db.Model): id = db.Column(db.Integer,primary_key = True, autoincrement= True) @@ -6,5 +7,27 @@ class Planet(db.Model): description = db.Column(db.String) diameter = db.Column(db.String) + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "diameter": self.diameter + } + @classmethod + def from_dict(cls, planet_data): + new_planet = Planet(name=planet_data["name"], + description=planet_data["description"], + diameter=planet_data["diameter"]) + return new_planet + + # def update(self, req_body): + # try: + # self.name = req_body["name"] + # self.description = req_body["description"] + # self.diameter = req_body["diameter"] + # except LookupError: + # print("Missing key:") + diff --git a/app/routes.py b/app/routes.py index fb5c9f48d..ea40a67e5 100644 --- a/app/routes.py +++ b/app/routes.py @@ -8,10 +8,7 @@ @planets_bp.route("", methods=["POST"]) def add_planet(): request_body = request.get_json() - new_planet = Planet(name=request_body["name"], - description=request_body["description"], - diameter=request_body["diameter"] - ) + new_planet = Planet.from_dict(request_body) db.session.add(new_planet) db.session.commit() @@ -20,84 +17,59 @@ def add_planet(): @planets_bp.route("", methods=["GET"]) def read_all_planets(): - planets_response = [] - planets = Planet.query.all() - for planet in planets: - planets_response.append( - { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "diameter": planet.diameter - } - ) + name_query = request.args.get("name") + description_query = request.args.get("description") + diameter_query = request.args.get("diameter") + if name_query: + planets = Planet.query.filter_by(name=name_query) + elif description_query: + planets = Planet.query.filter_by(description=description_query) + elif diameter_query: + planets = Planet.query.filter_by(diameter=diameter_query) + else: + planets = Planet.query.all() + + planets_response = [planet.to_dict() for planet in planets] return jsonify(planets_response) -def validate_planet(planet_id): +def validate_model(cls, model_id): try: - planet_id = int(planet_id) + model_id = int(model_id) except: - abort(make_response({"message": f"planet {planet_id} invalid"}, 400)) + abort(make_response({"message": f"{cls.__name__} {model_id} invalid"}, 400)) - planet = Planet.query.get(planet_id) + model = cls.query.get(model_id) - if not planet: - abort(make_response({"message": f"planet {planet_id} not found"}, 404)) + if not model: + abort(make_response({"message": f"{cls.__name__} {model_id} not found"}, 404)) - return planet + return model @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, - "diameter": planet.diameter - } + planet = validate_model(Planet,planet_id) + return planet.to_dict() @planets_bp.route("/", methods=["PUT"]) def update_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_model(Planet,planet_id) request_body = request.get_json() - planet.name = request_body["name"] - planet.description = request_body["description"] - planet.diameter = request_body["diameter"] - - + planet.update(request_body) db.session.commit() return make_response(f"Planet #{planet.id} successfully updated") @planets_bp.route("/", methods=["DELETE"]) def delete_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_model(Planet,planet_id) db.session.delete(planet) db.session.commit() return make_response(f"Planet #{planet.id} successfully deleted") -# class Planets(): -# def __init__(self, id, name, description, diameter): -# self.id = id -# self.name = name -# self.description = description -# self.diameter = diameter - -# PLANETS = [ -# Planets(1, "Mercury", "closest planet to the sun", "3032 miles"), -# Planets(2, "Venus", "hottest planet", "7521 miles"), -# Planets(3, "Earth", "round and trashy", "7917 miles"), -# Planets(4, "Mars", "reddish hue", "4212 miles"), -# Planets(5, "Jupiter", "largest planet", "86881 miles"), -# Planets(6, "Saturn", "surrounded by rings", "72367 miles"), -# Planets(7, "Uranus", "coldest planet", "31518 miles"), -# Planets(8, "Neptune", "most windy planet", "30599 miles"), -# ] From 00759f9646e4dbf580936268aabdcd3c5d6d2440 Mon Sep 17 00:00:00 2001 From: Kat Date: Wed, 2 Nov 2022 14:14:16 -0600 Subject: [PATCH 11/14] Added update instance method functionality --- app/models/planet.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index f7a503ab6..d9b512b0b 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -22,12 +22,12 @@ def from_dict(cls, planet_data): diameter=planet_data["diameter"]) return new_planet - # def update(self, req_body): - # try: - # self.name = req_body["name"] - # self.description = req_body["description"] - # self.diameter = req_body["diameter"] - # except LookupError: - # print("Missing key:") + def update(self, req_body): + try: + self.name = req_body["name"] + self.description = req_body["description"] + self.diameter = req_body["diameter"] + except KeyError as error: + abort(make_response({"message": f"Missing attribute: {error}"}, 400)) From 7079622826d834b20bcd7b1e5f41b5dfbe56b10a Mon Sep 17 00:00:00 2001 From: Kat Date: Thu, 3 Nov 2022 12:21:59 -0600 Subject: [PATCH 12/14] Created test environment --- app/__init__.py | 16 ++++++++++++---- app/models/planet.py | 2 +- app/tests/__init__.py | 0 app/tests/conftest.py | 25 +++++++++++++++++++++++++ app/tests/test_routes.py | 0 5 files changed, 38 insertions(+), 5 deletions(-) create mode 100644 app/tests/__init__.py create mode 100644 app/tests/conftest.py create mode 100644 app/tests/test_routes.py diff --git a/app/__init__.py b/app/__init__.py index def35bb1d..54de766a5 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,17 +1,25 @@ 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) diff --git a/app/models/planet.py b/app/models/planet.py index d9b512b0b..9bc47d682 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -28,6 +28,6 @@ def update(self, req_body): self.description = req_body["description"] self.diameter = req_body["diameter"] except KeyError as error: - abort(make_response({"message": f"Missing attribute: {error}"}, 400)) + abort(make_response({"message": f"Missing attribute: {error}"},400)) diff --git a/app/tests/__init__.py b/app/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/tests/conftest.py b/app/tests/conftest.py new file mode 100644 index 000000000..ac8a4193b --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,25 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished + + +@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() \ No newline at end of file diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..e69de29bb From df05165662899c1e3e338afe82aea79da61248c9 Mon Sep 17 00:00:00 2001 From: Kat Date: Thu, 3 Nov 2022 12:57:56 -0600 Subject: [PATCH 13/14] Added tests for POST and GET; refactored to jsonify --- app/routes.py | 6 ++-- app/tests/conftest.py | 16 ++++++++- app/tests/test_routes.py | 74 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 92 insertions(+), 4 deletions(-) diff --git a/app/routes.py b/app/routes.py index ea40a67e5..751279335 100644 --- a/app/routes.py +++ b/app/routes.py @@ -13,7 +13,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=["GET"]) def read_all_planets(): @@ -59,7 +59,7 @@ def update_planet(planet_id): planet.update(request_body) db.session.commit() - return make_response(f"Planet #{planet.id} successfully updated") + return make_response(jsonify(f"Planet #{planet.id} successfully updated")) @planets_bp.route("/", methods=["DELETE"]) def delete_planet(planet_id): @@ -68,7 +68,7 @@ def delete_planet(planet_id): db.session.delete(planet) db.session.commit() - return make_response(f"Planet #{planet.id} successfully deleted") + return make_response(jsonify(f"Planet #{planet.id} successfully deleted")) diff --git a/app/tests/conftest.py b/app/tests/conftest.py index ac8a4193b..aa30a074a 100644 --- a/app/tests/conftest.py +++ b/app/tests/conftest.py @@ -2,6 +2,7 @@ from app import create_app from app import db from flask.signals import request_finished +from app.models.planet import Planet @pytest.fixture @@ -22,4 +23,17 @@ def expire_session(sender, response, **extra): @pytest.fixture def client(app): - return app.test_client() \ No newline at end of file + return app.test_client() + +@pytest.fixture +def two_saved_planets(app): + # Arrange + ocean_planet = Planet(name="Ocean Planet", + description="watr 4evr", + diameter = "0 miles") + mountain_planet = Planet(name="Mountain Planet", + description="i luv 2 climb rocks", + diameter = "1 mile") + + db.session.add_all([ocean_planet, mountain_planet]) + db.session.commit() \ No newline at end of file diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py index e69de29bb..106384d87 100644 --- a/app/tests/test_routes.py +++ b/app/tests/test_routes.py @@ -0,0 +1,74 @@ +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_get_one_planet(client, two_saved_planets): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Ocean Planet", + "description": "watr 4evr", + "diameter": "0 miles" + } + +def test_get_one_planet_with_no_data(client): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"message": "Planet 1 not found"} + +def test_get_one_planet_with_invalid_id(client): + # Act + response = client.get("/planets/**") + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == {"message": "Planet ** invalid"} + +def test_get_all_planets(client, two_saved_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [{ + "id": 1, + "name": "Ocean Planet", + "description": "watr 4evr", + "diameter": "0 miles" + }, + { + "id": 2, + "name": "Mountain Planet", + "description": "i luv 2 climb rocks", + "diameter": "1 mile" + }] + assert len(response_body) == 2 + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "New Planet", + "description": "The Best!", + "diameter": "5 miles" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet New Planet successfully created" \ No newline at end of file From 0b4f04a1f5e0f6491e5e89aeb54eea94de80e945 Mon Sep 17 00:00:00 2001 From: Kat Date: Mon, 7 Nov 2022 12:47:01 -0700 Subject: [PATCH 14/14] created Procfile --- Procfile | 1 + requirements.txt | 9 +++++++++ 2 files changed, 10 insertions(+) create mode 100644 Procfile diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..62e430aca --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index fba2b3e38..517b98b2d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,19 +1,27 @@ alembic==1.5.4 +attrs==22.1.0 autopep8==1.5.5 blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==6.5.0 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 +iniconfig==1.1.1 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==21.3 +pluggy==1.0.0 psycopg2-binary==2.9.4 +py==1.11.0 pycodestyle==2.6.0 +pyparsing==3.0.9 pytest==7.1.1 pytest-cov==2.12.1 python-dateutil==2.8.1 @@ -23,5 +31,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