diff --git a/.gitignore b/.gitignore index 4e9b18359..30584e5c1 100644 --- a/.gitignore +++ b/.gitignore @@ -109,6 +109,7 @@ celerybeat.pid # Environments .env +.flaskend .venv env/ venv/ diff --git a/.planetsenv b/.planetsenv new file mode 100644 index 000000000..8064aaae8 --- /dev/null +++ b/.planetsenv @@ -0,0 +1,2 @@ +FLASK_ENV=development +FLASK_DEBUG=1 \ No newline at end of file diff --git a/app/__init__.py b/app/__init__.py index 70b4cabfe..16461c8db 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -1,7 +1,34 @@ +import os from flask import Flask +from flask_sqlalchemy import SQLAlchemy +from flask_migrate import Migrate +import sqlalchemy +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 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 .planets 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/planet.py b/app/models/planet.py new file mode 100644 index 000000000..142a20cc2 --- /dev/null +++ b/app/models/planet.py @@ -0,0 +1,7 @@ +from app import db + +class Planet(db.Model): + id = db.Column(db.Integer, primary_key=True, autoincrement=True) + name = db.Column(db.String) + color = db.Column(db.String) + description = db.Column(db.String) \ No newline at end of file diff --git a/app/planets.py b/app/planets.py new file mode 100644 index 000000000..3624170c9 --- /dev/null +++ b/app/planets.py @@ -0,0 +1,107 @@ +from flask import Blueprint,jsonify,abort,make_response,request +from app import db +from app.models.planet import Planet + + +if title_query: + title_query = title_query.filter_by(title=title_query) + + +planets_bp = Blueprint('planets_bp', __name__, url_prefix='/planets') + +@planets_bp.route('', methods=['GET']) +def handle_planet(): + planet_query = Planet.query + + + description_query = request.args.get("description") + + if description_query: + planet_query = planet_query.filter_by(description=description_query) + else: + planets = Planet.query.all() + + color_query = request.args.get("color") + if color_query: + planet_query = planet_query.filter_by(color=color_query) + else: + planets = Planet.query.all() + + name_query = request.args.get("name") + if name_query: + planet_query = planet_query.filter_by(name=name_query) + + planets = planet_query.all() + + + planets_response = [] + for planet in planets: + planets_response.append({ + "id": planet.id, + "name": planet.name, + "color": planet.color, + "description": planet.description + }) + + if not planets_response: + return make_response(jsonify(f"There are no {planet_query} planets")) + return jsonify(planets_response) + + board_response = [] + for board in boards: + board_response.append({ + "id": planet.id, + "name": planet.name, + "color": planet.color, + "description": planet.description + }) + + if not planets_response: + return make_response(jsonify(f"There are no {planet_query} planets")) + return jsonify(planets_response) + + +@planets_bp.route("/", methods=['GET','PUT','DELETE']) + +def handle_1_planet(id): + planet = Planet.query.get(id) + + + if request.method == "GET": + return{ + "id": planet.id, + "name": planet.name, + "color": planet.color, + "description": planet.description + } + elif request.method == "PUT": + request_body = request.get_json() + + planet.name = request_body["name"] + planet.color = request_body["color"] + planet.description = request_body["description"] + + + db.session.commit() + return make_response(f"planet color {planet.color} succesfully updated",200) + + elif request.method == "DELETE": + db.session.delete(planet) + db.session.commit() + + return make_response(f"planet color {planet.color} succesfully deleted", 200) + + + +@board_bp.route(/title, methods=["GET"]) +# GET /task/id +def handle_task(title): + # Query our db to grab the task that has the id we want: + + task = Task.query.get(title) + + if task.goal_id is not None: + return{"task": task.to_dict_in_goal()} + else: + return {"task": task.to_dict()} + diff --git a/app/routes.py b/app/routes.py index 8e9dfe684..ff2bd36a2 100644 --- a/app/routes.py +++ b/app/routes.py @@ -1,2 +1,4 @@ from flask import Blueprint + + 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..570194521 --- /dev/null +++ b/app/tests/conftest.py @@ -0,0 +1,56 @@ +import pytest +from app import create_app +from app import db +#create a new database session after a request as described below. +from flask.signals import request_finished +from app.models.planet import Planet + +# Create test versions of our flask app and database +@pytest.fixture +def app(): + app = create_app({"TESTING": True}) + + #will be invoked after any request is completed + @request_finished.connect_via(app) + def expire_session(sender, response, **extra): + db.session.remove() + + with app.app_context(): + # sets up database + db.create_all() + yield app + + with app.app_context(): + db.drop_all() + + +@pytest.fixture +def client(app): + # depends on app that references another fixture + # holds the reference to the test interface + return app.test_client() + +@pytest.fixture +def two_saved_planets(app): + # Arrange + blorp = Planet + { + "id": 2, + "name": 'Blorp', + "color": 'Purple', + "description": "Stinky" + } + florpus = Planet + { + "id": 3, + "name": 'Florpus', + "color": 'Red', + "description": "Shy" + } + db.session.add_all([blorp, florpus]) + # Alternatively, we could do + # db.session.add(winston) + # db.session.add(winter) + 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..9c5c22c42 --- /dev/null +++ b/app/tests/test_routes.py @@ -0,0 +1,80 @@ +from app.models.planet import Planet + +def test_get_all_planets_with_empty_db_return_empty_list(client): + + response = client.get('/planets') + response_body = response.get_json() + + assert response_body == [] + assert response.status_code == 200 + +def test_get_one_planet(client,two_saved_planets): + + response = client.get('/planets/2') + response_body = response.get_json() + + planet2 = { + 'id':2, + 'name': 'Blorp', + 'color': 'Purple', + 'description': 'Stinky' + } + + assert response.status_code == 200 + assert response_body == planet2 + +def test_no_data_return_failure(client): + + response = client.get("/planets/1") + response_body = response.get_json() + + assert response.status_code == 404 + +def test_return_array(client): +# Act + response = client.get("/planets") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert len(response_body) == 1 + assert response_body == [ + { + "id": 1, + "name": 'Dink', + "color": 'Green', + "description": 'Fluffy' + }, + { + "id": 2, + "name": 'Blorp', + "color": 'Purple', + "description": 'Stinky' + }, + { + "id": 3, + "name": 'Florpus', + "color": 'Red', + "description": 'Shy' + } + ] + +def test_request_body_json(client): +# Act + response = client.post("/planets", json={ + "name": "Cripper" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + + assert Planet.query.all() == [] + + + + +# 1. `GET` `/planets/1` returns a response body that matches our fixture +# 1. `GET` `/planets/1` with no data in test database (no fixture) returns a `404` +# 1. `GET` `/planets` with valid test data (fixtures) returns a `200` with an array including appropriate test data +# 1. `POST` `/planets` with a JSON request body returns a `201` \ 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/40e7b59395db_adds_planet_model.py b/migrations/versions/40e7b59395db_adds_planet_model.py new file mode 100644 index 000000000..86d454a1b --- /dev/null +++ b/migrations/versions/40e7b59395db_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds planet model + +Revision ID: 40e7b59395db +Revises: +Create Date: 2022-10-30 19:08:57.908052 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '40e7b59395db' +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('color', sa.String(), nullable=True), + sa.Column('description', 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/961ca395c403_adds_planet_model.py b/migrations/versions/961ca395c403_adds_planet_model.py new file mode 100644 index 000000000..e147fffa2 --- /dev/null +++ b/migrations/versions/961ca395c403_adds_planet_model.py @@ -0,0 +1,34 @@ +"""adds planet model + +Revision ID: 961ca395c403 +Revises: +Create Date: 2022-10-29 12:37:08.047362 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '961ca395c403' +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('color', sa.String(), nullable=True), + sa.Column('description', 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 ###