init

flask_demo_api/config.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+from flask_demo_api.repository.config import DBSettings
+
+
+@dataclass(frozen=True)
+class Settings:
+    db: DBSettings

flask_demo_api/error_handlers.py

@@ -0,0 +1,14 @@
+from flask import Flask, jsonify
+
+
+def name_not_found_error(e):
+    return jsonify(error=str(e)), 404
+
+
+def bad_request_error(e):
+    return jsonify(error=str(e)), 400
+
+
+def register_errors(app: Flask):
+    app.register_error_handler(404, name_not_found_error)
+    app.register_error_handler(400, bad_request_error)

flask_demo_api/ioc.py

@@ -0,0 +1,77 @@
+import os
+from collections.abc import Iterable
+
+import yaml  # type: ignore
+from dishka import Container, Provider, Scope, make_container, provide
+from sqlalchemy import Engine, create_engine
+from sqlalchemy.orm import Session, sessionmaker
+
+from flask_demo_api.config import Settings
+from flask_demo_api.protocols.repository import RepositoryGateway
+from flask_demo_api.repository.config import DBSettings
+from flask_demo_api.repository.repository import SqlalchemyRepositoryGateway
+from flask_demo_api.usecase.get_gender import GetGender
+
+
+def yaml_loader(file: str) -> dict[str, dict[str, str]]:
+    with open(file) as f:
+        yaml_data: dict = yaml.safe_load(f)
+    return yaml_data
+
+
+class DBSettingsProvider(Provider):
+    @provide(scope=Scope.APP)
+    def db_settings(self) -> DBSettings:
+        config_data = yaml_loader(
+            file=os.getenv("CONFIG_PATH", "./config/api_config.yml"),
+        )
+        return DBSettings(
+            pg_user=config_data["db"]["pg_user"],
+            pg_pass=config_data["db"]["pg_pass"],
+            pg_host=config_data["db"]["pg_host"],
+            pg_port=int(config_data["db"]["pg_port"]),
+            pg_db=config_data["db"]["pg_db"],
+        )
+
+
+class SettingsProvider(Provider):
+    @provide(scope=Scope.APP)
+    def main_settings(self, db_settings: DBSettings) -> Settings:
+        return Settings(db=db_settings)
+
+
+class SqlalchemyProvider(Provider):
+    @provide(scope=Scope.APP)
+    def provide_engine(self, config: Settings) -> Engine:
+        return create_engine(config.db.get_db_url)
+
+    @provide(scope=Scope.APP)
+    def provide_sessionmaker(self, engine: Engine) -> sessionmaker[Session]:
+        return sessionmaker(bind=engine, expire_on_commit=False, class_=Session)
+
+    @provide(scope=Scope.REQUEST, provides=Session)
+    def provide_session(self, sessionmaker: sessionmaker[Session]) -> Iterable[Session]:
+        with sessionmaker() as session:
+            yield session
+
+
+class RepositoryProvider(Provider):
+    @provide(scope=Scope.REQUEST)
+    def provide_repository(self, session: Session) -> RepositoryGateway:
+        return SqlalchemyRepositoryGateway(session=session)
+
+
+class UseCasesProvider(Provider):
+    scope = Scope.REQUEST
+
+    get = provide(GetGender)
+
+
+def create_container() -> Container:
+    return make_container(
+        DBSettingsProvider(),
+        SettingsProvider(),
+        SqlalchemyProvider(),
+        RepositoryProvider(),
+        UseCasesProvider(),
+    )

flask_demo_api/main.py

@@ -0,0 +1,26 @@
+from dishka.integrations.flask import setup_dishka
+from flask import Flask
+
+from flask_demo_api.error_handlers import register_errors
+from flask_demo_api.ioc import create_container
+from flask_demo_api.routers.webhook import wh_bp
+
+
+def app_factory() -> Flask:
+    app = Flask(__name__)
+    register_errors(app)
+    app.register_blueprint(wh_bp)
+    return app
+
+
+def run_app():
+    app = app_factory()
+
+    container = create_container()
+    setup_dishka(container=container, app=app, auto_inject=True)
+    app.run(host="0.0.0.0", debug=True)
+    container.close()
+
+
+if __name__ == "__main__":
+    run_app()

flask_demo_api/protocols/models.py

@@ -0,0 +1,19 @@
+from dataclasses import dataclass
+from enum import Enum
+
+
+class Gender(Enum):
+    MALE = "Male"
+    FEMALE = "Female"
+
+
+@dataclass(frozen=True)
+class PeopleRequest:
+    id: int | str
+    name: str
+
+
+@dataclass(frozen=True)
+class GenderResponse:
+    id: int | str
+    gender: Gender

flask_demo_api/protocols/repository.py

@@ -0,0 +1,10 @@
+from abc import abstractmethod
+from typing import Protocol
+
+from flask_demo_api.protocols.models import GenderResponse, PeopleRequest
+
+
+class RepositoryGateway(Protocol):
+    @abstractmethod
+    def get_gender(self, people: PeopleRequest) -> GenderResponse | None:
+        raise NotImplementedError

flask_demo_api/repository/config.py

@@ -0,0 +1,20 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class DBSettings:
+    pg_user: str
+    pg_pass: str
+    pg_host: str
+    pg_port: int
+    pg_db: str
+
+    @property
+    def get_db_url(self) -> str:
+        return "postgresql+psycopg2://{}:{}@{}:{}/{}".format(
+            self.pg_user,
+            self.pg_pass,
+            self.pg_host,
+            self.pg_port,
+            self.pg_db,
+        )

flask_demo_api/repository/migrations/README

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

flask_demo_api/repository/migrations/env.py

@@ -0,0 +1,76 @@
+from logging.config import fileConfig
+
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+
+from flask_demo_api.repository.models import Base
+
+# 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.
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = Base.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() -> None:
+    """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,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    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)
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

flask_demo_api/repository/migrations/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

flask_demo_api/repository/migrations/versions/22f68d68c369_first.py

@@ -0,0 +1,42 @@
+"""First
+
+Revision ID: 22f68d68c369
+Revises:
+Create Date: 2024-04-22 02:32:45.672666
+
+"""
+
+from collections.abc import Sequence
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "22f68d68c369"
+down_revision: str | None = None
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "names_man",
+        sa.Column("id", sa.UUID(), nullable=False),
+        sa.Column("name", sa.String(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_table(
+        "names_woman",
+        sa.Column("id", sa.UUID(), nullable=False),
+        sa.Column("name", sa.String(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("names_woman")
+    op.drop_table("names_man")
+    # ### end Alembic commands ###

flask_demo_api/repository/models.py

@@ -0,0 +1,23 @@
+import uuid
+
+from sqlalchemy import UUID
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
+
+
+class Base(DeclarativeBase):
+    __abstract__ = True
+
+    id: Mapped[uuid.UUID] = mapped_column(
+        UUID(as_uuid=True),
+        primary_key=True,
+        default=uuid.uuid4,
+    )
+    name: Mapped[str]
+
+
+class MaleNames(Base):
+    __tablename__ = "names_man"
+
+
+class FemaleNames(Base):
+    __tablename__ = "names_woman"

flask_demo_api/repository/repository.py

@@ -0,0 +1,25 @@
+from sqlalchemy import text
+from sqlalchemy.orm import Session
+
+from flask_demo_api.protocols.models import Gender, GenderResponse, PeopleRequest
+from flask_demo_api.protocols.repository import RepositoryGateway
+
+
+class SqlalchemyRepositoryGateway(RepositoryGateway):
+    def __init__(self, session: Session) -> None:
+        self.session = session
+
+    def get_gender(self, people: PeopleRequest) -> GenderResponse | None:
+        stmt = text("""SELECT * FROM names_man WHERE name = :name""")
+        man_result = self.session.execute(stmt, {"name": people.name})
+        man_result = man_result.mappings().one_or_none()
+        if man_result:
+            return GenderResponse(id=people.id, gender=Gender.MALE)
+
+        stmt = text("""SELECT * FROM names_woman WHERE name = :name""")
+        man_result = self.session.execute(stmt, {"name": people.name})
+        man_result = man_result.mappings().one_or_none()
+        if man_result:
+            return GenderResponse(id=people.id, gender=Gender.FEMALE)
+
+        return None

flask_demo_api/routers/webhook.py

@@ -0,0 +1,28 @@
+from dishka.integrations.flask import FromDishka, inject
+from flask import Blueprint, abort, jsonify, request
+
+from flask_demo_api.protocols.models import PeopleRequest
+from flask_demo_api.usecase.get_gender import GetGender
+
+wh_bp = Blueprint("gender", __name__)
+
+
+@wh_bp.route("/webhook", methods=["POST"])
+@inject
+def gender_request_webhook(usecase: FromDishka[GetGender]):
+    json_data = request.get_json()
+
+    if not json_data.get("id"):
+        abort(400, "'id' required")
+    elif not json_data.get("name"):
+        abort(400, "'name' required")
+
+    if json_data:
+        result = usecase(request=PeopleRequest(id=json_data.get("id"), name=json_data.get("name")))
+
+        if result is None:
+            abort(404, "Gender unknown")
+
+        return jsonify({"id": result.id, "gender": result.gender.value}), 200
+    else:
+        abort(400, "Invalid json data")

flask_demo_api/usecase/get_gender.py

@@ -0,0 +1,13 @@
+from flask_demo_api.protocols.models import GenderResponse, PeopleRequest
+from flask_demo_api.protocols.repository import RepositoryGateway
+
+
+class GetGender:
+    def __init__(
+        self,
+        repository: RepositoryGateway,
+    ) -> None:
+        self.__repository = repository
+
+    def __call__(self, request: PeopleRequest) -> GenderResponse | None:
+        return self.__repository.get_gender(people=request)