diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..c8b8fa16d 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,34 @@ 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__) + # 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.routes import bp + app.register_blueprint(bp) + return app diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..e880d568a --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,23 @@ +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) + composition = db.Column(db.String) + + @classmethod + def from_dict(cls, data_dict): + return cls( + name=data_dict["name"], + description=data_dict["description"], + composition=data_dict["composition"] + ) + + def to_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + composition=self.composition + ) \ No newline at end of file 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/routes.py b/app/routes/routes.py new file mode 100644 index 000000000..d7048c1e4 --- /dev/null +++ b/app/routes/routes.py @@ -0,0 +1,108 @@ +from flask import Blueprint, jsonify, make_response, request +from app.models.planet import Planet +from app import db +from .routes_helpers import validate_model + +# planets = [ +# Planet(1, "Mercury", "dark gray", "terrestrial"), +# Planet(2, "Venus", "light yellow", "terrestrial"), +# Planet(3, "Earth", "blue and green", "terrestrial"), +# Planet(4, "Mars", "red", "terrestrial"), +# Planet(5, "Jupiter", "orange and brown", "gas giant") +# ] + +bp = Blueprint("planets", __name__, url_prefix="/planets") +# @bp.route("",methods=["GET"]) + +# # helper function +# def validate_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# abort(make_response({"message": f"planet {planet_id} not valid"}, 400)) + +# planet = Planet.query.get(planet_id) + +# if not planet: +# abort(make_response({"message": f"planet {planet_id} not found"}, 404)) + +# return planet + +# routes +@bp.route("/", methods=["GET"]) +def get_one_planet(id): + planet = validate_model(Planet, id) + + return planet.to_dict(), 200 + +@bp.route("/", methods =["PUT"]) +def update_one_planet(id): + planet = validate_model(Planet,id) + request_body = request.get_json() + + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.composition = request_body["composition"] + + db.session.commit() + + return make_response(f"Planet {planet.name} successfully updated", 200) + +@bp.route("/", methods = ["DELETE"]) +def delete_one_planet(id): + planet = validate_model(Planet,id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet {planet.name} successfully deleted", 200) + +@bp.route("", methods=["POST"]) +def create_planet(): + request_body=request.get_json() + + # new_planet = Planet( + # name=request_body["name"], + # description=request_body["description"], + # composition=request_body["composition"] + # ) + 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) + +@bp.route("", methods=["GET"]) +def get_all_planets(): + planets = Planet.query.all() + planets_list = [] + for planet in planets: + planets_list.append(planet.to_dict()) + + return jsonify(planets_list), 200 + +# @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, +# "chemical composition": planet.composition +# }) +# return jsonify(planets_response) + +# def make_dict(planet): +# return dict( +# id = planet.id, +# name= planet.name, +# description= planet.description, +# composition= planet.composition +# ) + +# @bp.route("/", methods = ["GET"]) +# def handle_planet(planet_id): +# planet = validate_planet(planet_id) +# return make_dict(planet) \ No newline at end of file diff --git a/app/routes/routes_helpers.py b/app/routes/routes_helpers.py new file mode 100644 index 000000000..241ccb8bb --- /dev/null +++ b/app/routes/routes_helpers.py @@ -0,0 +1,16 @@ +from flask import abort, make_response + +# HELPER FUNCTION +def validate_model(cls, id): + try: + id = int(id) + except: + abort(make_response({"message": f"{id} was invalid"}, 400)) + + model = cls.query.get(id) + + if not model: + abort(make_response( + {"message": f"{cls.__name__} with id {id} was not found"}, 404)) + + return model \ No newline at end of file diff --git a/coworking_agreement.md b/coworking_agreement.md index 463598c27..36418c462 100644 --- a/coworking_agreement.md +++ b/coworking_agreement.md @@ -4,15 +4,19 @@ 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?* +Go slowly together through instructions, screen share as much as possible ## 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?* +Work independently, collaborate on zoom as much as needed ## Learning Style *How does each team member learn best in project settings?* +refer to Q2 ## Preferred Feedback Style *How does each team member best receive feedback?* +Included in the collabrating/discussion ## One Team Communication Skill to Improve *What is a teamwork-related skill you want to work on?* @@ -21,5 +25,5 @@ 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: _________ +Aisha Mohamed _______________ +Date: 4/24/23 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/52ece3cb3316_adds_planet_model.py b/migrations/versions/52ece3cb3316_adds_planet_model.py new file mode 100644 index 000000000..67df3b83d --- /dev/null +++ b/migrations/versions/52ece3cb3316_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: 52ece3cb3316 +Revises: +Create Date: 2023-04-28 13:43:39.794317 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '52ece3cb3316' +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('composition', sa.String(), 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/f8516ad14cf2_updates_planet_model.py b/migrations/versions/f8516ad14cf2_updates_planet_model.py new file mode 100644 index 000000000..6deed102a --- /dev/null +++ b/migrations/versions/f8516ad14cf2_updates_planet_model.py @@ -0,0 +1,34 @@ +"""updates planet model + +Revision ID: f8516ad14cf2 +Revises: 52ece3cb3316 +Create Date: 2023-05-04 16:57:29.569074 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'f8516ad14cf2' +down_revision = '52ece3cb3316' +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('composition', sa.String(), 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/seed.py b/seed.py new file mode 100644 index 000000000..480cb5b94 --- /dev/null +++ b/seed.py @@ -0,0 +1,13 @@ +from app import create_app, db +from app.models.planet import Planet + +my_app = create_app() +with my_app.app_context(): + db.session.add(Planet(name="Mercury", description="dark gray", composition="terrestrial")) + db.session.add(Planet(name="Venus", description="light yellow", composition="terrestrial")) + db.session.add(Planet(name="Earth", description="blue and green", composition="terrestrial")) + db.session.add(Planet(name="Mars", description="red", composition="terrestrial")) + db.session.add(Planet(name="Jupiter", description="orange and brown", composition="gas giant")) + + db.session.commit() + 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..3f9fdffe9 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,38 @@ +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): + first_planet = Planet(name="first planet", + description="the first one", + composition="first") + second_planet = Planet(name="second planet", + description="the second one", + composition="second") + + db.session.add_all([first_planet, second_planet]) + 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..d170cc842 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,65 @@ +#from werkzeug.exceptions import HTTPException +# from app.routes import validate_book +import pytest + +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_first_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": "first planet", + "description": "the first one", + "composition": "first" + } + +def test_get_first_planet_from_empty_database(client): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {'message': 'Planet with id 1 was not found'} + +def test_get_all_planets(client, two_saved_planets): + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [ + {"id": 1, + "name": "first planet", + "description": "the first one", + "composition": "first"}, + {"id": 2, + "name": "second planet", + "description": "the second one", + "composition": "second"} + ] + +def test_post_one_planet_returns_201(client): + # Act + response = client.post("/planets", json={ + "name": "new planet", + "description": "the new one", + "composition": "new" + }) + response_body = response.get_data(as_text=True) + + # Assert + assert response.status_code == 201 + assert response_body == "Planet new planet successfully created" \ No newline at end of file