iatoolkit 0.59.1__py3-none-any.whl → 0.67.0__py3-none-any.whl

iatoolkit/services/user_feedback_service.py

@@ -3,62 +3,103 @@
 #
 # IAToolkit is open source software.
 
-from iatoolkit.repositories.models import UserFeedback
+from iatoolkit.repositories.models import UserFeedback, Company
 from injector import inject
 from iatoolkit.repositories.profile_repo import ProfileRepo
+from iatoolkit.services.i18n_service import I18nService
 from iatoolkit.infra.google_chat_app import GoogleChatApp
+from iatoolkit.infra.mail_app import MailApp
 import logging
 
 
 class UserFeedbackService:
     @inject
-    def __init__(self, profile_repo: ProfileRepo, google_chat_app: GoogleChatApp):
+    def __init__(self,
+                 profile_repo: ProfileRepo,
+                 i18n_service: I18nService,
+                 google_chat_app: GoogleChatApp,
+                 mail_app: MailApp):
         self.profile_repo = profile_repo
+        self.i18n_service = i18n_service
         self.google_chat_app = google_chat_app
+        self.mail_app = mail_app
+
+    def _send_google_chat_notification(self, space_name: str, message_text: str):
+        """Envía una notificación de feedback a un espacio de Google Chat."""
+        try:
+            chat_data = {
+                "type": "MESSAGE_TRIGGER",
+                "space": {"name": space_name},
+                "message": {"text": message_text}
+            }
+            chat_result = self.google_chat_app.send_message(message_data=chat_data)
+            if not chat_result.get('success'):
+                logging.warning(f"error sending notification to Google Chat: {chat_result.get('message')}")
+        except Exception as e:
+            logging.exception(f"error sending notification to Google Chat: {e}")
+
+    def _send_email_notification(self, destination_email: str, company_name: str, message_text: str):
+        """Envía una notificación de feedback por correo electrónico."""
+        try:
+            subject = f"Nuevo Feedback de {company_name}"
+            # Convertir el texto plano a un HTML simple para mantener los saltos de línea
+            html_body = message_text.replace('\n', '<br>')
+            self.mail_app.send_email(to=destination_email, subject=subject, body=html_body)
+        except Exception as e:
+            logging.exception(f"error sending email de feedback: {e}")
+
+    def _handle_notification(self, company: Company, message_text: str):
+        """Lee la configuración de la empresa y envía la notificación al canal correspondiente."""
+        feedback_params = company.parameters.get('user_feedback')
+        if not isinstance(feedback_params, dict):
+            logging.warning(f"missing 'user_feedback' configuration for company: {company.short_name}.")
+            return
+
+        # get channel and destination
+        channel = feedback_params.get('channel')
+        destination = feedback_params.get('destination')
+        if not channel or not destination:
+            logging.warning(f"invalid 'user_feedback' configuration for: {company.short_name}. Faltan 'channel' o 'destination'.")
+            return
+
+        if channel == 'google_chat':
+            self._send_google_chat_notification(space_name=destination, message_text=message_text)
+        elif channel == 'email':
+            self._send_email_notification(destination_email=destination, company_name=company.short_name, message_text=message_text)
+        else:
+            logging.warning(f"unknown feedback channel: '{channel}' for company {company.short_name}.")
 
     def new_feedback(self,
                      company_short_name: str,
                      message: str,
                      user_identifier: str,
-                     space: str = None,
-                     type: str = None,
                      rating: int = None) -> dict:
         try:
-            # validate company
             company = self.profile_repo.get_company_by_short_name(company_short_name)
             if not company:
-                return {'error': f'No existe la empresa: {company_short_name}'}
+                return {'error': self.i18n_service.t('errors.company_not_found', company_short_name=company_short_name)}
 
-            # send notification to Google Chat
-            chat_message = f"*Nuevo feedback de {company_short_name}*:\n*Usuario:* {user_identifier}\n*Mensaje:* {message}\n*Calificación:* {rating}"
-
-            # TO DO: get the space and type from the input data
-            chat_data = {
-                "type": type,
-                "space": {
-                    "name": space
-                },
-                "message": {
-                    "text": chat_message
-                }
-            }
-
-            chat_result = self.google_chat_app.send_message(message_data=chat_data)
-            if not chat_result.get('success'):
-                logging.warning(f"Error al enviar notificación a Google Chat: {chat_result.get('message')}")
+            # 2. send notification using company configuration
+            notification_text = (f"*Nuevo feedback de {company_short_name}*:\n"
+                                 f"*Usuario:* {user_identifier}\n"
+                                 f"*Mensaje:* {message}\n"
+                                 f"*Calificación:* {rating if rating is not None else 'N/A'}")
+            self._handle_notification(company, notification_text)
 
-            # create the UserFeedback object
-            new_feedback = UserFeedback(
+            # 3. always save the feedback in the database
+            new_feedback_obj = UserFeedback(
                 company_id=company.id,
                 message=message,
                 user_identifier=user_identifier,
                 rating=rating
             )
-            new_feedback = self.profile_repo.save_feedback(new_feedback)
-            if not new_feedback:
-                return {'error': 'No se pudo guardar el feedback'}
+            saved_feedback = self.profile_repo.save_feedback(new_feedback_obj)
+            if not saved_feedback:
+                logging.error(f"can't save feedback for user {user_identifier}/{company_short_name}")
+                return {'error': 'can not save the feedback'}
 
-            return {'message': 'Feedback guardado correctamente'}
+            return {'success': True, 'message': 'Feedback guardado correctamente'}
 
         except Exception as e:
+            logging.exception(f"Error crítico en el servicio de feedback: {e}")
             return {'error': str(e)}

iatoolkit/static/js/chat_feedback_button.js

@@ -0,0 +1,80 @@
+$(document).ready(function () {
+    const feedbackModal = $('#feedbackModal');
+    $('#submit-feedback').on('click', function () {
+        sendFeedback(this);
+    });
+
+    // Evento para enviar el feedback
+    async function sendFeedback(submitButton) {
+        toastr.options = {"positionClass": "toast-bottom-right", "preventDuplicates": true};
+        const feedbackText = $('#feedback-text').val().trim();
+        const activeStars = $('.star.active').length;
+
+        if (!feedbackText) {
+            toastr.error(t_js('feedback_comment_error'));
+            return;
+        }
+
+        if (activeStars === 0) {
+            toastr.error(t_js('feedback_rating_error'));
+            return;
+        }
+
+        submitButton.disabled = true;
+
+        // call the IAToolkit API to send feedback
+        const data = {
+            "user_identifier": window.user_identifier,
+            "message": feedbackText,
+            "rating": activeStars,
+        };
+
+        const responseData = await callToolkit('/api/feedback', data, "POST");
+        if (responseData)
+            toastr.success(t_js('feedback_sent_success_body'), t_js('feedback_sent_success_title'));
+        else
+            toastr.error(t_js('feedback_sent_error'));
+
+        submitButton.disabled = false;
+        feedbackModal.modal('hide');
+    }
+
+// Evento para abrir el modal de feedback
+$('#send-feedback-button').on('click', function () {
+    $('#submit-feedback').prop('disabled', false);
+    $('.star').removeClass('active hover-active'); // Resetea estrellas
+    $('#feedback-text').val('');
+    feedbackModal.modal('show');
+});
+
+// Evento que se dispara DESPUÉS de que el modal se ha ocultado
+$('#feedbackModal').on('hidden.bs.modal', function () {
+    $('#feedback-text').val('');
+    $('.star').removeClass('active');
+});
+
+// Function for the star rating system
+window.gfg = function (rating) {
+    $('.star').removeClass('active');
+    $('.star').each(function (index) {
+        if (index < rating) {
+            $(this).addClass('active');
+        }
+    });
+};
+
+$('.star').hover(
+    function () {
+        const rating = $(this).data('rating');
+        $('.star').removeClass('hover-active');
+        $('.star').each(function (index) {
+            if ($(this).data('rating') <= rating) {
+                $(this).addClass('hover-active');
+            }
+        });
+    },
+    function () {
+        $('.star').removeClass('hover-active');
+    });
+
+});

iatoolkit/static/js/chat_help_content.js

@@ -0,0 +1,124 @@
+$(document).ready(function () {
+
+    let helpContent = null; // Variable para cachear el contenido de ayuda
+
+    // Evento de clic en el botón de ayuda
+    $('#open-help-button').on('click', async function () {
+        const helpModal = new bootstrap.Modal(document.getElementById('helpModal'));
+        const accordionContainer = $('#help-accordion-container');
+        const spinner = $('#help-spinner');
+
+        // Si el contenido no se ha cargado, hacer la llamada a la API
+        if (helpContent) {
+            // Si el contenido ya está cacheado, solo muestra el modal
+            helpModal.show();
+            return;
+        }
+
+        spinner.show();
+        accordionContainer.hide();
+        helpModal.show();
+
+        try {
+            const helpContent = await callToolkit('/api/help-content', {}, "POST");
+
+            if (!helpContent) {
+                toastr.error('No se pudo cargar la guía de uso. Por favor, intente más tarde.');
+                spinner.hide();
+                helpModal.hide();
+                return;
+            }
+
+            // Construir el HTML del acordeón y mostrarlo
+            buildHelpAccordion(helpContent);
+            spinner.hide();
+            accordionContainer.show();
+
+        } catch (error) {
+            console.error("Error al cargar el contenido de ayuda:", error);
+            toastr.error('Ocurrió un error de red al cargar la guía.');
+            spinner.hide();
+            helpModal.hide();
+        }
+    });
+
+    /**
+     * Construye dinámicamente el HTML para el acordeón de ayuda a partir de los datos.
+     * @param {object} data El objeto JSON con el contenido de ayuda.
+     */
+    function buildHelpAccordion(data) {
+        const container = $('#help-accordion-container');
+        container.empty(); // Limpiar cualquier contenido previo
+
+        let accordionHtml = '';
+
+        if (data.example_questions) {
+            let contentHtml = '';
+            data.example_questions.forEach(cat => {
+                contentHtml += `<h6 class="fw-bold">${cat.category}</h6><ul>`;
+                cat.questions.forEach(q => contentHtml += `<li>${q}</li>`);
+                contentHtml += `</ul>`;
+            });
+            accordionHtml += createAccordionItem('examples', 'Preguntas de Ejemplo', contentHtml, true);
+        }
+
+        if (data.data_sources) {
+            let contentHtml = '<dl>';
+            data.data_sources.forEach(p => {
+                contentHtml += `<dt>${p.source}</dt><dd>${p.description}</dd>`;
+            });
+            contentHtml += `</dl>`;
+            accordionHtml += createAccordionItem('sources', 'Datos disponibles', contentHtml );
+        }
+
+        if (data.best_practices) {
+            let contentHtml = '<dl>';
+            data.best_practices.forEach(p => {
+                contentHtml += `<dt>${p.title}</dt><dd>${p.description}`;
+                if (p.example) {
+                    contentHtml += `<br><small class="text-muted"><em>Ej: "${p.example}"</em></small>`;
+                }
+                contentHtml += `</dd>`;
+            });
+            contentHtml += `</dl>`;
+            accordionHtml += createAccordionItem('practices', 'Mejores Prácticas', contentHtml);
+        }
+
+        if (data.capabilities) {
+            let contentHtml = `<div class="row">`;
+            contentHtml += `<div class="col-md-6"><h6 class="fw-bold">Puede hacer:</h6><ul>${data.capabilities.can_do.map(item => `<li>${item}</li>`).join('')}</ul></div>`;
+            contentHtml += `<div class="col-md-6"><h6 class="fw-bold">No puede hacer:</h6><ul>${data.capabilities.cannot_do.map(item => `<li>${item}</li>`).join('')}</ul></div>`;
+            contentHtml += `</div>`;
+            accordionHtml += createAccordionItem('capabilities', 'Capacidades y Límites', contentHtml);
+        }
+
+        container.html(accordionHtml);
+    }
+
+    /**
+     * Helper para crear un item del acordeón de Bootstrap.
+     * @param {string} id El ID base para los elementos.
+     * @param {string} title El título que se muestra en el botón del acordeón.
+     * @param {string} contentHtml El HTML que va dentro del cuerpo colapsable.
+     * @param {boolean} isOpen Si el item debe estar abierto por defecto.
+     * @returns {string} El string HTML del item del acordeón.
+     */
+    function createAccordionItem(id, title, contentHtml, isOpen = false) {
+        const showClass = isOpen ? 'show' : '';
+        const collapsedClass = isOpen ? '' : 'collapsed';
+
+        return `
+            <div class="accordion-item">
+                <h2 class="accordion-header" id="heading-${id}">
+                    <button class="accordion-button ${collapsedClass}" type="button" data-bs-toggle="collapse" data-bs-target="#collapse-${id}" aria-expanded="${isOpen}" aria-controls="collapse-${id}">
+                        ${title}
+                    </button>
+                </h2>
+                <div id="collapse-${id}" class="accordion-collapse collapse ${showClass}" aria-labelledby="heading-${id}" data-bs-parent="#help-accordion-container">
+                    <div class="accordion-body">
+                        ${contentHtml}
+                    </div>
+                </div>
+            </div>`;
+    }
+});

iatoolkit/static/js/chat_history_button.js

@@ -0,0 +1,110 @@
+$(document).ready(function () {
+    // Evento para abrir el modal de historial
+    const historyModal = $('#historyModal');
+
+    $('#history-button').on('click', function() {
+        historyModal.modal('show');
+        loadHistory();
+    });
+
+
+    // Función para cargar el historial
+    async function loadHistory() {
+        const historyLoading = $('#history-loading');
+        const historyContent = $('#history-content');
+        const historyTable = historyContent.find('table');
+        const noHistoryMessage = $('#no-history-message');
+
+        // prepare UI for loading
+        historyLoading.show();
+        historyContent.hide();
+        historyTable.show();
+        noHistoryMessage.hide();
+
+        // cal the toolkit, handle the response and errors
+        const data = await callToolkit("/api/history", {}, "POST");
+
+        if (!data || !data.history) {
+            historyLoading.hide();
+            toastr.error(t_js('error_loading_history'));
+            return;
+        }
+
+        if (data.history.length === 0) {
+            historyTable.hide();
+            noHistoryMessage.show();
+        } else
+            displayAllHistory(data.history);
+
+        historyLoading.hide();
+        historyContent.show();
+    }
+
+    // Función para mostrar todo el historial
+    function displayAllHistory(historyData) {
+        const historyTableBody = $('#history-table-body');
+
+        historyTableBody.empty();
+
+        // Filtrar solo consultas que son strings simples
+        const filteredHistory = historyData.filter(item => {
+            try {
+                JSON.parse(item.query);
+                return false;
+            } catch (e) {
+                return true;
+            }
+        });
+
+        // Poblar la tabla
+        filteredHistory.forEach((item, index) => {
+            const icon = $('<i>').addClass('bi bi-pencil-fill');
+
+            const edit_link = $('<a>')
+                .attr('href', 'javascript:void(0);')
+                .addClass('edit-pencil')
+                .attr('title', t_js('edit_query'))
+                .data('query', item.query)
+                .append(icon);
+
+            const row = $('<tr>').append(
+                $('<td>').addClass('text-nowrap').text(formatDate(item.created_at)),
+                $('<td>').text(item.query),
+                $('<td>').append(edit_link),
+            );
+            historyTableBody.append(row);
+        });
+    }
+
+    function formatDate(dateString) {
+        const date = new Date(dateString);
+        const padTo2Digits = (num) => num.toString().padStart(2, '0');
+
+        const day = padTo2Digits(date.getDate());
+        const month = padTo2Digits(date.getMonth() + 1);
+        const year = date.getFullYear();
+        const hours = padTo2Digits(date.getHours());
+        const minutes = padTo2Digits(date.getMinutes());
+
+        return `${day}-${month} ${hours}:${minutes}`;
+    }
+
+    // event handler for the edit pencil icon
+    $('#history-table-body').on('click', '.edit-pencil', function() {
+        const queryText = $(this).data('query');
+
+        // copy the text to the chat input box
+        if (queryText) {
+            $('#question').val(queryText);
+            autoResizeTextarea($('#question')[0]);
+            $('#send-button').removeClass('disabled');
+
+            // Cerrar el modal
+            $('#historyModal').modal('hide');
+
+            // Hacer focus en el textarea
+            if (window.innerWidth > 768)
+                $('#question').focus();
+        }
+    });
+});

iatoolkit/static/js/chat_logout_button.js

@@ -0,0 +1,36 @@
+document.addEventListener('DOMContentLoaded', function() {
+    const logoutButton = document.getElementById('logout-button');
+    if (!logoutButton) {
+        console.warn('El botón de logout con id "logout-button" no fue encontrado.');
+        return;
+    }
+
+    if (window.toastr) {
+        toastr.options = { "positionClass": "toast-bottom-right", "preventDuplicates": true };
+    }
+
+    logoutButton.addEventListener('click', async function(event) {
+        event.preventDefault();
+
+        try {
+            const apiPath = '/api/logout';
+            const data = await callToolkit(apiPath, null, 'GET');
+
+            // Procesar la respuesta
+            if (data && data.status === 'success' && data.url) {
+                window.top.location.href = data.url;
+            } else {
+                // Si algo falla, callToolkit usualmente muestra un error.
+                // Mostramos un toast como fallback.
+                if (window.toastr) {
+                    toastr.error('No se pudo procesar el cierre de sesión. Por favor, intente de nuevo.');
+                }
+            }
+        } catch (error) {
+            console.error('Error durante el logout:', error);
+            if (window.toastr) {
+                toastr.error('Ocurrió un error de red al intentar cerrar sesión.');
+            }
+        }
+    });
+});