diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..f26e71da7 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,32 @@ 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 + + if not test_config: + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get( + "SQLALCHEMY_DATABASE_URI") + else: + app.config["TESTING"] = True + 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 planets_bp + app.register_blueprint(planets_bp) + return app diff --git a/app/models/__init__.py b/app/models/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/app/models/helpers.py b/app/models/helpers.py new file mode 100644 index 000000000..81ca10479 --- /dev/null +++ b/app/models/helpers.py @@ -0,0 +1,15 @@ +from flask import abort, make_response +from .planet import Planet + +def validate_planet(id): + try: + id = int(id) + except: + return abort(make_response({"message": f"planet {id} is invalid"}, 400)) + + planet = Planet.query.get(id) + + if not planet: + abort(make_response({"message": f"planet {id} not found"}, 404)) + + return planet diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..66c790987 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,31 @@ +from app import db +from flask import abort, make_response + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + description = db.Column(db.String) + circumference = db.Column(db.Integer) + length_of_year= db.Column(db.Integer) + + def to_json(self): + return { + "id" : self.id, + "name" : self.name, + "description" : self.description, + "circumference" : self.circumference, + "length_of_year" : self.length_of_year + } + + #update + def update(self, request_body): + self.name = request_body["name"] + self.description = request_body["description"] + self.circumference = request_body["circumference"] + self.length_of_year = request_body["length_of_year"] + + @classmethod + def create(cls, request_body): + new_planet = cls(name = request_body["name"], description = request_body["description"], circumference = request_body["circumference"], length_of_year = request_body["length_of_year"]) + + return new_planet diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..4edc8a2af 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,160 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.planet import Planet +from app.models.helpers import validate_planet + +planets_bp = Blueprint("planets", __name__, url_prefix = "/planets") + +# CREATE PLANET +@planets_bp.route("", methods = ["POST"]) +def create_planet(): + request_body = request.get_json() + + new_planet = Planet.create(request_body) + + db.session.add(new_planet) + db.session.commit() + + return jsonify(f"Planet {new_planet.name} has been successfully created"), 201 #use make response when you want to return something that is not json + +# GET ALL +@planets_bp.route("", methods = ["GET"]) +def get_all_planets(): + + days_query = request.args.get("length_of_year") + name_query = request.args.get("name") + description_query = request.args.get("description") + circumference_query = request.args.get("circumference") + + if days_query: + planets = Planet.query.filter_by(length_of_year = days_query) + elif name_query: + planets = Planet.query.filter_by(name = name_query) + elif description_query: + planets = Planet.query.filter_by(description = description_query) + elif circumference_query: + planets = Planet.query.filter_by(circumference = circumference_query) + else: + planets = Planet.query.all() + + planets_response = [] + + for planet in planets: + planets_response.append(planet.to_json()) + + return jsonify(planets_response) + +# GET ONE PLANET +@planets_bp.route("/", methods = ["GET"]) +def get_one_planet(id): + planet = validate_planet(id) + return jsonify(planet.to_json()), 200 + + + + + # { + # name: + # description: + # circumference: + # length_of_year: + # } + +#PUT or update ONE PLANET +@planets_bp.route("/", methods=["PUT"]) +def update_planet(id): + planet = validate_planet(id) + + request_body = request.get_json() + + planet.update(request_body) + # planet.name = request_body["name"] + # planet.description = request_body["description"] + # planet.circumference = request_body["circumference"] + # planet.length_of_year = request_body["length_of_year"] + + db.session.commit() + + return make_response(f"Planet #{id} succesffully updated"), 200 + +#MAKE PATCH REQUEST + +#DELETE ONE PLANET +@planets_bp.route("/", methods=["DELETE"]) +def delete_one_planet(id): + planet = validate_planet(id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet #{id} was successfully deleted"), 200 + # {"name": "Mercury", + # "description": "made mostly of rocks", + # "circumference": 9522, + # "length_of_year": 88 + # } + + + # { + # "name": Venus, + # "description": most like Earth, + # "circumference": 23617, + # "length_of_year": 225 + # } + + + # { + # "name": "Earth" + # "description": "you are here" + # "circumference": 24889 + # "length_of_year": 365 + # } + + + # { + # "name": "Mars", + # "description": "the red planet", + # "circumference": 13256, + # "length_of_year": 687 + # } + + + # { + # "name": "Jupiter", + # "description": "largest planet", + # "circumference": 278985, + # "length_of_year": 4320 + # } + + + # { + # "name": "Saturn", + # "description": "sun's bae with all 7 rings", + # "circumference": 235185, + # "length_of_year": 10620 + # } + + + # { + # "name": "Uranus", + # "description": "can only be seen with a telescope", + # "circumference": 99739, + # "length_of_year": 30240 + # } + + + # { + # "name": "Neptune", + # "description": "it is an intense blue color", + # "circumference": 96645, + # "length_of_year": 59400 + # } + + + # { + # "name": "Pluto", + # "description": "no dwarf in my book", + # "circumference": 7144, + # "length_of_year": 88920 + # } 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..5e3bae2d4 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,39 @@ +import pytest +from app.models.planet import Planet +from app import create_app +from app import db +from flask.signals import request_finished + + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + # everytime you finish a request this removes any saved data (like cleaning our a cache) + @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 + mercury = Planet(name="Mercury", + description="made mostly of rocks", circumference=9522, length_of_year = 88) + venus = Planet(name="Venus", + description="most like Earth", circumference=23617, length_of_year=225) + + db.session.add_all([mercury, venus]) + # Alternatively, we could do# db.session.add(mercury)# db.session.add(venus) + db.session.commit() diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..1722efcee --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,70 @@ + +def test_get_all_planets_successfully(client): + # Act + response = client.get("/planets") + # response has more than just json in it so we just want the json + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] # comparing to empty list bc we are in our test database + + + +def test_create_one_planet(client): + # Act + response = client.post("/planets", json={ + "name": "Goofy", + "description": "goofy", + "circumference": 1, + "length_of_year": 1 + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == "Planet Goofy has been successfully created" + +def test_get_one_planet_from_fixture_successfully(client, two_saved_planets): + #act + response = client.get("/planets/1") + + response_body = response.get_json() + #assert + assert response.status_code == 200 + assert response_body == {"name": "Mercury", + "description": "made mostly of rocks", + "circumference": 9522, + "length_of_year": 88, + "id": 1 + } + +def test_get_one_planet_with_no_data_returns_404(client): + #act + response = client.get("/planets/1") + + response_body = response.get_json() + #assert + assert response.status_code == 404 + assert response_body == {'message': 'planet 1 not found'} + +def test_get_planet_from_fixture_successfully(client, two_saved_planets): + #act + response = client.get("/planets") + + response_body = response.get_json() + #assert + assert response.status_code == 200 + assert response_body == [{"name": "Mercury", + "description": "made mostly of rocks", + "circumference": 9522, + "length_of_year": 88, + "id": 1 + }, + { + "name": "Venus", + "description": "most like Earth", + "circumference": 23617, + "length_of_year": 225, + 'id': 2, + }] \ No newline at end of file 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/23a4d026f209_adds_planet_model.py b/migrations/versions/23a4d026f209_adds_planet_model.py new file mode 100644 index 000000000..42d11d8ca --- /dev/null +++ b/migrations/versions/23a4d026f209_adds_planet_model.py @@ -0,0 +1,35 @@ +"""adds Planet model + +Revision ID: 23a4d026f209 +Revises: +Create Date: 2022-04-29 13:22:02.555439 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '23a4d026f209' +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('circumference', sa.Integer(), nullable=True), + sa.Column('length_of_year', 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/459fadb80120_.py b/migrations/versions/459fadb80120_.py new file mode 100644 index 000000000..ff7dba19a --- /dev/null +++ b/migrations/versions/459fadb80120_.py @@ -0,0 +1,35 @@ +"""empty message + +Revision ID: 459fadb80120 +Revises: +Create Date: 2022-04-30 03:27:32.186440 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '459fadb80120' +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('circumference', sa.Integer(), nullable=True), + sa.Column('length_of_year', 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 a506b4d12..9efd23f87 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ alembic==1.5.4 +attrs==21.4.0 autopep8==1.5.5 blinker==1.4 certifi==2020.12.5 @@ -8,12 +9,18 @@ Flask==1.1.2 Flask-Migrate==2.6.0 Flask-SQLAlchemy==2.4.4 idna==2.10 +importlib-metadata==4.11.3 +iniconfig==1.1.1 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==21.3 +pluggy==0.13.1 psycopg2-binary==2.8.6 +py==1.11.0 pycodestyle==2.6.0 +pyparsing==3.0.8 pytest==6.2.3 pytest-cov==2.12.1 python-dateutil==2.8.1 @@ -25,3 +32,4 @@ SQLAlchemy==1.3.23 toml==0.10.2 urllib3==1.26.4 Werkzeug==1.0.1 +zipp==3.8.0