From 485c041806854ba011c7a8659e91bb8ef1d63e09 Mon Sep 17 00:00:00 2001 From: reneesu99 Date: Fri, 21 Oct 2022 12:03:30 -0700 Subject: [PATCH 01/17] wave 1 complete --- app/__init__.py | 4 ++-- app/routes.py | 34 +++++++++++++++++++++++++++++++++- 2 files changed, 35 insertions(+), 3 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..041ad3966 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,7 @@ from flask import Flask - +from .routes import * def create_app(test_config=None): app = Flask(__name__) - + app.register_blueprint(planet_bp) return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..b9e3452b8 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,34 @@ -from flask import Blueprint +from flask import Blueprint, jsonify +from sqlalchemy import desc +class Planet: + def __init__(self, id, name, description): + self.id = id + self.name = name + self.description = description + +# instance = an instance of the object +jupiter = Planet(id=1, name = "Jupiter", description = "hmmm i think its a big planet") +mars = Planet(id= 2, name = "Mars", description="its close to the sun?") +mercury = Planet(id = 3, name = "Mercury", description="also close to the planet?") +venus = Planet(id= 4, name = "Venus", description = "this is aphrodite's planet?") +earth = Planet(id=5, name = "Earth", description = "us!") +saturn = Planet(id = 6, name = "Saturn", description = "this is the one with a lot of moons?") +uranus = Planet(id = 7, name = "Uranus", description="I know literally nothing about this one") +neptune = Planet(id = 8, name = "Neptune", description = "Poseidon's!") +pluto = Planet(id = 9, name = "Pluto", description = "dont forget about me!" ) +list_of_planets = [jupiter, mars, mercury, venus, earth, saturn, uranus, neptune, pluto] + +planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") + +@planet_bp.route("", methods = ["GET"]) +def read_planets(): + planets_json = [] + for planet in list_of_planets: + dict = { + "id": planet.id, + "name": planet.name, + "description": planet.description + } + planets_json.append(dict) + return jsonify(planets_json) \ No newline at end of file From d423722785b8199484f56189dad33fafb2e018a2 Mon Sep 17 00:00:00 2001 From: Semhar Tes Date: Mon, 24 Oct 2022 10:24:08 -0400 Subject: [PATCH 02/17] Read and handle an existing planet --- app/routes.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index b9e3452b8..71c433061 100644 --- a/app/routes.py +++ b/app/routes.py @@ -31,4 +31,18 @@ def read_planets(): "description": planet.description } planets_json.append(dict) - return jsonify(planets_json) \ No newline at end of file + return jsonify(planets_json) + + +@planet_bp.route("/", methods=["GET"]) +def handle_planet(planet_id): + planet_id = int(planet_id) + + for planet in list_of_planets: + if planet.id == planet_id: + return { + "id": planet.id, + "name": planet.name, + "description": planet.description + } + From c0ccf2b80233c7ec92640c31a4161b1a64604e70 Mon Sep 17 00:00:00 2001 From: Semhar Tes Date: Mon, 24 Oct 2022 11:07:58 -0400 Subject: [PATCH 03/17] handled non- existing and invalid planets --- app/routes.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 71c433061..8d289ec24 100644 --- a/app/routes.py +++ b/app/routes.py @@ -36,7 +36,10 @@ def read_planets(): @planet_bp.route("/", methods=["GET"]) def handle_planet(planet_id): - planet_id = int(planet_id) + try: + planet_id = int(planet_id) + except: + return "Message: Invalid Planet.", 400 for planet in list_of_planets: if planet.id == planet_id: @@ -45,4 +48,5 @@ def handle_planet(planet_id): "name": planet.name, "description": planet.description } + return "Message: Planet not found.", 404 From 74e72e74d257ce46af0fa80cc6168bbdffe796dc Mon Sep 17 00:00:00 2001 From: Semhar Tes Date: Mon, 24 Oct 2022 14:46:31 -0400 Subject: [PATCH 04/17] modified return statments for non-exsting and invalid planet --- app/routes.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index 8d289ec24..ea0430eb9 100644 --- a/app/routes.py +++ b/app/routes.py @@ -39,7 +39,7 @@ def handle_planet(planet_id): try: planet_id = int(planet_id) except: - return "Message: Invalid Planet.", 400 + return {"Message": f"Planet {planet_id} invalid."}, 400 for planet in list_of_planets: if planet.id == planet_id: @@ -48,5 +48,5 @@ def handle_planet(planet_id): "name": planet.name, "description": planet.description } - return "Message: Planet not found.", 404 + return {"Message": f"Planet {planet_id} not found."}, 404 From c00bad918ab4ab48a5fc3df4c838df07e46b9657 Mon Sep 17 00:00:00 2001 From: reneesu99 Date: Mon, 24 Oct 2022 13:47:09 -0700 Subject: [PATCH 05/17] refactored routes functions into helper functions --- app/planets.py | 30 ++++++++++++++++++++++++++++++ app/routes.py | 31 ++----------------------------- 2 files changed, 32 insertions(+), 29 deletions(-) create mode 100644 app/planets.py diff --git a/app/planets.py b/app/planets.py new file mode 100644 index 000000000..9f9f8426e --- /dev/null +++ b/app/planets.py @@ -0,0 +1,30 @@ +from flask import jsonify + +class Planet: + def __init__(self, id, name, description): + self.id = id + self.name = name + self.description = description + +# instance = an instance of the object +jupiter = Planet(id=1, name = "Jupiter", description = "hmmm i think its a big planet") +mars = Planet(id= 2, name = "Mars", description="its close to the sun?") +mercury = Planet(id = 3, name = "Mercury", description="also close to the planet?") +venus = Planet(id= 4, name = "Venus", description = "this is aphrodite's planet?") +earth = Planet(id=5, name = "Earth", description = "us!") +saturn = Planet(id = 6, name = "Saturn", description = "this is the one with a lot of moons?") +uranus = Planet(id = 7, name = "Uranus", description="I know literally nothing about this one") +neptune = Planet(id = 8, name = "Neptune", description = "Poseidon's!") +pluto = Planet(id = 9, name = "Pluto", description = "dont forget about me!" ) +list_of_planets = [jupiter, mars, mercury, venus, earth, saturn, uranus, neptune, pluto] + +def return_all_planets(): + planets_json = [] + for planet in list_of_planets: + dict = { + "id": planet.id, + "name": planet.name, + "description": planet.description + } + planets_json.append(dict) + return jsonify(planets_json) diff --git a/app/routes.py b/app/routes.py index ea0430eb9..d1af8fb55 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,38 +1,11 @@ from flask import Blueprint, jsonify from sqlalchemy import desc - -class Planet: - def __init__(self, id, name, description): - self.id = id - self.name = name - self.description = description - -# instance = an instance of the object -jupiter = Planet(id=1, name = "Jupiter", description = "hmmm i think its a big planet") -mars = Planet(id= 2, name = "Mars", description="its close to the sun?") -mercury = Planet(id = 3, name = "Mercury", description="also close to the planet?") -venus = Planet(id= 4, name = "Venus", description = "this is aphrodite's planet?") -earth = Planet(id=5, name = "Earth", description = "us!") -saturn = Planet(id = 6, name = "Saturn", description = "this is the one with a lot of moons?") -uranus = Planet(id = 7, name = "Uranus", description="I know literally nothing about this one") -neptune = Planet(id = 8, name = "Neptune", description = "Poseidon's!") -pluto = Planet(id = 9, name = "Pluto", description = "dont forget about me!" ) -list_of_planets = [jupiter, mars, mercury, venus, earth, saturn, uranus, neptune, pluto] - +from .planets import * planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") @planet_bp.route("", methods = ["GET"]) def read_planets(): - planets_json = [] - for planet in list_of_planets: - dict = { - "id": planet.id, - "name": planet.name, - "description": planet.description - } - planets_json.append(dict) - return jsonify(planets_json) - + return return_all_planets() @planet_bp.route("/", methods=["GET"]) def handle_planet(planet_id): From 89f2e7c8e013f14b2a02f26a9b784350280f5843 Mon Sep 17 00:00:00 2001 From: Semhar Tes Date: Mon, 24 Oct 2022 21:52:28 -0400 Subject: [PATCH 06/17] refactored wave-2 function --- app/planets.py | 22 +++++++++++++++++++++- app/routes.py | 16 +++------------- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/app/planets.py b/app/planets.py index 9f9f8426e..66e5d65e0 100644 --- a/app/planets.py +++ b/app/planets.py @@ -1,4 +1,4 @@ -from flask import jsonify +from flask import jsonify, abort, make_response class Planet: def __init__(self, id, name, description): @@ -28,3 +28,23 @@ def return_all_planets(): } planets_json.append(dict) return jsonify(planets_json) + +def verify_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 { + "id": planet.id, + "name": planet.name, + "description": planet.description + } + abort(make_response({"Message": f"Planet {planet_id} not found."}, 404)) + + + + + diff --git a/app/routes.py b/app/routes.py index d1af8fb55..90021deac 100644 --- a/app/routes.py +++ b/app/routes.py @@ -9,17 +9,7 @@ def read_planets(): @planet_bp.route("/", methods=["GET"]) def handle_planet(planet_id): - try: - planet_id = int(planet_id) - except: - return {"Message": f"Planet {planet_id} invalid."}, 400 - - for planet in list_of_planets: - if planet.id == planet_id: - return { - "id": planet.id, - "name": planet.name, - "description": planet.description - } - return {"Message": f"Planet {planet_id} not found."}, 404 + return verify_planet(planet_id) + + From 63cea2ee8de3924ddc1552f51da9662fb97c4695 Mon Sep 17 00:00:00 2001 From: reneesu99 Date: Tue, 25 Oct 2022 09:30:35 -0700 Subject: [PATCH 07/17] got rid of imports --- app/routes.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index 90021deac..17c9e4a9d 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,5 +1,4 @@ -from flask import Blueprint, jsonify -from sqlalchemy import desc +from flask import Blueprint from .planets import * planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") From ac44af3c70ab04180399c13e6a7a23e385393f47 Mon Sep 17 00:00:00 2001 From: Semhar Tes Date: Fri, 28 Oct 2022 14:13:44 -0400 Subject: [PATCH 08/17] created a module --- app/__init__.py | 21 +++- app/models/__init__.py | 0 app/models/model.py | 0 app/models/planet.py | 9 ++ app/planets.py | 86 ++++++++--------- app/routes.py | 34 ++++--- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../versions/48a8fe91a2d5_added_a_planet.py | 34 +++++++ 11 files changed, 294 insertions(+), 56 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/model.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/48a8fe91a2d5_added_a_planet.py diff --git a/app/__init__.py b/app/__init__.py index 041ad3966..0e2493ebc 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,24 @@ from flask import Flask -from .routes import * +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate + + +db = SQLAlchemy() # db and migrate are variables that gives us access to db operations +migrate = Migrate() def create_app(test_config=None): app = Flask(__name__) + + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False #hide a warning abt a feature that we wont be using + app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + + # connects db & migrate to flask app + 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 + + return app \ No newline at end of file diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/model.py b/app/models/model.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..651cbb282 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,9 @@ +from app import db + + +# MODELS are classes that inherit from db.Model from sqlalchemy +class Planet(db.Model): # defining the planet model + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) # attribute title which will map to a db column + description = db.Column(db.String) + moons = db.Column(db.Integer) diff --git a/app/planets.py b/app/planets.py index 66e5d65e0..9718648e2 100644 --- a/app/planets.py +++ b/app/planets.py @@ -1,48 +1,48 @@ from flask import jsonify, abort, make_response -class Planet: - def __init__(self, id, name, description): - self.id = id - self.name = name - self.description = description - -# instance = an instance of the object -jupiter = Planet(id=1, name = "Jupiter", description = "hmmm i think its a big planet") -mars = Planet(id= 2, name = "Mars", description="its close to the sun?") -mercury = Planet(id = 3, name = "Mercury", description="also close to the planet?") -venus = Planet(id= 4, name = "Venus", description = "this is aphrodite's planet?") -earth = Planet(id=5, name = "Earth", description = "us!") -saturn = Planet(id = 6, name = "Saturn", description = "this is the one with a lot of moons?") -uranus = Planet(id = 7, name = "Uranus", description="I know literally nothing about this one") -neptune = Planet(id = 8, name = "Neptune", description = "Poseidon's!") -pluto = Planet(id = 9, name = "Pluto", description = "dont forget about me!" ) -list_of_planets = [jupiter, mars, mercury, venus, earth, saturn, uranus, neptune, pluto] - -def return_all_planets(): - planets_json = [] - for planet in list_of_planets: - dict = { - "id": planet.id, - "name": planet.name, - "description": planet.description - } - planets_json.append(dict) - return jsonify(planets_json) - -def verify_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 { - "id": planet.id, - "name": planet.name, - "description": planet.description - } - abort(make_response({"Message": f"Planet {planet_id} not found."}, 404)) +# class Planet: +# def __init__(self, id, name, description): +# self.id = id +# self.name = name +# self.description = description + +# # instance = an instance of the object +# jupiter = Planet(id=1, name = "Jupiter", description = "hmmm i think its a big planet") +# mars = Planet(id= 2, name = "Mars", description="its close to the sun?") +# mercury = Planet(id = 3, name = "Mercury", description="also close to the planet?") +# venus = Planet(id= 4, name = "Venus", description = "this is aphrodite's planet?") +# earth = Planet(id=5, name = "Earth", description = "us!") +# saturn = Planet(id = 6, name = "Saturn", description = "this is the one with a lot of moons?") +# uranus = Planet(id = 7, name = "Uranus", description="I know literally nothing about this one") +# neptune = Planet(id = 8, name = "Neptune", description = "Poseidon's!") +# pluto = Planet(id = 9, name = "Pluto", description = "dont forget about me!" ) +# list_of_planets = [jupiter, mars, mercury, venus, earth, saturn, uranus, neptune, pluto] + +# def return_all_planets(): +# planets_json = [] +# for planet in list_of_planets: +# dict = { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description +# } +# planets_json.append(dict) +# return jsonify(planets_json) + +# def verify_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 { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description +# } +# abort(make_response({"Message": f"Planet {planet_id} not found."}, 404)) diff --git a/app/routes.py b/app/routes.py index 17c9e4a9d..053089f8c 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,14 +1,26 @@ -from flask import Blueprint -from .planets import * +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request + planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") -@planet_bp.route("", methods = ["GET"]) -def read_planets(): - return return_all_planets() +@planet_bp.route("", methods=["POST"]) +def handle_planets(): + request_body = request.get_json() + planet_1 = Planet( + name = request_body["name"], + description = request_body["description"], + moons = request_body["moons"]) + + db.session.add(planet_1) + db.session.commit() + + return make_response(f"Planet {planet_1.name} successfully created", 201) + +# @planet_bp.route("", methods = ["GET"]) +# def read_planets(): +# return return_all_planets() -@planet_bp.route("/", methods=["GET"]) -def handle_planet(planet_id): - return verify_planet(planet_id) - - - +# @planet_bp.route("/", methods=["GET"]) +# def handle_planet(planet_id): +# return verify_planet(planet_id) 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/48a8fe91a2d5_added_a_planet.py b/migrations/versions/48a8fe91a2d5_added_a_planet.py new file mode 100644 index 000000000..667f29770 --- /dev/null +++ b/migrations/versions/48a8fe91a2d5_added_a_planet.py @@ -0,0 +1,34 @@ +"""added a planet + +Revision ID: 48a8fe91a2d5 +Revises: +Create Date: 2022-10-28 14:11:25.119178 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '48a8fe91a2d5' +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 1ece771f0b1badf194614a34ce9e205832945bc9 Mon Sep 17 00:00:00 2001 From: reneesu99 Date: Fri, 28 Oct 2022 12:17:36 -0700 Subject: [PATCH 09/17] added get method to planets --- app/planets.py | 2 +- app/routes.py | 42 ++++++++++++++++++++++++------------------ 2 files changed, 25 insertions(+), 19 deletions(-) diff --git a/app/planets.py b/app/planets.py index 9718648e2..fd3eb84cf 100644 --- a/app/planets.py +++ b/app/planets.py @@ -1,4 +1,4 @@ -from flask import jsonify, abort, make_response +# from flask import jsonify, abort, make_response # class Planet: # def __init__(self, id, name, description): diff --git a/app/routes.py b/app/routes.py index 053089f8c..714dfe8fd 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,26 +1,32 @@ +from time import monotonic_ns from app import db from app.models.planet import Planet from flask import Blueprint, jsonify, make_response, request planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") -@planet_bp.route("", methods=["POST"]) +@planet_bp.route("", methods=["POST", "GET"]) def handle_planets(): - request_body = request.get_json() - planet_1 = Planet( - name = request_body["name"], - description = request_body["description"], - moons = request_body["moons"]) + if request.method == "POST": + request_body = request.get_json() + planet_1 = Planet( + name = request_body["name"], + description = request_body["description"], + moons = request_body["moons"]) + db.session.add(planet_1) + db.session.commit() - db.session.add(planet_1) - db.session.commit() - - return make_response(f"Planet {planet_1.name} successfully created", 201) - -# @planet_bp.route("", methods = ["GET"]) -# def read_planets(): -# return return_all_planets() - -# @planet_bp.route("/", methods=["GET"]) -# def handle_planet(planet_id): -# return verify_planet(planet_id) + return make_response(f"Planet {planet_1.name} successfully created", 201) + + if request.method == "GET": + response_body = [] + planets= Planet.query.all() + for planet in planets: + response_body.append({ + "name": planet.name, + "description": planet.description, + "moons": planet.moons, + "id": planet.id, + }) + + return jsonify(response_body), 200 \ No newline at end of file From 2bc78b985df8b908a06bed5917ff18e91d35195f Mon Sep 17 00:00:00 2001 From: Semhar Tes Date: Tue, 1 Nov 2022 13:37:51 -0400 Subject: [PATCH 10/17] read a planet and handled 400 and 404 errors for invalid ad non-existing plaent --- app/routes.py | 61 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 57 insertions(+), 4 deletions(-) diff --git a/app/routes.py b/app/routes.py index 714dfe8fd..a62bad98e 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,7 +1,7 @@ -from time import monotonic_ns +# from time import monotonic_ns 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 planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") @@ -17,7 +17,7 @@ def handle_planets(): db.session.commit() return make_response(f"Planet {planet_1.name} successfully created", 201) - + if request.method == "GET": response_body = [] planets= Planet.query.all() @@ -29,4 +29,57 @@ def handle_planets(): "id": planet.id, }) - return jsonify(response_body), 200 \ No newline at end of file + return jsonify(response_body), 200 + + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + abort(make_response ({"Message": f"Planet {planet_id} invalid."}, 400)) + + # to access a planet with planet_id in our db, we use + planet = Planet.query.get(planet_id) + if not planet: + abort(make_response({"Message": f"Planet {planet_id} not found."}, 404)) + return planet + + +@planet_bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = validate_planet(planet_id) + # planet = Planet.query.get(planet_id) + + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "moons": planet.moons + } + +@planet_bp.route("/", methods=["PUT"]) +def update_planet(planet_id): + planet = validate_planet(planet_id) + + request_body = request.get_json() + +#updating the attributes + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.moons = request_body["moons"] + +# commit changes to our db + db.session.commit() + + return make_response(f"Planet #{planet_id} is updated.") + +@planet_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} is deleted.") + + From 6477e8eb0bc236f5aaef6611502b19a1a8862a31 Mon Sep 17 00:00:00 2001 From: reneesu99 Date: Tue, 1 Nov 2022 10:48:53 -0700 Subject: [PATCH 11/17] added put and delete methods for one planet, refactored to put it into one function --- app/routes.py | 56 ++++++++++++++++++++++----------------------------- 1 file changed, 24 insertions(+), 32 deletions(-) diff --git a/app/routes.py b/app/routes.py index a62bad98e..18d312cb4 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,3 @@ -# from time import monotonic_ns from app import db from app.models.planet import Planet from flask import Blueprint, jsonify, make_response, request, abort @@ -18,7 +17,7 @@ def handle_planets(): return make_response(f"Planet {planet_1.name} successfully created", 201) - if request.method == "GET": + elif request.method == "GET": response_body = [] planets= Planet.query.all() for planet in planets: @@ -45,41 +44,34 @@ def validate_planet(planet_id): return planet -@planet_bp.route("/", methods=["GET"]) -def read_one_planet(planet_id): - planet = validate_planet(planet_id) - # planet = Planet.query.get(planet_id) - - return { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "moons": planet.moons - } - -@planet_bp.route("/", methods=["PUT"]) -def update_planet(planet_id): +@planet_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_one_planet(planet_id): planet = validate_planet(planet_id) + if request.method == "GET": + return { + "id": planet.id, + "name": planet.name, + "description": planet.description, + "moons": planet.moons + } + + elif request.method == "PUT": + request_body = request.get_json() - request_body = request.get_json() - -#updating the attributes - planet.name = request_body["name"] - planet.description = request_body["description"] - planet.moons = request_body["moons"] - -# commit changes to our db - db.session.commit() + #updating the attributes + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.moons = request_body["moons"] - return make_response(f"Planet #{planet_id} is updated.") + # commit changes to our db + db.session.commit() -@planet_bp.route("/", methods=["DELETE"]) -def delete_planet(planet_id): - planet = validate_planet(planet_id) + return make_response(f"Planet #{planet_id} is updated.") - db.session.delete(planet) - db.session.commit() + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() - return make_response(f"Planet #{planet_id} is deleted.") + return make_response(f"Planet #{planet_id} is deleted.") From 02c35d11cace6241b41898b63c72d14404afed80 Mon Sep 17 00:00:00 2001 From: reneesu99 Date: Wed, 2 Nov 2022 10:55:30 -0700 Subject: [PATCH 12/17] refactored and added query param moons --- app/models/planet.py | 8 ++++++++ app/routes.py | 37 +++++++++++++++---------------------- 2 files changed, 23 insertions(+), 22 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 651cbb282..83ee908ff 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -7,3 +7,11 @@ class Planet(db.Model): # defining the planet model name = db.Column(db.String) # attribute title which will map to a db column description = db.Column(db.String) moons = db.Column(db.Integer) + + def to_dict(self): + return { + "name": self.name, + "description": self.description, + "moons": self.moons, + "id": self.id, + } \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 18d312cb4..0719043c6 100644 --- a/app/routes.py +++ b/app/routes.py @@ -19,41 +19,34 @@ def handle_planets(): elif request.method == "GET": response_body = [] - planets= Planet.query.all() + moons_param = request.args.get("moons") + if moons_param: + planets = Planet.query.filter_by(moons = moons_param) + else: + planets= Planet.query.all() for planet in planets: - response_body.append({ - "name": planet.name, - "description": planet.description, - "moons": planet.moons, - "id": planet.id, - }) - + response_body.append(planet.to_dict()) return jsonify(response_body), 200 -def validate_planet(planet_id): +def validate_id(id, cls): try: - planet_id = int(planet_id) + id = int(id) except: - abort(make_response ({"Message": f"Planet {planet_id} invalid."}, 400)) + abort(make_response ({"Message": f"{cls.__name__} {id} invalid."}, 400)) # to access a planet with planet_id in our db, we use - planet = Planet.query.get(planet_id) - if not planet: - abort(make_response({"Message": f"Planet {planet_id} not found."}, 404)) - return planet + obj = cls.query.get(id) + if not obj: + abort(make_response({"Message": f"{cls.__name__} {id} not found."}, 404)) + return obj @planet_bp.route("/", methods=["GET", "PUT", "DELETE"]) def handle_one_planet(planet_id): - planet = validate_planet(planet_id) + planet = validate_id(planet_id, Planet) if request.method == "GET": - return { - "id": planet.id, - "name": planet.name, - "description": planet.description, - "moons": planet.moons - } + return planet.to_dict() elif request.method == "PUT": request_body = request.get_json() From 3dea5d36fb0b890d13fb960c87ea6b0310d053ab Mon Sep 17 00:00:00 2001 From: Semhar Tes Date: Thu, 3 Nov 2022 04:32:33 -0400 Subject: [PATCH 13/17] created class method and refactored creating a Planet model in create planet route --- app/models/planet.py | 11 ++++++++++- app/routes.py | 15 +++++---------- 2 files changed, 15 insertions(+), 11 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 83ee908ff..9b372d9b9 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -14,4 +14,13 @@ def to_dict(self): "description": self.description, "moons": self.moons, "id": self.id, - } \ No newline at end of file + } + +@classmethod +def from_dict(cls, planet_data): + planet_1 = Planet( + name=planet_data["name"], + description=planet_data["description"], + moons=planet_data["moons"] + ) + return planet_1 \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 0719043c6..1e85d5562 100644 --- a/app/routes.py +++ b/app/routes.py @@ -8,24 +8,19 @@ def handle_planets(): if request.method == "POST": request_body = request.get_json() - planet_1 = Planet( - name = request_body["name"], - description = request_body["description"], - moons = request_body["moons"]) + planet_1 = Planet.from_dict(request_body) db.session.add(planet_1) db.session.commit() - + return make_response(f"Planet {planet_1.name} successfully created", 201) - - elif request.method == "GET": - response_body = [] + + elif request.method == "GET": moons_param = request.args.get("moons") if moons_param: planets = Planet.query.filter_by(moons = moons_param) else: planets= Planet.query.all() - for planet in planets: - response_body.append(planet.to_dict()) + response_body = [planet.to_dict() for planet in planets] return jsonify(response_body), 200 From f92bcc6f65faed5bce6a4757328633c9de41c83a Mon Sep 17 00:00:00 2001 From: Semhar Tes Date: Thu, 3 Nov 2022 08:24:28 -0400 Subject: [PATCH 14/17] created .env file and populated 2 env variables in it, refactored create app method, created tests folder and checked GET /planets returns200 and test run and passes --- app/__init__.py | 16 +++++++++++++--- tests/__init__.py | 0 tests/conftest.py | 24 ++++++++++++++++++++++++ tests/test_routes.py | 8 ++++++++ 4 files changed, 45 insertions(+), 3 deletions(-) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_routes.py diff --git a/app/__init__.py b/app/__init__.py index 0e2493ebc..c8aa0cfb3 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() # db and migrate are variables that gives us access to db operations migrate = Migrate() +load_dotenv() def create_app(test_config=None): app = Flask(__name__) - - app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False #hide a warning abt a feature that we wont be using - 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") + # connects db & migrate to flask app db.init_app(app) migrate.init_app(app, db) 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..b531cc0ba --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,24 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + @request_finished.connect_via(app) + def expire_session(sender, response, **extra): + db.session.remove() + + with app.app_context(): + db.create_all() + yield app + + with app.app_context(): + db.drop_all() + + +@pytest.fixture +def client(app): + return app.test_client() \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..1124a9765 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,8 @@ +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 == [] \ No newline at end of file From 1dbdd31a5949c8c8a21e5c45c7dcb5d4598ef91c Mon Sep 17 00:00:00 2001 From: reneesu99 Date: Thu, 3 Nov 2022 10:52:37 -0700 Subject: [PATCH 15/17] finished wave 6 --- app/__init__.py | 19 ++++++-- app/routes.py | 2 +- tests/__init__.py | 0 tests/conftest.py | 40 +++++++++++++++++ tests/test_routes.py | 102 +++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 158 insertions(+), 5 deletions(-) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_routes.py diff --git a/app/__init__.py b/app/__init__.py index 0e2493ebc..d17ea4910 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,22 +1,33 @@ from flask import Flask from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate +from dotenv import dotenv_values +import os db = SQLAlchemy() # db and migrate are variables that gives us access to db operations migrate = Migrate() +config = dotenv_values(".env") + + +print(config["SQLALCHEMY_DATABASE_URI"]) def create_app(test_config=None): app = Flask(__name__) + if not test_config: + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False #hide a warning abt a feature that we wont be using + app.config['SQLALCHEMY_DATABASE_URI'] = config["SQLALCHEMY_DATABASE_URI"] + else: + app.config["TESTING"] = True + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + app.config["SQLALCHEMY_DATABASE_URI"] = config["SQLALCHEMY_TEST_DATABASE_URI"] - app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False #hide a warning abt a feature that we wont be using - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' - # connects db & migrate to flask app + from app.models.planet import Planet + db.init_app(app) migrate.init_app(app, db) - from app.models.planet import Planet from .routes import planet_bp app.register_blueprint(planet_bp) diff --git a/app/routes.py b/app/routes.py index 0719043c6..da62eeeee 100644 --- a/app/routes.py +++ b/app/routes.py @@ -44,7 +44,7 @@ def validate_id(id, cls): @planet_bp.route("/", methods=["GET", "PUT", "DELETE"]) def handle_one_planet(planet_id): - planet = validate_id(planet_id, Planet) + planet = validate_id(planet_id, Planet) if request.method == "GET": return planet.to_dict() 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..941b311a7 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,40 @@ +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 + mars = Planet(name = "Mars", + description="no watr 4evr", + moons = 0) + jupiter = Planet(name="Jupiter", + description="i luv storms", + moons = 1) + + db.session.add_all([mars, jupiter]) + + 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..940911d6b --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,102 @@ +from werkzeug.exceptions import HTTPException +from app.routes import validate_id +from app.models.planet import Planet +import pytest + + +# 1. `POST` `/planets` with a JSON request body returns a `201` + +def test_get_all_planets_empty(client): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + +def test_get_planet_by_id(client, two_saved_planets): + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Mars", + "moons": 0, + "description": "no watr 4evr" + } + +def test_get_planet_by_id_empty(client): + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + +def test_get_all_planets(client, two_saved_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body[0] == { + "id": 1, + "name": "Mars", + "moons": 0, + "description": "no watr 4evr" + } + assert response_body[1] == { + "id": 2, + "name": "Jupiter", + "moons": 1, + "description": "i luv storms" + } + +def test_get_query_param_planets(client, two_saved_planets): + # Act + response = client.get("/planets?moons=0") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body[0] == { + "id": 1, + "name": "Mars", + "moons": 0, + "description": "no watr 4evr" + } + + + +def test_post_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Earth", + "description": "The Best!", + "moons": 1 + }) + + # Assert + assert response.status_code == 201 + +def test_update_planet(client, two_saved_planets): + # Act + response = client.put("/planets/1", json = { + "name":"Mars2", + "description": "The Best!", + "moons": 1 + }) + assert response.status_code == 200 + +def test_delete_planet(client, two_saved_planets): + # Act + response = client.delete("/planets/1") + assert response.status_code == 200 + +def test_delete_planet_invalid_id(client, two_saved_planets): + # Act + response = client.delete("/planets/random") + assert response.status_code == 400 From 873a96aea763727c2db4e920d5860cb493662bc5 Mon Sep 17 00:00:00 2001 From: reneesu99 Date: Thu, 3 Nov 2022 11:01:50 -0700 Subject: [PATCH 16/17] resolved merge conflicts --- app/models/planet.py | 16 ++++++++-------- tests/test_routes.py | 2 ++ 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/app/models/planet.py b/app/models/planet.py index 9b372d9b9..2544b7f02 100644 --- a/app/models/planet.py +++ b/app/models/planet.py @@ -16,11 +16,11 @@ def to_dict(self): "id": self.id, } -@classmethod -def from_dict(cls, planet_data): - planet_1 = Planet( - name=planet_data["name"], - description=planet_data["description"], - moons=planet_data["moons"] - ) - return planet_1 \ No newline at end of file + @classmethod + def from_dict(cls, planet_data): + planet_1 = Planet( + name=planet_data["name"], + description=planet_data["description"], + moons=planet_data["moons"] + ) + return planet_1 \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py index 6cb06c722..4d926b168 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -38,6 +38,8 @@ def test_get_all_planets_with_no_records(client): def test_get_all_planets(client, two_saved_planets): + response = client.get("/planets") + response_body = response.get_json() assert response_body[0] == { "id": 1, "name": "Mars", From 75f0a404ba955cdc241662434dcf437cb5a826ee Mon Sep 17 00:00:00 2001 From: Semhar Tes Date: Mon, 7 Nov 2022 08:30:47 -0500 Subject: [PATCH 17/17] added gunicorn to requirements.txt --- requirements.txt | 1 + tests/conftest.py | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/requirements.txt b/requirements.txt index fba2b3e38..b4dd0350e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,6 +7,7 @@ click==7.1.2 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 itsdangerous==1.1.0 Jinja2==2.11.3 diff --git a/tests/conftest.py b/tests/conftest.py index 8d8dea1be..e926ba6db 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -29,11 +29,11 @@ def client(app): def two_saved_planets(app): # Arrange mars = Planet(name = "Mars", - description="no watr 4evr", - moons = 0) + description="no watr 4evr", + moons = 0) jupiter = Planet(name="Jupiter", - description="i luv storms", - moons = 1) + description="i luv storms", + moons = 1) db.session.add_all([mars, jupiter])