diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..f45009144 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,35 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from dotenv import load_dotenv +import os -def create_app(test_config=None): +db = SQLAlchemy() +migrate = Migrate() +load_dotenv() + +def create_app(testing=None): app = Flask(__name__) + + if testing is None: + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get("RENDER_DATABASE_URI") + else: + app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get('SQLALCHEMY_TEST_DATABASE_URI') + + app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False + db.init_app(app) + migrate.init_app(app, db) + + + from app.models.planet import Planet + from flask import Blueprint + from .routes import planets_bp + + + app.register_blueprint(planets_bp) return app + + + diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..e8f2e6e01 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,26 @@ +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) + distance_from_sun = db.Column(db.Integer) + + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "distance from sun": self.distance_from_sun + } + + @classmethod + def from_dict(cls, planet_details): + new_planet = cls( + name=planet_details["name"], + description=planet_details["description"], + distance_from_sun=planet_details["distance from sun"] + ) + return new_planet + diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..62516870b 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,113 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.planet import Planet + +# class Planet(): +# def __init__(self, id, name, description, distance_from_sun): +# self.id = id +# self.name = name +# self.description = description +# self.distance_from_sun = distance_from_sun + +# planet_list = [ +# Planet(1, "Mercury", "blue", 0.39), +# Planet(2, "Venus", "yellow", 0.72), +# Planet(3, "Earth", "blue", 1), +# Planet(4, "Mars", "orange", 1.52), +# Planet(5, "Jupiter", "orange", 5.2), +# Planet(6, "Saturn", "yellow", 9.54), +# Planet(7, "Uranus", "blue", 19.2), +# Planet(8, "Neptune", "blue", 30.06) +# ] + +def get_valid_item_by_id(model, id): + try: + id = int(id) + except: + abort(make_response({'msg': f"Invalid id '{id}'"}, 400)) + + item = model.query.get(id) + + return item if item else abort(make_response({'msg': f"No {model.__name__} with id {id}"}, 404)) + + + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + +@planets_bp.route("", methods=['POST']) +def create_planet(): + request_body = request.get_json() + new_planet = Planet.from_dict(request_body) + + db.session.add(new_planet) + db.session.commit() + + return ({ + "id": new_planet.id, + "name": new_planet.name, + "description": new_planet.description, + "distance from sun": new_planet.distance_from_sun, + "msg": "Successfully created" + }, 201) + + +@planets_bp.route("", methods=['GET']) +def get_planets(): + name_query = request.args.get("name") + if name_query: + planets = Planet.query.filter_by(name=name_query) + else: + planets = Planet.query.all() + + planets_response = [] + for planet in planets: + planets_response.append(planet.to_dict()) + + return jsonify(planets_response), 200 + + +@planets_bp.route("/", methods=["GET"]) +def get_one_planet(planet_id): + + planet = get_valid_item_by_id(Planet, planet_id) + + return ({ + "id": planet.id, + "name": planet.name, + "description": planet.description, + "distance from sun": planet.distance_from_sun + }), 200 + + +@planets_bp.route("/", methods=["PUT"]) +def update_one_planet(planet_id): + # Get the data from the request body + request_body = request.get_json() + + planet_to_update = get_valid_item_by_id(Planet, planet_id) + + planet_to_update.name = request_body["name"] + planet_to_update.description = request_body["description"] + planet_to_update.distance_from_sun = request_body["distance from sun"] + + db.session.commit() + + return ({ + "id": planet_to_update.id, + "name": planet_to_update.name, + "description": planet_to_update.description, + "distance from sun": planet_to_update.distance_from_sun + }), 200 + + + +@planets_bp.route("/", methods=["DELETE"]) +def delete_one_planet(planet_id): + planet_to_delete = get_valid_item_by_id(Planet, planet_id) + + db.session.delete(planet_to_delete) + db.session.commit() + + return f"Planet {planet_to_delete.name} is 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/beefc1e65a76_created_models_folder_and_added_planet_.py b/migrations/versions/beefc1e65a76_created_models_folder_and_added_planet_.py new file mode 100644 index 000000000..02d471620 --- /dev/null +++ b/migrations/versions/beefc1e65a76_created_models_folder_and_added_planet_.py @@ -0,0 +1,34 @@ +"""created models folder and added Planet model in planet.py + +Revision ID: beefc1e65a76 +Revises: +Create Date: 2023-04-27 14:14:25.328130 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'beefc1e65a76' +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('distance_from_sun', 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/requirements.txt b/requirements.txt index ae59e7b55..f4ff77124 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,14 +4,20 @@ blinker==1.4 certifi==2020.12.5 chardet==4.0.0 click==7.1.2 +coverage==7.2.3 +exceptiongroup==1.1.1 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 +iniconfig==2.0.0 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==23.1 +pluggy==1.0.0 psycopg2-binary==2.9.5 pycodestyle==2.6.0 pytest==7.3.1 @@ -23,5 +29,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 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..480fa8a7f --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,46 @@ +import pytest +from app import create_app +from app import db +from flask.signals import request_finished +from app.models.planet import Planet + + +# CREATE A NEW "TEST" APP +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + # CLOSE THE DATABASE SESSION + @request_finished.connect_via(app) + def expire_session(send, response, **extra): + db.session.remove() + + # AKA ARRANGE PORTION OF TESTING + # SET UP A DATABASE + with app.app_context(): + db.create_all() # RUN ALL THE MIGRATIONS + yield app + + # CLEAR DATABASE + with app.app_context(): + db.drop_all() + +# CREATE A NEW CLIENT TO SEND OUR REQUESTS +# AKA: creating a pytest version of Postman +@pytest.fixture +def client(app): + return app.test_client() + +@pytest.fixture +def two_planets(app): + planet_one = Planet(id=1, name="Furby", description="Purple", distance_from_sun=17) + planet_two = Planet(id=2, name="Squiggles", description="Orange", distance_from_sun=29) + + db.session.add(planet_one) + db.session.add(planet_two) + + + db.session.commit() + + + # we are working on writing tests portion of wave 6 of project. We need to create fixtures and unit tests \ No newline at end of file diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..cc8e72e28 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,67 @@ +def test_get_all_planets_with_empty_db_returns_empty_list(client): + # ARRANGE IS INSIDE CONFTEST + # ACT + response = client.get('/planets') + response_body = response.get_json() + + # ASSERT + assert response_body == [] + assert response.status_code == 200 + + +def test_get_one_planet_returns_correct_planet(client, two_planets): + # ACT + response = client.get('/planets/1') + response_body = response.get_json() + + # ASSERT + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Furby", + "description": "Purple", + "distance from sun": 17 + } + +def test_get_one_planet_empty_db_returns_404(client): + response = client.get("/planets/1") + assert response.status_code == 404 + + +def test_get_all_planets_returns_200(client, two_planets): + # ACT + response = client.get('/planets') + response_body = response.get_json() + + # ASSERT + assert response.status_code == 200 + assert response_body == [ + { + "id": 1, + "name": "Furby", + "description": "Purple", + "distance from sun": 17 + }, + { + "id": 2, + "name": "Squiggles", + "description": "Orange", + "distance from sun": 29 + }] + +def test_post_one_planet_creates_planet_in_db(client): + response = client.post("/planets", json={ + "name": "Earth", + "description": "Blue", + "distance from sun": 2 + } + ) + print ("testing") + response_body = response.get_json() + print(response_body) + assert response.status_code == 201 + + # print(response_body["name"]) + # assert response_body["id"] == + # assert response_body["name"] == "Earth" + # assert "msg" in response_body \ No newline at end of file