chatgraph 0.1.3__tar.gz → 0.2.0__tar.gz

{chatgraph-0.1.3 → chatgraph-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: chatgraph
-Version: 0.1.3
+Version: 0.2.0
 Summary: A user-friendly chatbot library
 Home-page: https://github.com/irissonnlima/chatgraph
 License: MIT

{chatgraph-0.1.3 → chatgraph-0.2.0}/chatgraph/__init__.py

@@ -2,19 +2,20 @@ from .auth.credentials import Credential
 from .bot.chatbot_model import ChatbotApp
 from .bot.chatbot_router import ChatbotRouter
 from .messages.rabbitMQ_message_consumer import RabbitMessageConsumer
-from .types.message_types import Message
-from .types.output_state import ChatbotResponse, RedirectResponse
+from .types.message_types import Message, UserState
+from .types.output_state import ChatbotResponse, RedirectResponse, EndChatResponse, TransferToHuman
 from .types.route import Route
-from .types.user_state import SimpleUserState
 
 __all__ = [
     'ChatbotApp',
     'Credential',
-    'SimpleUserState',
     'Message',
     'ChatbotRouter',
     'ChatbotResponse',
     'RedirectResponse',
     'RabbitMessageConsumer',
     'Route',
+    'EndChatResponse',
+    'TransferToHuman',
+    'UserState',
 ]

{chatgraph-0.1.3 → chatgraph-0.2.0}/chatgraph/bot/chatbot_model.py

@@ -6,9 +6,8 @@ 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
 
 
@@ -17,16 +16,14 @@ class ChatbotApp(ABC):
     Classe principal para a aplicação do chatbot, gerencia as rotas e a lógica de processamento de mensagens.
     """
 
-    def __init__(self, user_state: UserState, message_consumer: MessageConsumer):
+    def __init__(self, message_consumer: MessageConsumer):
         """
         Inicializa a classe ChatbotApp com um estado de usuário e um consumidor de mensagens.
 
         Args:
-            user_state (UserState): O estado do usuário, que contém informações persistentes sobre as interações do usuário.
             message_consumer (MessageConsumer): O consumidor de mensagens que lida com a entrada de mensagens no sistema.
         """
         self.__message_consumer = message_consumer
-        self.__user_state = user_state
         self.__routes = {}
     
     def include_router(self, router: ChatbotRouter, prefix: str):
@@ -118,7 +115,7 @@ class ChatbotApp(ABC):
         """
         customer_id = message.customer_id
 
-        menu = self.__user_state.get_menu(customer_id)
+        menu = message.user_state.menu
         menu = menu.lower()
         handler = self.__routes.get(menu, None)
 
@@ -139,14 +136,14 @@ class ChatbotApp(ABC):
         message_response = func(**kwargs)
 
         if type(message_response) in (str, float, int):
-            return message_response
-        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
+            response = ChatbotResponse(message_response)
+            return response.json()
+        elif type(message_response) in (ChatbotResponse, EndChatResponse, TransferToHuman):
+            # route = self.__adjust_route(message_response.route, menu)
+            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)
+            message.user_state.menu = route
             return self.process_message(message)
         else:
             raise ChatbotError('Tipo de retorno inválido!')

{chatgraph-0.1.3 → chatgraph-0.2.0}/chatgraph/messages/rabbitMQ_message_consumer.py

@@ -4,7 +4,7 @@ import os
 import pika
 from typing import Callable
 from ..auth.credentials import Credential
-from ..types.message_types import Message
+from ..types.message_types import Message, UserState
 from .base_message_consumer import MessageConsumer
 
 
@@ -164,7 +164,12 @@ class RabbitMessageConsumer(MessageConsumer):
         return Message(
             type=message.get('type', ''),
             text=message.get('text', ''),
-            customer_id=message.get('customer_id', ''),
+            user_state=UserState(
+                customer_id=message.get('customer_id', ''),
+                menu=message.get('menu', ''),
+                lst_update=message.get('lst_update', ''),
+                obs=message.get('obs', {}),
+            ),
             channel=message.get('channel', ''),
             customer_phone=message.get('customer_phone', ''),
             company_phone=message.get('company_phone', ''),

chatgraph-0.2.0/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.3 → chatgraph-0.2.0}/chatgraph/types/message_types.py

@@ -2,6 +2,22 @@ from dataclasses import dataclass
 from typing import Optional
 
 
+@dataclass
+class UserState:
+    """
+    Representa o estado de um usuário.
+    
+    Atributos:
+        customer_id (str): O ID do cliente.
+        menu (str): O menu atual.
+        lst_update (str): A última atualização do menu.
+        obs (dict): Observações adicionais sobre o estado do usuário.
+    """
+    customer_id: str
+    menu: str
+    lst_update: str
+    obs: Optional[dict] = None
+
 @dataclass
 class Message:
     """
@@ -10,7 +26,7 @@ class Message:
     Atributos:
         type (str): O tipo da mensagem (por exemplo, texto, imagem, etc.).
         text (str): O conteúdo textual da mensagem.
-        customer_id (str): O ID do cliente que enviou ou recebeu a mensagem.
+        UserState (UserState): O estado do usuário.
         channel (str): O canal pelo qual a mensagem foi enviada ou recebida (por exemplo, WhatsApp, SMS, etc.).
         customer_phone (str): O número de telefone do cliente.
         company_phone (str): O número de telefone da empresa que está enviando ou recebendo a mensagem.
@@ -18,7 +34,7 @@ class Message:
     """
     type: str
     text: str
-    customer_id: str
+    user_state: UserState
     channel: str
     customer_phone: str
     company_phone: str

chatgraph-0.2.0/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.3 → chatgraph-0.2.0}/chatgraph/types/user_state.py

@@ -1,3 +1,7 @@
+"""
+Deprecated!!
+"""
+
 from abc import ABC, abstractmethod
 
 
@@ -31,6 +35,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):
@@ -72,3 +86,13 @@ class SimpleUserState(UserState):
         """
         if menu:
             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.3 → chatgraph-0.2.0}/pyproject.toml

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

chatgraph-0.1.3/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