chatgraph 0.1.2__tar.gz → 0.1.4__tar.gz

{chatgraph-0.1.2 → chatgraph-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: chatgraph
-Version: 0.1.2
+Version: 0.1.4
 Summary: A user-friendly chatbot library
 Home-page: https://github.com/irissonnlima/chatgraph
 License: MIT
@@ -108,11 +108,11 @@ from chatgraph import ChatbotApp, ChatbotRouter, SimpleUserState, RabbitMessageC
 # Definindo rotas com ChatbotRouter
 router = ChatbotRouter()
 
-@router.route("START")
+@router.route("start")
 def say_hello():
-    return ChatbotResponse(message="Hello! How can I assist you today?", route=".HELP")
+    return ChatbotResponse(message="Hello! How can I assist you today?", route=".help")
 
-@router.route(".HELP")
+@router.route(".help")
 def provide_help():
     return ChatbotResponse(message="Here are some things I can help with: ...")
 

{chatgraph-0.1.2 → chatgraph-0.1.4}/README.md

@@ -91,11 +91,11 @@ from chatgraph import ChatbotApp, ChatbotRouter, SimpleUserState, RabbitMessageC
 # Definindo rotas com ChatbotRouter
 router = ChatbotRouter()
 
-@router.route("START")
+@router.route("start")
 def say_hello():
-    return ChatbotResponse(message="Hello! How can I assist you today?", route=".HELP")
+    return ChatbotResponse(message="Hello! How can I assist you today?", route=".help")
 
-@router.route(".HELP")
+@router.route(".help")
 def provide_help():
     return ChatbotResponse(message="Here are some things I can help with: ...")
 

{chatgraph-0.1.2 → chatgraph-0.1.4}/chatgraph/bot/chatbot_model.py

@@ -6,7 +6,7 @@ from logging import debug
 from ..error.chatbot_error import ChatbotError, ChatbotMessageError
 from ..messages.base_message_consumer import MessageConsumer
 from ..types.message_types import Message
-from ..types.output_state import ChatbotResponse, RedirectResponse
+from ..types.output_state import ChatbotResponse, RedirectResponse, EndChatResponse, TransferToHuman
 from ..types.route import Route
 from ..types.user_state import UserState
 from .chatbot_router import ChatbotRouter
@@ -38,16 +38,16 @@ class ChatbotApp(ABC):
             prefix (str): O prefixo a ser adicionado às rotas do roteador.
 
         Raises:
-            ChatbotError: Se a rota 'START' não for encontrada no roteador.
+            ChatbotError: Se a rota 'start' não for encontrada no roteador.
         """
-        if 'START' not in router.routes.keys():
-            raise ChatbotError('Erro ao incluir rota, START não encontrado!')
+        if 'start' not in router.routes.keys():
+            raise ChatbotError('Erro ao incluir rota, start não encontrado!')
 
         prefixed_routes = {
             (
-                f'START{prefix.upper()}'
-                if key.upper() == 'START'
-                else f'START{prefix.upper()}{key.upper().replace("START", "")}'
+                f'start{prefix.lower()}'
+                if key.lower() == 'start'
+                else f'start{prefix.lower()}{key.lower().replace("start", "")}'
             ): value
             for key, value in router.routes.items()
         }
@@ -63,10 +63,10 @@ class ChatbotApp(ABC):
         Returns:
             function: O decorador que adiciona a função à rota especificada.
         """
-        route_name = route_name.strip().upper()
+        route_name = route_name.strip().lower()
 
-        if 'START' not in route_name:
-            route_name = f'START{route_name}'
+        if 'start' not in route_name:
+            route_name = f'start{route_name}'
 
         def decorator(func):
             params = dict()
@@ -119,7 +119,7 @@ class ChatbotApp(ABC):
         customer_id = message.customer_id
 
         menu = self.__user_state.get_menu(customer_id)
-        menu = menu.upper()
+        menu = menu.lower()
         handler = self.__routes.get(menu, None)
 
         if not handler:
@@ -143,11 +143,17 @@ class ChatbotApp(ABC):
         elif type(message_response) == ChatbotResponse:
             route = self.__adjust_route(message_response.route, menu)
             self.__user_state.set_menu(customer_id, route)
-            return message_response.message
+            return message_response.json()
         elif type(message_response) == RedirectResponse:
             route = self.__adjust_route(message_response.route, menu)
             self.__user_state.set_menu(customer_id, route)
             return self.process_message(message)
+        elif type(message_response) == EndChatResponse:
+            self.__user_state.delete_menu(customer_id)
+            return message_response.json()
+        elif type(message_response) == TransferToHuman:
+            self.__user_state.delete_menu(customer_id)
+            return message_response.json()
         else:
             raise ChatbotError('Tipo de retorno inválido!')
 
@@ -165,7 +171,7 @@ class ChatbotApp(ABC):
         if not route:
             return absolute_route
 
-        if 'START' not in route:
+        if 'start' not in route:
             route = absolute_route + route
 
         return route

{chatgraph-0.1.2 → chatgraph-0.1.4}/chatgraph/bot/chatbot_router.py

@@ -29,8 +29,8 @@ class ChatbotRouter:
         Returns:
             function: O decorador que adiciona a função à rota especificada.
         """
-        if 'START' not in route_name:
-            route_name = f'START{route_name}'
+        if 'start' not in route_name:
+            route_name = f'start{route_name}'
 
         def decorator(func):
             params = dict()
@@ -46,7 +46,7 @@ class ChatbotRouter:
                 params[param_type] = name
                 debug(f'Parameter: {name}, Type: {param_type}')
 
-            self.routes[route_name.strip().upper()] = {
+            self.routes[route_name.strip().lower()] = {
                 'function': func,
                 'params': params,
                 'return': output_param,
@@ -69,16 +69,16 @@ class ChatbotRouter:
             prefix (str): O prefixo a ser adicionado às rotas do roteador.
 
         Raises:
-            ChatbotError: Se a rota 'START' não for encontrada no roteador fornecido.
+            ChatbotError: Se a rota 'start' não for encontrada no roteador fornecido.
         """
-        if 'START' not in router.routes.keys():
-            raise ChatbotError('Erro ao incluir rota, START não encontrado!')
+        if 'start' not in router.routes.keys():
+            raise ChatbotError('Erro ao incluir rota, start não encontrado!')
 
         prefixed_routes = {
             (
-                f'{prefix.upper()}'
-                if key.upper() == 'START'
-                else f'START{prefix.upper()}{key.upper().replace("START", "")}'
+                f'{prefix.lower()}'
+                if key.lower() == 'start'
+                else f'start{prefix.lower()}{key.lower().replace("start", "")}'
             ): value
             for key, value in router.routes.items()
         }

chatgraph-0.1.4/chatgraph/messages/test_message_consumer.py

@@ -0,0 +1,17 @@
+from typing import Any, Callable
+from .base_message_consumer import MessageConsumer
+
+
+class TestMessageConsumer(MessageConsumer):
+    """
+    Classe de consumidor de mensagens de teste para uso em testes unitários.
+    """
+    def __init__(self) -> None:
+        super().__init__()
+        
+    @classmethod
+    def load_dotenv(cls) -> 'TestMessageConsumer':
+        return cls()
+    
+    def start_consume(self, process_message: Callable) -> Any:
+        return super().start_consume(process_message)

chatgraph-0.1.4/chatgraph/types/output_state.py

@@ -0,0 +1,99 @@
+from typing import Union
+import json
+
+messageTypes = Union[str, float, int, None]
+
+
+class ChatbotResponse:
+    """
+    Representa a resposta do chatbot, contendo a mensagem a ser enviada ao usuário e a rota a ser seguida.
+
+    Atributos:
+        message (messageTypes): A mensagem de resposta do chatbot. Pode ser uma string, um número, ou None.
+        route (str, opcional): A rota para a qual o chatbot deve direcionar após esta mensagem. Padrão é None.
+    """
+
+    def __init__(self, message: messageTypes = None, route: str = None) -> None:
+        """
+        Inicializa a resposta do chatbot com uma mensagem e uma rota opcional.
+
+        Args:
+            message (messageTypes, opcional): A mensagem a ser enviada ao usuário. Pode ser uma string, um número, ou None.
+            route (str, opcional): A rota para a qual o chatbot deve direcionar após esta mensagem. Padrão é None.
+        """
+        self.message = message
+        self.route = route
+    
+    def json(self):
+        '''
+        Retorna o objeto em formato json.
+        '''
+        return json.dumps({
+            'type': 'message',
+            'message': self.message,
+        })
+
+
+class RedirectResponse:
+    """
+    Representa uma resposta que redireciona o fluxo do chatbot para uma nova rota.
+
+    Atributos:
+        route (str): A rota para a qual o chatbot deve redirecionar.
+    """
+
+    def __init__(self, route: str) -> None:
+        """
+        Inicializa a resposta de redirecionamento com a rota especificada.
+
+        Args:
+            route (str): A rota para a qual o chatbot deve redirecionar.
+        """
+        self.route = route
+
+class EndChatResponse:
+    """
+    Representa uma resposta que indica o fim do chatbot.
+
+    Atributos:
+        tabulation_id (str): O ID da tabulação do chatbot.
+        observations (str): As observações finais do chatbot.
+    """
+
+    def __init__(self, tabulation_id: str, observations:str) -> None:
+        '''
+        Finzaliza e tabula as informações do chatbot.
+        '''
+        self.tabulation_id = tabulation_id
+        self.observations = observations
+        
+    def json(self):
+        '''
+        Retorna o objeto em formato json.
+        '''
+        return json.dumps({
+            'type': 'tabulate',
+            'tabulation_id': self.tabulation_id,
+            'observations': self.observations,
+        })
+        
+class TransferToHuman:
+    """
+    Representa uma transferencia para um atendente humano.
+    """
+    def __init__(self, campaign_id: str, observations:str) -> None:
+        '''
+        Finzaliza e tabula as informações do chatbot.
+        '''
+        self.campaign_id = campaign_id
+        self.observations = observations
+        
+    def json(self):
+        '''
+        Retorna o objeto em formato json.
+        '''
+        return json.dumps({
+            'type': 'transfer',
+            'campaign_id': self.campaign_id,
+            'observations': self.observations,
+        })

{chatgraph-0.1.2 → chatgraph-0.1.4}/chatgraph/types/route.py

@@ -28,13 +28,13 @@ class Route:
         Retorna o caminho anterior ao caminho atual.
 
         Raises:
-            RouteError: Se a rota atual for 'START', indicando que não há caminho anterior.
+            RouteError: Se a rota atual for 'start', indicando que não há caminho anterior.
 
         Returns:
             str: O caminho anterior à rota atual.
         """
-        if self.current == 'START':
-            raise RouteError('Não há caminho anterior ao START')
+        if self.current == 'start':
+            raise RouteError('Não há caminho anterior ao start')
 
         previous_route = self.separator.join(self.current.split(self.separator)[:-1])
         return previous_route
@@ -52,7 +52,7 @@ class Route:
         Returns:
             str: O próximo caminho construído a partir da rota atual e da parte fornecida.
         """
-        next_part = next_part.strip().upper()
+        next_part = next_part.strip().lower()
         next_route = f"{self.current.rstrip(self.separator)}{next_part}"
         if next_route not in self.routes:
             raise RouteError(f'Rota não encontrada: {next_route}')

{chatgraph-0.1.2 → chatgraph-0.1.4}/chatgraph/types/user_state.py

@@ -31,6 +31,16 @@ class UserState(ABC):
             menu (str): O menu a ser definido para o cliente.
         """
         pass
+    
+    @abstractmethod
+    def delete_menu(self, customer_id: str) -> None:
+        """
+        Deleta o menu atual para o ID de cliente fornecido.
+
+        Args:
+            customer_id (str): O ID do cliente.
+        """
+        pass
 
 
 class SimpleUserState(UserState):
@@ -49,7 +59,7 @@ class SimpleUserState(UserState):
 
     def get_menu(self, customer_id: str) -> str:
         """
-        Retorna o menu atual para o ID de cliente fornecido. Se o cliente não tiver um menu definido, define 'START' como padrão.
+        Retorna o menu atual para o ID de cliente fornecido. Se o cliente não tiver um menu definido, define 'start' como padrão.
 
         Args:
             customer_id (str): O ID do cliente.
@@ -57,8 +67,8 @@ class SimpleUserState(UserState):
         Returns:
             str: O menu atual associado ao cliente.
         """
-        menu = self.states.get(customer_id, 'START')
-        if menu == 'START':
+        menu = self.states.get(customer_id, 'start')
+        if menu == 'start':
             self.set_menu(customer_id, menu)
         return menu
 
@@ -71,4 +81,14 @@ class SimpleUserState(UserState):
             menu (str | None): O menu a ser definido para o cliente. Se None, não faz nenhuma alteração.
         """
         if menu:
-            self.states[customer_id] = menu.upper()
+            self.states[customer_id] = menu.lower()
+
+    def delete_menu(self, customer_id: str) -> None:
+        """
+        Deleta o menu atual para o ID de cliente fornecido.
+
+        Args:
+            customer_id (str): O ID do cliente.
+        """
+        if customer_id in self.states:
+            self.states.pop(customer_id)

{chatgraph-0.1.2 → chatgraph-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "chatgraph"
-version = "0.1.2"
+version = "0.1.4"
 description = "A user-friendly chatbot library"
 authors = ["Irisson N. Lima <irisson.lima@verdecard.com.br>"]
 readme = "README.md"

chatgraph-0.1.2/chatgraph/types/output_state.py

@@ -1,42 +0,0 @@
-from typing import Union
-
-messageTypes = Union[str, float, int, None]
-
-
-class ChatbotResponse:
-    """
-    Representa a resposta do chatbot, contendo a mensagem a ser enviada ao usuário e a rota a ser seguida.
-
-    Atributos:
-        message (messageTypes): A mensagem de resposta do chatbot. Pode ser uma string, um número, ou None.
-        route (str, opcional): A rota para a qual o chatbot deve direcionar após esta mensagem. Padrão é None.
-    """
-
-    def __init__(self, message: messageTypes = None, route: str = None) -> None:
-        """
-        Inicializa a resposta do chatbot com uma mensagem e uma rota opcional.
-
-        Args:
-            message (messageTypes, opcional): A mensagem a ser enviada ao usuário. Pode ser uma string, um número, ou None.
-            route (str, opcional): A rota para a qual o chatbot deve direcionar após esta mensagem. Padrão é None.
-        """
-        self.message = message
-        self.route = route
-
-
-class RedirectResponse:
-    """
-    Representa uma resposta que redireciona o fluxo do chatbot para uma nova rota.
-
-    Atributos:
-        route (str): A rota para a qual o chatbot deve redirecionar.
-    """
-
-    def __init__(self, route: str) -> None:
-        """
-        Inicializa a resposta de redirecionamento com a rota especificada.
-
-        Args:
-            route (str): A rota para a qual o chatbot deve redirecionar.
-        """
-        self.route = route