diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..fa7576a75 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,21 @@ from flask import Flask +from .db import db, migrate +from .models import planet +from .routes.planet_routes import planets_bp +import os -def create_app(test_config=None): +def create_app(config=None): app = Flask(__name__) + + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI') + if config: + app.config.update(config) + + db.init_app(app) + migrate.init_app(app, db) + + app.register_blueprint(planets_bp) return app diff --git a/app/db.py b/app/db.py new file mode 100644 index 000000000..3ada8d10c --- /dev/null +++ b/app/db.py @@ -0,0 +1,6 @@ +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from .models.base import Base + +db = SQLAlchemy(model_class=Base) +migrate = Migrate() \ 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/base.py b/app/models/base.py new file mode 100644 index 000000000..227841686 --- /dev/null +++ b/app/models/base.py @@ -0,0 +1,4 @@ +from sqlalchemy.orm import DeclarativeBase + +class Base(DeclarativeBase): + pass \ No newline at end of file diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..6319ebe2e --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,16 @@ +from sqlalchemy.orm import Mapped, mapped_column +from ..db import db + +class Planet(db.Model): + id: Mapped[int] = mapped_column(primary_key=True, autoincrement=True) + name: Mapped[str] + description: Mapped[str] + galaxy: Mapped[str] + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "galaxy": self.galaxy + } diff --git a/app/routes.py b/app/routes.py deleted file mode 100644 index 8e9dfe684..000000000 --- a/app/routes.py +++ /dev/null @@ -1,2 +0,0 @@ -from flask import Blueprint - diff --git a/app/routes/__init__.py b/app/routes/__init__.py new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/app/routes/__init__.py @@ -0,0 +1 @@ + diff --git a/app/routes/planet_routes.py b/app/routes/planet_routes.py new file mode 100644 index 000000000..56227b0c0 --- /dev/null +++ b/app/routes/planet_routes.py @@ -0,0 +1,88 @@ +from flask import Blueprint, make_response, abort, request, Response +from app.models.planet import Planet +from ..db import db + +planets_bp = Blueprint("planets_bp",__name__,url_prefix="/planets") + +@planets_bp.post("") +def create_planet(): + request_body = request.get_json() + name = request_body["name"] + description = request_body["description"] + galaxy = request_body["galaxy"] + + new_planet = Planet(name=name, description=description, galaxy=galaxy) + db.session.add(new_planet) + db.session.commit() + + response = new_planet.to_dict() + + return response, 201 + + +@planets_bp.get("") +def get_all_planets(): + + query = db.select(Planet) + description_param = request.args.get("description") + if description_param: + query = query.where(Planet.description.ilike(f"%{description_param}%")) + + galaxy_param = request.args.get("galaxy") + if galaxy_param: + query = query.where(Planet.galaxy.ilike(f"%{galaxy_param}%")) + + #query = query.order_by(Planet.id) + planets = db.session.scalars(query.order_by(Planet.id)) + + planets_response = [] + for planet in planets: + planets_response.append(planet.to_dict()) + return planets_response + +@planets_bp.get("/") +def get_one_planet(planet_id): + planet = validate_planet(planet_id) + return planet.to_dict() + +@planets_bp.get("/count") +def get_count(): + query = db.session.query(Planet.name).count() + return {"count" : query} + +@planets_bp.put("/") +def update_planet(planet_id): + planet = validate_planet(planet_id) + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.galaxy = request_body["galaxy"] + + db.session.commit() + + return Response(status=204, mimetype="application/json") + +@planets_bp.delete("/") +def delete_planet(planet_id): + planet = validate_planet(planet_id) + db.session.delete(planet) + db.session.commit() + + return Response(status=204, mimetype="application/json") + +def validate_planet(planet_id): + try: + planet_id = int(planet_id) + except: + response = {"message": f"{planet_id} is not valid"} + abort(make_response(response, 400)) + + query = db.select(Planet).where(Planet.id == planet_id) + planet = db.session.scalar(query) + + if not planet: + response = {"message": f"{planet_id} is not found"} + abort(make_response(response, 404)) + + return planet diff --git a/coworking_agreement.md b/coworking_agreement.md index 463598c27..811de5019 100644 --- a/coworking_agreement.md +++ b/coworking_agreement.md @@ -5,21 +5,32 @@ Talk through each section with your partner. Add notes on what you discussed and ## Accessibility Needs *What does each team member need access to in order to succeed and show up the best they can?* + +Flexibility and schedule. + ## Collaboration vs. individual work expectations *Clarify your collaboration expectations- does your group want to write code together all of the time? Or divide work to do independently, then come together to share accomplishments? What tools and technologies can help your collaboration?* +Group work & indepent work for best practice. ## Learning Style *How does each team member learn best in project settings?* +Practicing + ## Preferred Feedback Style *How does each team member best receive feedback?* +Open to feedback. Meetings/slack + ## One Team Communication Skill to Improve *What is a teamwork-related skill you want to work on?* +Communication skill ## Optional: Other agreements *Other co-working agreements that were not captured in the above sections.* ## Signatures -______________ _______________ +______________ _____Wei Qiang__________ +Date: ___2024/10/18______ +_Beenish Ali____________ _______________ Date: _________ 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..4c9709271 --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,113 @@ +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') + + +def get_engine(): + try: + # this works with Flask-SQLAlchemy<3 and Alchemical + return current_app.extensions['migrate'].db.get_engine() + except (TypeError, AttributeError): + # this works with Flask-SQLAlchemy>=3 + return current_app.extensions['migrate'].db.engine + + +def get_engine_url(): + try: + return get_engine().url.render_as_string(hide_password=False).replace( + '%', '%%') + except AttributeError: + return str(get_engine().url).replace('%', '%%') + + +# 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', get_engine_url()) +target_db = current_app.extensions['migrate'].db + +# 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 get_metadata(): + if hasattr(target_db, 'metadatas'): + return target_db.metadatas[None] + return target_db.metadata + + +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=get_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.') + + conf_args = current_app.extensions['migrate'].configure_args + if conf_args.get("process_revision_directives") is None: + conf_args["process_revision_directives"] = process_revision_directives + + connectable = get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=get_metadata(), + **conf_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/4286577df677_adds_planet_model.py b/migrations/versions/4286577df677_adds_planet_model.py new file mode 100644 index 000000000..6f116430e --- /dev/null +++ b/migrations/versions/4286577df677_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: 4286577df677 +Revises: +Create Date: 2024-10-28 16:40:56.310882 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '4286577df677' +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=False), + sa.Column('description', sa.String(), nullable=False), + sa.Column('galaxy', sa.String(), nullable=False), + 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/seed.py b/seed.py new file mode 100644 index 000000000..e69de29bb 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..ff71d4ee0 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,45 @@ +import pytest +from app import create_app +from app.db import db +from flask.signals import request_finished +from dotenv import load_dotenv +import os +from app.models.planet import Planet + +load_dotenv() + +@pytest.fixture +def app(): + test_config = { + "TESTING": True, + "SQLALCHEMY_DATABASE_URI": os.environ.get('SQLALCHEMY_TEST_DATABASE_URI') + } + app = create_app(test_config) + + @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): + earth = Planet(name="Earth", + description="A vibrant blue and green planet, known for its diverse ecosystems and human inhabitants.", + galaxy="Milky Way") + mars = Planet(name="Mars", + description="A cold, red planet with a thin atmosphere and known for its high mountains and deep valleys.", + galaxy="Milky Way") + + db.session.add_all([earth,mars]) + db.session.commit() \ No newline at end of file diff --git a/tests/test_planet_routes.py b/tests/test_planet_routes.py new file mode 100644 index 000000000..14495267f --- /dev/null +++ b/tests/test_planet_routes.py @@ -0,0 +1,96 @@ +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_with_no_records_returns_404(client): + #Act + response = client.get("/planets/1") + + #Assert + assert response.status_code == 404 + +def test_get_one_planet_with_records_successful(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": "A vibrant blue and green planet, known for its diverse ecosystems and human inhabitants.", + "galaxy":"Milky Way" + } + + +def test_get_all_planets_returns_all_records(client, two_saved_planets): + #Act + response = client.get("/planets") + response_body = response.get_json() + + #Assert + assert response.status_code == 200 + assert response_body == [{ + "id": 1, + "name": "Earth", + "description": "A vibrant blue and green planet, known for its diverse ecosystems and human inhabitants.", + "galaxy":"Milky Way" + }, + { + "id" : 2, + "name": "Mars", + "description": "A cold, red planet with a thin atmosphere and known for its high mountains and deep valleys.", + "galaxy": "Milky Way" + } + ] + +def test_create_one_planet_with_no_records(client): + #Act + response = client.post("/planets", json={ + "name": "Jupiter", + "description": "A massive gas giant with a prominent red spot and swirling clouds, the largest planet in the Solar System.", + "galaxy": "Milky Way" + }) + response_body = response.get_json() + + #Assert + assert response.status_code == 201 + assert response_body == { + "id" : 1, + "name": "Jupiter", + "description": "A massive gas giant with a prominent red spot and swirling clouds, the largest planet in the Solar System.", + "galaxy": "Milky Way" + } + +def test_create_one_planet_with_existing_records(client, two_saved_planets): + #Act + response = client.post("/planets", json={ + "name": "Jupiter", + "description": "A massive gas giant with a prominent red spot and swirling clouds, the largest planet in the Solar System.", + "galaxy": "Milky Way" + }) + response_body = response.get_json() + + #Assert + assert response.status_code == 201 + assert response_body == { + "id" : 3, + "name": "Jupiter", + "description": "A massive gas giant with a prominent red spot and swirling clouds, the largest planet in the Solar System.", + "galaxy": "Milky Way" + } + +def test_delete_one_planet_with_two_saved_planets(client, two_saved_planets): + response = client.delete("/planets/1") + count_response = client.get("/planets/count") + response_body = count_response.get_json() + + + assert response.status_code == 204 + assert response_body == {"count": 1} \ No newline at end of file