From 016d948b25faf55840754865a4c598dc6b995807 Mon Sep 17 00:00:00 2001 From: Yonese James Date: Fri, 22 Apr 2022 14:06:32 -0400 Subject: [PATCH 1/5] Initial change --- app/__init__.py | 3 +++ app/routes.py | 30 +++++++++++++++++++++++++++++- 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..b2bd60609 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -4,4 +4,7 @@ def create_app(test_config=None): app = Flask(__name__) + from .routes import planet_bp + app.register_blueprint(planet_bp) + return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..7ceb7e68b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,30 @@ -from flask import Blueprint +from flask import Blueprint, jsonify +class Planet: + + def __init__(self, id, name, description, habitable): + self.id = id + self.name = name + self.description = description + self.habitable = habitable + +planets = [ + Planet(1, "Mercury", "Small, hot, first planet", False), + Planet(2, "Venus", "Medium, bright, second planet", False), + Planet(3, "Earth", "Medium, Oceans, third planet", True) +] + +planet_bp = Blueprint("planet", __name__, url_prefix="/planets") + +@planet_bp.route("", methods=["GET"]) +def read_all_planets(): + planets_response = [] + for planet in planets: + planets_response.append({ + "id": planet.id, + "name": planet.name, + "description": planet.description, + "habitable": planet.habitable, + } + ) + return jsonify(planets_response) From ab83471848d38898aa23ebafda5aaf071d2b6cdb Mon Sep 17 00:00:00 2001 From: Philomena Kelly Date: Mon, 25 Apr 2022 14:54:57 -0400 Subject: [PATCH 2/5] finished wave 2, added get planet endpoint --- app/routes.py | 40 +++++++++++++++++++++++++++++++++------- 1 file changed, 33 insertions(+), 7 deletions(-) diff --git a/app/routes.py b/app/routes.py index 7ceb7e68b..278161e66 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,6 @@ -from flask import Blueprint, jsonify +from os import abort +from flask import Blueprint, jsonify, make_response, abort + class Planet: @@ -7,6 +9,15 @@ def __init__(self, id, name, description, habitable): self.name = name self.description = description self.habitable = habitable + + def to_json(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "habitable": self.habitable + } + planets = [ Planet(1, "Mercury", "Small, hot, first planet", False), @@ -16,15 +27,30 @@ def __init__(self, id, name, description, habitable): planet_bp = Blueprint("planet", __name__, url_prefix="/planets") + @planet_bp.route("", methods=["GET"]) def read_all_planets(): planets_response = [] for planet in planets: - planets_response.append({ - "id": planet.id, - "name": planet.name, - "description": planet.description, - "habitable": planet.habitable, - } + planets_response.append( + planet.to_json() ) return jsonify(planets_response) + + +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} not found"}, 404)) + +@planet_bp.route("/", methods=["GET"]) +def read_one_planet(id): + planet = validate_planet(id) + return jsonify(planet.to_json()) + From 4c1f26314b9140bcaf637393f41d91e084be19b1 Mon Sep 17 00:00:00 2001 From: Philomena Kelly Date: Tue, 3 May 2022 14:19:32 -0400 Subject: [PATCH 3/5] add DELETE, POST, PUT, and GET endpoints --- app/__init__.py | 14 +++ app/models/__init__.py | 0 app/models/planet.py | 9 ++ app/routes.py | 111 ++++++++++++------ list.txt | 0 migrations/README | 1 + migrations/alembic.ini | 50 ++++++++ migrations/env.py | 91 ++++++++++++++ migrations/script.py.mako | 24 ++++ .../33489ffd7c15_initializing_database.py | 34 ++++++ 10 files changed, 299 insertions(+), 35 deletions(-) create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.py create mode 100644 list.txt 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/33489ffd7c15_initializing_database.py diff --git a/app/__init__.py b/app/__init__.py index b2bd60609..1d284dbc5 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,9 +1,23 @@ 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_api' + + # Import models here + + 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/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..c16abb04a --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,9 @@ +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) + habitable = db.Column(db.Boolean) diff --git a/app/routes.py b/app/routes.py index 278161e66..0bd8af126 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,56 +1,97 @@ -from os import abort -from flask import Blueprint, jsonify, make_response, abort +from urllib import response +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request, abort -class Planet: - def __init__(self, id, name, description, habitable): - self.id = id - self.name = name - self.description = description - self.habitable = habitable - - def to_json(self): - return { - "id": self.id, - "name": self.name, - "description": self.description, - "habitable": self.habitable - } -planets = [ - Planet(1, "Mercury", "Small, hot, first planet", False), - Planet(2, "Venus", "Medium, bright, second planet", False), - Planet(3, "Earth", "Medium, Oceans, third planet", True) -] planet_bp = Blueprint("planet", __name__, url_prefix="/planets") @planet_bp.route("", methods=["GET"]) def read_all_planets(): + planets = Planet.query.all() planets_response = [] + for planet in planets: - planets_response.append( - planet.to_json() - ) + planets_response.append({ + "id" : planet.id, + "name" : planet.name, + "description" : planet.description, + "habitable" : planet.habitable + }) return jsonify(planets_response) -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} not found"}, 404)) +@planet_bp.route("", methods=["POST"]) +def create_one_planet(): + request_body = request.get_json() + + new_planet = Planet(name = request_body["name"], + description = request_body["description"], + habitable = request_body["habitable"]) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.id} created") + @planet_bp.route("/", methods=["GET"]) def read_one_planet(id): + + planet = validate_planet(id) + + + return { + "id" : planet.id, + "name" : planet.name, + "description" : planet.description, + "habitable" : planet.habitable + } + + +@planet_bp.route("/", methods=["PUT"]) +def update_one_planet(id): + planet = validate_planet(id) - return jsonify(planet.to_json()) + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.habitable = request_body["habitable"] + + db.session.commit() + + return make_response(f"Planet {planet.id} successfully updated.") + + +@planet_bp.route("/", methods=["DELETE"]) +def delete_one_planet(id): + + planet = validate_planet(id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet {planet.id} successfully deleted.") + + + + +def validate_planet(planet_id): + try: + 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 {id} not found"}, 404)) + return planet + diff --git a/list.txt b/list.txt new file mode 100644 index 000000000..e69de29bb diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..0e0484415 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..ec9d45c26 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# 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,flask_migrate + +[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 + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[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..68feded2a --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,91 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +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.get_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 = current_app.extensions['migrate'].db.get_engine() + + 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/33489ffd7c15_initializing_database.py b/migrations/versions/33489ffd7c15_initializing_database.py new file mode 100644 index 000000000..578b7ca47 --- /dev/null +++ b/migrations/versions/33489ffd7c15_initializing_database.py @@ -0,0 +1,34 @@ +"""initializing database + +Revision ID: 33489ffd7c15 +Revises: +Create Date: 2022-05-03 13:46:35.428465 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '33489ffd7c15' +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('habitable', sa.Boolean(), 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 e757f99b991ac0abc50a8269a60195729d3866b6 Mon Sep 17 00:00:00 2001 From: Yonese James Date: Wed, 4 May 2022 14:03:34 -0400 Subject: [PATCH 4/5] Added query param for habitable --- app/routes.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/app/routes.py b/app/routes.py index 0bd8af126..08a7e0244 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,19 +1,19 @@ -from urllib import response from app import db from app.models.planet import Planet from flask import Blueprint, jsonify, make_response, request, abort - - - - planet_bp = Blueprint("planet", __name__, url_prefix="/planets") @planet_bp.route("", methods=["GET"]) def read_all_planets(): - planets = Planet.query.all() + habitable_query = request.args.get("habitable") + if habitable_query: + planets = Planet.query.filter_by(habitable = habitable_query) + + else: + planets = Planet.query.all() planets_response = [] for planet in planets: From 8d3806c986e949ea23226d57a90d7f37405bb788 Mon Sep 17 00:00:00 2001 From: Philomena Kelly Date: Thu, 5 May 2022 14:51:49 -0400 Subject: [PATCH 5/5] created test folder, get 1 planet test, get all planets test, and create planet test --- .gitignore | 3 ++- app/__init__.py | 15 ++++++++++--- app/routes.py | 2 +- list.txt | 12 +++++++++++ requirements.txt | 50 ++++++++++++++++++++------------------------ tests/__init__.py | 0 tests/conftest.py | 43 +++++++++++++++++++++++++++++++++++++ tests/test_routes.py | 42 +++++++++++++++++++++++++++++++++++++ 8 files changed, 135 insertions(+), 32 deletions(-) create mode 100644 tests/__init__.py create mode 100644 tests/conftest.py create mode 100644 tests/test_routes.py diff --git a/.gitignore b/.gitignore index 4e9b18359..6a1e3ef70 100644 --- a/.gitignore +++ b/.gitignore @@ -138,4 +138,5 @@ dmypy.json .pytype/ # Cython debug symbols -cython_debug/ \ No newline at end of file +cython_debug/ +.env \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py index 1d284dbc5..d5d1ae96a 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,17 +1,26 @@ from flask import Flask from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate +import os +from dotenv import load_dotenv 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_api' + 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") # Import models here db.init_app(app) diff --git a/app/routes.py b/app/routes.py index 08a7e0244..8bfa96051 100644 --- a/app/routes.py +++ b/app/routes.py @@ -37,7 +37,7 @@ def create_one_planet(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.id} created") + return make_response(f"Planet {new_planet.name} successfully created!", 201) @planet_bp.route("/", methods=["GET"]) diff --git a/list.txt b/list.txt index e69de29bb..8a884791e 100644 --- a/list.txt +++ b/list.txt @@ -0,0 +1,12 @@ + + - postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_api + - set the models folder + add init + - import db to models + - in init import models + - flask db init + - flask db migrate + - flask db upgrade + - confirm migration in postgres + - create endpoints for post + - import request + \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index a506b4d12..c737d8eff 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,27 +1,23 @@ -alembic==1.5.4 -autopep8==1.5.5 -blinker==1.4 -certifi==2020.12.5 -chardet==4.0.0 -click==7.1.2 -Flask==1.1.2 -Flask-Migrate==2.6.0 -Flask-SQLAlchemy==2.4.4 -idna==2.10 -itsdangerous==1.1.0 -Jinja2==2.11.3 -Mako==1.1.4 -MarkupSafe==1.1.1 -psycopg2-binary==2.8.6 -pycodestyle==2.6.0 -pytest==6.2.3 -pytest-cov==2.12.1 -python-dateutil==2.8.1 -python-dotenv==0.15.0 -python-editor==1.0.4 -requests==2.25.1 -six==1.15.0 -SQLAlchemy==1.3.23 -toml==0.10.2 -urllib3==1.26.4 -Werkzeug==1.0.1 +alembic==1.7.7 +attrs==21.4.0 +click==8.1.2 +Flask==2.1.1 +Flask-Migrate==3.1.0 +Flask-SQLAlchemy==2.5.1 +importlib-metadata==4.11.3 +iniconfig==1.1.1 +itsdangerous==2.1.2 +Jinja2==3.1.1 +Mako==1.2.0 +MarkupSafe==2.1.1 +packaging==21.3 +pluggy==1.0.0 +psycopg2==2.9.3 +py==1.11.0 +pyparsing==3.0.8 +pytest==7.1.2 +python-dotenv==0.20.0 +SQLAlchemy==1.4.36 +tomli==2.0.1 +Werkzeug==2.1.1 +zipp==3.8.0 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..8c4f21bf5 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,43 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished + +from app.models.planet import Planet + + +@pytest.fixture +def 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 + blue_planet = Planet(name="Earth", + description="watr 4evr", + habitable=True) + red_planet = Planet(name="Mars", + description="small and red", + habitable=False) + + db.session.add_all([blue_planet, red_planet]) + # 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..3fc336dd3 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,42 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished + + +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": "Earth", + "description": "watr 4evr", + "habitable" : True + } + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Pluto", + "description": "small and very cold", + "habitable" : False + }) + response_body = response.get_data(as_text=True) + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Pluto successfully created!" \ No newline at end of file