bot-framework 0.1.3__py3-none-any.whl

bot_framework/flows/request_role_flow/handlers/role_selection_handler.py

@@ -0,0 +1,76 @@
+from uuid import uuid4
+
+from bot_framework.entities.bot_callback import BotCallback
+from bot_framework.flows.request_role_flow.exceptions import NoSupervisorsFoundError
+from bot_framework.flows.request_role_flow.protocols import (
+    IRequestRoleFlowStateStorage,
+    IRoleRequestSender,
+)
+from bot_framework.language_management.repos.protocols.i_phrase_repo import IPhraseRepo
+from bot_framework.protocols.i_callback_answerer import ICallbackAnswerer
+from bot_framework.protocols.i_message_sender import IMessageSender
+from bot_framework.role_management.repos.protocols.i_role_repo import IRoleRepo
+from bot_framework.role_management.repos.protocols.i_user_repo import IUserRepo
+
+
+class RoleSelectionHandler:
+    def __init__(
+        self,
+        callback_answerer: ICallbackAnswerer,
+        message_sender: IMessageSender,
+        phrase_repo: IPhraseRepo,
+        role_repo: IRoleRepo,
+        user_repo: IUserRepo,
+        state_storage: IRequestRoleFlowStateStorage,
+        role_request_sender: IRoleRequestSender,
+    ) -> None:
+        self.callback_answerer = callback_answerer
+        self.message_sender = message_sender
+        self.phrase_repo = phrase_repo
+        self.role_repo = role_repo
+        self.user_repo = user_repo
+        self.state_storage = state_storage
+        self.role_request_sender = role_request_sender
+        self.prefix = uuid4().hex
+        self.allowed_roles: set[str] | None = None
+
+    def handle(self, callback: BotCallback) -> None:
+        self.callback_answerer.answer(callback_query_id=callback.id)
+
+        if not callback.user_id:
+            raise ValueError("callback.user_id is required but was None")
+        if not callback.message_chat_id:
+            raise ValueError("callback.message_chat_id is required but was None")
+        if not callback.data:
+            raise ValueError("callback.data is required but was None")
+
+        parts = callback.data.split(":")
+        if len(parts) < 2:
+            raise ValueError(f"Invalid callback data format: {callback.data}")
+
+        role_id = int(parts[1])
+        telegram_id = callback.user_id
+        language_code = callback.user_language_code or "en"
+
+        self.state_storage.save_selected_role(telegram_id=telegram_id, role_id=role_id)
+
+        role = self.role_repo.get_by_id(id=role_id)
+        requester = self.user_repo.get_by_id(id=telegram_id)
+
+        user_roles = self.role_repo.get_user_roles(user_id=telegram_id)
+        if any(r.id == role_id for r in user_roles):
+            phrase_key = "request_role.already_has_role"
+        else:
+            try:
+                self.role_request_sender.send_to_supervisors(requester=requester, role=role)
+                phrase_key = "request_role.sent"
+            except NoSupervisorsFoundError:
+                phrase_key = "request_role.no_supervisors"
+
+        text = self.phrase_repo.get_phrase(
+            key=phrase_key,
+            language_code=language_code,
+        )
+        self.message_sender.send(chat_id=callback.message_chat_id, text=text)
+
+        self.state_storage.clear_state(telegram_id=telegram_id)

bot_framework/flows/request_role_flow/handlers/show_roles_handler.py

@@ -0,0 +1,30 @@
+from uuid import uuid4
+
+from bot_framework.entities.bot_callback import BotCallback
+from bot_framework.flows.request_role_flow.protocols import IRoleListPresenter
+from bot_framework.protocols.i_callback_answerer import ICallbackAnswerer
+
+
+class ShowRolesHandler:
+    def __init__(
+        self,
+        callback_answerer: ICallbackAnswerer,
+        role_list_presenter: IRoleListPresenter,
+    ) -> None:
+        self.callback_answerer = callback_answerer
+        self.role_list_presenter = role_list_presenter
+        self.prefix = uuid4().hex
+        self.allowed_roles: set[str] | None = None
+
+    def handle(self, callback: BotCallback) -> None:
+        self.callback_answerer.answer(callback_query_id=callback.id)
+
+        if not callback.message_chat_id:
+            raise ValueError("callback.message_chat_id is required but was None")
+
+        language_code = callback.user_language_code or "en"
+        self.role_list_presenter.present(
+            chat_id=callback.message_chat_id,
+            user_id=callback.user_id,
+            language_code=language_code,
+        )

bot_framework/flows/request_role_flow/presenters/__init__.py

@@ -0,0 +1,7 @@
+from bot_framework.flows.request_role_flow.presenters.role_list_presenter import (
+    RoleListPresenter,
+)
+
+__all__ = [
+    "RoleListPresenter",
+]

bot_framework/flows/request_role_flow/presenters/role_list_presenter.py

@@ -0,0 +1,53 @@
+from bot_framework.entities.button import Button
+from bot_framework.entities.keyboard import Keyboard
+from bot_framework.language_management.repos.protocols.i_phrase_repo import IPhraseRepo
+from bot_framework.protocols.i_message_sender import IMessageSender
+from bot_framework.role_management.repos.protocols.i_role_repo import IRoleRepo
+
+
+class RoleListPresenter:
+    def __init__(
+        self,
+        message_sender: IMessageSender,
+        phrase_repo: IPhraseRepo,
+        role_repo: IRoleRepo,
+        role_selection_handler_prefix: str,
+    ) -> None:
+        self.message_sender = message_sender
+        self.phrase_repo = phrase_repo
+        self.role_repo = role_repo
+        self.role_selection_handler_prefix = role_selection_handler_prefix
+
+    def present(self, chat_id: int, user_id: int, language_code: str) -> None:
+        roles = self.role_repo.get_all()
+
+        if not roles:
+            text = self.phrase_repo.get_phrase(
+                key="request_role.no_roles",
+                language_code=language_code,
+            )
+            self.message_sender.send(chat_id=chat_id, text=text)
+            return
+
+        text = self.phrase_repo.get_phrase(
+            key="request_role.select_title",
+            language_code=language_code,
+        )
+
+        user_roles = self.role_repo.get_user_roles(user_id)
+        user_role_ids = {role.id for role in user_roles}
+
+        buttons = []
+        for role in roles:
+            role_text = f"✓ {role.name}" if role.id in user_role_ids else role.name
+            buttons.append(
+                [
+                    Button(
+                        text=role_text,
+                        callback_data=f"{self.role_selection_handler_prefix}:{role.id}",
+                    )
+                ]
+            )
+
+        keyboard = Keyboard(rows=buttons)
+        self.message_sender.send(chat_id=chat_id, text=text, keyboard=keyboard)

bot_framework/flows/request_role_flow/protocols/__init__.py

@@ -0,0 +1,27 @@
+from bot_framework.flows.request_role_flow.protocols.i_request_role_flow_router import (
+    IRequestRoleFlowRouter,
+)
+from bot_framework.flows.request_role_flow.protocols.i_request_role_flow_state_storage import (
+    IRequestRoleFlowStateStorage,
+)
+from bot_framework.flows.request_role_flow.protocols.i_role_assigner import (
+    IRoleAssigner,
+)
+from bot_framework.flows.request_role_flow.protocols.i_role_list_presenter import (
+    IRoleListPresenter,
+)
+from bot_framework.flows.request_role_flow.protocols.i_role_rejection_notifier import (
+    IRoleRejectionNotifier,
+)
+from bot_framework.flows.request_role_flow.protocols.i_role_request_sender import (
+    IRoleRequestSender,
+)
+
+__all__ = [
+    "IRequestRoleFlowRouter",
+    "IRequestRoleFlowStateStorage",
+    "IRoleAssigner",
+    "IRoleListPresenter",
+    "IRoleRejectionNotifier",
+    "IRoleRequestSender",
+]

bot_framework/flows/request_role_flow/protocols/i_request_role_flow_router.py

@@ -0,0 +1,7 @@
+from typing import Protocol
+
+from bot_framework.entities.bot_message import BotMessageUser
+
+
+class IRequestRoleFlowRouter(Protocol):
+    def start(self, user: BotMessageUser, chat_id: int) -> None: ...

bot_framework/flows/request_role_flow/protocols/i_request_role_flow_state_storage.py

@@ -0,0 +1,11 @@
+from typing import Protocol
+
+from bot_framework.flows.request_role_flow.entities import RequestRoleFlowState
+
+
+class IRequestRoleFlowStateStorage(Protocol):
+    def save_selected_role(self, telegram_id: int, role_id: int) -> None: ...
+
+    def get_state(self, telegram_id: int) -> RequestRoleFlowState | None: ...
+
+    def clear_state(self, telegram_id: int) -> None: ...

bot_framework/flows/request_role_flow/protocols/i_role_assigner.py

@@ -0,0 +1,10 @@
+from typing import Protocol
+
+
+class IRoleAssigner(Protocol):
+    def assign_and_notify(
+        self,
+        user_id: int,
+        role_id: int,
+        language_code: str,
+    ) -> None: ...

bot_framework/flows/request_role_flow/protocols/i_role_list_presenter.py

@@ -0,0 +1,5 @@
+from typing import Protocol
+
+
+class IRoleListPresenter(Protocol):
+    def present(self, chat_id: int, user_id: int, language_code: str) -> None: ...

bot_framework/flows/request_role_flow/protocols/i_role_rejection_notifier.py

@@ -0,0 +1,9 @@
+from typing import Protocol
+
+
+class IRoleRejectionNotifier(Protocol):
+    def notify(
+        self,
+        user_id: int,
+        language_code: str,
+    ) -> None: ...

bot_framework/flows/request_role_flow/protocols/i_role_request_sender.py

@@ -0,0 +1,12 @@
+from typing import Protocol
+
+from bot_framework.entities.role import Role
+from bot_framework.entities.user import User
+
+
+class IRoleRequestSender(Protocol):
+    def send_to_supervisors(
+        self,
+        requester: User,
+        role: Role,
+    ) -> None: ...

bot_framework/flows/request_role_flow/repos/__init__.py

@@ -0,0 +1,7 @@
+from bot_framework.flows.request_role_flow.repos.redis_request_role_flow_state_storage import (
+    RedisRequestRoleFlowStateStorage,
+)
+
+__all__ = [
+    "RedisRequestRoleFlowStateStorage",
+]

bot_framework/flows/request_role_flow/repos/redis_request_role_flow_state_storage.py

@@ -0,0 +1,33 @@
+import json
+
+import redis
+
+from bot_framework.flows.request_role_flow.entities import RequestRoleFlowState
+
+
+class RedisRequestRoleFlowStateStorage:
+    def __init__(self, redis_url: str):
+        self.redis_client = redis.from_url(redis_url)  # pyright: ignore[reportUnknownMemberType]
+        self.ttl = 600
+
+    def _get_key(self, telegram_id: int) -> str:
+        return f"request_role_flow:{telegram_id}"
+
+    def save_selected_role(self, telegram_id: int, role_id: int) -> None:
+        key = self._get_key(telegram_id)
+        state = RequestRoleFlowState(
+            requester_user_id=telegram_id,
+            selected_role_id=role_id,
+        )
+        self.redis_client.set(key, state.model_dump_json(), ex=self.ttl)
+
+    def get_state(self, telegram_id: int) -> RequestRoleFlowState | None:
+        key = self._get_key(telegram_id)
+        data = self.redis_client.get(key)
+        if not data:
+            return None
+        return RequestRoleFlowState.model_validate(json.loads(data))  # pyright: ignore[reportArgumentType]
+
+    def clear_state(self, telegram_id: int) -> None:
+        key = self._get_key(telegram_id)
+        self.redis_client.delete(key)

bot_framework/flows/request_role_flow/request_role_flow_router.py

@@ -0,0 +1,18 @@
+from bot_framework.entities.bot_message import BotMessageUser
+from bot_framework.flows.request_role_flow.protocols import IRoleListPresenter
+
+
+class RequestRoleFlowRouter:
+    def __init__(
+        self,
+        role_list_presenter: IRoleListPresenter,
+    ) -> None:
+        self.role_list_presenter = role_list_presenter
+
+    def start(self, user: BotMessageUser, chat_id: int) -> None:
+        language_code = user.language_code or "en"
+        self.role_list_presenter.present(
+            chat_id=chat_id,
+            user_id=user.id,
+            language_code=language_code,
+        )

bot_framework/language_management/__init__.py

@@ -0,0 +1,13 @@
+from bot_framework.language_management.entities import Language, LanguageCode, Phrase
+from bot_framework.language_management.repos import LanguageRepo, PhraseRepo
+from bot_framework.language_management.repos.protocols import ILanguageRepo, IPhraseRepo
+
+__all__ = [
+    "Language",
+    "LanguageCode",
+    "Phrase",
+    "LanguageRepo",
+    "PhraseRepo",
+    "ILanguageRepo",
+    "IPhraseRepo",
+]

bot_framework/language_management/entities/__init__.py

@@ -0,0 +1,10 @@
+from bot_framework.entities import LanguageCode
+
+from .language import Language
+from .phrase import Phrase
+
+__all__ = [
+    "Language",
+    "LanguageCode",
+    "Phrase",
+]

bot_framework/language_management/entities/language.py

@@ -0,0 +1,15 @@
+from datetime import datetime
+
+from pydantic import (
+    BaseModel, ConfigDict, Field,
+)
+
+
+class Language(BaseModel):
+    code: str
+    name: str
+    native_name: str
+    is_active: bool = True
+    created_at: datetime = Field(default_factory=datetime.now)
+
+    model_config = ConfigDict(from_attributes=True)

bot_framework/language_management/entities/phrase.py

@@ -0,0 +1,16 @@
+from datetime import datetime
+
+from pydantic import (
+    BaseModel, ConfigDict, Field,
+)
+
+
+class Phrase(BaseModel):
+    id: int = 0
+    key: str
+    language_code: str
+    text: str
+    created_at: datetime = Field(default_factory=datetime.now)
+    updated_at: datetime = Field(default_factory=datetime.now)
+
+    model_config = ConfigDict(from_attributes=True)

bot_framework/language_management/repos/__init__.py

@@ -0,0 +1,7 @@
+from .language_repo import LanguageRepo
+from .phrase_repo import PhraseRepo
+
+__all__ = [
+    "LanguageRepo",
+    "PhraseRepo",
+]

bot_framework/language_management/repos/language_repo.py

@@ -0,0 +1,67 @@
+import psycopg
+from psycopg.rows import class_row
+
+from bot_framework.language_management.entities.language import Language
+from bot_framework.language_management.repos.protocols.i_language_repo import ILanguageRepo
+
+
+class LanguageRepo(ILanguageRepo):
+    def __init__(
+        self,
+        database_url: str,
+    ):
+        self.database_url = database_url
+
+    def get_all(self) -> list[Language]:
+        with psycopg.connect(self.database_url) as conn:
+            with conn.cursor(row_factory=class_row(Language)) as cur:
+                cur.execute(
+                    "SELECT * FROM languages WHERE is_active = TRUE ORDER BY code",
+                )
+                return cur.fetchall()
+
+    def get_by_key(
+        self,
+        key: str,
+    ) -> Language:
+        language = self.find_by_key(key)
+        if not language:
+            raise ValueError(f"Language with code {key} not found")
+        return language
+
+    def find_by_key(
+        self,
+        key: str,
+    ) -> Language | None:
+        with psycopg.connect(self.database_url) as conn:
+            with conn.cursor(row_factory=class_row(Language)) as cur:
+                cur.execute(
+                    "SELECT * FROM languages WHERE code = %(key)s",
+                    {
+                        "key": key,
+                    },
+                )
+                return cur.fetchone()
+
+    def get_by_id(
+        self,
+        id: int,
+    ) -> Language:
+        language = self.find_by_id(id)
+        if not language:
+            raise ValueError(f"Language with id {id} not found")
+        return language
+
+    def find_by_id(
+        self,
+        id: int,
+    ) -> Language | None:
+        with psycopg.connect(self.database_url) as conn:
+            with conn.cursor(row_factory=class_row(Language)) as cur:
+                cur.execute(
+                    "SELECT * FROM languages WHERE code = %(id)s",
+                    {
+                        "id": id,
+                    },
+                )
+                return cur.fetchone()

bot_framework/language_management/repos/phrase_repo.py

@@ -0,0 +1,31 @@
+import psycopg
+
+from bot_framework.language_management.repos.protocols.i_phrase_repo import IPhraseRepo
+
+
+class PhraseRepo(IPhraseRepo):
+    def __init__(
+        self,
+        database_url: str,
+    ):
+        self.database_url = database_url
+
+    def get_phrase(
+        self,
+        key: str,
+        language_code: str,
+    ) -> str:
+        with psycopg.connect(self.database_url) as conn:
+            with conn.cursor() as cur:
+                cur.execute(
+                    "SELECT text FROM phrases WHERE key = %(key)s"
+                    " AND language_code = %(language_code)s",
+                    {
+                        "key": key,
+                        "language_code": language_code,
+                    },
+                )
+                row = cur.fetchone()
+                return (
+                    str(row[0]) if row else f"[Missing phrase: {key}-{language_code}]"
+                )

bot_framework/language_management/repos/protocols/__init__.py

@@ -0,0 +1,7 @@
+from .i_language_repo import ILanguageRepo
+from .i_phrase_repo import IPhraseRepo
+
+__all__ = [
+    "ILanguageRepo",
+    "IPhraseRepo",
+]

bot_framework/language_management/repos/protocols/i_language_repo.py

@@ -0,0 +1,10 @@
+from typing import Protocol
+
+from bot_framework.base_protocols import (
+    GetAllProtocol,
+    GetByKeyProtocol,
+    ReadProtocol,
+)
+
+
+class ILanguageRepo(GetAllProtocol, GetByKeyProtocol, ReadProtocol, Protocol): ...

bot_framework/language_management/repos/protocols/i_phrase_repo.py

@@ -0,0 +1,9 @@
+from typing import Protocol
+
+
+class IPhraseRepo(Protocol):
+    def get_phrase(
+        self,
+        key: str,
+        language_code: str,
+    ) -> str: ...

bot_framework/protocols/__init__.py

@@ -0,0 +1,37 @@
+from .i_callback_answerer import ICallbackAnswerer
+from .i_callback_handler import ICallbackHandler
+from .i_callback_handler_registry import ICallbackHandlerRegistry
+from .i_card_field_formatter import ICardFieldFormatter
+from .i_display_width_calculator import IDisplayWidthCalculator
+from .i_ensure_user_exists import IEnsureUserExists
+from .i_flow_router import IFlowRouter
+from .i_markdown_to_html_converter import IMarkdownToHtmlConverter
+from .i_message_deleter import IMessageDeleter
+from .i_message_handler import IMessageHandler
+from .i_message_handler_registry import IMessageHandlerRegistry
+from .i_message_replacer import IMessageReplacer
+from .i_message_sender import IMessageSender
+from .i_message_service import IMessageService
+from .i_next_step_handler_registrar import INextStepHandlerRegistrar
+from .i_notify_replacer import INotifyReplacer
+from .i_remaining_time_formatter import IRemainingTimeFormatter
+
+__all__ = [
+    "ICallbackAnswerer",
+    "ICallbackHandler",
+    "ICallbackHandlerRegistry",
+    "ICardFieldFormatter",
+    "IDisplayWidthCalculator",
+    "IEnsureUserExists",
+    "IFlowRouter",
+    "IMarkdownToHtmlConverter",
+    "IMessageDeleter",
+    "IMessageHandler",
+    "IMessageHandlerRegistry",
+    "IMessageReplacer",
+    "IMessageSender",
+    "IMessageService",
+    "INextStepHandlerRegistrar",
+    "INotifyReplacer",
+    "IRemainingTimeFormatter",
+]

bot_framework/protocols/i_callback_answerer.py

@@ -0,0 +1,10 @@
+from typing import Protocol
+
+
+class ICallbackAnswerer(Protocol):
+    def answer(
+        self,
+        callback_query_id: str,
+        text: str | None = None,
+        show_alert: bool = False,
+    ) -> None: ...

bot_framework/protocols/i_callback_handler.py

@@ -0,0 +1,16 @@
+from typing import (
+    Protocol,
+    runtime_checkable,
+)
+
+from bot_framework.entities.bot_callback import BotCallback
+from bot_framework.protocols.i_callback_answerer import ICallbackAnswerer
+
+
+@runtime_checkable
+class ICallbackHandler(Protocol):
+    callback_answerer: ICallbackAnswerer
+    prefix: str
+    allowed_roles: set[str] | None
+
+    def handle(self, callback: BotCallback) -> None: ...

bot_framework/protocols/i_callback_handler_registry.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from typing import Protocol
+
+from bot_framework.protocols.i_callback_handler import ICallbackHandler
+
+
+class ICallbackHandlerRegistry(Protocol):
+    def register(self, handler: ICallbackHandler) -> None: ...

bot_framework/protocols/i_card_field_formatter.py

@@ -0,0 +1,7 @@
+from typing import Protocol
+
+
+class ICardFieldFormatter(Protocol):
+    def display_width(self, text: str) -> int: ...
+
+    def generate_field_lines(self, label: str, value: str) -> list[str]: ...

bot_framework/protocols/i_display_width_calculator.py

@@ -0,0 +1,5 @@
+from typing import Protocol
+
+
+class IDisplayWidthCalculator(Protocol):
+    def calculate(self, text: str) -> int: ...

bot_framework/protocols/i_ensure_user_exists.py

@@ -0,0 +1,7 @@
+from typing import Protocol
+
+from bot_framework.entities.bot_user import BotUser
+
+
+class IEnsureUserExists(Protocol):
+    def execute(self, user: BotUser) -> None: ...

bot_framework/protocols/i_flow_router.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from typing import (
+    Protocol,
+    runtime_checkable,
+)
+
+from bot_framework.entities.user import User
+
+
+@runtime_checkable
+class IFlowRouter(Protocol):
+    def get_name(self) -> str: ...
+
+    def start(
+        self,
+        user: User,
+        return_to: IFlowRouter | None = None,
+    ) -> None: ...

bot_framework/protocols/i_markdown_to_html_converter.py

@@ -0,0 +1,5 @@
+from typing import Protocol
+
+
+class IMarkdownToHtmlConverter(Protocol):
+    def convert(self, text: str) -> str: ...

bot_framework/protocols/i_message_deleter.py

@@ -0,0 +1,5 @@
+from typing import Protocol
+
+
+class IMessageDeleter(Protocol):
+    def delete(self, chat_id: int, message_id: int) -> None: ...