diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..2503b7c7c 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,36 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from dotenv import load_dotenv +import os +db = SQLAlchemy() # db and migrate are variables that gives us access to db operations +migrate = Migrate() + +load_dotenv() + def create_app(test_config=None): app = Flask(__name__) + + 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") + + # connects db & migrate to flask app + from app.models.planet import Planet + + db.init_app(app) + migrate.init_app(app, db) + + + from .routes import planet_bp + app.register_blueprint(planet_bp) - return app + 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/model.py b/app/models/model.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..2544b7f02 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,26 @@ +from app import db + + +# MODELS are classes that inherit from db.Model from sqlalchemy +class Planet(db.Model): # defining the planet model + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) # attribute title which will map to a db column + description = db.Column(db.String) + moons = db.Column(db.Integer) + + def to_dict(self): + return { + "name": self.name, + "description": self.description, + "moons": self.moons, + "id": self.id, + } + + @classmethod + def from_dict(cls, planet_data): + planet_1 = Planet( + name=planet_data["name"], + description=planet_data["description"], + moons=planet_data["moons"] + ) + return planet_1 \ No newline at end of file diff --git a/app/planets.py b/app/planets.py new file mode 100644 index 000000000..fd3eb84cf --- /dev/null +++ b/app/planets.py @@ -0,0 +1,50 @@ +# from flask import jsonify, abort, make_response + +# class Planet: +# def __init__(self, id, name, description): +# self.id = id +# self.name = name +# self.description = description + +# # instance = an instance of the object +# jupiter = Planet(id=1, name = "Jupiter", description = "hmmm i think its a big planet") +# mars = Planet(id= 2, name = "Mars", description="its close to the sun?") +# mercury = Planet(id = 3, name = "Mercury", description="also close to the planet?") +# venus = Planet(id= 4, name = "Venus", description = "this is aphrodite's planet?") +# earth = Planet(id=5, name = "Earth", description = "us!") +# saturn = Planet(id = 6, name = "Saturn", description = "this is the one with a lot of moons?") +# uranus = Planet(id = 7, name = "Uranus", description="I know literally nothing about this one") +# neptune = Planet(id = 8, name = "Neptune", description = "Poseidon's!") +# pluto = Planet(id = 9, name = "Pluto", description = "dont forget about me!" ) +# list_of_planets = [jupiter, mars, mercury, venus, earth, saturn, uranus, neptune, pluto] + +# def return_all_planets(): +# planets_json = [] +# for planet in list_of_planets: +# dict = { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description +# } +# planets_json.append(dict) +# return jsonify(planets_json) + +# def verify_planet(planet_id): +# try: +# planet_id = int(planet_id) +# except: +# abort(make_response ({"Message": f"Planet {planet_id} invalid."}, 400)) + +# for planet in list_of_planets: +# if planet.id == planet_id: +# return { +# "id": planet.id, +# "name": planet.name, +# "description": planet.description +# } +# abort(make_response({"Message": f"Planet {planet_id} not found."}, 404)) + + + + + diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..da882ce74 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,65 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request, abort + +planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") + +@planet_bp.route("", methods=["POST", "GET"]) +def handle_planets(): + if request.method == "POST": + request_body = request.get_json() + planet_1 = Planet.from_dict(request_body) + db.session.add(planet_1) + db.session.commit() + + return make_response(f"Planet {planet_1.name} successfully created", 201) + + elif request.method == "GET": + moons_param = request.args.get("moons") + if moons_param: + planets = Planet.query.filter_by(moons = moons_param) + else: + planets= Planet.query.all() + response_body = [planet.to_dict() for planet in planets] + return jsonify(response_body), 200 + + +def validate_id(id, cls): + try: + id = int(id) + except: + abort(make_response ({"Message": f"{cls.__name__} {id} invalid."}, 400)) + + # to access a planet with planet_id in our db, we use + obj = cls.query.get(id) + if not obj: + abort(make_response({"Message": f"{cls.__name__} {id} not found."}, 404)) + return obj + + +@planet_bp.route("/", methods=["GET", "PUT", "DELETE"]) +def handle_one_planet(planet_id): + planet = validate_id(planet_id, Planet) + if request.method == "GET": + return planet.to_dict() + + elif request.method == "PUT": + request_body = request.get_json() + + #updating the attributes + planet.name = request_body["name"] + planet.description = request_body["description"] + planet.moons = request_body["moons"] + + # commit changes to our db + db.session.commit() + + return make_response(f"Planet #{planet_id} is updated.") + + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet #{planet_id} is deleted.") + 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/48a8fe91a2d5_added_a_planet.py b/migrations/versions/48a8fe91a2d5_added_a_planet.py new file mode 100644 index 000000000..667f29770 --- /dev/null +++ b/migrations/versions/48a8fe91a2d5_added_a_planet.py @@ -0,0 +1,34 @@ +"""added a planet + +Revision ID: 48a8fe91a2d5 +Revises: +Create Date: 2022-10-28 14:11:25.119178 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '48a8fe91a2d5' +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('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/requirements.txt b/requirements.txt index fba2b3e38..b4dd0350e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,6 +7,7 @@ click==7.1.2 Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 +gunicorn==20.1.0 idna==2.10 itsdangerous==1.1.0 Jinja2==2.11.3 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..e926ba6db --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,41 @@ +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): + # Arrange + mars = Planet(name = "Mars", + description="no watr 4evr", + moons = 0) + jupiter = Planet(name="Jupiter", + description="i luv storms", + moons = 1) + + db.session.add_all([mars, jupiter]) + + db.session.commit() + diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..4d926b168 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,100 @@ +from werkzeug.exceptions import HTTPException +from app.routes import validate_id +from app.models.planet import Planet +import pytest + + +# 1. `POST` `/planets` with a JSON request body returns a `201` + +def test_get_planet_by_id(client, two_saved_planets): + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == { + "id": 1, + "name": "Mars", + "moons": 0, + "description": "no watr 4evr" + } + +def test_get_planet_by_id_empty(client): + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + + +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_all_planets(client, two_saved_planets): + response = client.get("/planets") + response_body = response.get_json() + assert response_body[0] == { + "id": 1, + "name": "Mars", + "moons": 0, + "description": "no watr 4evr" + } + assert response_body[1] == { + "id": 2, + "name": "Jupiter", + "moons": 1, + "description": "i luv storms" + } + +def test_get_query_param_planets(client, two_saved_planets): + # Act + response = client.get("/planets?moons=0") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body[0] == { + "id": 1, + "name": "Mars", + "moons": 0, + "description": "no watr 4evr" + } + + + +def test_post_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Earth", + "description": "The Best!", + "moons": 1 + }) + + # Assert + assert response.status_code == 201 + +def test_update_planet(client, two_saved_planets): + # Act + response = client.put("/planets/1", json = { + "name":"Mars2", + "description": "The Best!", + "moons": 1 + }) + assert response.status_code == 200 + +def test_delete_planet(client, two_saved_planets): + # Act + response = client.delete("/planets/1") + assert response.status_code == 200 + +def test_delete_planet_invalid_id(client, two_saved_planets): + # Act + response = client.delete("/planets/random") + assert response.status_code == 400