From aa0759e22bcc955f01a0ded2fe8b8f769e02d9d0 Mon Sep 17 00:00:00 2001 From: asya0107 Date: Fri, 15 Oct 2021 14:03:29 -0400 Subject: [PATCH 1/5] planets and instances --- app/routes.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..2b82b857a 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,14 @@ from flask import Blueprint + +class Planet: + def __init__(self, id, name, description, color): + self.planet_id = id + self.name = name + self.description = description + self.color = color + + +planets = [Planet(1, 'Mars', '3rd planet from the sun', 'Red'), Planet(2, 'Jupiter', 'the largest planet in our solar system', 'Blue'), Planet(3, 'Venus', '2nd closest to the sun', 'Pink')] + + From 9e5c8f1e3db0644a052a6161c161c79ec1e7b59f Mon Sep 17 00:00:00 2001 From: asya0107 Date: Mon, 18 Oct 2021 17:15:14 -0400 Subject: [PATCH 2/5] finished product of solar systems API --- app/__init__.py | 8 +++++++- app/routes.py | 32 +++++++++++++++++++++++++++++--- 2 files changed, 36 insertions(+), 4 deletions(-) diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..4891d62f5 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,13 @@ + + + + from flask import Flask -def create_app(test_config=None): +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 2b82b857a..5b87c442a 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,14 +1,40 @@ -from flask import Blueprint + + + + + + + + + +from flask import Blueprint, jsonify + +planets_bp = Blueprint('planets', __name__, url_prefix = '/planets') class Planet: def __init__(self, id, name, description, color): - self.planet_id = id + self.id = id self.name = name self.description = description self.color = color planets = [Planet(1, 'Mars', '3rd planet from the sun', 'Red'), Planet(2, 'Jupiter', 'the largest planet in our solar system', 'Blue'), Planet(3, 'Venus', '2nd closest to the sun', 'Pink')] - + +@planets_bp.route('', methods = ['GET']) +def get_all_planets(): + all_planets = [] + for planet in planets: + all_planets.append({'id': planet.id,'name': planet.name, 'description':planet.description, 'color': planet.color} ) + return jsonify(all_planets) + + +@planets_bp.route('/', methods = ['GET']) +def get_specific_planet(planet_name): + for planet in planets: + if planet.name == planet_name: + return {'id': planet.id,'name': planet.name, 'description':planet.description, 'color': planet.color} + + return 'Planet not found' \ No newline at end of file From e9ea65a13de0ad5b9083e53e7a20d97e54c8df5e Mon Sep 17 00:00:00 2001 From: Gabe Kelemen Date: Tue, 26 Oct 2021 15:48:48 -0400 Subject: [PATCH 3/5] update and delete --- app/__init__.py | 15 +++ app/models/__init__.py | 0 app/models/planet.py | 7 ++ app/routes.py | 61 +++++++++++- migrations/README | 1 + migrations/alembic.ini | 45 +++++++++ migrations/env.py | 96 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../fd6ab4fe0f5b_adds_planet_model.py | 34 +++++++ 9 files changed, 282 insertions(+), 1 deletion(-) 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/fd6ab4fe0f5b_adds_planet_model.py diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..784705c30 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,22 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate, 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) return app 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..f5f2515bc --- /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) + circum = db.Column(db.Integer) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..34b9c63b3 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,61 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, request, make_response +planets_bp = Blueprint('planets', __name__, url_prefix="/planets") + +@planets_bp.route("", methods=["POST", "GET"]) +def handle_all_planets(): + if request.method == "POST": + request_body = request.get_json() + new_planet = Planet(name=request_body["name"], description = request_body["description"], circum = request_body["circum"]) + + db.session.add(new_planet) + db.session.commit() + return make_response(f"Planet {new_planet.name} create", 201) + + elif 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, "circumference in mkm": planet.circum}) + return jsonify(planets_response) + + +@planets_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_one_planet(planet_name): + planet = Planet.query.get(planet_name) + + if planet is None: + return make_response(f"Error: Planet {planet_name} not found", 404) + + if request.method == "GET": + return {"id": planet.id, "name": planet.name, "description": planet.description, "circumference": planet.circum} + + elif request.method == "PUT": + request_body = request.get_json() + + if request_body is None: + return make_response(f"Error: Request requires name, description, and circumference", 400) + + elif "name" not in request_body or "description" not in request_body or "circum" not in request_body: + return make_response(f"Error: Request requires name, description, and circumference", 400) + + planet.name = request_body['name'] + planet.description = request_body["description"] + planet.circum = request_body["circum"] + + db.session.commit() + + return { + "id": planet.id, + "name": planet.name, + "description": planet.description + + }, 200 + + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + return f"{planet.name} was successfully deleted", 200 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/fd6ab4fe0f5b_adds_planet_model.py b/migrations/versions/fd6ab4fe0f5b_adds_planet_model.py new file mode 100644 index 000000000..c8a1308e8 --- /dev/null +++ b/migrations/versions/fd6ab4fe0f5b_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: fd6ab4fe0f5b +Revises: +Create Date: 2021-10-22 11:00:00.758779 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'fd6ab4fe0f5b' +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('circum', 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 88789937125288211a2633fd861bb9129390a4d7 Mon Sep 17 00:00:00 2001 From: Gabe Kelemen Date: Wed, 27 Oct 2021 12:11:02 -0400 Subject: [PATCH 4/5] adds test files --- app/__init__.py | 15 +++++++++++++-- app/routes.py | 3 ++- tests/__init__.py | 0 tests/conftest.py | 40 ++++++++++++++++++++++++++++++++++++++++ tests/test_routes.py | 24 ++++++++++++++++++++++++ 5 files changed, 79 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 784705c30..b39abb9d9 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,19 +1,30 @@ from flask import Flask from flask_sqlalchemy import SQLAlchemy from flask_migrate import Migrate, migrate +from dotenv import load_dotenv +import os db = SQLAlchemy() migrate = Migrate() +load_dotenv() def create_app(test_config=None): app = Flask(__name__) - app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False - app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development' + if not test_config: + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + "SQLALCHEMY_DATABASE_URI") + else: + app.config["TESTING"] = True + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( + "SQLALCHEMY_TEST_DATABASE_URI") db.init_app(app) migrate.init_app(app, db) + from app.models.planet import Planet from .routes import planets_bp diff --git a/app/routes.py b/app/routes.py index 34b9c63b3..a8059bac1 100644 --- a/app/routes.py +++ b/app/routes.py @@ -51,7 +51,8 @@ def handle_one_planet(planet_name): return { "id": planet.id, "name": planet.name, - "description": planet.description + "description": planet.description, + "circum": planet.circum }, 200 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..fcf16b808 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,40 @@ +import pytest +from app import create_app +from app import db +from apps.model.planet import Planet + + +@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() + + + + +@pytest.fixture +def two_saved_planets(app): + # Arrange + nine_planet = Planet(name="Planet Nine", + description="mysterious shadow planet", + circum= 10000) + pluto_planet = Planet(name="Pluto", + description="not named after a cartoon", + circum = 9000) + + db.session.add_all([nine_planet, pluto_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..69f63e9b0 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,24 @@ +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": "Planet Nine", + "description": "mysterious shadow planet", + "circum": 10000 + } \ No newline at end of file From bea0aa1e69703b8c65f610dd8f0d19f49137cbbd Mon Sep 17 00:00:00 2001 From: Gabe Kelemen Date: Wed, 27 Oct 2021 17:37:26 -0400 Subject: [PATCH 5/5] fixes error with pytest --- requirements.txt | 50 ++++++++++++++++++++++++-------------------- tests/conftest.py | 14 +++++-------- tests/test_routes.py | 2 +- 3 files changed, 33 insertions(+), 33 deletions(-) diff --git a/requirements.txt b/requirements.txt index fd90fffa8..33112d43b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,24 +1,28 @@ -alembic==1.5.4 -autopep8==1.5.5 -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 -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 +alembic==1.7.4 +attrs==20.3.0 +certifi==2021.10.8 +charset-normalizer==2.0.6 +click==8.0.3 +Flask==2.0.2 +Flask-Migrate==3.1.0 +Flask-SQLAlchemy==2.5.1 +greenlet==1.1.2 +idna==3.2 +iniconfig==1.1.1 +itsdangerous==2.0.1 +Jinja2==3.0.2 +Mako==1.1.5 +MarkupSafe==2.0.1 +packaging==20.8 +pluggy==0.13.1 +psycopg2-binary==2.9.1 +py==1.10.0 +pyparsing==2.4.7 +pytest==6.2.1 +python-dotenv==0.19.1 +requests==2.26.0 +SQLAlchemy==1.4.26 toml==0.10.2 -urllib3==1.26.4 -Werkzeug==1.0.1 +urllib3==1.26.7 +Werkzeug==2.0.2 +wonderwords==2.2.0 diff --git a/tests/conftest.py b/tests/conftest.py index fcf16b808..e441b3c60 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,7 +1,7 @@ import pytest from app import create_app from app import db -from apps.model.planet import Planet +from app.models.planet import Planet @pytest.fixture @@ -26,14 +26,10 @@ def client(app): @pytest.fixture def two_saved_planets(app): # Arrange - nine_planet = Planet(name="Planet Nine", - description="mysterious shadow planet", - circum= 10000) - pluto_planet = Planet(name="Pluto", - description="not named after a cartoon", - circum = 9000) - - db.session.add_all([nine_planet, pluto_planet]) + nine_planet = Planet(name="Planet Nine", description="mysterious shadow planet", circum= 10000) + pluto_planet = Planet(name="Pluto", description="not named after a cartoon", circum = 9000) + + db.session.add_all([nine_planet, pluto_planet]) # Alternatively, we could do # db.session.add(ocean_book) # db.session.add(mountain_book) diff --git a/tests/test_routes.py b/tests/test_routes.py index 69f63e9b0..6e12543f2 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -20,5 +20,5 @@ def test_get_one_planet(client, two_saved_planets): "id": 1, "name": "Planet Nine", "description": "mysterious shadow planet", - "circum": 10000 + "circumference": 10000 } \ No newline at end of file