diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..831d45bf9 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__) - return app + 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 import planets_bp + app.register_blueprint(planets_bp) + + 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/planet.py b/app/models/planet.py new file mode 100644 index 000000000..f028c8c64 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,44 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String, nullable=False) + description = db.Column(db.String, nullable=False) + has_moons = db.Column(db.Boolean, nullable=False) + + required_attributes = { + "name":True, + "description":True, + "has_moons":True + } + # Instance methods: + + def self_to_dict(self): + return dict( + id=self.id, + name=self.name, + description=self.description, + has_moons=self.has_moons) + + def update_self(self, data_dict): + for key in data_dict.keys(): + if hasattr(self, key): + setattr(self, key, data_dict[key]) + else: + raise ValueError(key) + + + # Class methods + + @classmethod + def create_from_dict(cls, data_dict): + if data_dict.keys() == cls.required_attributes.keys(): + return cls( + name=data_dict["name"], + description = data_dict["description"], + has_moons = data_dict["has_moons"] + ) + else: + remaining_keys= set(data_dict.keys())-set(cls.required_attributes.keys()) + response=list(remaining_keys) + raise ValueError(response) \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..89a492322 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,114 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, abort, make_response, request +from app import db +from app.models.planet import Planet + + +# planets = [ +# Planet(1, "Arrakis", "A desert planet, source of Spice.", True), +# Planet(2, "Bela Tegeuse", "The fifth planet of Keuntsing.", False), +# Planet(3, "Tupile", "Sanctuary planet for defeated houses of the Imperium.", True), +# Planet(4, "Ix", "Supreme machine culture.", False) +# ] + +planets_bp = Blueprint("Planets", __name__, url_prefix="/planets") + +# Helper Functions: + +def error_message(message, status_code): + abort(make_response(jsonify(dict(details=message)), status_code)) + +def success_message(message, status_code=200): + return make_response(jsonify(dict(details=message)), status_code) + +def return_database_info(return_value): + return make_response(jsonify(return_value)) + +def get_planet_record_by_id(id): + try: + id = int(id) + except ValueError: + error_message(f"Invalid id: {id}", 400) + planet = Planet.query.get(id) + if planet: + return planet + else: + error_message(f"Planet id: {id} not found", 404) + +def discover_planet_safely(data_dict): + try: + return Planet.create_from_dict(data_dict) + except ValueError as err: + error_message(f"Invalid key(s):{err}. Planet not added to database.", 400) + except KeyError as err: + error_message(f"Missing key(s): {err}. Planet not added to database.", 400) + + +def update_planet_safely(planet, data_dict): + try: + planet.update_self(data_dict) + except ValueError as err: + error_message(f"Invalid key(s): {err}. Planet not updated.", 400) + except KeyError as err: + error_message(f"Missing key(s): {err}. Planet not updated.", 400) + + + + +# Route Functions: + +@planets_bp.route("", methods=["GET"]) +def get_all_planets(): + moon_param = request.args.get("has_moons") + description_param = request.args.get("description") + if moon_param: + planets = Planet.query.filter_by(has_moons=moon_param) + if description_param: + planets = Planet.query.filter(Planet.description.like('%'+description_param+'%')).all() + else: + planets = Planet.query.all() + + all_planets = [ + planet.self_to_dict() + for planet in planets + ] + return return_database_info(all_planets) + + +@planets_bp.route("/", methods=["GET"]) +def read_one_planet(planet_id): + planet = get_planet_record_by_id(planet_id) + return return_database_info(planet.self_to_dict()) + + +@planets_bp.route("", methods=["POST"]) +def discover_planet(): + request_body = request.get_json() + new_planet = discover_planet_safely(request_body) + + db.session.add(new_planet) + db.session.commit() + + return success_message(f"Planet {new_planet.name} successfully added to the Planets Database.", 201) + + +@planets_bp.route("/", methods=["PUT", "PATCH"]) +def update_planet_by_id(planet_id): + planet = get_planet_record_by_id(planet_id) + + request_body = request.get_json() + update_planet_safely(planet, request_body) + + db.session.commit() + + return return_database_info(planet.self_to_dict()) + + +@planets_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = get_planet_record_by_id(planet_id) + + db.session.delete(planet) + db.session.commit() + + return success_message(f"Planet {planet.name} successfully deleted from the Planets Database.") 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..7c6e67962 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,38 @@ +import pytest +from app import create_app +from app import db +from app.models.planet import Planet +from flask.signals import request_finished + + +@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 sample_data_with_two_planets(app): + ocean_planet = Planet(name="Ocean Planet", + description="It's wet!", + has_moons=True) + jungle_planet = Planet(name="Jungle Planet", + description="Full of big cats. And trees!", + has_moons=False) + + db.session.add_all([ocean_planet, jungle_planet]) + db.session.commit() \ No newline at end of file diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py new file mode 100644 index 000000000..f3b72db52 --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,73 @@ +def test_get_all_returns_200_and_empty_array(client): + response = client.get("/planets") + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] + + +def test_get_one_planet(client, sample_data_with_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":"Ocean Planet", + "description":"It's wet!", + "has_moons":True} + +def test_get_one_planet_without_data_returns_404(client): + # Act + response = client.get("/planets/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == {"details":"Planet id: 1 not found"} + +def test_get_all_planets(client, sample_data_with_two_planets): + # Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [{"id":1, + "name":"Ocean Planet", + "description":"It's wet!", + "has_moons":True}, + {"id":2, + "name":"Jungle Planet", + "description":"Full of big cats. And trees!", + "has_moons":False}] + +def test_create_a_planet(client): + # Act + response = client.post("/planets", json={ + "name":"Ice Planet", + "description":"Right next to Canada", + "has_moons":True + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == {"details":"Planet Ice Planet successfully added to the Planets Database."} + +def test_update_planet_patches_properly(client, sample_data_with_two_planets): + pre_patch_response = client.get("/planets/1") + pre_patch_response_body = pre_patch_response.get_json() + + response = client.patch("/planets/1", json={"description":"It's wet and full of fish."}) + response_body= response.get_json() + + assert response.status_code == 200 + assert response_body["description"] == "It's wet and full of fish." + assert response_body["name"] == pre_patch_response_body["name"] + assert response_body["has_moons"] == pre_patch_response_body["has_moons"] + assert response_body["id"] == pre_patch_response_body["id"] + assert response_body["description"] != pre_patch_response_body["description"] + + 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/9557fc207db6_created_planet_model.py b/migrations/versions/9557fc207db6_created_planet_model.py new file mode 100644 index 000000000..8345d0d0e --- /dev/null +++ b/migrations/versions/9557fc207db6_created_planet_model.py @@ -0,0 +1,34 @@ +"""Created Planet model + +Revision ID: 9557fc207db6 +Revises: +Create Date: 2022-04-29 14:16:42.315886 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '9557fc207db6' +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('desciption', sa.String(), nullable=False), + sa.Column('has_moons', sa.Boolean(), 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/migrations/versions/d67fb4735306_fixed_column_name.py b/migrations/versions/d67fb4735306_fixed_column_name.py new file mode 100644 index 000000000..0ad9a6eb0 --- /dev/null +++ b/migrations/versions/d67fb4735306_fixed_column_name.py @@ -0,0 +1,30 @@ +"""fixed column name + +Revision ID: d67fb4735306 +Revises: 9557fc207db6 +Create Date: 2022-04-29 15:49:55.683954 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'd67fb4735306' +down_revision = '9557fc207db6' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('description', sa.String(), nullable=False)) + op.drop_column('planet', 'desciption') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('desciption', sa.VARCHAR(), autoincrement=False, nullable=False)) + op.drop_column('planet', 'description') + # ### end Alembic commands ### diff --git a/touch b/touch new file mode 100644 index 000000000..e69de29bb