Lynn Jansheski - Cheetahs

app/__init__.py

@@ -19,13 +19,15 @@ def create_app():
 
     # Import models here for Alembic setup
     # from app.models.ExampleModel import ExampleModel
+    from app.models.card import Card
+    from app.models.board import Board
 
     db.init_app(app)
     migrate.init_app(app, db)
 
     # Register Blueprints here
-    # from .routes import example_bp
-    # app.register_blueprint(example_bp)
+    from .routes import boards_bp
+    app.register_blueprint(boards_bp)
 
     CORS(app)
     return app

app/models/board.py

@@ -1 +1,25 @@
 from app import db
+from flask import abort, make_response
+
+
+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):
+        board_as_json = {}
+        board_as_json["id"] = self.board_id
+        board_as_json["title"] = self.title
+        board_as_json["owner"] = self.owner
+        return board_as_json
+
+    @classmethod
+    def from_json(cls, board_json):
+        if board_json.get("title") and board_json.get("owner"):
+            new_obj = cls(title=board_json["title"], owner=board_json["owner"])
+            return new_obj
+        else:
+            abort(make_response({"Invalid data": "Board title or owner's name cannot be blank"}, 400))
+

app/models/card.py

@@ -1 +1,25 @@
 from app import db
+from flask import abort, make_response
+
+
+class Card(db.Model):
+    card_id = db.Column(db.Integer, primary_key=True, autoincrement=True)
+    message = db.Column(db.String)
+    likes_count = db.Column(db.Integer)
+    board_id = db.Column(db.Integer, db.ForeignKey("board.board_id"), nullable=True)
+    board = db.relationship("Board", back_populates="cards")
+
+    def to_json(self):
+        card_as_json = {}
+        card_as_json["id"] = self.card_id
+        card_as_json["message"] = self.message
+        card_as_json["likes_count"] = self.likes_count
+        return card_as_json
+
+    @classmethod
+    def from_json(cls, card_json):
+        if "message" in card_json and len(card_json["message"]) <= 40:
+            new_obj = cls(message=card_json["message"])
+            return new_obj
+        else:
+            abort(make_response({"Invalid data": "Message cannot be blank or more than 40 characters"}, 400))

app/routes.py

@@ -1,4 +1,105 @@
-from flask import Blueprint, request, jsonify, make_response
+from flask import Blueprint, request, jsonify, abort, make_response
 from app import db
+from app.models.card import Card
+from app.models.board import Board
 
-# example_bp = Blueprint('example_bp', __name__)
+
+def get_one_obj_or_abort(cls, obj_id):
+    try:
+        obj_id = int(obj_id)
+    except ValueError:
+        abort(make_response({"message":f"Invalid {cls.__name__} ID: `{obj_id}`. ID must be an integer"}, 400))
+
+    matching_obj = cls.query.get(obj_id)
+
+    if not matching_obj:
+        abort(make_response({"message":f"{cls.__name__} with id `{obj_id}` was not found in the database."}, 404))
+
+    return matching_obj
+
+
+# **************************** CRUD ROUTES FOR BOARDS *****************************************
+
+boards_bp = Blueprint("boards", __name__, url_prefix="/boards")
+
+@boards_bp.route("", methods=["POST"])
+def add_board():
+    request_body = request.get_json()
+
+    new_board = Board.from_json(request_body)
+
+    db.session.add(new_board)
+    db.session.commit()
+
+    return {"board": new_board.to_json()}, 201
+
+
+@boards_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)
+
+
+@boards_bp.route("/<board_id>", methods=["GET"])
+def get_one_board(board_id):
+    chosen_board = get_one_obj_or_abort(Board, board_id)
+
+    board_json = chosen_board.to_json()
+
+    return jsonify(board_json), 200
+
+# ***************************** NESTED ROUTES FOR BOARDS AND CARDS *********************************
+
+@boards_bp.route("/<board_id>/cards", methods=["POST"])
+def add_board_card(board_id):
+    chosen_board = get_one_obj_or_abort(Board, board_id)
+    request_body = request.get_json()
+    new_card = Card.from_json(request_body)
+
+    new_card.board_id = chosen_board.board_id
+
+    db.session.add(new_card)
+    db.session.commit()
+
+    return {"card": new_card.to_json()}, 201
+
+
+@boards_bp.route("/<board_id>/cards", methods=["GET"])
+def get_board_cards(board_id):
+    chosen_board = get_one_obj_or_abort(Board, board_id)
+
+    cards_response = [card.to_json() for card in chosen_board.cards]
+
+    return jsonify({"chosen board id": chosen_board.board_id, "title": chosen_board.title, "chosen board cards": cards_response})
+
+
+@boards_bp.route("/cards/<card_id>", methods=["DELETE"])
+def delete_one_card(card_id):
+    # chosen_board = get_one_obj_or_abort(Board, board_id)
+
+    chosen_card = get_one_obj_or_abort(Card, card_id)
+
+    # card_to_delete = None
+
+    # for card in chosen_board.cards:
+    #     print(f"🌼 {card.__dict__}")
+    #     if chosen_card == card.card_id:
+    #         card_to_delete = card
+
+    db.session.delete(chosen_card)
+
+    db.session.commit()
+
+    return jsonify({"message": f"Successfully deleted card with id `{card_id}`"}), 200
+
+
+@boards_bp.route("/cards/<card_id>", methods=["GET"])
+def get_one_card(card_id):
+    chosen_card = get_one_obj_or_abort(Card, card_id)
+
+    card_json = chosen_card.to_json()
+
+    return jsonify(card_json), 200

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

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

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()

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"}

migrations/versions/1602f98994c8_adds_board_and_card_models.py

@@ -0,0 +1,40 @@
+"""adds Board and Card models
+
+Revision ID: 1602f98994c8
+Revises: 
+Create Date: 2022-12-23 07:07:46.653883
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '1602f98994c8'
+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('likes_count', sa.Integer(), nullable=True),
+    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 ###