From 905731f8d7040ac52c09d6fe66594eb6c9ea8a1c Mon Sep 17 00:00:00 2001 From: Pavi Date: Fri, 21 Oct 2022 10:57:19 -0700 Subject: [PATCH 01/16] Flask setup and defining planet class --- app/routes.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..d9ef0b7d9 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,15 @@ from flask import Blueprint +class Planet(): + def __init__(self, id, name, description, moons): + self.id = id + self.name = name + self.description = description + self.moons = moons + +list_of_planets = [ + Planet(1, "Mercury", "Grey smallest planet",0), + Planet(2, "Venus", "Orange planet of love", 0), + Planet(3, "Earth", "Our planet!", 1), + Planet(4, "Mars", "Red planet that we're exploring", 2) +] \ No newline at end of file From 47f9113b9d911a331c312b3efac047c30c6f0f37 Mon Sep 17 00:00:00 2001 From: Pavi Date: Fri, 21 Oct 2022 11:06:53 -0700 Subject: [PATCH 02/16] finished Wave 1 --- app/routes.py | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index d9ef0b7d9..1c0598721 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,4 @@ -from flask import Blueprint +from flask import Blueprint, jsonify class Planet(): def __init__(self, id, name, description, moons): @@ -12,4 +12,18 @@ def __init__(self, id, name, description, moons): Planet(2, "Venus", "Orange planet of love", 0), Planet(3, "Earth", "Our planet!", 1), Planet(4, "Mars", "Red planet that we're exploring", 2) -] \ No newline at end of file +] + +planets_bp = Blueprint("planets", __name__) + +@planets_bp.route("/planets", methods=["GET"]) +def show_all_planets(): + planets_response = [] + for planet in list_of_planets: + planets_response.append({ + "id": planet.id, + "title": planet.title, + "description": planet.description, + "number of moons": planet.moons + }) + return jsonify(planets_response) \ No newline at end of file From 2950d8399ade75860b4551429b31d9b0bddfe92f Mon Sep 17 00:00:00 2001 From: Pavi Date: Fri, 21 Oct 2022 11:09:52 -0700 Subject: [PATCH 03/16] registered bp --- app/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..6596942bd 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -3,5 +3,7 @@ def create_app(test_config=None): app = Flask(__name__) + from .routes import planets_bp + app.register_blueprint(planets_bp) return app From 057adad0a7693a4689a6d181a18649884f38eb01 Mon Sep 17 00:00:00 2001 From: Pavi Date: Mon, 24 Oct 2022 11:30:23 -0700 Subject: [PATCH 04/16] finished wave 1 --- app/routes.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 1c0598721..6a170b347 100644 --- a/app/routes.py +++ b/app/routes.py @@ -22,7 +22,7 @@ def show_all_planets(): for planet in list_of_planets: planets_response.append({ "id": planet.id, - "title": planet.title, + "name": planet.name, "description": planet.description, "number of moons": planet.moons }) From daa3b631db405ef6dea9cc19ca0b2b145b338203 Mon Sep 17 00:00:00 2001 From: Pavi Date: Mon, 24 Oct 2022 11:37:09 -0700 Subject: [PATCH 05/16] added more planets --- app/routes.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/app/routes.py b/app/routes.py index 6a170b347..b21a274da 100644 --- a/app/routes.py +++ b/app/routes.py @@ -12,6 +12,11 @@ def __init__(self, id, name, description, moons): Planet(2, "Venus", "Orange planet of love", 0), Planet(3, "Earth", "Our planet!", 1), Planet(4, "Mars", "Red planet that we're exploring", 2) + Planet(5, "Jupiter", "Biggest planet in the solar system", 80) + Planet(6, "Saturn", "The planet with the rings", 83) + Planet(7, "Uranus", "Ice giant", 27) + Planet(8, "Neptune", "A cold blue planet", 14) + Planet(9, "Pluto", "The tiniest dwarf planet", 5) ] planets_bp = Blueprint("planets", __name__) From ca9e751963129a68ed91c68f5d97d12591fc875b Mon Sep 17 00:00:00 2001 From: Pavi Date: Mon, 24 Oct 2022 11:37:58 -0700 Subject: [PATCH 06/16] fixed issues --- app/routes.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/app/routes.py b/app/routes.py index b21a274da..bfa7d0ec5 100644 --- a/app/routes.py +++ b/app/routes.py @@ -11,12 +11,12 @@ def __init__(self, id, name, description, moons): Planet(1, "Mercury", "Grey smallest planet",0), Planet(2, "Venus", "Orange planet of love", 0), Planet(3, "Earth", "Our planet!", 1), - Planet(4, "Mars", "Red planet that we're exploring", 2) - Planet(5, "Jupiter", "Biggest planet in the solar system", 80) - Planet(6, "Saturn", "The planet with the rings", 83) - Planet(7, "Uranus", "Ice giant", 27) - Planet(8, "Neptune", "A cold blue planet", 14) - Planet(9, "Pluto", "The tiniest dwarf planet", 5) + Planet(4, "Mars", "Red planet that we're exploring", 2), + Planet(5, "Jupiter", "Biggest planet in the solar system", 80), + Planet(6, "Saturn", "The planet with the rings", 83), + Planet(7, "Uranus", "Ice giant", 27), + Planet(8, "Neptune", "A cold blue planet", 14), + Planet(9, "Pluto", "The tiniest dwarf planet", 5), ] planets_bp = Blueprint("planets", __name__) From 82b2704c83060332e28f3ee0b9ce35a08c3c36cf Mon Sep 17 00:00:00 2001 From: Rose Le Date: Mon, 24 Oct 2022 11:53:06 -0700 Subject: [PATCH 07/16] Set up route for Wave 02 --- app/routes.py | 28 ++++++++++++++++++++++++++-- requirements.txt | 8 ++++++++ 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index bfa7d0ec5..60e30369b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,5 @@ -from flask import Blueprint, jsonify +from flask import Blueprint, jsonify, abort, make_response + class Planet(): def __init__(self, id, name, description, moons): @@ -19,6 +20,18 @@ def __init__(self, id, name, description, moons): Planet(9, "Pluto", "The tiniest dwarf planet", 5), ] +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 list_of_planets: + if planet.id == planet.id: + return planet + + abort(make_response({"message":f"planet {planet_id} not found"}, 404)) + planets_bp = Blueprint("planets", __name__) @planets_bp.route("/planets", methods=["GET"]) @@ -31,4 +44,15 @@ def show_all_planets(): "description": planet.description, "number of moons": planet.moons }) - return jsonify(planets_response) \ No newline at end of file + return jsonify(planets_response) + +@planets_bp.route("/planet_info", methods=["GET"]) +def get_planet_info(planet_id): + planet = validate_planet(planet_id) + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "number of moons": planet.moons + } + diff --git a/requirements.txt b/requirements.txt index fba2b3e38..1eeabccdc 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,19 +1,26 @@ 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 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 +30,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 From dc3d19cf88cbfe6511b111935e6307197956e316 Mon Sep 17 00:00:00 2001 From: Pavi Date: Mon, 24 Oct 2022 11:59:12 -0700 Subject: [PATCH 08/16] fixed errors of Wave 2, now complete --- app/routes.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/app/routes.py b/app/routes.py index 60e30369b..2cd5d2332 100644 --- a/app/routes.py +++ b/app/routes.py @@ -27,14 +27,14 @@ def validate_planet(planet_id): abort(make_response({"message":f"planet {planet_id} invalid"}, 400)) for planet in list_of_planets: - if planet.id == planet.id: + if planet.id == planet_id: return planet abort(make_response({"message":f"planet {planet_id} not found"}, 404)) -planets_bp = Blueprint("planets", __name__) +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") -@planets_bp.route("/planets", methods=["GET"]) +@planets_bp.route("", methods=["GET"]) def show_all_planets(): planets_response = [] for planet in list_of_planets: @@ -46,7 +46,7 @@ def show_all_planets(): }) return jsonify(planets_response) -@planets_bp.route("/planet_info", methods=["GET"]) +@planets_bp.route("/", methods=["GET"]) def get_planet_info(planet_id): planet = validate_planet(planet_id) return { From 9a141050538e6f98434730e9e0643590d1bce024 Mon Sep 17 00:00:00 2001 From: Rose Le Date: Tue, 1 Nov 2022 10:47:37 -0700 Subject: [PATCH 09/16] Set up db for Wave 03 --- app/__init__.py | 13 +++ app/models/planet.py | 8 ++ migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../versions/cf1014eb5fc2_add_planet_model.py | 34 +++++++ 7 files changed, 221 insertions(+) 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/cf1014eb5fc2_add_planet_model.py diff --git a/app/__init__.py b/app/__init__.py index 6596942bd..d32b782d9 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,9 +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 .routes import planets_bp app.register_blueprint(planets_bp) + from app.models.planet import Planet + return app diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..735e1e2a3 --- /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) + moons = db.Column(db.Integer) 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/cf1014eb5fc2_add_planet_model.py b/migrations/versions/cf1014eb5fc2_add_planet_model.py new file mode 100644 index 000000000..ec108c114 --- /dev/null +++ b/migrations/versions/cf1014eb5fc2_add_planet_model.py @@ -0,0 +1,34 @@ +"""add Planet model + +Revision ID: cf1014eb5fc2 +Revises: +Create Date: 2022-11-01 10:44:51.550673 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'cf1014eb5fc2' +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('moons', 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 7f8b195d693a5cb733ecce2879c2edfd070bd18f Mon Sep 17 00:00:00 2001 From: Rose Le Date: Tue, 1 Nov 2022 17:31:29 -0700 Subject: [PATCH 10/16] Completed Wave 3 --- app/models/__init__.py | 0 app/routes.py | 128 +++++++++++++++++++++++++---------------- 2 files changed, 78 insertions(+), 50 deletions(-) create mode 100644 app/models/__init__.py diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/routes.py b/app/routes.py index 2cd5d2332..d1fc6da17 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,58 +1,86 @@ -from flask import Blueprint, jsonify, abort, make_response - - -class Planet(): - def __init__(self, id, name, description, moons): - self.id = id - self.name = name - self.description = description - self.moons = moons - -list_of_planets = [ - Planet(1, "Mercury", "Grey smallest planet",0), - Planet(2, "Venus", "Orange planet of love", 0), - Planet(3, "Earth", "Our planet!", 1), - Planet(4, "Mars", "Red planet that we're exploring", 2), - Planet(5, "Jupiter", "Biggest planet in the solar system", 80), - Planet(6, "Saturn", "The planet with the rings", 83), - Planet(7, "Uranus", "Ice giant", 27), - Planet(8, "Neptune", "A cold blue planet", 14), - Planet(9, "Pluto", "The tiniest dwarf planet", 5), -] - -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 list_of_planets: - if planet.id == planet_id: - return planet - - abort(make_response({"message":f"planet {planet_id} not found"}, 404)) +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.planet import Planet + + +# class Planet(): +# def __init__(self, id, name, description, moons): +# self.id = id +# self.name = name +# self.description = description +# self.moons = moons + +# list_of_planets = [ +# Planet(1, "Mercury", "Grey smallest planet",0), +# Planet(2, "Venus", "Orange planet of love", 0), +# Planet(3, "Earth", "Our planet!", 1), +# Planet(4, "Mars", "Red planet that we're exploring", 2), +# Planet(5, "Jupiter", "Biggest planet in the solar system", 80), +# Planet(6, "Saturn", "The planet with the rings", 83), +# Planet(7, "Uranus", "Ice giant", 27), +# Planet(8, "Neptune", "A cold blue planet", 14), +# Planet(9, "Pluto", "The tiniest dwarf planet", 5), +# ] + +# 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 list_of_planets: +# if planet.id == planet_id: +# return planet + +# abort(make_response({"message":f"planet {planet_id} not found"}, 404)) planets_bp = Blueprint("planets", __name__, url_prefix="/planets") +#creating new planet +@planets_bp.route("", methods=["POST"]) +def create_new_planet(): + request_body = request.get_json(force=True) + new_planet = Planet(name=request_body["name"], + description=request_body["description"], moons=request_body["moons"]) + + 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 show_all_planets(): +def read_all_planets(): planets_response = [] - for planet in list_of_planets: - planets_response.append({ - "id": planet.id, - "name": planet.name, - "description": planet.description, - "number of moons": planet.moons - }) + planets = Planet.query.all() + for planet in planets: + planets_response.append( + { + "id": planet.id, + "name": planet.name, + "description": planet.description + } + ) return jsonify(planets_response) -@planets_bp.route("/", methods=["GET"]) -def get_planet_info(planet_id): - planet = validate_planet(planet_id) - return { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "number of moons": planet.moons - } +# @planets_bp.route("", methods=["GET"]) +# def show_all_planets(): +# planets_response = [] +# for planet in list_of_planets: +# planets_response.append({ +# "id": planet.id, +# "name": planet.name, +# "description": planet.description, +# "number of moons": planet.moons +# }) +# return jsonify(planets_response) + +# @planets_bp.route("/", methods=["GET"]) +# def get_planet_info(planet_id): +# planet = validate_planet(planet_id) +# return { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description, +# "number of moons": planet.moons +# } From e32607de2717e1c75f288397bd5e99fb8ef15510 Mon Sep 17 00:00:00 2001 From: Pavi Date: Wed, 2 Nov 2022 10:59:25 -0700 Subject: [PATCH 11/16] reads one planet --- app/routes.py | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index d1fc6da17..caef18176 100644 --- a/app/routes.py +++ b/app/routes.py @@ -34,9 +34,24 @@ # abort(make_response({"message":f"planet {planet_id} not found"}, 404)) +#for handling errors: + +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 = Blueprint("planets", __name__, url_prefix="/planets") -#creating new planet @planets_bp.route("", methods=["POST"]) def create_new_planet(): request_body = request.get_json(force=True) @@ -57,11 +72,23 @@ def read_all_planets(): { "id": planet.id, "name": planet.name, - "description": planet.description + "description": planet.description, + "moons": planet.moons } ) 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, + "moons": planet.moons, + } + + # @planets_bp.route("", methods=["GET"]) # def show_all_planets(): # planets_response = [] From b5fb19406338cc389f544fd5173afe65d21f9e4c Mon Sep 17 00:00:00 2001 From: Rose Le Date: Thu, 3 Nov 2022 21:09:44 -0700 Subject: [PATCH 12/16] Completed GET refactoring --- app/models/planet.py | 9 +++++++++ app/routes.py | 24 +++++++++--------------- 2 files changed, 18 insertions(+), 15 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 735e1e2a3..3f04c27bc 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -6,3 +6,12 @@ class Planet(db.Model): name = db.Column(db.String) description = db.Column(db.String) moons = db.Column(db.Integer) + + def to_dict(self): + planet_to_dict = {} + planet_to_dict["id"] = self.id + planet_to_dict["name"] = self.name + planet_to_dict["description"] = self.description + planet_to_dict["moons"] = self.moons + + return planet_to_dict \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index caef18176..82b55ac72 100644 --- a/app/routes.py +++ b/app/routes.py @@ -65,28 +65,22 @@ def create_new_planet(): @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 = [] - planets = Planet.query.all() + for planet in planets: - planets_response.append( - { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "moons": planet.moons - } - ) + planets_response.append(planet.to_dict()) 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, - "moons": planet.moons, - } + return planet.to_dict() # @planets_bp.route("", methods=["GET"]) From 0b291564ce3a04c2b2b7b04be11ff6f192355735 Mon Sep 17 00:00:00 2001 From: Rose Le Date: Thu, 3 Nov 2022 22:19:02 -0700 Subject: [PATCH 13/16] Completed Wave 05 --- app/models/planet.py | 9 ++++++++- app/routes.py | 33 ++++++++++++++++++++++----------- 2 files changed, 30 insertions(+), 12 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 3f04c27bc..f9d3eee9a 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -14,4 +14,11 @@ def to_dict(self): planet_to_dict["description"] = self.description planet_to_dict["moons"] = self.moons - return planet_to_dict \ No newline at end of file + return planet_to_dict + + @classmethod + def from_dict(cls, planet_data): + new_planet = Planet(name=planet_data["name"], description=planet_data["description"], moons=planet_data["moons"]) + return new_planet + + \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 82b55ac72..134d2d698 100644 --- a/app/routes.py +++ b/app/routes.py @@ -36,27 +36,38 @@ #for handling errors: -def validate_planet(planet_id): +# 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 + +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)) - - planet = Planet.query.get(planet_id) + abort(make_response({"message":f"{cls.__name__} {model_id} invalid"}, 400)) - if not planet: - abort(make_response({"message":f"planet {planet_id} not found"}, 404)) + model = cls.query.get(model_id) - return planet + if not model: + abort(make_response({"message":f"{cls.__name__} {model_id} not found"}, 404)) + return model planets_bp = Blueprint("planets", __name__, url_prefix="/planets") @planets_bp.route("", methods=["POST"]) def create_new_planet(): request_body = request.get_json(force=True) - new_planet = Planet(name=request_body["name"], - description=request_body["description"], moons=request_body["moons"]) + new_planet = Planet.from_dict(request_body) db.session.add(new_planet) db.session.commit() @@ -79,7 +90,7 @@ def read_all_planets(): @planets_bp.route("/", methods=["GET"]) def read_one_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_model(Planet, planet_id) return planet.to_dict() From c560d2abe6b3bffbf1a13eb590acd934052ea957 Mon Sep 17 00:00:00 2001 From: Rose Le Date: Thu, 3 Nov 2022 22:30:33 -0700 Subject: [PATCH 14/16] Created test database + refactored create_app fxn --- .gitignore | 5 ++++- app/__init__.py | 16 ++++++++++++++-- 2 files changed, 18 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 4e9b18359..c8f043791 100644 --- a/.gitignore +++ b/.gitignore @@ -138,4 +138,7 @@ dmypy.json .pytype/ # Cython debug symbols -cython_debug/ \ No newline at end of file +cython_debug/ + +#.env file +.env \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py index d32b782d9..28d72024f 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,15 +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_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + "SQLALCHEMY_DATABASE_URI") + else: + app.config["TESTING"] = True + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( + "SQLALCHEMY_TEST_DATABASE_URI") + db.init_app(app) migrate.init_app(app, db) From 8ef8f0e8f90162b39b8fbea22fa8bcc9a3f3fed5 Mon Sep 17 00:00:00 2001 From: Rose Le Date: Thu, 3 Nov 2022 23:25:15 -0700 Subject: [PATCH 15/16] Completed unit tests for Wave 6 --- app/routes.py | 47 -------------------------------------------- tests/__init__.py | 0 tests/conftest.py | 38 +++++++++++++++++++++++++++++++++++ tests/test_routes.py | 42 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 80 insertions(+), 47 deletions(-) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_routes.py diff --git a/app/routes.py b/app/routes.py index 134d2d698..e8dcd090a 100644 --- a/app/routes.py +++ b/app/routes.py @@ -2,53 +2,6 @@ from app import db from app.models.planet import Planet - -# class Planet(): -# def __init__(self, id, name, description, moons): -# self.id = id -# self.name = name -# self.description = description -# self.moons = moons - -# list_of_planets = [ -# Planet(1, "Mercury", "Grey smallest planet",0), -# Planet(2, "Venus", "Orange planet of love", 0), -# Planet(3, "Earth", "Our planet!", 1), -# Planet(4, "Mars", "Red planet that we're exploring", 2), -# Planet(5, "Jupiter", "Biggest planet in the solar system", 80), -# Planet(6, "Saturn", "The planet with the rings", 83), -# Planet(7, "Uranus", "Ice giant", 27), -# Planet(8, "Neptune", "A cold blue planet", 14), -# Planet(9, "Pluto", "The tiniest dwarf planet", 5), -# ] - -# 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 list_of_planets: -# if planet.id == planet_id: -# return planet - -# abort(make_response({"message":f"planet {planet_id} not found"}, 404)) - -#for handling errors: - -# 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 - def validate_model(cls, model_id): try: model_id = int(model_id) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 000000000..845ee9b18 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,38 @@ +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 + mercury = Planet(name="Mercury", description="small", moons=2) + venus = Planet(name="Venus", description="love", moons=1) + + db.session.add_all([mercury, venus]) + # Alternatively, we could do + # db.session.add(ocean_book) + # db.session.add(mountain_book) + db.session.commit() \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..1f0c6bef8 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,42 @@ +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": "Mercury", + "description": "small", + "moons": 2 + } + +def test_get_planet_with_no_data(client): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Ivy", + "description": "furry!", + "moons": 3 + }) + response_body = response.get_data(as_text=True) + print('RESPONSE BODY:', response) + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Ivy successfully created" \ No newline at end of file From d0acd41f47d06dac3a0d5557af173e43efb8d943 Mon Sep 17 00:00:00 2001 From: Rose Le Date: Mon, 7 Nov 2022 11:40:30 -0800 Subject: [PATCH 16/16] Created Procfile + installed gunicorn --- Procfile | 1 + requirements.txt | 1 + 2 files changed, 2 insertions(+) create mode 100644 Procfile diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..066ed31d9 --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' diff --git a/requirements.txt b/requirements.txt index 1eeabccdc..517b98b2d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -9,6 +9,7 @@ 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