From 7ea0e159c1d7f8fed80f2a21c9db271473a8039c Mon Sep 17 00:00:00 2001 From: Asli Athman Date: Fri, 15 Oct 2021 14:05:27 -0400 Subject: [PATCH 01/10] finished pt 1, all endpoint, one endpoint --- app/__init__.py | 3 +++ app/routes.py | 42 +++++++++++++++++++++++++++++++++++++++++- 2 files changed, 44 insertions(+), 1 deletion(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..243a5a1df 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 planets_bp + app.register_blueprint(planets_bp) + return app diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..6d29c540b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,42 @@ -from flask import Blueprint +from flask import Blueprint, jsonify +class Planet: + def __init__(self, id, name, description, moons): + self.id = id + self.name = name + self.description = description + self.moons = moons + +planets = [ + Planet(1, "Mercury", "Rogue moon turned planet!", 0), + Planet(2, "Venus", "Hottest planet in our solar system ;-)", 0), + Planet(3, "Earth", "In her flop era", 1) +] + +planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") + +@planets_bp.route("", methods=["GET"]) +def handle_planets(): + planets_response = [] + for planet in planets: + planets_response.append( + {"id" : planet.id, + "name" : planet.name, + "description" : planet.description, + "moons" : planet.moons, + } + ) + + return jsonify(planets_response) + +@planets_bp.route("/", methods=["GET"]) +def handle_planet(id): + id = int(id) + for planet in planets: + if planet.id == id: + return { + "id" : planet.id, + "name" : planet.name, + "description" : planet.description, + "moons" : planet.moons, + } From 28d4b922f658bc168bfe2f9b296c6be681b82452 Mon Sep 17 00:00:00 2001 From: Ivette Fernandez Date: Mon, 18 Oct 2021 16:12:55 -0500 Subject: [PATCH 02/10] added french solar system api request for english planet name info --- app/routes.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/app/routes.py b/app/routes.py index 6d29c540b..91b0f1c11 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,4 +1,5 @@ from flask import Blueprint, jsonify +import requests class Planet: def __init__(self, id, name, description, moons): @@ -40,3 +41,17 @@ def handle_planet(id): "description" : planet.description, "moons" : planet.moons, } + +def get_response(planet): + path = "https://api.le-systeme-solaire.net/rest/bodies/" + + query_params = { + "filter[]" : f"englishName,eq,{planet}" + } + + response = requests.get(path, params=query_params).json() + print(response) + print() + +get_response("mars") +get_response("venus") From ba35338c97c31bb853510112b864164b4d755eb2 Mon Sep 17 00:00:00 2001 From: Ivette Fernandez Date: Fri, 22 Oct 2021 13:09:13 -0500 Subject: [PATCH 03/10] created Planet model, migration set up --- app/__init__.py | 12 ++++ app/models/__init__.py | 0 app/models/planet.py | 7 ++ migrations/README | 1 + migrations/alembic.ini | 45 +++++++++++++ migrations/env.py | 96 ++++++++++++++++++++++++++++ migrations/script.py.mako | 24 +++++++ migrations/versions/4bca517e56a0_.py | 34 ++++++++++ 8 files changed, 219 insertions(+) create mode 100644 app/models/__init__.py create mode 100644 app/models/planet.py create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/4bca517e56a0_.py diff --git a/app/__init__.py b/app/__init__.py index 243a5a1df..b21dac6a2 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,9 +1,21 @@ 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 app.models.planet import Planet + from .routes import planets_bp app.register_blueprint(planets_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..4b822cd0d --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,7 @@ +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) \ No newline at end of file diff --git a/migrations/README b/migrations/README new file mode 100644 index 000000000..98e4f9c44 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 000000000..f8ed4801f --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,45 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/migrations/env.py b/migrations/env.py new file mode 100644 index 000000000..8b3fb3353 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,96 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool +from flask import current_app + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option( + 'sqlalchemy.url', + str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%')) +target_metadata = current_app.extensions['migrate'].db.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline(): + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=target_metadata, literal_binds=True + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/migrations/script.py.mako b/migrations/script.py.mako new file mode 100644 index 000000000..2c0156303 --- /dev/null +++ b/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/migrations/versions/4bca517e56a0_.py b/migrations/versions/4bca517e56a0_.py new file mode 100644 index 000000000..4bb3effe5 --- /dev/null +++ b/migrations/versions/4bca517e56a0_.py @@ -0,0 +1,34 @@ +"""empty message + +Revision ID: 4bca517e56a0 +Revises: +Create Date: 2021-10-22 13:06:12.466269 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '4bca517e56a0' +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 a03b77288fcede2b747c9c3a6b18f49833284bcc Mon Sep 17 00:00:00 2001 From: Ivette Fernandez Date: Fri, 22 Oct 2021 13:29:45 -0500 Subject: [PATCH 04/10] added routes for reading one planet, reading all planets, and creating a planet --- app/routes.py | 85 ++++++++++++++++++++++++--------------------------- 1 file changed, 40 insertions(+), 45 deletions(-) diff --git a/app/routes.py b/app/routes.py index 91b0f1c11..f270878ce 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,57 +1,52 @@ -from flask import Blueprint, jsonify -import requests - -class Planet: - def __init__(self, id, name, description, moons): - self.id = id - self.name = name - self.description = description - self.moons = moons - -planets = [ - Planet(1, "Mercury", "Rogue moon turned planet!", 0), - Planet(2, "Venus", "Hottest planet in our solar system ;-)", 0), - Planet(3, "Earth", "In her flop era", 1) -] +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request planets_bp = Blueprint("planets_bp", __name__, url_prefix="/planets") -@planets_bp.route("", methods=["GET"]) +@planets_bp.route("", methods=["POST", "GET"]) def handle_planets(): - planets_response = [] - for planet in planets: - planets_response.append( - {"id" : planet.id, - "name" : planet.name, - "description" : planet.description, - "moons" : planet.moons, - } - ) - - return jsonify(planets_response) - -@planets_bp.route("/", methods=["GET"]) -def handle_planet(id): - id = int(id) - for planet in planets: - if planet.id == id: - return { + if request.method == "GET": + planets = Planet.query.all() + planets_response = [] + for planet in planets: + planets_response.append({ "id" : planet.id, "name" : planet.name, "description" : planet.description, "moons" : planet.moons, - } + }) + return jsonify(planets_response) -def get_response(planet): - path = "https://api.le-systeme-solaire.net/rest/bodies/" + elif request.method == "POST": + request_body = request.get_json() + new_planet = Planet(name=request_body["name"], description=request_body["description"], moons=request_body["moons"]) - query_params = { - "filter[]" : f"englishName,eq,{planet}" - } + db.session.add(new_planet) + db.session.commit() - response = requests.get(path, params=query_params).json() - print(response) - print() + return make_response(f"Planet {new_planet.name} was successfully created", 201) -get_response("mars") -get_response("venus") +@planets_bp.route("/", methods=["GET"]) +def handle_planet(id): + planet = Planet.query.get(id) + return { + "id" : planet.id, + "name" : planet.name, + "description" : planet.description, + "moons" : planet.moons, + } + +# def get_response(planet): +# path = "https://api.le-systeme-solaire.net/rest/bodies/" + +# query_params = { +# "filter[]" : f"englishName,eq,{planet}" +# } + +# response = requests.get(path, params=query_params).json() +# print(response) +# print() + +# get_response("mars") +# get_response("venus") From 6c9e684e4f4e1d9d9b9bc2f922f19e991b0a639f Mon Sep 17 00:00:00 2001 From: Asli Athman Date: Mon, 25 Oct 2021 17:25:49 -0400 Subject: [PATCH 05/10] successfully added 'put' and 'delete' endpoints --- app/routes.py | 33 ++++++++++++++++++++++++++------- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/app/routes.py b/app/routes.py index f270878ce..4e2e6bd12 100644 --- a/app/routes.py +++ b/app/routes.py @@ -27,15 +27,34 @@ def handle_planets(): return make_response(f"Planet {new_planet.name} was successfully created", 201) -@planets_bp.route("/", methods=["GET"]) +@planets_bp.route("/", methods=["GET", "PUT", "DELETE"]) def handle_planet(id): planet = Planet.query.get(id) - return { - "id" : planet.id, - "name" : planet.name, - "description" : planet.description, - "moons" : planet.moons, - } + + 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() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.moons = request_body["moons"] + + db.session.commit() + + return jsonify(f"Planet {planet.name} successfully updated!"), 200 + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + + return jsonify(f"Planet {planet.name} successfully deleted!"), 200 + + # def get_response(planet): # path = "https://api.le-systeme-solaire.net/rest/bodies/" From ccd899dbcecfdf864bf39d710acb85a79658f528 Mon Sep 17 00:00:00 2001 From: Asli Athman Date: Tue, 26 Oct 2021 23:26:14 -0400 Subject: [PATCH 06/10] modified /id get, put, delete endpoints to respond 404 when non-existent data is called --- app/routes.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/app/routes.py b/app/routes.py index 4e2e6bd12..36f4a71b7 100644 --- a/app/routes.py +++ b/app/routes.py @@ -30,7 +30,9 @@ def handle_planets(): @planets_bp.route("/", methods=["GET", "PUT", "DELETE"]) def handle_planet(id): planet = Planet.query.get(id) - + if planet is None: + return jsonify(f"Error: Plannet #{id} not found"), 404 + if request.method == "GET": return { "id" : planet.id, From 18c71c872b7beab444daf2fb245fece269d52f2f Mon Sep 17 00:00:00 2001 From: Asli Athman Date: Wed, 27 Oct 2021 14:17:45 -0400 Subject: [PATCH 07/10] test setup, env variables, created get planet with no records test + passed --- app/__init__.py | 13 +++++++++++-- tests/__init__.py | 0 tests/conftest.py | 21 +++++++++++++++++++++ tests/test_routes.py | 7 +++++++ 4 files changed, 39 insertions(+), 2 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 b21dac6a2..d55056013 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,6 +1,8 @@ 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() @@ -8,9 +10,16 @@ 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) 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..e660f42f2 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,21 @@ +from app.models.planet import Planet +import pytest +from app import create_app +from app import db + +@pytest.fixture +def app(): + app = create_app({"TESTING":True}) + + with app.app_context(): + db.create_all() + yield app + + with app.app_context(): + db.drop_all() + +@pytest.fixture +def client(app): + return app.test_client() + + diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..f100f380e --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,7 @@ +def test_get_planet_with_no_records(client): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] + From 609f986af6fdf123a278730574ab6205d61132ef Mon Sep 17 00:00:00 2001 From: Asli Athman Date: Wed, 27 Oct 2021 20:13:42 -0400 Subject: [PATCH 08/10] added the rest of the tests, all passing --- app/routes.py | 4 ++-- tests/conftest.py | 8 +++++++ tests/test_routes.py | 51 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 61 insertions(+), 2 deletions(-) diff --git a/app/routes.py b/app/routes.py index 36f4a71b7..510e1f8c5 100644 --- a/app/routes.py +++ b/app/routes.py @@ -25,13 +25,13 @@ def handle_planets(): db.session.add(new_planet) db.session.commit() - return make_response(f"Planet {new_planet.name} was successfully created", 201) + return jsonify(f"Planet {new_planet.name} was successfully created"), 201 @planets_bp.route("/", methods=["GET", "PUT", "DELETE"]) def handle_planet(id): planet = Planet.query.get(id) if planet is None: - return jsonify(f"Error: Plannet #{id} not found"), 404 + return jsonify(f"Error: Planet #{id} not found"), 404 if request.method == "GET": return { diff --git a/tests/conftest.py b/tests/conftest.py index e660f42f2..ba0a35a93 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -18,4 +18,12 @@ def app(): def client(app): return app.test_client() +@pytest.fixture +def two_planets(app): + venus = Planet(name="venus", description="hottie w a body", moons=0) + earth = Planet(name="earth", description="in her flop era", moons=1) + + db.session.add_all([venus, earth]) + db.session.commit() + diff --git a/tests/test_routes.py b/tests/test_routes.py index f100f380e..cccf9bc45 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -1,3 +1,7 @@ +# from flask.wrappers import Response + +# ^ huh ?? why was this in my hello books code ? + def test_get_planet_with_no_records(client): response = client.get("/planets") response_body = response.get_json() @@ -5,3 +9,50 @@ def test_get_planet_with_no_records(client): assert response.status_code == 200 assert response_body == [] +def test_get_one_planet(client, two_planets): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == { + "id" : 1, + "name" : "venus", + "description" : "hottie w a body", + "moons" : 0 + } + +def test_get_one_planet_with_no_records(client): + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + assert response_body == "Error: Planet #1 not found" + +def test_get_all_planets(client, two_planets): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [ + { + "id" : 1, + "name" : "venus", + "description" : "hottie w a body", + "moons" : 0 + }, + { + "id" : 2, + "name" : "earth", + "description" : "in her flop era", + "moons" : 1 + } + ] + +def test_create_a_planet_when_none_exists(client): + response = client.post("/planets", json={"name" : "mars", "description" : "future mall of america", "moons" : 0}) + response_body = response.get_json() + + + assert response.status_code == 201 + assert response_body == "Planet mars was successfully created" + From 6d87ecbacbc033ef0030d6ac8be8d6fb3ac1c170 Mon Sep 17 00:00:00 2001 From: Asli Athman Date: Tue, 2 Nov 2021 10:59:27 -0400 Subject: [PATCH 09/10] added gunicorn to requirements.txt --- requirements.txt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/requirements.txt b/requirements.txt index fd90fffa8..09438102a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ alembic==1.5.4 +attrs==21.2.0 autopep8==1.5.5 certifi==2020.12.5 chardet==4.0.0 @@ -6,13 +7,20 @@ 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 +iniconfig==1.1.1 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==21.0 +pluggy==1.0.0 psycopg2-binary==2.8.6 +py==1.10.0 pycodestyle==2.6.0 +pyparsing==3.0.2 +pytest==6.2.5 python-dateutil==2.8.1 python-dotenv==0.15.0 python-editor==1.0.4 From 2b71bc66fb8120952088ee944aa904f3837fa5ef Mon Sep 17 00:00:00 2001 From: Asli Athman Date: Tue, 2 Nov 2021 13:53:34 -0400 Subject: [PATCH 10/10] added Procfile --- Procfile | 1 + 1 file changed, 1 insertion(+) 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()'