diff --git a/.gitignore b/.gitignore index 4e9b18359..1f6919d4f 100644 --- a/.gitignore +++ b/.gitignore @@ -67,6 +67,7 @@ db.sqlite3-journal # Flask stuff: instance/ .webassets-cache +.flaskenv # Scrapy stuff: .scrapy diff --git a/Procfile b/Procfile new file mode 100644 index 000000000..62e430aca --- /dev/null +++ b/Procfile @@ -0,0 +1 @@ +web: gunicorn 'app:create_app()' \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..18f67aed7 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 planet_bp + app.register_blueprint(planet_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/planet.py b/app/models/planet.py new file mode 100644 index 000000000..43391ca0d --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,15 @@ +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) + type = db.Column(db.String) + + def create_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "type": self.type, + } \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..0b0b85b81 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,82 @@ -from flask import Blueprint +from flask import Blueprint, jsonify, make_response, request +from app.models.planet import Planet +from app import db + +planet_bp = Blueprint("planet_bp", __name__, url_prefix="/planets") + + +@planet_bp.route("", methods=["GET", "POST"]) +def handle_planets(): + if request.method == "GET": + name_from_url = request.args.get("name") + if name_from_url: + planets = Planet.query.filter_by(name=name_from_url).all() + if not planets: + planets = Planet.query.filter(Planet.name.contains(name_from_url)) + + else: + planets = Planet.query.all() + + planets_response = [] + for planet in planets: + planets_response.append(planet.create_dict()) + + if not planets_response: + planets = Planet.query.all() + for planet in planets: + planets_response.append(planet.create_dict()) + + return jsonify(planets_response) + + elif request.method == "POST": + request_body = request.get_json() + new_planet = Planet(name=request_body["name"], + description=request_body["description"], + type=request_body["type"], + ) + db.session.add(new_planet) + db.session.commit() + + # return make_response(new_planet.create_dict(), 201) + return jsonify(f"Planet with id:{new_planet.id} successfully created"), 201 + +@planet_bp.route("/", methods=["GET", "PUT", "DELETE", "PATCH"]) +def planet(planet_id): + planet = Planet.query.get(planet_id) + if not planet: + return jsonify(f"Error: Planet {planet_id} not found"), 404 + + if request.method == "GET": + return (planet.create_dict()) + + + elif request.method == "PUT": + form_data = request.get_json() + + planet.name = form_data["name"] + planet.description = form_data["description"] + planet.type = form_data["type"] + + db.session.commit() + return jsonify(f"Planet #{planet.id} successfully updated") + + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + return jsonify(f"Planet #{planet.id} successfully deleted") + + elif request.method == "PATCH": + request_body = request.get_json() + + if "name" in request_body: + planet.name = request_body["name"] + db.session.commit() + if "description" in request_body: + planet.description = request_body["description"] + db.session.commit() + if "type" in request_body: + planet.type = request_body["type"] + db.session.commit() + + return jsonify(f"Planet # {planet.id} succesfully updated") 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/c0591105be81_adds_planet_model.py b/migrations/versions/c0591105be81_adds_planet_model.py new file mode 100644 index 000000000..adf1801e1 --- /dev/null +++ b/migrations/versions/c0591105be81_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: c0591105be81 +Revises: +Create Date: 2021-11-02 14:22:57.158289 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'c0591105be81' +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('type', 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/requirements.txt b/requirements.txt index fd90fffa8..09438102a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ alembic==1.5.4 +attrs==21.2.0 autopep8==1.5.5 certifi==2020.12.5 chardet==4.0.0 @@ -6,13 +7,20 @@ 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 +iniconfig==1.1.1 itsdangerous==1.1.0 Jinja2==2.11.3 Mako==1.1.4 MarkupSafe==1.1.1 +packaging==21.0 +pluggy==1.0.0 psycopg2-binary==2.8.6 +py==1.10.0 pycodestyle==2.6.0 +pyparsing==3.0.2 +pytest==6.2.5 python-dateutil==2.8.1 python-dotenv==0.15.0 python-editor==1.0.4 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..6c00fe5f4 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,36 @@ +import pytest +from app import create_app +from app import db +from app.models.planet import Planet + + +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + 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 + planet_1 = Planet(name="Planet 1", + description="I'm planet 1", + type="gas giant") + planet_2 = Planet(name="Planet 2", + description="I'm planet 2", + type="gas giant") + + db.session.add(planet_1) + db.session.add(planet_2) + + 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..ea33b6f51 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,46 @@ +from app.models.planet import Planet + +def test_get_all_planets_when_none_exist(client): + response = client.get("/planets") + + response_body = response.get_json() + + assert response.status_code == 200 + assert response_body == [] + +def test_get_planet_1_when_none_exist(client): + response = client.get("/planets/1") + + response_body = response.get_json() + + assert response.status_code == 404 + assert response_body == "Error: Planet 1 not found" + +def test_get_all_planets_when_some_exist(client, two_saved_planets): + planet1 = dict(id=1, name="Planet 1", description="I'm planet 1", type="gas giant") + planet2 = dict(id=2, name="Planet 2", description="I'm planet 2", type="gas giant") + + response = client.get("/planets") + + response_body = response.get_json() + + assert response.status_code == 200 + assert len(response_body) == 2 + assert planet1 in response_body + assert planet2 in response_body + +def test_create_a_planet_when_none_exist(client): + # tried to use the self.create_dict method to return a full dictionary + # but could not get the tests to work + # data = {"name":"Planet 1", "description":"I'm planet 1", "type":"gas giant"} + # response = client.post("/planets", json=(data)) + # response_body = response.get_json() + + # assert response.status_code == 201 + # assert "Planet 1" in response_body + + response = client.post("/planets", json=({"name":"Planet 1", "description":"I'm planet 1", "type":"gas giant"})) + response_body = response.get_json() + + assert response.status_code == 201 + assert response_body == "Planet with id:1 successfully created" \ No newline at end of file