From f2d6e9e3bf4b5dcfe664f51bcf8552109c9c7d41 Mon Sep 17 00:00:00 2001 From: Chinazo Onwukaike Date: Mon, 25 Apr 2022 13:48:37 -0500 Subject: [PATCH 1/5] wave 01 --- app/__init__.py | 3 +++ app/routes.py | 41 ++++++++++++++++++++++++++++++++++++++++- 2 files changed, 43 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..b386c5938 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -3,5 +3,8 @@ def create_app(test_config=None): app = Flask(__name__) + + from .routes import planet_bp + app.register_blueprint(planet_bp) return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..900ad40fa 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,41 @@ -from flask import Blueprint +import json +from sys import prefix +from flask import Blueprint, jsonify +class Planet: + def __init__(self, id, name, description, color): + self.id = id + self.name = name + self.description = description + self.color = color + + def to_json(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "color": self.color + } + +planets =[ + Planet(1, "Mercury", "Closest planet to the sun", "grey"), + Planet(2, "Venus", "Temperatures around 900F", "brown and grey"), + Planet(3, "Earth", "Only planet currently with life", "blue, brown green, and white"), + Planet(4, "Mars", "Known as the red and the rusty planet", "red, brown, and tan"), + Planet(5, "Jupiter", "The king of the solar system", "brown, orange and tan, with white cloud stripes"), + Planet(6, "Saturn", "The ringed planet.", "golden, brown, and blue-grey"), + Planet(7, "Uranus", "The planet that spins on it's side", "blue-green"), + Planet(8, "Neptune", "4x the size of earth and freezing", "blue"), + Planet(9, "Pluto", "No one can tell me it's not a planet", "blue") + ] + +planet_bp = Blueprint("planet", __name__, url_prefix="/planets") + +#GET all planets +@planet_bp.route("", methods=["GET"]) +def get_all_planets(): + planets_lists = [] + for planet in planets: + planets_lists.append(planet.to_json()) + + return jsonify(planets_lists) \ No newline at end of file From c4120e17d9683906f22cb5f366eeeba94ce8d4b3 Mon Sep 17 00:00:00 2001 From: Chinazo Onwukaike Date: Tue, 26 Apr 2022 15:57:41 -0500 Subject: [PATCH 2/5] wave 02 --- app/routes.py | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/app/routes.py b/app/routes.py index 900ad40fa..adbe0edd0 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,6 +1,4 @@ -import json -from sys import prefix -from flask import Blueprint, jsonify +from flask import Blueprint, jsonify, abort, make_response class Planet: def __init__(self, id, name, description, color): @@ -32,10 +30,28 @@ def to_json(self): planet_bp = Blueprint("planet", __name__, url_prefix="/planets") #GET all planets -@planet_bp.route("", methods=["GET"]) +@planet_bp.route("/", methods=["GET"]) def get_all_planets(): planets_lists = [] for planet in planets: planets_lists.append(planet.to_json()) - return jsonify(planets_lists) \ No newline at end of file + return jsonify(planets_lists) + +def validate_planet(id): + try: + id = int(id) + except: + return abort(make_response({"message": f"planet {id} is invalid"}, 400)) + + for planet in planets: + if planet.id == id: + return planet + + return abort(make_response({"message": f"planet {id} is not found"}, 404)) + +@planet_bp.route("", methods=["GET"]) +def get_one_planet(id): + planet = validate_planet(id) + + return jsonify(planet.to_json()) \ No newline at end of file From 820b86763476223fcd7be45c6dc0d0b09fd519d3 Mon Sep 17 00:00:00 2001 From: Chinazo Onwukaike Date: Fri, 29 Apr 2022 17:24:49 -0500 Subject: [PATCH 3/5] waves 03, 04, 05 --- app/__init__.py | 13 +++++ app/models/Planet.py | 7 +++ app/models/__init__.py | 0 app/routes.py | 130 ++++++++++++++++++++++++++--------------- 4 files changed, 103 insertions(+), 47 deletions(-) create mode 100644 app/models/Planet.py create mode 100644 app/models/__init__.py diff --git a/app/__init__.py b/app/__init__.py index b386c5938..cf8f91c07 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() +URI = "postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development" def create_app(test_config=None): app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = URI + + 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/models/Planet.py b/app/models/Planet.py new file mode 100644 index 000000000..235c1f8c5 --- /dev/null +++ b/app/models/Planet.py @@ -0,0 +1,7 @@ +from app import db + +class Planet(db.Model): + planet_id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + description = db.Column(db.String) + color = db.Column(db.String) 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 adbe0edd0..0ce650ebe 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,57 +1,93 @@ -from flask import Blueprint, jsonify, abort, make_response - -class Planet: - def __init__(self, id, name, description, color): - self.id = id - self.name = name - self.description = description - self.color = color - - def to_json(self): - return { - "id": self.id, - "name": self.name, - "description": self.description, - "color": self.color - } - -planets =[ - Planet(1, "Mercury", "Closest planet to the sun", "grey"), - Planet(2, "Venus", "Temperatures around 900F", "brown and grey"), - Planet(3, "Earth", "Only planet currently with life", "blue, brown green, and white"), - Planet(4, "Mars", "Known as the red and the rusty planet", "red, brown, and tan"), - Planet(5, "Jupiter", "The king of the solar system", "brown, orange and tan, with white cloud stripes"), - Planet(6, "Saturn", "The ringed planet.", "golden, brown, and blue-grey"), - Planet(7, "Uranus", "The planet that spins on it's side", "blue-green"), - Planet(8, "Neptune", "4x the size of earth and freezing", "blue"), - Planet(9, "Pluto", "No one can tell me it's not a planet", "blue") - ] +import re +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.Planet import Planet planet_bp = Blueprint("planet", __name__, url_prefix="/planets") -#GET all planets -@planet_bp.route("/", methods=["GET"]) +#Validate planet data +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + return abort(make_response({"message": f"Planet {planet_id} is invalid"}, 400)) + + planet = Planet.query.get(planet_id) + + if not planet: + return abort(make_response({"message": f"Planet {planet_id} is not found"}, 404)) + return planet + +#GET all planets or GET by NAME query +@planet_bp.route("", methods=["GET"]) def get_all_planets(): - planets_lists = [] + name_query = request.args.get("name").title() + if name_query: + planets = Planet.query.filter_by(name=name_query) + else: + planets = Planet.query.all() + + planet_response = [] for planet in planets: - planets_lists.append(planet.to_json()) + planet_response.append({ + "id" : planet.planet_id, + "name" : planet.name, + "description" : planet.description, + "color" : planet.color + }) + if not planet_response: + return abort(make_response({"message": f"Planet {name_query} is not found"}, 404)) - return jsonify(planets_lists) + return jsonify(planet_response) -def validate_planet(id): - try: - id = int(id) - except: - return abort(make_response({"message": f"planet {id} is invalid"}, 400)) +#POST new planet +@planet_bp.route("", methods=["POST"]) +def add_new_planet(): + request_body = request.get_json() + new_planet = Planet( + name=request_body["name"], + description=request_body["description"], + color=request_body["color"]) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} was successfully created", 201) + + +#GET one planet by id +@planet_bp.route("", methods=["GET"]) +def get_one_planet(planet_id): + planet = validate_planet(planet_id) + return { + "id" : planet.planet_id, + "name" : planet.name, + "description" : planet.description, + "color" : planet.color + } + + +#UPDATE one planet by id with PUT +@planet_bp.route("", methods=["PUT"]) +def update_one_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.color = request_body["color"] + + db.session.commit() + + return make_response(f"Planet #{planet.planet_id}, '{planet.name}', successfully updated.") - for planet in planets: - if planet.id == id: - return planet - - return abort(make_response({"message": f"planet {id} is not found"}, 404)) -@planet_bp.route("", methods=["GET"]) -def get_one_planet(id): - planet = validate_planet(id) +#DELETE one planet by id +@planet_bp.route("", methods=["DELETE"]) +def delete_one_planet(planet_id): + planet = validate_planet(planet_id) + + db.session.delete(planet) + db.session.commit() - return jsonify(planet.to_json()) \ No newline at end of file + return make_response(f"Planet #{planet.planet_id}, '{planet.name}', successfully deleted.") \ No newline at end of file From b482728c0570b66bdfa68f237d339d492ed5646d Mon Sep 17 00:00:00 2001 From: Chinazo Onwukaike Date: Fri, 29 Apr 2022 18:07:20 -0500 Subject: [PATCH 4/5] add migrations folder --- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../57f03e966f57_adds_planet_model.py | 34 +++++++ 5 files changed, 200 insertions(+) create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/57f03e966f57_adds_planet_model.py diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..f8ed4801f --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,45 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..8b3fb3353 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,96 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool +from flask import current_app + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option( + 'sqlalchemy.url', + str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) +target_metadata = current_app.extensions['migrate'].db.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=target_metadata, literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/migrations/versions/57f03e966f57_adds_planet_model.py b/migrations/versions/57f03e966f57_adds_planet_model.py new file mode 100644 index 000000000..daa06e1cc --- /dev/null +++ b/migrations/versions/57f03e966f57_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: 57f03e966f57 +Revises: +Create Date: 2022-04-29 13:21:20.111514 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '57f03e966f57' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('planet', + sa.Column('planet_id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.Column('description', sa.String(), nullable=True), + sa.Column('color', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('planet_id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('planet') + # ### end Alembic commands ### From 271ba0f69e1115154a9a5e6243a8a306bd55de0c Mon Sep 17 00:00:00 2001 From: Chinazo Onwukaike Date: Thu, 5 May 2022 13:06:29 -0500 Subject: [PATCH 5/5] completes wave 02 adds testing files --- app/__init__.py | 15 ++++++++++++--- app/routes.py | 15 +++++++-------- tests/__init__.py | 0 tests/conftest.py | 39 +++++++++++++++++++++++++++++++++++++++ tests/test_routes.py | 38 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 96 insertions(+), 11 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 cf8f91c07..a8eabea68 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,22 +1,31 @@ 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() -URI = "postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development" +load_dotenv() def create_app(test_config=None): app = Flask(__name__) - app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False - app.config['SQLALCHEMY_DATABASE_URI'] = URI + 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_DATABASE_TESTING_URI") + # Import models db.init_app(app) migrate.init_app(app, db) from app.models.Planet import Planet + #Import blueprints from .routes import planet_bp app.register_blueprint(planet_bp) diff --git a/app/routes.py b/app/routes.py index 0ce650ebe..bf25a24c4 100644 --- a/app/routes.py +++ b/app/routes.py @@ -21,9 +21,10 @@ def validate_planet(planet_id): #GET all planets or GET by NAME query @planet_bp.route("", methods=["GET"]) def get_all_planets(): - name_query = request.args.get("name").title() + + name_query = request.args.get("name") if name_query: - planets = Planet.query.filter_by(name=name_query) + planets = Planet.query.filter_by(name=name_query.title()) else: planets = Planet.query.all() @@ -35,9 +36,7 @@ def get_all_planets(): "description" : planet.description, "color" : planet.color }) - if not planet_response: - return abort(make_response({"message": f"Planet {name_query} is not found"}, 404)) - + return jsonify(planet_response) #POST new planet @@ -52,7 +51,7 @@ def add_new_planet(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.name} was successfully created", 201) + return make_response(jsonify(f"Planet {new_planet.name} was successfully created"), 201) #GET one planet by id @@ -79,7 +78,7 @@ def update_one_planet(planet_id): db.session.commit() - return make_response(f"Planet #{planet.planet_id}, '{planet.name}', successfully updated.") + return make_response(jsonify(f"Planet #{planet.planet_id}, '{planet.name}', successfully updated."), 200) #DELETE one planet by id @@ -90,4 +89,4 @@ def delete_one_planet(planet_id): db.session.delete(planet) db.session.commit() - return make_response(f"Planet #{planet.planet_id}, '{planet.name}', successfully deleted.") \ No newline at end of file + return make_response(jsonify(f"Planet #{planet.planet_id}, '{planet.name}', successfully deleted."), 200) \ No newline at end of file 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..dae5045cf --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,39 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.Planet import Planet + + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + @request_finished.connect_via(app) + def expire_session(sender, response, **extra): + db.session.remove() + + with app.app_context(): + db.create_all() + yield app + + with app.app_context(): + db.drop_all() + + +@pytest.fixture +def client(app): + return app.test_client() + +@pytest.fixture +def two_saved_planets(app): + # Arrange + chi_planet = Planet(name="Chiland", + description="The coolest place ever", + color="lavender and blue") + bahareh_planet = Planet(name="Baharehland", + description="No, the coolest place ever. More than Chiland", + color="rainbow awesomeness") + + db.session.add_all([chi_planet, bahareh_planet]) + 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..40d91737f --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,38 @@ +import pytest + + +# @pytest.mark.skip +def test_get_all_planets_with_no_records(client): + 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": "Chiland", + "description": "The coolest place ever", + "color" : "lavender and blue" + } + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "New Planet", + "description": "The Best Planet!", + "color" : "pink" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet New Planet was successfully created" \ No newline at end of file