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..1ce0506e9 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,37 @@ from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +from dotenv import load_dotenv +import os + +load_dotenv() + +db = SQLAlchemy() +migrate = Migrate() def create_app(test_config=None): app = Flask(__name__) + app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False + + if test_config is None: + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_DATABASE_URI') + else: + app.config['SQLALCHEMY_DATABASE_URI'] = os.environ.get('SQLALCHEMY_TEST_DATABASE_URI') + + + db.init_app(app) + migrate.init_app(app, db) + + + from .routes import solar_systems_bp + app.register_blueprint(solar_systems_bp) + + from app.models.planet import Planet + 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..05800d758 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,17 @@ +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) + color = db.Column(db.String) + distance = db.Column(db.String) + + def to_dict(self): + return { + "id": self.id, + "name": self.name, + "description": self.description, + "color": self.color, + "distance":self.distance + } \ No newline at end of file diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..72faeb8f0 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,103 @@ -from flask import Blueprint +from app import db +from app.models.planet import Planet +from flask import Blueprint, jsonify, make_response, request, abort + +solar_systems_bp = Blueprint("planets", __name__, url_prefix="/planets") + + +def valid_int(number,parameter_type): + try: + int(number) + except: + abort(make_response({"error": f"{parameter_type} must be an integer"},400)) + +def get_planet_from_id(planet_id): + valid_int(planet_id, "planet_id") + return Planet.query.get_or_404(planet_id, description = "{planet not found}") + +#Routes +@solar_systems_bp.route("", methods=["GET"]) +def read_all_planets(): + + distance_query = request.args.get("distance") + further_query = request.args.get("further") + sort_query = request.args.get("sort") + + + if distance_query: + valid_int(distance_query, "distance") + planets = Planet.query.filter_by(distance = distance_query) + elif further_query: + valid_int(further_query, "further") + planets = Planet.query.filter(Planet.distance > further_query) + elif sort_query == "asc": + planets = Planet.query.order_by(Planet.distance.asc()) + elif sort_query == "desc": + planets = Planet.query.order_by(Planet.distance.desc()) + else: + planets = Planet.query.all() + + + planets_response = [] + for planet in planets: + planets_response.append( + planet.to_dict() + ) + return jsonify(planets_response) + + +@solar_systems_bp.route("", methods=["POST"]) +def create_planets(): + request_body = request.get_json() + if "name" not in request_body or "color" not in request_body or "description" not in request_body or "distance" not in request_body: + return {"error": "incomplete request body"}, 400 + + + new_planet = Planet( + name=request_body["name"], + description=request_body["description"], + color=request_body["color"], + distance=request_body["distance"] + ) + + db.session.add(new_planet) + db.session.commit() + + return make_response(f"Planet {new_planet.name} successfully created", 201) + + +@solar_systems_bp.route("/", methods=["GET"]) +def read_planet(planet_id): + planet = get_planet_from_id(planet_id) + + return planet.to_dict() + + +@solar_systems_bp.route("/", methods=["PATCH"]) +def update_planet(planet_id): + planet = get_planet_from_id(planet_id) + request_body = request.get_json() + + if "name" in request_body: + planet.name = request_body["name"] + if "color" in request_body: + planet.color = request_body["color"] + if "description" in request_body: + planet.description = request_body["description"] + if "distance" in request_body: + planet.distance = request_body["distance"] + + + db.session.commit() + return jsonify(planet.to_dict()) + + +@solar_systems_bp.route("/", methods=["DELETE"]) +def delete_planet(planet_id): + planet = get_planet_from_id(planet_id) + + db.session.delete(planet) + db.session.commit() + + return make_response(f"Planet {jsonify(planet.to_dict())} successfully 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/0ea287c6ef5c_.py b/migrations/versions/0ea287c6ef5c_.py new file mode 100644 index 000000000..a7ba23c41 --- /dev/null +++ b/migrations/versions/0ea287c6ef5c_.py @@ -0,0 +1,34 @@ +"""empty message + +Revision ID: 0ea287c6ef5c +Revises: +Create Date: 2021-10-25 14:05:24.798398 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '0ea287c6ef5c' +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('color', 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/migrations/versions/6282beecfa6d_distance.py b/migrations/versions/6282beecfa6d_distance.py new file mode 100644 index 000000000..938906ed2 --- /dev/null +++ b/migrations/versions/6282beecfa6d_distance.py @@ -0,0 +1,28 @@ +"""distance + +Revision ID: 6282beecfa6d +Revises: 0ea287c6ef5c +Create Date: 2021-10-27 11:36:54.771525 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '6282beecfa6d' +down_revision = '0ea287c6ef5c' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('planet', sa.Column('distance', sa.String(), nullable=True)) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_column('planet', 'distance') + # ### end Alembic commands ### diff --git a/requirements.txt b/requirements.txt index fd90fffa8..cfdf74050 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 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..90e68965f --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,29 @@ +import pytest +from app import create_app, 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 one_planet(app): + new_planet = Planet( + color="light brown", description = "in betwen Mars and Saturn",distance = "5", name= "Jupiter") + db.session.add(new_planet) + db.session.commit() \ No newline at end of file diff --git a/tests/test_planet_routes.py b/tests/test_planet_routes.py new file mode 100644 index 000000000..353b997fa --- /dev/null +++ b/tests/test_planet_routes.py @@ -0,0 +1,28 @@ +from app.models.planet import Planet + + +def test_get_all_planets_returns_empty_list_when_db_is_empty(client): + #act + response = client.get("/planets") + + #assert + assert response.status_code == 200 + assert response.get_json() == [] + + +def test_get_one_planet_retuns_one_planet(client, one_planet): + response = client.get("/planets/1") + response_body = response.get_json() + + #assert + + assert response.status_code == 200 + # assert "planet" in response_body + assert response_body == { + "color": "light brown", + "description": "in betwen Mars and Saturn", + "distance": "5", + "id": 1, + "name": "Jupiter" + + } \ No newline at end of file