diff --git a/app/__init__.py b/app/__init__.py index 1c821436..18643a46 100644 --- a/app/__init__.py +++ b/app/__init__.py @@ -10,15 +10,23 @@ load_dotenv() -def create_app(): +def create_app(test_config=None): app = Flask(__name__) app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False - app.config["SQLALCHEMY_DATABASE_URI"] = os.environ.get( - "SQLALCHEMY_DATABASE_URI") + if test_config is None: + 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") + # Import models here for Alembic setup # from app.models.ExampleModel import ExampleModel + from app.models.board import Board + from app.models.card import Card db.init_app(app) migrate.init_app(app, db) @@ -26,6 +34,11 @@ def create_app(): # Register Blueprints here # from .routes import example_bp # app.register_blueprint(example_bp) + from .routes.board_routes import board_bp + app.register_blueprint(board_bp) + + from .routes.card_routes import card_bp + app.register_blueprint(card_bp) CORS(app) return app diff --git a/app/models/board.py b/app/models/board.py index 147eb748..2e6b6a7f 100644 --- a/app/models/board.py +++ b/app/models/board.py @@ -1 +1,26 @@ from app import db + + +class Board(db.Model): + board_id = db.Column(db.Integer, primary_key=True, autoincrement=True) + title = db.Column(db.String) + owner = db.Column(db.String) + cards = db.relationship("Card", back_populates="board", lazy=True) + + def to_json(self): + return { + "board_id": self.board_id, + "title": self.title, + "owner": self.owner, + # "cards": self.cards + # do we want to return an empty list of cards? + } + + @classmethod + def create(cls, request_body): + return cls(title=request_body["title"], owner=request_body["owner"]) + + # UPDATE BOARD + def update(self, request_body): + self.title = request_body["title"] + self.owner = request_body["owner"] diff --git a/app/models/card.py b/app/models/card.py index 147eb748..0e400f4d 100644 --- a/app/models/card.py +++ b/app/models/card.py @@ -1 +1,29 @@ from app import db +from flask import make_response, abort + + +class Card(db.Model): + card_id = db.Column(db.Integer, primary_key=True, autoincrement=True) + message = db.Column(db.String) + like_count = db.Column(db.Integer) + board_id = db.Column(db.Integer, db.ForeignKey('board.board_id')) + board = db.relationship("Board", back_populates="cards") + + def to_json(self): + return { + "id": self.card_id, + "message": self.message, + "like_count": self.like_count, + "board_id": self.board_id, + "board": self.board.title + } + + @classmethod + def create(cls, board_id, request_body): + if "message" not in request_body: + return abort(make_response({"message": "Must include message for card in request"}, 400)) + return cls(message=request_body["message"], board_id=board_id, like_count=0) + + # UPDATE Card + def update(self, request_body): + self.message = request_body["message"] diff --git a/app/routes.py b/app/routes.py deleted file mode 100644 index 480b8c4b..00000000 --- a/app/routes.py +++ /dev/null @@ -1,4 +0,0 @@ -from flask import Blueprint, request, jsonify, make_response -from app import db - -# example_bp = Blueprint('example_bp', __name__) diff --git a/app/routes/board_routes.py b/app/routes/board_routes.py new file mode 100644 index 00000000..9b546b96 --- /dev/null +++ b/app/routes/board_routes.py @@ -0,0 +1,91 @@ +from flask import Blueprint, request, jsonify, make_response +from app import db +from app.models.board import Board +from app.models.card import Card +from app.routes.helper import validate_class_instance + +# example_bp = Blueprint('example_bp', __name__) +board_bp = Blueprint('board_bp', __name__, url_prefix="/boards") + + +# ********* BOARD ********* +# CREATE new board +# CREATE BOARD - "/boards" - POST +@board_bp.route("", methods=["POST"]) +def create_board(): + request_body = request.get_json() + try: + new_board = Board.create(request_body) + except KeyError: + return make_response({"details": "Invalid data"}), 400 + + db.session.add(new_board) + db.session.commit() + + return jsonify({"board": new_board.to_json()}), 201 + + +# READ all boards +# GET ALL BOARDS - "/boards" - GET +@board_bp.route("", methods=["GET"]) +def get_all_boards(): + boards = Board.query.all() + boards_response = [board.to_json() for board in boards] + + return jsonify(boards_response), 200 + + +# READ one board +# GET ONE BOARDs - "/boards/1" - GET +@board_bp.route("/", methods=["GET"]) +def get_one_board(id): + board = validate_class_instance(id, Board) + + return jsonify({"board": board.to_json()}), 200 + + +# UPDATE cards +# UPDATE BAORD - "/boards/1" - PUT +@board_bp.route("/", methods=["PUT"]) +def update_board(id): + board = validate_class_instance(id, Board) + request_body = request.get_json() + board.update(request_body) + + db.session.commit() + + return jsonify({"board": board.to_json()}), 200 + + +# DELETE board +# UPDATE BAORD - "/boards/1" - DELETE +@board_bp.route("/", methods=["DELETE"]) +def delete_board(id): + board = validate_class_instance(id, Board) + + db.session.delete(board) + db.session.commit() + + return jsonify({"details": f'Board {id} "{board.title}" successfully deleted'}), 200 + + +# CREATE new card under board ID: +@board_bp.route("//cards", methods=["POST"]) +def create_card(board_id): + request_body = request.get_json() + + new_card = Card.create(board_id, request_body) + + db.session.add(new_card) + db.session.commit() + + return make_response({"card": new_card.to_json()}, 201) + + +# GET ALL cards for 1 board: +@board_bp.route("//cards", methods=["GET"]) +def get_all_cards(board_id): + board = validate_class_instance(board_id, Board) + cards = Card.query.filter_by(board=board) + + return jsonify([{"message": card.message, "like_count": card.like_count, "card_id": card.card_id, "board_id": card.board_id} for card in cards]), 200 diff --git a/app/routes/card_routes.py b/app/routes/card_routes.py new file mode 100644 index 00000000..6ab23274 --- /dev/null +++ b/app/routes/card_routes.py @@ -0,0 +1,48 @@ +from flask import Blueprint, request, jsonify +from app import db +from .helper import validate_class_instance +from ..models.card import Card + +# Blueprint: +card_bp = Blueprint('card_bp', __name__, url_prefix="/cards") + +# GET ONE card: + + +# @card_bp.route("/", methods=["GET"]) +# def get_one_card(id): +# card = validate(id, Card) + +# return jsonify({"card": card.to_json()}), 200 + +# UPDATE one card: +@card_bp.route("/", methods=["PATCH"]) +def update_card(id): + card = validate_class_instance(id, Card) + request_body = request.get_json() + card.update(request_body) + + db.session.commit() + + return jsonify({"card": card.to_json()}), 200 + + +# UPDATE likes for one card: +@card_bp.route("//like", methods=["PATCH"]) +def update_likes(id): + card = validate_class_instance(id, Card) + card.like_count += 1 + db.session.commit() + + return jsonify({"card": card.to_json()}), 200 + + +# DELETE card: +@card_bp.route("/", methods=["DELETE"]) +def delete_card(id): + card = validate_class_instance(id, Card) + + db.session.delete(card) + db.session.commit() + + return jsonify({"details": f"Card {id} successfully deleted"}), 200 diff --git a/app/routes/helper.py b/app/routes/helper.py new file mode 100644 index 00000000..73afafaa --- /dev/null +++ b/app/routes/helper.py @@ -0,0 +1,16 @@ +from flask import abort, make_response + + +def validate_class_instance(instance_id, cls): + try: + instance_id = int(instance_id) + except: + return abort(make_response({"message": f'{cls.__name__} {instance_id} is invalid'}, 400)) + + instance = cls.query.get(instance_id) + + if not instance: + abort(make_response( + {"message": f'{cls.__name__} {instance_id} not found'}, 404)) + + return instance diff --git a/migrations/README b/migrations/README new file mode 100644 index 00000000..98e4f9c4 --- /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 00000000..f8ed4801 --- /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 00000000..8b3fb335 --- /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 00000000..2c015630 --- /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/d799ee2b683f_initializing_models.py b/migrations/versions/d799ee2b683f_initializing_models.py new file mode 100644 index 00000000..e0942ba6 --- /dev/null +++ b/migrations/versions/d799ee2b683f_initializing_models.py @@ -0,0 +1,42 @@ +"""initializing models + +Revision ID: d799ee2b683f +Revises: +Create Date: 2022-06-27 19:59:39.131140 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'd799ee2b683f' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('board', + sa.Column('board_id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('title', sa.String(), nullable=True), + sa.Column('owner', sa.String(), nullable=True), + sa.PrimaryKeyConstraint('board_id') + ) + op.create_table('card', + sa.Column('card_id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('message', sa.String(), nullable=True), + sa.Column('like_count', sa.Integer(), nullable=True), + sa.Column('board_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['board_id'], ['board.board_id'], ), + sa.PrimaryKeyConstraint('card_id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('card') + op.drop_table('board') + # ### end Alembic commands ### diff --git a/tests/conftest.py b/tests/conftest.py index 2b7296d5..f03d11ec 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,6 +1,8 @@ import pytest from app import create_app from app import db +from app.models.board import Board +from app.models.card import Card @pytest.fixture @@ -20,3 +22,55 @@ def app(): @pytest.fixture def client(app): return app.test_client() + + +@pytest.fixture +def one_board(app): + new_board = Board( + title="Create new board", owner="Emily") + db.session.add(new_board) + db.session.commit() + + +@pytest.fixture +def all_boards(app): + board1 = Board( + title="Happy board", owner="Jande") + board2 = Board( + title="Winter board", owner="Emily") + board3 = Board( + title="Awesome board", owner="Ivana") + db.session.add_all([board1, board2, board3]) + db.session.commit() + + +# Fixtures for Cards +@pytest.fixture +def one_card(app): + new_card = Card( + message="New card") + db.session.add(new_card) + db.session.commit() + + +@pytest.fixture +def all_cards(app, one_board): + board = Board.query.first() + card1 = Card( + message="Jande's card") + card2 = Card( + message="Emily's card") + card3 = Card( + message="Ivana's card") + board.cards.append(card1) + board.cards.append(card2) + board.cards.append(card3) + db.session.commit() + + +@pytest.fixture +def one_card_belongs_to_one_board(app, one_board, one_card): + card = Card.query.first() + board = Board.query.first() + board.cards.append(card) + db.session.commit() diff --git a/tests/test_routes.py b/tests/test_routes.py index e69de29b..808420f4 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -0,0 +1,271 @@ +from app.models.board import Board +from app.models.card import Card +import pytest + + +def test_get_all_boards(client, all_boards): + # Act + response = client.get("/boards") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [ + {'board_id': 1, 'owner': 'Jande', 'title': 'Happy board'}, + {'board_id': 2, 'owner': 'Emily', 'title': 'Winter board'}, + {'board_id': 3, 'owner': 'Ivana', 'title': 'Awesome board'}] + + +def test_get_one_board(client, one_board): + response = client.get("/boards/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert "board" in response_body + assert response_body == { + "board": { + "board_id": 1, + "title": "Create new board", + "owner": "Emily", + } + } + + +def test_get_board_not_found(client): + # Act + response = client.get("/boards/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == { + "message": "Board 1 not found"} + + +def test_create_board(client): + # Act + response = client.post("/boards", json={ + "title": "Created a New Board", + "owner": "Emily", + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert "board" in response_body + assert response_body == { + "board": { + "board_id": 1, + "title": "Created a New Board", + "owner": "Emily", + } + } + + +def test_create_board_missing_title(client): + # Act + response = client.post("/boards", json={}) + response_body = response.get_json() + + # Assert + assert response.status_code == 400 + assert response_body == { + "details": "Invalid data" + } + + +def test_update_board(client, one_board): + # Act + response = client.put("/boards/1", json={ + "title": "Updated Board Title", + "owner": "Jande" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert "board" in response_body + assert response_body == { + "board": { + "board_id": 1, + "title": "Updated Board Title", + "owner": "Jande" + } + } + board = Board.query.get(1) + assert board.title == "Updated Board Title" + + +def test_update_board_not_found(client): + # Act + response = client.put("/boards/1", json={ + "title": "Updated Board Title" + }) + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == { + "message": "Board 1 not found"} + + +def test_delete_board(client, one_board): + # Act + response = client.delete("/boards/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert "details" in response_body + assert response_body == { + "details": 'Board 1 "Create new board" successfully deleted' + } + + +def test_delete_board_not_found(client): + # Act + response = client.delete("/boards/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == { + "message": "Board 1 not found"} + assert Board.query.all() == [] + + +# TESTS FOR CARDS +def test_get_all_cards_for_specific_board(client, one_card_belongs_to_one_board): + # Act + response = client.get("/boards/1/cards") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [ + { + "card_id": 1, + "message": "New card", + "like_count": None, + "board_id": 1, + } + ] + + +def test_get_cards_for_specific_board_without_cards(client, one_board): + # Act + response = client.get("/boards/1/cards") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert response_body == [] + + +def test_get_card_for_non_existent_board(client): + # Act + response = client.get("/boards/1/cards") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == { + "message": "Board 1 not found"} + + +def test_create_card_for_board_with_cards(client, one_card_belongs_to_one_board): + # Act + response = client.post("/boards/1/cards", json={"message": "New card"}) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == { + 'card': { + "board": 'Create new board', + "board_id": 1, + "id": 2, + "like_count": 0, + "message": "New card" + } + } + + +def test_create_card_for_board_with_no_cards(client, one_board): + # Act + response = client.post("/boards/1/cards", json={"message": "New card"}) + response_body = response.get_json() + + # Assert + assert response.status_code == 201 + assert response_body == { + 'card': { + "board": 'Create new board', + "board_id": 1, + "id": 1, + "like_count": 0, + "message": "New card" + } + } + + +def test_update_card_from_board(client, one_card_belongs_to_one_board): + # Act + response = client.patch( + "/cards/1", json={"message": "Updated card"}) + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert "card" in response_body + assert response_body == { + "card": { + "board": 'Create new board', + "board_id": 1, + "id": 1, + "like_count": None, + "message": "Updated card", + } + } + + card = Card.query.get(1) + assert card.message == "Updated card" + + +def test_update_card_from_board_card_not_found(client): + # Act + response = client.patch( + "/cards/1", json={"message": "Updated card"}) + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == { + "message": "Card 1 not found"} + + +def test_delete_card_from_board(client, all_cards): + # Act + response = client.delete("cards/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 200 + assert "details" in response_body + assert response_body == { + "details": "Card 1 successfully deleted" + } + assert Card.query.get(1) == None + + +def test_delete_card_from_board_card_not_found(client): + # Act + response = client.delete("cards/1") + response_body = response.get_json() + + # Assert + assert response.status_code == 404 + assert response_body == { + "message": "Card 1 not found"} + assert Card.query.all() == []