diff --git a/.gitignore b/.gitignore index 4e9b18359..72d16b84c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.env .vscode .DS_Store diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..62e430aca --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..be4a741ca 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +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() +load_dotenv() def create_app(test_config=None): app = Flask(__name__) - return app + 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_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 planet_bp + app.register_blueprint(planet_bp) + + 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/planet.py b/app/models/planet.py new file mode 100644 index 000000000..ad07200a5 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,28 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + color = db.Column(db.String) + livability = db.Column(db.Integer) + moons = db.Column(db.Integer) + is_dwarf = db.Column(db.Boolean) + + def to_dict(self): + planet_as_dict = {} + planet_as_dict["id"] = self.id + planet_as_dict["name"] = self.name + planet_as_dict["color"] = self.color + planet_as_dict["livability"] = self.livability + planet_as_dict["moons"] = self.moons + planet_as_dict["is_dwarf"] = self.is_dwarf + return planet_as_dict + + @classmethod + def from_dict(cls, planet_data): + new_planet = Planet(name=planet_data["name"], + color=planet_data["color"], + moons=planet_data["moons"], + livability=planet_data["livability"], + is_dwarf=planet_data["is_dwarf"]) + return new_planet \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..c54676817 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,69 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, abort, make_response, request +planet_bp = Blueprint("planets", __name__, url_prefix="/planets") + +def validate_model(cls, model_id): + try: + model_id = int(model_id) + except: + abort(make_response({"message":f"the planet {cls.__name__} {model_id} is invalid, please search by planet_id."}, 400)) + + planet = cls.query.get(model_id) + + if not planet: + abort(make_response({"message":f"the planet {cls.__name__} {model_id} doesn't exist."}, 404)) + return planet + +@planet_bp.route("/", methods = ["GET"]) +def get_one_planet(model_id): + planet = validate_model(Planet, model_id) + # planet = cls.query.get(model_id) + return planet.to_dict() + +@planet_bp.route("", methods=["GET"]) +def get_all_planets(): + name_query = request.args.get("name") + if name_query: + planets = Planet.query.filter_by(name=name_query) + else: + planets = Planet.query.all() + + planet_response = [] + for planet in planets: + planet_response.append(planet.to_dict()) + return jsonify(planet_response) + +@planet_bp.route("", methods=["POST"]) +def create_new_planet(): + request_body = request.get_json() + new_planet = Planet.from_dict(request_body) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} successfully created", 201) + +@planet_bp.route("/", methods = ["PUT"]) +def update_planet(model_id): + planet = validate_model(Planet, model_id) + request_body = request.get_json() + + planet.name = request_body["name"], + planet.color = request_body["color"], + planet.moons = request_body["moons"], + planet.livability = request_body["livability"], + planet.is_dwarf = request_body["is_dwarf"] + + db.session.commit() + + return make_response(f"Planet #{model_id} successfully updated.") + +@planet_bp.route("/", methods = ["DELETE"]) +def delete_planet(model_id): + planet = validate_model(Planet, model_id) + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet #{model_id} successfully deleted.") diff --git a/app/tests/__init__.py b/app/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/tests/conftest.py b/app/tests/conftest.py new file mode 100644 index 000000000..4baf70fde --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,33 @@ +import pytest +from app import create_app +from app import db +from app.models.planet import Planet +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() + +@pytest.fixture +def saved_test_planets(app): + + test_planet1 = Planet(color= "pink", is_dwarf= True, livability= 3, moons= 99, name= "Pretend Planet X") + test_planet2 = Planet(color= "purple", is_dwarf= False, livability= 7.4, moons= 1, name= "Planet Pretend Z") + + db.session.add_all([test_planet1, test_planet2]) + db.session.commit() \ No newline at end of file diff --git a/app/tests/test_models.py b/app/tests/test_models.py new file mode 100644 index 000000000..bc98e3c67 --- /dev/null +++ b/app/tests/test_models.py @@ -0,0 +1,80 @@ +from app.models.planet import Planet + +def test_to_dict_no_missing_data(): + # Arrange + test_data = Planet( + id = 1, + color = "pink", + is_dwarf = True, + livability = 3, + moons = 99, + name = "Pretend Planet X") + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 6 + assert result["id"] == 1 + assert result["color"] == "pink" + assert result["livability"] == 3 + assert result["moons"] == 99 + assert result["name"] == "Pretend Planet X" + +def test_to_dict_missing_id(): + # Arrange + test_data = Planet( + color = "pink", + is_dwarf = True, + livability = 3, + moons = 99, + name = "Pretend Planet X") + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 6 + assert result["id"] is None + assert result["color"] == "pink" + assert result["livability"] == 3 + assert result["moons"] == 99 + assert result["name"] == "Pretend Planet X" + + + +def test_to_dict_missing_name(): + # Arrange + test_data = Planet(id = 1, + color = "pink", + is_dwarf = True, + livability = 3, + moons = 99) + + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 6 + assert result["id"] == 1 + assert result["color"] == "pink" + assert result["livability"] == 3 + assert result["moons"] == 99 + assert result["name"] is None + +def test_to_dict_missing_moons(): + # Arrange + test_data = Planet(id = 1, + color = "pink", + is_dwarf = True, + livability = 3, + name = "Pretend Planet X") + + # Act + result = test_data.to_dict() + + # Assert + assert len(result) == 6 + assert result["id"] == 1 + assert result["color"] == "pink" + assert result["livability"] == 3 + assert result["moons"] is None + assert result["name"] == "Pretend Planet X" \ No newline at end of file diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..ffa6d7451 --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,58 @@ +from app.models.planet import Planet + +def test_get_all_planets_in_database(client, saved_test_planets): + # Act + response = client.get('/planets') + response_body = Planet.query.all() + + # Assert + assert response.status_code == 200 + +def test_missing_planet_id(client): + # Act + response = client.get('planets/3') + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + +def test_get_planets_for_empty_database(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_by_id(client, saved_test_planets): + # Act + response = client.get('/planets/1') + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == {'id': 1, 'color': "pink", 'is_dwarf': True, 'livability': 3, 'moons': 99, 'name': "Pretend Planet X"} + +def test_create_one_new_planet(client): + # Act + EXPECTED_PLANET = { + "color": "green", + "is_dwarf": False, + "livability": 6, + "moons": 43, + "name": "New Pretend Planet Y", + } + + response = client.post("/planets", json=EXPECTED_PLANET) + response_body = response.get_data(as_text=True) + actual_planet = Planet.query.get(1) + + # Assert + assert response.status_code == 201 + assert response_body == f"Planet {EXPECTED_PLANET['name']} successfully created" + assert actual_planet.color == EXPECTED_PLANET["color"] + assert actual_planet.is_dwarf == EXPECTED_PLANET["is_dwarf"] + assert actual_planet.livability == EXPECTED_PLANET["livability"] + assert actual_planet.moons == EXPECTED_PLANET["moons"] + assert actual_planet.name == EXPECTED_PLANET["name"] \ No newline at end of file diff --git a/coworking_agreement.md b/coworking_agreement.md index 463598c27..acf3d64f3 100644 --- a/coworking_agreement.md +++ b/coworking_agreement.md @@ -21,5 +21,6 @@ Talk through each section with your partner. Add notes on what you discussed and *Other co-working agreements that were not captured in the above sections.* ## Signatures -______________ _______________ -Date: _________ +Leimomi Bong +Mishella Joy +Novemeber 2022 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/036c26fe57f3_.py b/migrations/versions/036c26fe57f3_.py new file mode 100644 index 000000000..5d03961ae --- /dev/null +++ b/migrations/versions/036c26fe57f3_.py @@ -0,0 +1,35 @@ +"""empty message + +Revision ID: 036c26fe57f3 +Revises: +Create Date: 2022-10-28 18:47:18.909945 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '036c26fe57f3' +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('color', sa.String(), nullable=True), + sa.Column('livability', sa.Integer(), 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 ### diff --git a/migrations/versions/65348fa233e7_add_is_dwarf_attribute.py b/migrations/versions/65348fa233e7_add_is_dwarf_attribute.py new file mode 100644 index 000000000..e412e64cd --- /dev/null +++ b/migrations/versions/65348fa233e7_add_is_dwarf_attribute.py @@ -0,0 +1,28 @@ +"""add is_dwarf attribute + +Revision ID: 65348fa233e7 +Revises: 036c26fe57f3 +Create Date: 2022-11-01 10:54:27.577573 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '65348fa233e7' +down_revision = '036c26fe57f3' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('is_dwarf', sa.Boolean(), nullable=True)) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column('planet', 'is_dwarf') + # ### end Alembic commands ### diff --git a/project-directions/wave_01.md b/project-directions/wave_01.md index a07cc6548..1793f76e3 100644 --- a/project-directions/wave_01.md +++ b/project-directions/wave_01.md @@ -1,6 +1,6 @@ # Wave 01: Setup and Read -## Flask Setup +## Flask Setup *HI THERE Perform following setup steps for the Solar System API repo to get started on this Flask project: 1. Create a virtual environment and activate it diff --git a/requirements.txt b/requirements.txt index fba2b3e38..517b98b2d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,19 +1,27 @@ alembic==1.5.4 +attrs==22.1.0 autopep8==1.5.5 blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==6.5.0 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.3 +pluggy==1.0.0 psycopg2-binary==2.9.4 +py==1.11.0 pycodestyle==2.6.0 +pyparsing==3.0.9 pytest==7.1.1 pytest-cov==2.12.1 python-dateutil==2.8.1 @@ -23,5 +31,6 @@ requests==2.25.1 six==1.15.0 SQLAlchemy==1.3.23 toml==0.10.2 +tomli==2.0.1 urllib3==1.26.4 Werkzeug==1.0.1