diff --git a/.env b/.env new file mode 100644 index 000000000..19080225d --- /dev/null +++ b/.env @@ -0,0 +1,2 @@ +SQLALCHEMY_DATABASE_URI=postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_development +SQLALCHEMY_TEST_DATABASE_URI=postgresql+psycopg2://postgres:postgres@localhost:5432/solar_system_test diff --git a/.gitignore b/.gitignore index 4e9b18359..e2e92a9c5 100644 --- a/.gitignore +++ b/.gitignore @@ -107,13 +107,13 @@ celerybeat.pid # SageMath parsed files *.sage.py -# Environments -.env +# # Environments +# .env .venv -env/ +# env/ venv/ -ENV/ -env.bak/ +# ENV/ +# env.bak/ venv.bak/ # Spyder project settings 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..1e5bb9ed2 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 .routes import planets_bp + app.register_blueprint(planets_bp) + + from app.models.planet import Planet return app diff --git a/app/models/planet.py b/app/models/planet.py new file mode 100644 index 000000000..fa6f002d3 --- /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) + size_rank = db.Column(db.Integer) + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "size_rank": self.size_rank + } \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..c661b80d1 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,66 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, request, make_response, abort + +planets_bp = Blueprint("planets", __name__, url_prefix="/planets") + +#Helper functions +def valid_planet(planet_id): + try: + int(planet_id) + except: + abort(make_response({"error": "planet_id must be an int"}, 400)) + +def get_planet_from_id(planet_id): + valid_planet(planet_id) + selected_planet = Planet.query.get_or_404(planet_id) + return selected_planet + +# Routes +@planets_bp.route("", methods=["POST"], strict_slashes=False) +def add_planet(): + request_body = request.get_json() + new_planet = Planet( + name=request_body["name"], + description=request_body["description"], + size_rank=request_body["size_rank"] + ) + db.session.add(new_planet) + db.session.commit() + return make_response({"planet": new_planet.to_dict()}, 201) + +@planets_bp.route("", methods=["GET"], strict_slashes=False) +def get_all_planets(): + planet_objects = Planet.query.all() # returning list of objects + response_list = [] + for planet in planet_objects: + response_list.append(planet.to_dict()) + return make_response(jsonify(response_list), 200) + +# Routes for single planet +@planets_bp.route("/", methods=["GET"]) +def get_planet(planet_id): + selected_planet = get_planet_from_id(planet_id) + return make_response({"planet": selected_planet.to_dict()}, 200) + +@planets_bp.route("/", methods=["PATCH"]) +def update_planet(planet_id): + selected_planet = get_planet_from_id(planet_id) + request_body = request.get_json() + if "name" in request_body: + selected_planet.name = request_body["name"] + if "description" in request_body: + selected_planet.description = request_body["description"] + if "size_rank" in request_body: + selected_planet.size_rank = request_body["size_rank"] + db.session.commit() + return make_response(f"{selected_planet.name} updated", 200) + +@planets_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + selected_planet = get_planet_from_id(planet_id) + db.session.delete(selected_planet) + db.session.commit() + return make_response(f"{selected_planet.name} 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/9129fcb5000b_adds_planet_model.py b/migrations/versions/9129fcb5000b_adds_planet_model.py new file mode 100644 index 000000000..1ae08fcf7 --- /dev/null +++ b/migrations/versions/9129fcb5000b_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds Planet model + +Revision ID: 9129fcb5000b +Revises: +Create Date: 2021-10-25 13:59:20.565157 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '9129fcb5000b' +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('size_rank', 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 fd90fffa8..ffcfcb2eb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ alembic==1.5.4 +attrs==20.3.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==20.9 +pluggy==0.13.1 psycopg2-binary==2.8.6 +py==1.10.0 pycodestyle==2.6.0 +pyparsing==2.4.7 +pytest==6.2.3 python-dateutil==2.8.1 python-dotenv==0.15.0 python-editor==1.0.4 @@ -21,4 +29,4 @@ six==1.15.0 SQLAlchemy==1.3.23 toml==0.10.2 urllib3==1.26.4 -Werkzeug==1.0.1 +Werkzeug==1.0.1 \ No newline at end of file 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..111ba3895 --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,39 @@ +import pytest + +from app import create_app, db +from app.models.planet import Planet + +#app +@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() + +#client +@pytest.fixture +def client(app): + return app.test_client() + +#data +@pytest.fixture +def one_planet(app): + new_planet = Planet( + name="Jupiter", description="A planet in the Milky Way", size_rank=1) + db.session.add(new_planet) + db.session.commit() + +@pytest.fixture +def multiple_planets(app): + planet_one = Planet( + name="Jupiter", description="A planet in the Milky Way", size_rank=1) + planet_two = Planet( + name="Saturn", description="A planet in the Milky Way", size_rank=2) + db.session.add(planet_one) + db.session.add(planet_two) + db.session.commit() diff --git a/tests/test_routes.py b/tests/test_routes.py new file mode 100644 index 000000000..e4722a019 --- /dev/null +++ b/tests/test_routes.py @@ -0,0 +1,82 @@ +from app.models.planet import Planet + +def test_get_planets_returns_200_empty_array_when_db_is_empty(client): + # act + response = client.get("/planets") + + # assert + assert response.status_code == 200 + assert response.get_json() == [] + +def test_get_single_planet_returns_one_saved_planet(client, one_planet): + # act + response = client.get("/planets/1") + + # assert + assert response.status_code == 200 + assert response.get_json() == { + "planet": { + "id": 1, + "name": "Jupiter", + "description": "A planet in the Milky Way", + "size_rank": 1 + } + } + +def test_get_single_planet_with_empty_db_returns_404(client): + # act + response = client.get("/planets/1") + response_body = response.get_json() + + # assert + assert response.status_code == 404 + assert response.get_json() == None + + +def test_get_planets_with_valid_data_returns_correct_array(client, multiple_planets): + # act + response = client.get("/planets") + + # assert + assert response.status_code == 200 + assert response.get_json() == [ + { + "id": 1, + "name": "Jupiter", + "description": "A planet in the Milky Way", + "size_rank": 1 + }, + { + "id": 2, + "name": "Saturn", + "description": "A planet in the Milky Way", + "size_rank": 2 + } + ] + +def test_post_planet_with_JSON_request_body_returns_201(client): + # Act + response = client.post("/planets", json={ + "name": "Jupiter", + "description": "A planet in the Milky Way", + "size_rank": 1 + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert "planet" in response_body + assert response_body == { + "planet": { + "id": 1, + "name": "Jupiter", + "description": "A planet in the Milky Way", + "size_rank": 1 + } + } + new_planet = Planet.query.get(1) + assert new_planet + assert new_planet.id == 1 + assert new_planet.name == "Jupiter" + assert new_planet.description == "A planet in the Milky Way" + assert new_planet.size_rank == 1 \ No newline at end of file