From ad91652c165a93dee4ec3ecf85a3ba47371939f6 Mon Sep 17 00:00:00 2001 From: Niloofar Nayebi Date: Fri, 21 Oct 2022 18:07:10 -0400 Subject: [PATCH 01/12] wave_1 in progress --- app/__init__.py | 4 ++++ app/routes.py | 29 ++++++++++++++++++++++++++++- 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..456d5d341 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -3,5 +3,9 @@ def create_app(test_config=None): app = Flask(__name__) + + from .routes import solar_system_bp + app.register_blueprint(solar_system_bp) + return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..e7bde0b83 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,29 @@ -from flask import Blueprint + +from flask import Blueprint , jsonify + +solar_system_bp = Blueprint("solar_system", __name__) + +class Planet: + def __init__(self , id , name, description, size): + self.id = id + self.name=name + self.description = description + self.size=size +planets = [ + Planet(1, "Fictional Book Title", "A fantasy novel set in an imaginary world.", 2), + Planet(2, "Fictional Book Title", "A fantasy novel set in an imaginary world.", 3), + Planet(3, "Fictional Book Title", "A fantasy novel set in an imaginary world.", 4) +] +solar_system_bp=Blueprint("planets",__name__ , url_prefix="/planets") +@solar_system_bp.route("",methods=["GET"]) +def handle_planet(): + result=[] + for i in planets: + result.append({ + "id":i.id, + "name":i.name, + "description":i.description, + "size":i.size + }) + return jsonify(result) From dd6dd422f84ebbb4df3e53c75d81410234ac988e Mon Sep 17 00:00:00 2001 From: Thao Le Date: Tue, 25 Oct 2022 11:14:39 -0400 Subject: [PATCH 02/12] wave 01 complete --- app/routes.py | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/app/routes.py b/app/routes.py index e7bde0b83..5777b38ad 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,26 +4,32 @@ solar_system_bp = Blueprint("solar_system", __name__) class Planet: - def __init__(self , id , name, description, size): + def __init__(self, id, name, description, diameter): self.id = id - self.name=name + self.name = name self.description = description - self.size=size + self.diameter = diameter planets = [ - Planet(1, "Fictional Book Title", "A fantasy novel set in an imaginary world.", 2), - Planet(2, "Fictional Book Title", "A fantasy novel set in an imaginary world.", 3), - Planet(3, "Fictional Book Title", "A fantasy novel set in an imaginary world.", 4) + Planet(1, "Mercury", "The smallest planet in the solar system", 3031.9), + Planet(2, "Venus", "The hottest planet in the solar system", 7520.8), + Planet(3, "Earth", "Two-thirds of the planet is covered by water", 7917.5), + Planet(4, "Mars", "A dusty, cold, desert world", 4212.3), + Planet(5, "Jupiter", "The planet with swirling cloud stripes", 86881), + Planet(6, "Saturn", "A massive ball made mostly of hydrogen and helium", 72367), + Planet(7, "Uranus", "The first planet found, discovered in 1781", 31518), + Planet(8, "Neptune", "The densest giant planet", 30599), + ] -solar_system_bp=Blueprint("planets",__name__ , url_prefix="/planets") +solar_system_bp=Blueprint("planets", __name__, url_prefix="/planets") @solar_system_bp.route("",methods=["GET"]) def handle_planet(): - result=[] - for i in planets: + result = [] + for planet in planets: result.append({ - "id":i.id, - "name":i.name, - "description":i.description, - "size":i.size + "id":planet.id, + "name":planet.name, + "description":planet.description, + "diameter":planet.diameter }) return jsonify(result) From eef6af688da7161511df74f160cc3eb77db6dffd Mon Sep 17 00:00:00 2001 From: Niloofar Nayebi Date: Tue, 25 Oct 2022 17:07:43 -0400 Subject: [PATCH 03/12] handle error --- app/routes.py | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 5777b38ad..d63ea33db 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,5 +1,5 @@ -from flask import Blueprint , jsonify +from flask import Blueprint , jsonify, abort, make_response solar_system_bp = Blueprint("solar_system", __name__) @@ -33,3 +33,26 @@ def handle_planet(): }) return jsonify(result) +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)) + + + @solar_system_bp.route("/", methods=["GET"]) + def handle_planet(planet_id): + book = validate_planet(planet_id) + + return { + "id":planet.id, + "name":planet.name, + "description":planet.description, + "diameter":planet.diameter + } \ No newline at end of file From b97be08b902c7d85245e58b4859f9294431981ef Mon Sep 17 00:00:00 2001 From: Thao Le Date: Tue, 25 Oct 2022 17:48:30 -0400 Subject: [PATCH 04/12] wave 02 complete --- app/__init__.py | 4 ++-- app/routes.py | 53 ++++++++++++++++++++++++++----------------------- 2 files changed, 30 insertions(+), 27 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 456d5d341..05e3aa85f 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,8 +4,8 @@ def create_app(test_config=None): app = Flask(__name__) - from .routes import solar_system_bp - app.register_blueprint(solar_system_bp) + from .routes import planets_bp + app.register_blueprint(planets_bp) return app diff --git a/app/routes.py b/app/routes.py index d63ea33db..ecdcf44cb 100644 --- a/app/routes.py +++ b/app/routes.py @@ -20,39 +20,42 @@ def __init__(self, id, name, description, diameter): Planet(8, "Neptune", "The densest giant planet", 30599), ] -solar_system_bp=Blueprint("planets", __name__, url_prefix="/planets") -@solar_system_bp.route("",methods=["GET"]) -def handle_planet(): - result = [] - for planet in planets: - result.append({ - "id":planet.id, - "name":planet.name, - "description":planet.description, - "diameter":planet.diameter - }) - return jsonify(result) +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") def validate_planet(planet_id): try: - planet_id= int(planet_id) + 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)) + abort(make_response({"message":f"planet {planet_id} not found"}, 404)) + +@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) + - @solar_system_bp.route("/", methods=["GET"]) - def handle_planet(planet_id): - book = validate_planet(planet_id) - - return { - "id":planet.id, - "name":planet.name, - "description":planet.description, - "diameter":planet.diameter - } \ No newline at end of file +@planets_bp.route("/", methods=["GET"]) +def handle_planet(planet_id): + planet = validate_planet(planet_id) + + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "diameter": planet.diameter + } \ No newline at end of file From 7ab3baa5b76972c328a4a3306e8c9d021aa7d1e1 Mon Sep 17 00:00:00 2001 From: Niloofar Nayebi Date: Fri, 28 Oct 2022 10:34:49 -0400 Subject: [PATCH 05/12] models --- app/models/__init__.py | 0 app/models/book.py | 0 app/models/books.py | 0 app/routes.py | 19 +++++++++---------- 4 files changed, 9 insertions(+), 10 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/book.py create mode 100644 app/models/books.py diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/book.py b/app/models/book.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/books.py b/app/models/books.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes.py b/app/routes.py index d63ea33db..c23234b5d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -45,14 +45,13 @@ def validate_planet(planet_id): abort(make_response({"message":f"planet {planet_id} not found"}, 404)) - - @solar_system_bp.route("/", methods=["GET"]) - def handle_planet(planet_id): - book = validate_planet(planet_id) +@solar_system_bp.route("/", methods=["GET"]) +def handle_planet(planet_id): + planet = validate_planet(planet_id) - return { - "id":planet.id, - "name":planet.name, - "description":planet.description, - "diameter":planet.diameter - } \ No newline at end of file + return { + "id":planet.id, + "name":planet.name, + "description":planet.description, + "diameter":planet.diameter + } \ No newline at end of file From f36f37732bbaaa24cf51691eed8e0f0b9596aeff Mon Sep 17 00:00:00 2001 From: Thao Le Date: Fri, 28 Oct 2022 14:59:57 -0400 Subject: [PATCH 06/12] wave 03 complete --- app/__init__.py | 29 +++- app/models/__init__.py | 0 app/models/planet.py | 8 ++ app/routes.py | 133 +++++++++++------- migrations/README | 1 + migrations/alembic.ini | 45 ++++++ migrations/env.py | 96 +++++++++++++ migrations/script.py.mako | 24 ++++ .../6a703089fb4b_adds_planet_model.py | 34 +++++ 9 files changed, 319 insertions(+), 51 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/6a703089fb4b_adds_planet_model.py diff --git a/app/__init__.py b/app/__init__.py index 05e3aa85f..df34d89f2 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,11 +1,38 @@ 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' + + from app.models.planet import Planet + db.init_app(app) + migrate.init_app(app, db) + + from .routes import planets_bp app.register_blueprint(planets_bp) - + return app + + +# from flask import Flask + + +# 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/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..44608658a --- /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) + diameter = db.Column(db.Integer) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index ecdcf44cb..434e00ddc 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,61 +1,94 @@ +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request -from flask import Blueprint , jsonify, abort, make_response - -solar_system_bp = Blueprint("solar_system", __name__) - -class Planet: - def __init__(self, id, name, description, diameter): - self.id = id - self.name = name - self.description = description - self.diameter = diameter -planets = [ - Planet(1, "Mercury", "The smallest planet in the solar system", 3031.9), - Planet(2, "Venus", "The hottest planet in the solar system", 7520.8), - Planet(3, "Earth", "Two-thirds of the planet is covered by water", 7917.5), - Planet(4, "Mars", "A dusty, cold, desert world", 4212.3), - Planet(5, "Jupiter", "The planet with swirling cloud stripes", 86881), - Planet(6, "Saturn", "A massive ball made mostly of hydrogen and helium", 72367), - Planet(7, "Uranus", "The first planet found, discovered in 1781", 31518), - Planet(8, "Neptune", "The densest giant planet", 30599), - -] -planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") -def validate_planet(planet_id): - try: - planet_id = int(planet_id) - except: - abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) +@planets_bp.route("", methods=["POST"]) +def create_planet(): + request_body = request.get_json() + new_planet = Planet(id=request_body["id"], + name=request_body["name"], + description=request_body["description"], + diameter=request_body["diameter"]) - for planet in planets: - if planet.id == planet_id: - return planet - - abort(make_response({"message":f"planet {planet_id} not found"}, 404)) + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.id} successfully created", 201) -@planets_bp.route("",methods=["GET"]) -def handle_planets(): +@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 + "id": planet.id, + "name": planet.name, + "description": planet.description, + "diameter": planet.diameter } - ) - return jsonify(planets_response) + ) + return jsonify(planets_response) + + +# solar_system_bp = Blueprint("solar_system", __name__) + +# class Planet: +# def __init__(self, id, name, description, diameter): +# self.id = id +# self.name = name +# self.description = description +# self.diameter = diameter +# planets = [ +# Planet(1, "Mercury", "The smallest planet in the solar system", 3031.9), +# Planet(2, "Venus", "The hottest planet in the solar system", 7520.8), +# Planet(3, "Earth", "Two-thirds of the planet is covered by water", 7917.5), +# Planet(4, "Mars", "A dusty, cold, desert world", 4212.3), +# Planet(5, "Jupiter", "The planet with swirling cloud stripes", 86881), +# Planet(6, "Saturn", "A massive ball made mostly of hydrogen and helium", 72367), +# Planet(7, "Uranus", "The first planet found, discovered in 1781", 31518), +# Planet(8, "Neptune", "The densest giant planet", 30599), -@planets_bp.route("/", methods=["GET"]) -def handle_planet(planet_id): - planet = validate_planet(planet_id) - - return { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "diameter": planet.diameter - } \ No newline at end of file +# # ] +# planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +# 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)) + +# @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_planet(planet_id): +# planet = validate_planet(planet_id) + +# return { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description, +# "diameter": planet.diameter +# } \ No newline at end of file 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/6a703089fb4b_adds_planet_model.py b/migrations/versions/6a703089fb4b_adds_planet_model.py new file mode 100644 index 000000000..572e17dac --- /dev/null +++ b/migrations/versions/6a703089fb4b_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: 6a703089fb4b +Revises: +Create Date: 2022-10-28 14:27:39.465649 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '6a703089fb4b' +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.Integer(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + # ### end Alembic commands ### From 15c98f3876d6e87d9bfde1ed5bb23412adae8908 Mon Sep 17 00:00:00 2001 From: Niloofar Nayebi Date: Tue, 1 Nov 2022 14:46:32 -0400 Subject: [PATCH 07/12] wave 3, 4 completed --- app/routes.py | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 434e00ddc..5f266dc8b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,9 +1,22 @@ 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_bp", __name__, url_prefix="/planets") +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=["POST"]) def create_planet(): request_body = request.get_json() @@ -33,6 +46,44 @@ def read_all_planets(): return jsonify(planets_response) + + +@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") + + + # solar_system_bp = Blueprint("solar_system", __name__) From 9327f09318c399bdc5dfc8faa434260a2f2b18de Mon Sep 17 00:00:00 2001 From: Thao Le Date: Wed, 2 Nov 2022 17:52:03 -0400 Subject: [PATCH 08/12] wave 5 complete --- app/models/planet.py | 28 ++++++- app/routes.py | 194 ++++++++++++++++++++++++++++++------------- 2 files changed, 162 insertions(+), 60 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 44608658a..875df1628 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -1,8 +1,34 @@ from app import db +from flask import abort, make_response 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.Integer) \ No newline at end of file + diameter = db.Column(db.Integer) + + + def to_dict(self): + return { + "name": self.name, + "description": self.description, + "diameter": self.diameter, + "id": self.id + } + + @classmethod + def from_dict(cls,req_body): + return cls( + name=req_body['name'], + description=req_body['description'], + diameter=req_body['diameter'] + ) + + 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}"})) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 5f266dc8b..c724996db 100644 --- a/app/routes.py +++ b/app/routes.py @@ -4,83 +4,159 @@ planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") -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=["POST"]) def create_planet(): request_body = request.get_json() - new_planet = Planet(id=request_body["id"], - 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() - return make_response(f"Planet {new_planet.id} successfully created", 201) + return make_response(f"Planet {new_planet.name} has been created", 201) + @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 - } - ) - return jsonify(planets_response) - - - - -@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) +def get_all_cats(): + name_param = request.args.get("name") + diameter_param = request.args.get("diameter") + if name_param: + planets = Planet.query.filter_by(name=name_param) + elif diameter_param: + planets = Planet.query.filter_by(diameter=diameter_param) + else: + planets = Planet.query.all() + + result_list = [planet.to_dict() for planet in planets] + + return jsonify(result_list), 200 + + +@planets_bp.route("/", methods=["GET"]) +def get_one_cat(id): + planet = validate_id(Planet,id) + + return jsonify(planet.to_dict()), 200 + + +@planets_bp.route("/", methods=["PUT"]) +def update_planet(id): + planet = validate_id(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") + return make_response(f"planet {id} successfully updated") +@planets_bp.route("/", methods=["DELETE"]) +def delete_planet(id): + planet = validate_id(Planet,id) -@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 {id} successfully deleted") + + +def validate_id(class_obj,id): + try: + id = int(id) + except: + abort(make_response({"message":f"{class_obj} {id} is an invalid id"}, 400)) + + query_result = class_obj.query.get(id) + if not query_result: + abort(make_response({"message":f"{class_obj} {id} not found"}, 404)) + + return query_result + + +######## before wave 5 ################ + +# 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=["POST"]) +# def create_planet(): +# 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.id} successfully created", 201) + +# @planets_bp.route("", methods=["GET"]) +# def read_all_planets(): +# name_query = request.args.get("name") +# if name_query: +# planets = Planet.query.filter_by(name=name_query) +# else: +# planets = Planet.query.all() + +# planets_response = [] +# for planet in planets: +# planets_response.append( +# { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description, +# "diameter": planet.diameter +# } +# ) +# return jsonify(planets_response) + + + + +# @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") +# return make_response(f"Planet # {planet.id} successfully deleted") From ac456c3c86daaa4538f2caa2dbccbfd91be8a98b Mon Sep 17 00:00:00 2001 From: Niloofar Nayebi Date: Thu, 3 Nov 2022 18:59:18 -0400 Subject: [PATCH 09/12] 3 test passed --- app/__init__.py | 15 +++++++++++- app/tests/__init__.py | 0 app/tests/conftest.py | 44 ++++++++++++++++++++++++++++++++++ app/tests/test_routes.py | 52 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 110 insertions(+), 1 deletion(-) 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 df34d89f2..dac2e1d96 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,16 +1,29 @@ 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 test_config is None: + 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") + + from app.models.planet import Planet 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..24265047f --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,44 @@ +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(send, 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 one_planet(app): + # Arrange + ocean_planet = Planet(name="Mercury", description="watr 4evr", + diameter="39999") + + + db.session.add(ocean_planet) + # Alternatively, we could do + # db.session.add(ocean_book) + # db.session.add(mountain_book) + db.session.commit() + return ocean_planet + + + + + diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..9bac5440d --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,52 @@ + +from app.models.planet import Planet + + +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,one_planet): + # Act + response = client.get(f"/planets/{one_planet.id}") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body["id"] == one_planet.id + assert response_body["name"] == one_planet.name + assert response_body["description"] ==one_planet.description + assert response_body["diameter"]==one_planet.diameter + +def test_create_planet_can_create_planet_in_empty_db(client): + EXPECTED_PLANET={ "name": "Mercury", + "description": "watr 4evr", "diameter":39999} + EXPECTED_ID =1 + + # Act + + response = client.post("/planets", json=EXPECTED_PLANET) + response_body = response.get_data(as_text=True) + + actual_planet = Planet.query.get(EXPECTED_ID) + + # assert + assert response.status_code == 201 + assert response_body == f"Planet {EXPECTED_PLANET['name']} has been created" + assert actual_planet.id == EXPECTED_ID + assert actual_planet.name == EXPECTED_PLANET["name"] + assert actual_planet.description == EXPECTED_PLANET["description"] + assert actual_planet.diameter == EXPECTED_PLANET["diameter"] + + + + + + + + \ No newline at end of file From 1a7e6d9044854e618d90c775c9eaf8798c876913 Mon Sep 17 00:00:00 2001 From: Niloofar Nayebi Date: Thu, 3 Nov 2022 23:33:29 -0400 Subject: [PATCH 10/12] add new test in wave_6 --- app/tests/test_routes.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py index 9bac5440d..dbcf0a818 100644 --- a/app/tests/test_routes.py +++ b/app/tests/test_routes.py @@ -43,7 +43,12 @@ def test_create_planet_can_create_planet_in_empty_db(client): assert actual_planet.description == EXPECTED_PLANET["description"] assert actual_planet.diameter == EXPECTED_PLANET["diameter"] - +def test_no_data_in_test_database(client): + #Act + response=client.get("/planets/1") + response_body=response.get_json() + #Assert + assert response.status_code==404 From 92612f0f8f87387e1a8170b313141ec456e49544 Mon Sep 17 00:00:00 2001 From: Thao Le Date: Fri, 4 Nov 2022 10:06:27 -0400 Subject: [PATCH 11/12] thao's changes, undo --- app/tests/__init__.py | 0 app/tests/conftest.py | 43 ++++++++++++++++++++++++++++++++++++++++ app/tests/test_routes.py | 36 +++++++++++++++++++++++++++++++++ 3 files changed, 79 insertions(+) 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/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..5db3782f9 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,43 @@ +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 two_saved_planets(app): + # Arrange + ocean_planet = Planet(name="Ocean Planet", + description="watr 4evr", + diameter=12000) + mountain_planet = Planet(name="Mountain Planet", + description="i luv 2 climb rocks", + diameter=1500000) + + db.session.add_all([ocean_planet, mountain_planet]) + # Alternatively, we could do + # db.session.add(ocean_book) + # db.session.add(mountain_book) + db.session.commit() + + +@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() + diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..0da39eaf6 --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,36 @@ +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": 12000 + } + +def test_create_one_planer(client): + # Act + response = client.post("/planets", json={ + "name": "New Planet", + "description": "The Best!", + "diameter": 50000 + }) + response_body = response.get_data(as_text=True) + + # Assert + assert response.status_code == 201 + assert response_body == "Planet New Planet successfully created" \ No newline at end of file From 1ca82fa16bf1ee622a9c1e36a36094d7f2b29ab9 Mon Sep 17 00:00:00 2001 From: Niloofar Nayebi Date: Mon, 7 Nov 2022 15:18:19 -0500 Subject: [PATCH 12/12] add requirements --- 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