From 85c83727645906cad3dd8dfe115afc88c1ea72b3 Mon Sep 17 00:00:00 2001 From: Juli Date: Fri, 22 Apr 2022 14:16:33 -0400 Subject: [PATCH 01/18] added planet class and endpoints --- app/routes.py | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..f41d0b338 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,31 @@ -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,"Mars","Next livable planet","131.48 million mi"), + Planet(2,"Mercury","Smallest planet","94.025 million mi"), + Planet(3,"Earth","We live here, slowly dying", "0.0 million mi") +] + +planet_bp = Blueprint("planet", __name__, url_prefix="/planets") + + +@planet_bp.route("", methods=["GET"]) +def get_planets(): + planets_response = [] + for planet in planets: + planets_response.append( + { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "Distance from Earth": planet.distance_from_earth + }) + return jsonify(planets_response) From ba93e9101eee6ab2e87749350a00a372cf3bb4e5 Mon Sep 17 00:00:00 2001 From: jeannie Date: Sat, 23 Apr 2022 17:02:48 -0500 Subject: [PATCH 02/18] changes to __init__ _ --- app/__init__.py | 3 ++- app/routes.py | 11 ++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..fee3e0494 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -3,5 +3,6 @@ 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 f41d0b338..696f1cd25 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,16 +1,18 @@ from flask import Blueprint, jsonify + class Planet: def __init__(self, id, name, description, distance_from_earth): - self.id = id + self.id = id self.name = name self.description = description self.distance_from_earth = distance_from_earth + planets = [ - Planet(1,"Mars","Next livable planet","131.48 million mi"), - Planet(2,"Mercury","Smallest planet","94.025 million mi"), - Planet(3,"Earth","We live here, slowly dying", "0.0 million mi") + Planet(1, "Mars", "Next livable planet", "131.48 million mi"), + Planet(2, "Mercury", "Smallest planet", "94.025 million mi"), + Planet(3, "Earth", "We live here, slowly dying", "0.0 million mi") ] planet_bp = Blueprint("planet", __name__, url_prefix="/planets") @@ -28,4 +30,3 @@ def get_planets(): "Distance from Earth": planet.distance_from_earth }) return jsonify(planets_response) - From 2576c0ce2b227a1eef574fa9eee6701f276f79ed Mon Sep 17 00:00:00 2001 From: Juli Date: Mon, 25 Apr 2022 13:44:28 -0400 Subject: [PATCH 03/18] updated __init__.py --- app/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..b2bd60609 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 From 9fccce8d2ef7ec24eb0828bafa6d2a57efb35228 Mon Sep 17 00:00:00 2001 From: Juli Date: Mon, 25 Apr 2022 15:04:28 -0400 Subject: [PATCH 04/18] Finished wave 2 --- app/routes.py | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/app/routes.py b/app/routes.py index 696f1cd25..6eabff3ba 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,5 +1,4 @@ -from flask import Blueprint, jsonify - +from flask import Blueprint, jsonify, abort, make_response class Planet: def __init__(self, id, name, description, distance_from_earth): @@ -8,6 +7,13 @@ def __init__(self, id, name, description, distance_from_earth): self.description = description self.distance_from_earth = distance_from_earth + def to_json(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "Distance from Earth": self.distance_from_earth + } planets = [ Planet(1, "Mars", "Next livable planet", "131.48 million mi"), @@ -17,7 +23,6 @@ def __init__(self, id, name, description, distance_from_earth): planet_bp = Blueprint("planet", __name__, url_prefix="/planets") - @planet_bp.route("", methods=["GET"]) def get_planets(): planets_response = [] @@ -30,3 +35,22 @@ def get_planets(): "Distance from Earth": planet.distance_from_earth }) return jsonify(planets_response) + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + return abort(make_response({"message": f"planet {planet_id} invaid"}, 400)) + + for planet in planets: + if planet.id == planet_id: + return planet + return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) + + +@planet_bp.route("/", methods=["GET"]) +def get_one_planet(planet_id): + planet = validate_planet(planet_id) + return jsonify(planet.to_json(), 200) + + From dd61ed8870e894c2d898ea30f31272a6c817379f Mon Sep 17 00:00:00 2001 From: Juli Date: Tue, 26 Apr 2022 16:13:13 -0400 Subject: [PATCH 05/18] Updated error messages. --- app/routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 6eabff3ba..4fac8e73e 100644 --- a/app/routes.py +++ b/app/routes.py @@ -40,7 +40,7 @@ def validate_planet(planet_id): try: planet_id = int(planet_id) except: - return abort(make_response({"message": f"planet {planet_id} invaid"}, 400)) + return abort(make_response({"message": f"planet {planet_id} invaild"}, 400)) for planet in planets: if planet.id == planet_id: From 8a4fcb6c88de2a5b821f7e87b38b86f517a412d2 Mon Sep 17 00:00:00 2001 From: Juli Date: Tue, 26 Apr 2022 16:15:36 -0400 Subject: [PATCH 06/18] Minor updates. --- app/routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 4fac8e73e..8d6838c9b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -40,7 +40,7 @@ def validate_planet(planet_id): try: planet_id = int(planet_id) except: - return abort(make_response({"message": f"planet {planet_id} invaild"}, 400)) + return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) for planet in planets: if planet.id == planet_id: From 880cfea0418325c700328beefd20ff839fe98729 Mon Sep 17 00:00:00 2001 From: jeannie Date: Fri, 29 Apr 2022 13:04:22 -0500 Subject: [PATCH 07/18] created models for planet --- app/__init__.py | 14 +++ app/models/__init__.py | 0 app/models/planet.py | 8 ++ app/routes.py | 22 ++--- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../5b418a0c89d5_added_planet_model.py | 34 +++++++ 9 files changed, 233 insertions(+), 11 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/5b418a0c89d5_added_planet_model.py diff --git a/app/__init__.py b/app/__init__.py index fee3e0494..0f01c3093 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,8 +1,22 @@ 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) 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..1ed02bd97 --- /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) + distance_from_earth = db.Column(db.String) diff --git a/app/routes.py b/app/routes.py index 696f1cd25..ff15d0c98 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,19 +1,19 @@ 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 +# 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, "Mars", "Next livable planet", "131.48 million mi"), - Planet(2, "Mercury", "Smallest planet", "94.025 million mi"), - Planet(3, "Earth", "We live here, slowly dying", "0.0 million mi") -] +# planets = [ +# Planet(1, "Mars", "Next livable planet", "131.48 million mi"), +# Planet(2, "Mercury", "Smallest planet", "94.025 million mi"), +# Planet(3, "Earth", "We live here, slowly dying", "0.0 million mi") +# ] planet_bp = Blueprint("planet", __name__, url_prefix="/planets") 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/5b418a0c89d5_added_planet_model.py b/migrations/versions/5b418a0c89d5_added_planet_model.py new file mode 100644 index 000000000..187768642 --- /dev/null +++ b/migrations/versions/5b418a0c89d5_added_planet_model.py @@ -0,0 +1,34 @@ +"""added planet model + +Revision ID: 5b418a0c89d5 +Revises: +Create Date: 2022-04-29 13:02:45.187757 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '5b418a0c89d5' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('planet', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('distance_from_earth', 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 ce18f36100ffef50f5526f6e3d9bde5f0a0b77ba Mon Sep 17 00:00:00 2001 From: jeannie Date: Fri, 29 Apr 2022 13:24:41 -0500 Subject: [PATCH 08/18] post one planet --- app/models/planet.py | 8 ++++ app/routes.py | 97 +++++++++++++++++++++++--------------------- 2 files changed, 58 insertions(+), 47 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 1ed02bd97..3f080d534 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -6,3 +6,11 @@ class Planet(db.Model): name = db.Column(db.String) description = db.Column(db.String) distance_from_earth = db.Column(db.String) + + def to_json(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "Distance from Earth": self.distance_from_earth + } diff --git a/app/routes.py b/app/routes.py index b8a6c0e19..be3247950 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,19 +1,7 @@ -from flask import Blueprint, jsonify, abort, make_response - -# 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 - - def to_json(self): - return { - "id": self.id, - "name": self.name, - "description": self.description, - "Distance from Earth": self.distance_from_earth - } +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, abort, make_response, request + # planets = [ # Planet(1, "Mars", "Next livable planet", "131.48 million mi"), @@ -23,34 +11,49 @@ def to_json(self): planet_bp = Blueprint("planet", __name__, url_prefix="/planets") -@planet_bp.route("", methods=["GET"]) -def get_planets(): - planets_response = [] - for planet in planets: - planets_response.append( - { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "Distance from Earth": planet.distance_from_earth - }) - return jsonify(planets_response) - -def validate_planet(planet_id): - try: - planet_id = int(planet_id) - except: - return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) - - for planet in planets: - if planet.id == planet_id: - return planet - return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) - - -@planet_bp.route("/", methods=["GET"]) -def get_one_planet(planet_id): - planet = validate_planet(planet_id) - return jsonify(planet.to_json(), 200) - - + +@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_earth=request_body['Distance from Earth'] + ) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} has been created", 201) + + +# @planet_bp.route("", methods=["GET"]) +# def get_planets(): +# planets_response = [] +# for planet in planets: +# planets_response.append( +# { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description, +# "Distance from Earth": planet.distance_from_earth +# }) +# return jsonify(planets_response) + +# def validate_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) + +# for planet in planets: +# if planet.id == planet_id: +# return planet +# return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) + + +# @planet_bp.route("/", methods=["GET"]) +# def get_one_planet(planet_id): +# planet = validate_planet(planet_id) +# return jsonify(planet.to_json(), 200) From 604991fb597fab43bbfd52df671945fdea63cd81 Mon Sep 17 00:00:00 2001 From: jeannie Date: Fri, 29 Apr 2022 13:29:48 -0500 Subject: [PATCH 09/18] read all planets --- app/routes.py | 27 ++++++++------------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/app/routes.py b/app/routes.py index be3247950..6aa0c43bf 100644 --- a/app/routes.py +++ b/app/routes.py @@ -2,13 +2,6 @@ from app.models.planet import Planet from flask import Blueprint, jsonify, abort, make_response, request - -# planets = [ -# Planet(1, "Mars", "Next livable planet", "131.48 million mi"), -# Planet(2, "Mercury", "Smallest planet", "94.025 million mi"), -# Planet(3, "Earth", "We live here, slowly dying", "0.0 million mi") -# ] - planet_bp = Blueprint("planet", __name__, url_prefix="/planets") @@ -28,18 +21,14 @@ def create_planet(): return make_response(f"Planet {new_planet.name} has been created", 201) -# @planet_bp.route("", methods=["GET"]) -# def get_planets(): -# planets_response = [] -# for planet in planets: -# planets_response.append( -# { -# "id": planet.id, -# "name": planet.name, -# "description": planet.description, -# "Distance from Earth": planet.distance_from_earth -# }) -# return jsonify(planets_response) +@planet_bp.route("", methods=["GET"]) +def get_planets(): + planets = Planet.query.all() + planets_response = [] + for planet in planets: + planets_response.append(planet.to_json()) + + return jsonify(planets_response, 200) # def validate_planet(planet_id): # try: From feaf92e23270df3c27c6de21fb9d26dbe92e65bc Mon Sep 17 00:00:00 2001 From: Juli Date: Fri, 29 Apr 2022 14:33:40 -0400 Subject: [PATCH 10/18] Revised String Attributes to match. --- app/models/planet.py | 3 +-- app/routes.py | 4 +--- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 3f080d534..11c77e508 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -1,6 +1,5 @@ from app import db - class Planet(db.Model): id = db.Column(db.Integer, primary_key=True, autoincrement=True) name = db.Column(db.String) @@ -12,5 +11,5 @@ def to_json(self): "id": self.id, "name": self.name, "description": self.description, - "Distance from Earth": self.distance_from_earth + "distance from earth": self.distance_from_earth } diff --git a/app/routes.py b/app/routes.py index 6aa0c43bf..5151f752a 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,7 +4,6 @@ planet_bp = Blueprint("planet", __name__, url_prefix="/planets") - @planet_bp.route("", methods=["POST"]) def create_planet(): request_body = request.get_json() @@ -12,7 +11,7 @@ def create_planet(): new_planet = Planet( name=request_body['name'], description=request_body['description'], - distance_from_earth=request_body['Distance from Earth'] + distance_from_earth=request_body['distance from earth'] ) db.session.add(new_planet) @@ -20,7 +19,6 @@ def create_planet(): return make_response(f"Planet {new_planet.name} has been created", 201) - @planet_bp.route("", methods=["GET"]) def get_planets(): planets = Planet.query.all() From ae0ab718230e38f2733b4accb401b6591bb6c966 Mon Sep 17 00:00:00 2001 From: Juli Date: Tue, 3 May 2022 13:46:25 -0400 Subject: [PATCH 11/18] Added validate planet and get One Planet routes --- app/routes.py | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/app/routes.py b/app/routes.py index 5151f752a..45cd346a1 100644 --- a/app/routes.py +++ b/app/routes.py @@ -28,19 +28,20 @@ def get_planets(): return jsonify(planets_response, 200) -# def validate_planet(planet_id): -# try: -# planet_id = int(planet_id) -# except: -# return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) - -# for planet in planets: -# if planet.id == planet_id: -# return planet -# return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) - - -# @planet_bp.route("/", methods=["GET"]) -# def get_one_planet(planet_id): -# planet = validate_planet(planet_id) -# return jsonify(planet.to_json(), 200) +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) + + planet = Planet.query.get(planet_id) + + if not planet: + return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) + return planet + + +@planet_bp.route("/", methods=["GET"]) +def get_one_planet(planet_id): + planet = validate_planet(planet_id) + return jsonify(planet.to_json(), 200) From cd4ee9b2226e32492f1dbfbca094bd2b463c8e10 Mon Sep 17 00:00:00 2001 From: jeannie Date: Tue, 3 May 2022 12:53:44 -0500 Subject: [PATCH 12/18] added update endpoint route --- app/routes.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 45cd346a1..835cb4a55 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,6 +4,7 @@ planet_bp = Blueprint("planet", __name__, url_prefix="/planets") + @planet_bp.route("", methods=["POST"]) def create_planet(): request_body = request.get_json() @@ -19,6 +20,7 @@ def create_planet(): return make_response(f"Planet {new_planet.name} has been created", 201) + @planet_bp.route("", methods=["GET"]) def get_planets(): planets = Planet.query.all() @@ -28,6 +30,7 @@ def get_planets(): return jsonify(planets_response, 200) + def validate_planet(planet_id): try: planet_id = int(planet_id) @@ -35,7 +38,7 @@ def validate_planet(planet_id): return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) planet = Planet.query.get(planet_id) - + if not planet: return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) return planet @@ -45,3 +48,14 @@ def validate_planet(planet_id): def get_one_planet(planet_id): planet = validate_planet(planet_id) return jsonify(planet.to_json(), 200) + + +@planet_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.distance_from_earth = request_body["distance from earth"] + db.session.commit() + return make_response(f"Planet #{planet.id} successfully updated") From 5513730e6f9798043cc69ee90e165b941d6696c1 Mon Sep 17 00:00:00 2001 From: Juli Date: Tue, 3 May 2022 13:54:35 -0400 Subject: [PATCH 13/18] Added Delete route --- app/routes.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/app/routes.py b/app/routes.py index 45cd346a1..41e82e2c1 100644 --- a/app/routes.py +++ b/app/routes.py @@ -45,3 +45,13 @@ def validate_planet(planet_id): def get_one_planet(planet_id): planet = validate_planet(planet_id) return jsonify(planet.to_json(), 200) + + +@planet_bp.route("/", methods=["DELETE"]) +def delete_one_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet {planet.id} has been deleted", 200) \ No newline at end of file From 3242fb4274b7de0154b3854bdc9468a3ad1b0fdf Mon Sep 17 00:00:00 2001 From: Juli Date: Tue, 3 May 2022 14:20:02 -0400 Subject: [PATCH 14/18] Refactored per Audrey's suggestions. --- app/__init__.py | 2 +- app/routes/__init__.py | 0 app/{routes.py => routes/planet_routes.py} | 54 +++++++++++----------- 3 files changed, 28 insertions(+), 28 deletions(-) create mode 100644 app/routes/__init__.py rename app/{routes.py => routes/planet_routes.py} (79%) diff --git a/app/__init__.py b/app/__init__.py index 0f01c3093..172762847 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -17,6 +17,6 @@ def create_app(test_config=None): migrate.init_app(app, db) from app.models.planet import Planet - from .routes import planet_bp + from .routes.planet_routes import planet_bp app.register_blueprint(planet_bp) return app diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes.py b/app/routes/planet_routes.py similarity index 79% rename from app/routes.py rename to app/routes/planet_routes.py index a28fec12a..06cabe335 100644 --- a/app/routes.py +++ b/app/routes/planet_routes.py @@ -4,6 +4,17 @@ planet_bp = Blueprint("planet", __name__, url_prefix="/planets") +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) + + planet = Planet.query.get(planet_id) + + if not planet: + return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) + return planet @planet_bp.route("", methods=["POST"]) def create_planet(): @@ -20,35 +31,33 @@ def create_planet(): return make_response(f"Planet {new_planet.name} has been created", 201) - @planet_bp.route("", methods=["GET"]) def get_planets(): planets = Planet.query.all() - planets_response = [] - for planet in planets: - planets_response.append(planet.to_json()) + planets_response = [planet.to_json() for planet in planets] return jsonify(planets_response, 200) - -def validate_planet(planet_id): - try: - planet_id = int(planet_id) - except: - return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) - - planet = Planet.query.get(planet_id) - - if not planet: - return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) - return planet - - @planet_bp.route("/", methods=["GET"]) def get_one_planet(planet_id): planet = validate_planet(planet_id) return jsonify(planet.to_json(), 200) +@planet_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + try: + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.distance_from_earth = request_body["distance from earth"] + db.session.commit() + except KeyError: + return abort(make_response({"message": "Missing information"}, 400)) + + + return make_response(f"Planet #{planet.id} successfully updated") @planet_bp.route("/", methods=["DELETE"]) def delete_one_planet(planet_id): @@ -58,12 +67,3 @@ def delete_one_planet(planet_id): db.session.commit() return make_response(f"Planet {planet.id} has been deleted", 200) -@planet_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.distance_from_earth = request_body["distance from earth"] - db.session.commit() - return make_response(f"Planet #{planet.id} successfully updated") From 7aadde26353eb62a7f5819ba5218afffe655159a Mon Sep 17 00:00:00 2001 From: jeannie Date: Tue, 3 May 2022 13:20:48 -0500 Subject: [PATCH 15/18] testing pull --- app/routes.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/app/routes.py b/app/routes.py index a28fec12a..1f1cc8525 100644 --- a/app/routes.py +++ b/app/routes.py @@ -58,6 +58,8 @@ def delete_one_planet(planet_id): db.session.commit() return make_response(f"Planet {planet.id} has been deleted", 200) + + @planet_bp.route("/", methods=["PUT"]) def update_planet(planet_id): planet = validate_planet(planet_id) @@ -66,4 +68,5 @@ def update_planet(planet_id): planet.description = request_body["description"] planet.distance_from_earth = request_body["distance from earth"] db.session.commit() + return make_response(f"Planet #{planet.id} successfully updated") From ef7d2211223587c9a65f70fba19f94c2482b7931 Mon Sep 17 00:00:00 2001 From: Juli Date: Tue, 3 May 2022 14:27:46 -0400 Subject: [PATCH 16/18] Another test. --- app/routes/planet_routes.py | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 9fb3a2d95..06cabe335 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -67,18 +67,3 @@ def delete_one_planet(planet_id): db.session.commit() return make_response(f"Planet {planet.id} has been deleted", 200) -<<<<<<< HEAD:app/routes.py - - -@planet_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.distance_from_earth = request_body["distance from earth"] - db.session.commit() - - return make_response(f"Planet #{planet.id} successfully updated") -======= ->>>>>>> 3242fb4274b7de0154b3854bdc9468a3ad1b0fdf:app/routes/planet_routes.py From c2be4e06dec6fbeac16a8ed58b1fec2f99befe68 Mon Sep 17 00:00:00 2001 From: jeannie Date: Wed, 4 May 2022 13:18:35 -0500 Subject: [PATCH 17/18] refactored and added q parm --- app/models/planet.py | 19 ++++++++- app/routes/helpers.py | 17 ++++++++ app/routes/planet_routes.py | 45 +++++++++------------ migrations/versions/08a85b38fecd_changed.py | 30 ++++++++++++++ 4 files changed, 84 insertions(+), 27 deletions(-) create mode 100644 app/routes/helpers.py create mode 100644 migrations/versions/08a85b38fecd_changed.py diff --git a/app/models/planet.py b/app/models/planet.py index 11c77e508..a987a0772 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -1,15 +1,30 @@ from app import db + class Planet(db.Model): id = db.Column(db.Integer, primary_key=True, autoincrement=True) name = db.Column(db.String) description = db.Column(db.String) - distance_from_earth = db.Column(db.String) + color = db.Column(db.String) def to_json(self): return { "id": self.id, "name": self.name, "description": self.description, - "distance from earth": self.distance_from_earth + "color": self.color } + + def update(self, request_body): + self.name = request_body["name"] + self.description = request_body["description"] + self.color = request_body["color"] + + @classmethod + def create(cls, request_body): + new_planet = cls( + name=request_body['name'], + description=request_body['description'], + color=request_body['color'] + ) + return new_planet diff --git a/app/routes/helpers.py b/app/routes/helpers.py new file mode 100644 index 000000000..02e8c0fc1 --- /dev/null +++ b/app/routes/helpers.py @@ -0,0 +1,17 @@ +from app.models.planet import Planet +from flask import abort, make_response + +# helper function to validate + + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) + + planet = Planet.query.get(planet_id) + + if not planet: + return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) + return planet diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index 06cabe335..d7325b85a 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -1,65 +1,60 @@ from app import db from app.models.planet import Planet from flask import Blueprint, jsonify, abort, make_response, request +from .helpers import validate_planet planet_bp = Blueprint("planet", __name__, url_prefix="/planets") -def validate_planet(planet_id): - try: - planet_id = int(planet_id) - except: - return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) - - planet = Planet.query.get(planet_id) - - if not planet: - return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) - return planet @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_earth=request_body['distance from earth'] - ) + new_planet = Planet.create(request_body) db.session.add(new_planet) db.session.commit() return make_response(f"Planet {new_planet.name} has been created", 201) -@planet_bp.route("", methods=["GET"]) + +@ planet_bp.route("", methods=["GET"]) def get_planets(): - planets = Planet.query.all() + planet_query = request.args.get("name") + color_query = request.args.get("color") + if planet_query: + planets = Planet.query.filter_by(name=planet_query) + elif color_query: + planets = Planet.query.filter_by(color=color_query) + else: + planets = Planet.query.all() + planets_response = [planet.to_json() for planet in planets] return jsonify(planets_response, 200) -@planet_bp.route("/", methods=["GET"]) + +@ planet_bp.route("/", methods=["GET"]) def get_one_planet(planet_id): planet = validate_planet(planet_id) return jsonify(planet.to_json(), 200) -@planet_bp.route("/", methods=["PUT"]) + +@ planet_bp.route("/", methods=["PUT"]) def update_planet(planet_id): planet = validate_planet(planet_id) request_body = request.get_json() try: - planet.name = request_body["name"] - planet.description = request_body["description"] - planet.distance_from_earth = request_body["distance from earth"] + Planet.update(request_body) db.session.commit() except KeyError: return abort(make_response({"message": "Missing information"}, 400)) - return make_response(f"Planet #{planet.id} successfully updated") -@planet_bp.route("/", methods=["DELETE"]) + +@ planet_bp.route("/", methods=["DELETE"]) def delete_one_planet(planet_id): planet = validate_planet(planet_id) diff --git a/migrations/versions/08a85b38fecd_changed.py b/migrations/versions/08a85b38fecd_changed.py new file mode 100644 index 000000000..dd042b8b3 --- /dev/null +++ b/migrations/versions/08a85b38fecd_changed.py @@ -0,0 +1,30 @@ +"""changed + +Revision ID: 08a85b38fecd +Revises: 5b418a0c89d5 +Create Date: 2022-05-04 13:01:11.258180 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '08a85b38fecd' +down_revision = '5b418a0c89d5' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('color', sa.String(), nullable=True)) + op.drop_column('planet', 'distance_from_earth') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('distance_from_earth', sa.VARCHAR(), autoincrement=False, nullable=True)) + op.drop_column('planet', 'color') + # ### end Alembic commands ### From fdde89e04c0ec0b52be5d1a4204e501a3766c0ea Mon Sep 17 00:00:00 2001 From: Juli Date: Thu, 5 May 2022 14:53:43 -0400 Subject: [PATCH 18/18] Added tests --- app/__init__.py | 12 +++++- app/routes/helpers.py | 8 ++-- app/routes/planet_routes.py | 17 +++------ app/tests/__init__.py | 0 app/tests/conftest.py | 39 ++++++++++++++++++++ app/tests/test_routes.py | 73 +++++++++++++++++++++++++++++++++++++ 6 files changed, 132 insertions(+), 17 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 172762847..a0cca079e 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,17 +1,27 @@ 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/helpers.py b/app/routes/helpers.py index 02e8c0fc1..1a8c95640 100644 --- a/app/routes/helpers.py +++ b/app/routes/helpers.py @@ -1,17 +1,15 @@ from app.models.planet import Planet -from flask import abort, make_response +from flask import abort, make_response, jsonify # helper function to validate - - def validate_planet(planet_id): try: planet_id = int(planet_id) except: - return abort(make_response({"message": f"planet {planet_id} is invaild"}, 400)) + return abort(make_response(jsonify(f"Planet {planet_id} is invalid"), 400)) planet = Planet.query.get(planet_id) if not planet: - return abort(make_response({"message": f"planet {planet_id} does not exist"}, 404)) + return abort(make_response(jsonify(f"Planet {planet_id} does not exist"), 404)) return planet diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py index d7325b85a..d4d614b33 100644 --- a/app/routes/planet_routes.py +++ b/app/routes/planet_routes.py @@ -5,7 +5,6 @@ planet_bp = Blueprint("planet", __name__, url_prefix="/planets") - @planet_bp.route("", methods=["POST"]) def create_planet(): request_body = request.get_json() @@ -15,8 +14,7 @@ def create_planet(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.name} has been created", 201) - + return make_response(jsonify(f"Planet {new_planet.name} has been created"), 201) @ planet_bp.route("", methods=["GET"]) def get_planets(): @@ -31,14 +29,12 @@ def get_planets(): planets_response = [planet.to_json() for planet in planets] - return jsonify(planets_response, 200) - + return make_response(jsonify(planets_response), 200) @ planet_bp.route("/", methods=["GET"]) def get_one_planet(planet_id): planet = validate_planet(planet_id) - return jsonify(planet.to_json(), 200) - + return make_response(jsonify(planet.to_json()), 200) @ planet_bp.route("/", methods=["PUT"]) def update_planet(planet_id): @@ -49,10 +45,9 @@ def update_planet(planet_id): Planet.update(request_body) db.session.commit() except KeyError: - return abort(make_response({"message": "Missing information"}, 400)) - - return make_response(f"Planet #{planet.id} successfully updated") + return abort(make_response(jsonify("Missing information")), 400) + return make_response(jsonify(f"Planet #{planet.id} successfully updated"), 200) @ planet_bp.route("/", methods=["DELETE"]) def delete_one_planet(planet_id): @@ -61,4 +56,4 @@ def delete_one_planet(planet_id): db.session.delete(planet) db.session.commit() - return make_response(f"Planet {planet.id} has been deleted", 200) + return make_response(jsonify(f"Planet {planet.id} has been deleted"), 200) 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..c929f9560 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,39 @@ +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_saved_planets(app): + # Arrange + planet_one = Planet(name="Mars", + description="Close enough", + color="Red") + planet_two = Planet(name="Earth", + description="we out here", + color = "Green") + + db.session.add_all([planet_one, planet_two]) + db.session.commit() \ 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..6f1b8a919 --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,73 @@ +#`GET` `/planets` returns `200` and an empty array. +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 == [] + + +# GET /planets/1 returns a response body that matches our fixture +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": "Mars", + "description": "Close enough", + "color": "Red" + } + + +# GET /planets/1 with no data in test database (no fixture) returns a 404 +def test_get_one_planet_but_no_data(client): + # ACT + response = client.get("/planets/1") + response_body = response.get_json() + + # ASSERT + assert response.status_code == 404 + assert response_body == "Planet 1 does not exist" + + +# GET /planets with valid test data (fixtures) returns a 200 with +# an array including appropriate test data +def test_get_planets_with_records(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": "Mars", + "description": "Close enough", + "color": "Red"}, + { + "id" : 2, + "name": "Earth", + "description":"we out here", + "color" : "Green"}] + + +# POST /planets with a JSON request body returns a 201 +def test_create_one_planet(client): + #ACT + response = client.post("/planets", json={ + "name": "new planet", + "description": "with aliens", + "color": "rainbow" + }) + response_body = response.get_json() + + #ASSERT + assert response.status_code == 201 + assert response_body == "Planet new planet has been created" \ No newline at end of file