Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

S18 - Meowtains #41

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
5 changes: 4 additions & 1 deletion app/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
migrate = Migrate()
load_dotenv()


def create_app():
app = Flask(__name__)
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
Expand All @@ -18,6 +17,8 @@ def create_app():
"SQLALCHEMY_DATABASE_URI")

# Import models here for Alembic setup
from app.models.board import Board
from app.models.card import Card
# from app.models.ExampleModel import ExampleModel

db.init_app(app)
Expand All @@ -26,6 +27,8 @@ def create_app():
# Register Blueprints here
# from .routes import example_bp
# app.register_blueprint(example_bp)
from .routes import board_bp
app.register_blueprint(board_bp)

CORS(app)
return app
23 changes: 23 additions & 0 deletions app/models/board.py
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
from app import db
from app.models.card import Card

class Board(db.Model):
board_id = db.Column(db.Integer, primary_key=True, autoincrement=True, nullable=False)
title = db.Column(db.String)
owner = db.Column(db.String)
cards = db.relationship('Card', back_populates='board')

def dictionfy(self):
board_info = {
'id':self.board_id,
'title':self.title,
'owner':self.owner,
'cards':[]
}
for card in self.cards:
board_info['cards'].append(card.dictionfy())
return board_info

@classmethod
def create_board(cls,request_body):
return Board(title=request_body['title'], owner=request_body['owner'])

18 changes: 18 additions & 0 deletions app/models/card.py
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
from app import db

class Card(db.Model):
card_id = db.Column(db.Integer, primary_key=True, autoincrement=True, nullable=False)
message = db.Column(db.String)
likes_count = db.Column(db.Integer, default=0)
board_id = db.Column(db.Integer, db.ForeignKey('board.board_id'), default=None, nullable=False)
board=db.relationship('Board', back_populates='cards')

def dictionfy(self):
return {
'id':self.card_id,
'message':self.message,
'likes':self.likes_count
}

@classmethod
def create_card(cls,board_id,request_body):
return Card(message=request_body['message'],board_id=board_id)
76 changes: 74 additions & 2 deletions app/routes.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,76 @@
from flask import Blueprint, request, jsonify, make_response
from flask import Blueprint, request, jsonify, make_response,abort
from app.models.board import Board
from app.models.card import Card
from app import db

# example_bp = Blueprint('example_bp', __name__)
board_bp = Blueprint('board_bp', __name__, url_prefix='/board')

"""Board Routes"""
@board_bp.route("", methods=['POST'])
def add_one_board():
response_body = request.get_json()
try:
new_board = Board.create_board(response_body)
except KeyError:
return make_response(jsonify({'warning':'invalid title or owner'}),400)
db.session.add(new_board)
db.session.commit()

return make_response(jsonify({'msg':f'Board with id {new_board.board_id} created'}),201)

@board_bp.route("", methods=['GET'])
def get_all_boards():
boards=Board.query.all()
return_list=[]
for board in boards:
return_list.append(board.dictionfy())
return make_response(jsonify(return_list),200)

@board_bp.route('/<board_id>', methods=['GET'])
def get_one_board_with_cards(board_id):
board = validate_id(Board,board_id)
board_info = board.dictionfy()
return make_response(jsonify(board_info),200)

"""Card Routes"""
@board_bp.route('/<board_id>', methods=['POST'])
def add_one_card(board_id):
request_body=request.get_json()

try:
new_card=Card.create_card(board_id,request_body)
except KeyError:
return make_response(jsonify({'warning':'invalid message'}),400)

db.session.add(new_card)
db.session.commit()

return make_response(jsonify({
'id':new_card.card_id,
'msg':f'Card created with id {new_card.card_id}'}),201)

@board_bp.route('/<board_id>/<card_id>', methods=['PATCH','DELETE'])
def modify_one_card(board_id, card_id):
card=validate_id(Card, card_id)
method_string = "deleted" if request.method == 'DELETE' else 'upvoted'

if request.method=='DELETE':
db.session.delete(card)
else:
card.likes_count+=1

db.session.commit()

return make_response(jsonify({'msg':f"card {card_id} {method_string} from Board with id {board_id}"}),200)

"""Helper Functions"""
def validate_id(cls,id):
try:
model_id = int(id)
except TypeError:
abort(make_response({'details':'Invalid, id must be integer'}),400)
model = cls.query.get(model_id)

if not model:
abort(make_response({'details':'ID is invalid'}),404)
return model
1 change: 1 addition & 0 deletions migrations/README
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Generic single-database configuration.
45 changes: 45 additions & 0 deletions migrations/alembic.ini
Original file line number Diff line number Diff line change
@@ -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
96 changes: 96 additions & 0 deletions migrations/env.py
Original file line number Diff line number Diff line change
@@ -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()
24 changes: 24 additions & 0 deletions migrations/script.py.mako
Original file line number Diff line number Diff line change
@@ -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"}
30 changes: 30 additions & 0 deletions migrations/versions/6090d125c0eb_.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"""empty message

Revision ID: 6090d125c0eb
Revises: 9c2454f722e1
Create Date: 2023-01-03 10:53:29.190014

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '6090d125c0eb'
down_revision = '9c2454f722e1'
branch_labels = None
depends_on = None


def upgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.add_column('card', sa.Column('board_id', sa.Integer(), nullable=True))
op.create_foreign_key(None, 'card', 'board', ['board_id'], ['board_id'])
# ### end Alembic commands ###


def downgrade():
# ### commands auto generated by Alembic - please adjust! ###
op.drop_constraint(None, 'card', type_='foreignkey')
op.drop_column('card', 'board_id')
# ### end Alembic commands ###
40 changes: 40 additions & 0 deletions migrations/versions/9c2454f722e1_.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
"""empty message

Revision ID: 9c2454f722e1
Revises:
Create Date: 2022-12-22 13:52:14.051231

"""
from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision = '9c2454f722e1'
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 ###
Loading