From 472f682c58ffb75648e1939a7742e7f92e1efcaf Mon Sep 17 00:00:00 2001 From: Gardient Date: Sun, 19 Sep 2021 23:55:36 +0300 Subject: [PATCH] adds target-exchange and initial migrations --- api/__init__.py | 3 +- api/exceptions.py | 4 +- api/target_exchange/__init__.py | 3 + api/target_exchange/models.py | 10 ++ api/target_exchange/serializers.py | 8 ++ api/target_exchange/views.py | 49 ++++++++++ migrations/README | 1 + migrations/alembic.ini | 50 ++++++++++ migrations/env.py | 91 +++++++++++++++++++ migrations/script.py.mako | 24 +++++ .../versions/14ceaaaa6e85_initial_create.py | 33 +++++++ 11 files changed, 273 insertions(+), 3 deletions(-) create mode 100644 api/target_exchange/__init__.py create mode 100644 api/target_exchange/models.py create mode 100644 api/target_exchange/serializers.py create mode 100644 api/target_exchange/views.py create mode 100644 migrations/README create mode 100644 migrations/alembic.ini create mode 100644 migrations/env.py create mode 100644 migrations/script.py.mako create mode 100644 migrations/versions/14ceaaaa6e85_initial_create.py diff --git a/api/__init__.py b/api/__init__.py index 2a94ba9..93226a1 100644 --- a/api/__init__.py +++ b/api/__init__.py @@ -1,5 +1,5 @@ from flask import Flask, Blueprint -from . import commands, login +from . import commands, login, target_exchange from .settings import ProdConfig, Config from .extensions import db, migrate, jwt from .exceptions import ApiException @@ -35,6 +35,7 @@ def register_blueprints(app: Flask): api_blueprint = Blueprint('api', __name__, url_prefix='/api') api_blueprint.register_blueprint(login.views.blueprint, url_prefix='/login') + api_blueprint.register_blueprint(target_exchange.views.blueprint, url_prefix='/target-exchange') app.register_blueprint(api_blueprint) diff --git a/api/exceptions.py b/api/exceptions.py index 5511173..21d9e11 100644 --- a/api/exceptions.py +++ b/api/exceptions.py @@ -14,8 +14,8 @@ class ApiException(Exception): return rv class NotFoundException(ApiException): - def __init__(self, message) -> None: - super().__init__(404, message) + def __init__(self, entity_name) -> None: + super().__init__(404, f'{entity_name} could not be found') class BadRequestException(ApiException): def __init__(self, message) -> None: diff --git a/api/target_exchange/__init__.py b/api/target_exchange/__init__.py new file mode 100644 index 0000000..72b68ef --- /dev/null +++ b/api/target_exchange/__init__.py @@ -0,0 +1,3 @@ +"""exchange management""" + +from . import views diff --git a/api/target_exchange/models.py b/api/target_exchange/models.py new file mode 100644 index 0000000..14e58ea --- /dev/null +++ b/api/target_exchange/models.py @@ -0,0 +1,10 @@ +from api.database import (Model, SurrogatePK, db, + Column, reference_col, relationship) + + +class TargetExchange(SurrogatePK, Model): + __tablename__ = "target-exchange" + name = Column(db.String(255), unique=True, nullable=False) + + def __init__(self, name, **kwargs) -> None: + Model.__init__(self, name=name, **kwargs) diff --git a/api/target_exchange/serializers.py b/api/target_exchange/serializers.py new file mode 100644 index 0000000..bed34f5 --- /dev/null +++ b/api/target_exchange/serializers.py @@ -0,0 +1,8 @@ +from marshmallow import Schema, fields + +class TargetExchangeSchema(Schema): + id = fields.Int() + name = fields.Str() + +target_exchange_schema = TargetExchangeSchema() +target_exchanges_schema = TargetExchangeSchema(many=True) diff --git a/api/target_exchange/views.py b/api/target_exchange/views.py new file mode 100644 index 0000000..27337e9 --- /dev/null +++ b/api/target_exchange/views.py @@ -0,0 +1,49 @@ +from flask import Blueprint +from flask_jwt_extended import jwt_required +from flask_apispec import use_kwargs, marshal_with + +from api.exceptions import NotFoundException + +from .models import TargetExchange +from .serializers import target_exchange_schema, target_exchanges_schema + +blueprint = Blueprint('target_exchange', __name__) + + +@blueprint.route('', methods=['GET']) +@jwt_required() +@marshal_with(target_exchanges_schema) +def get_list(): + return TargetExchange.query.all() + + +@blueprint.route('', methods=['POST']) +@jwt_required() +@use_kwargs(target_exchange_schema) +@marshal_with(target_exchange_schema) +def create(name): + target_exchange = TargetExchange(name=name) + target_exchange.save() + return target_exchange + + +@blueprint.route('/', methods=['GET']) +@jwt_required() +@marshal_with(target_exchange_schema) +def get_by_id(id): + target_exchange = TargetExchange.get_by_id(id) + if target_exchange is not None: + return target_exchange + else: + return NotFoundException(__name__) + +@blueprint.route('/', methods=['PUT']) +@jwt_required() +@use_kwargs(target_exchange_schema) +@marshal_with(target_exchange_schema) +def update(id, **kwargs): + target_exchange = TargetExchange.get_by_id(id) + if target_exchange is not None: + return target_exchange.update(**kwargs) + else: + return NotFoundException(__name__) diff --git a/migrations/README b/migrations/README new file mode 100644 index 0000000..0e04844 --- /dev/null +++ b/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 0000000..ec9d45c --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,50 @@ +# 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,flask_migrate + +[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 + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[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 0000000..68feded --- /dev/null +++ b/migrations/env.py @@ -0,0 +1,91 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +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.get_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 = current_app.extensions['migrate'].db.get_engine() + + 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 0000000..2c01563 --- /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/14ceaaaa6e85_initial_create.py b/migrations/versions/14ceaaaa6e85_initial_create.py new file mode 100644 index 0000000..b1f06d0 --- /dev/null +++ b/migrations/versions/14ceaaaa6e85_initial_create.py @@ -0,0 +1,33 @@ +"""initial create + +Revision ID: 14ceaaaa6e85 +Revises: +Create Date: 2021-09-19 23:52:49.797793 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '14ceaaaa6e85' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('target-exchange', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(length=255), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('name') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('target-exchange') + # ### end Alembic commands ###