csc-cia-stne 0.0.67__tar.gz → 0.0.68__tar.gz

{csc_cia_stne-0.0.67 → csc_cia_stne-0.0.68}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: csc_cia_stne
-Version: 0.0.67
+Version: 0.0.68
 Summary: Biblioteca do time CSC-CIA utilizada no desenvolvimento de RPAs
 License: MIT
 Keywords: karavela,csc,cia,stone,rpa,botcity,stne

{csc_cia_stne-0.0.67 → csc_cia_stne-0.0.68}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "csc_cia_stne"
-version = "0.0.67"
+version = "0.0.68"
 license = { text = "MIT" }
 description = "Biblioteca do time CSC-CIA utilizada no desenvolvimento de RPAs"
 keywords = ["karavela", "csc", "cia", "stone", "rpa", "botcity", "stne"]

csc_cia_stne-0.0.68/src/csc_cia_stne/google_drive.py

@@ -0,0 +1,319 @@
+import os
+from googleapiclient.discovery import build
+from googleapiclient.http import MediaFileUpload
+from googleapiclient.errors import HttpError
+from io import BytesIO
+from google.oauth2 import service_account
+from .utilitarios.validations.GoogleDriveValidator import (
+    InitParamsValidator,
+    CreateFolderValidator,
+    ListFolderValidator,
+    UploadValidator,
+)
+from pydantic import ValidationError
+
+
+class GoogleDrive:
+    """
+    Classe responsável por gerenciar operações no Google Drive, como upload de arquivos, criação de pastas
+    e listagem de conteúdo. Utiliza a API do Google Drive para realizar essas operações.
+
+    Args:
+        key (str): Chave de autenticação para acessar a API do Google Drive.
+    """
+
+    _instance = None  # Atributo de classe para armazenar a única instância.
+
+    def __new__(cls, *args, **kwargs):
+        # Verifica se já existe uma instância da classe.
+        if cls._instance is None:
+            # Cria e armazena a instância na primeira chamada.
+            cls._instance = super().__new__(cls)
+        return cls._instance
+
+    def __init__(
+        self,
+        token: dict,
+        with_subject: str,
+        scopes: list = ["https://www.googleapis.com/auth/drive"],
+        version: str = "v3",
+    ):
+        """
+        Inicializa uma instância da classe GoogleDrive.
+        Parâmetros:
+        - key (str): A chave para acessar o segredo necessário para autenticação.
+        - with_subject (str): O assunto para o qual a autenticação será realizada.
+        - scopes (list): Uma lista de escopos de permissão para acesso ao Google Drive. O valor padrão é ["https://www.googleapis.com/auth/drive"].
+        - version (str): A versão da API do Google Drive a ser utilizada. O valor padrão é "v3".
+        Raises:
+        - ValueError: Se ocorrer um erro na validação dos dados de input da inicialização da instância.
+        Exemplo de uso:
+        ```
+        google_drive = GoogleDrive(key="chave_secreta", with_subject="assunto", scopes=["https://www.googleapis.com/auth/drive"], version="v3")
+        ```
+        """
+
+        try:
+            InitParamsValidator(
+                token=token, with_subject=with_subject, scopes=scopes, version=version
+            )
+        except ValidationError as e:
+            raise ValueError(
+                "Erro na validação dos dados de input da inicialização da instância:",
+                e.errors(),
+            )
+        self.__token = token
+        self.version = version
+        self.scopes = scopes
+        self.with_subject = with_subject
+        self.page_size = 1000
+        self.service = self.__create_service()
+
+    def __create_service(self):
+        """
+        Cria um serviço do Google Drive.
+        Returns:
+            cred: Objeto de credenciais do Google Drive.
+            False: Caso ocorra algum erro ao criar o serviço.
+        Raises:
+            Exception: Caso ocorra algum erro ao criar o serviço do Google Drive.
+        Exemplo de uso:
+            service = create_service()
+            if service:
+                # Fazer algo com o serviço do Google Drive
+            else:
+                # Tratar o erro de criação do serviço
+        """
+
+        try:
+            auth = self.__autentica(self.with_subject)
+            service = build(f"drive", f"{self.version}", credentials=auth)
+            return service
+        except Exception as e:
+            return False
+
+    def __autentica(self, with_subject: str):
+        """
+        Autentica o usuário com as credenciais fornecidas e retorna as credenciais delegadas para o assunto especificado.
+        Args:
+            with_subject (str): O assunto para o qual as credenciais serão delegadas.
+        Returns:
+            google.auth.credentials.Credentials: As credenciais delegadas para o assunto especificado.
+        Raises:
+            Exception: Se ocorrer um erro durante a autenticação.
+        Example:
+            # Autenticar com o assunto "user@example.com"
+            credentials = self.__autentica("user@example.com")
+        """
+
+        try:
+            credentials = service_account.Credentials.from_service_account_info(
+                self.__token, scopes=self.scopes
+            )
+            delegated_credencial = credentials.with_subject(with_subject)
+            return delegated_credencial
+
+        except Exception as e:
+            return False
+
+    def upload(self, folder_id: str, name: str, file_path: str, mimetype: str):
+        """
+        Faz o upload de um arquivo para o Google Drive em uma pasta especificada.
+
+        Args:
+            folder_id (str): ID da pasta no Google Drive onde o arquivo será armazenado.
+            name (str): Nome do arquivo que será carregado.
+            file_path (str): Caminho completo do arquivo no sistema local.
+            mimetype (str): Tipo MIME do arquivo a ser carregado.
+                exemplos:   text/plain
+                            text/html
+                            image/jpeg
+                            image/png
+                            audio/mpeg
+                            audio/ogg
+                            audio/*
+                            video/mp4
+                            application/octet-stream
+
+        Returns:
+            dict: Informações sobre o arquivo carregado, incluindo o ID do arquivo.
+            None: Caso o caminho do arquivo não seja encontrado.
+        """
+        try:
+            UploadValidator(
+                folder_id=folder_id, name=name, file_path=file_path, mimetype=mimetype
+            )
+        except ValidationError as e:
+            raise ValueError(
+                "Erro na validação dos dados para realizar o upload do arquivo",
+                e.errors(),
+            )
+
+        file_metadata = {"name": name, "parents": [folder_id]}
+        if not os.path.exists(file_path):
+            return {
+                "success": False,
+                "result": None,
+                "error": "Diretório ou arquivo não encontrado",
+            }
+
+        try:
+            media = MediaFileUpload(file_path, mimetype=mimetype, resumable=True)
+            file = (
+                self.service.files()
+                .create(
+                    body=file_metadata,
+                    media_body=media,
+                    fields="id",
+                    supportsAllDrives=True,
+                )
+                .execute()
+            )
+
+            return {"success": True, "result": file}
+        except Exception as e:
+
+            return {"success": False, "result": None, "error": str(e)}
+
+    def create_folder(self, name: str, parent_folder_id: str):
+        """
+        Cria uma pasta no Google Drive dentro de uma pasta existente.
+
+        Args:
+            name (str): Nome da pasta a ser criada.
+            parent_folder_id (int): ID da pasta pai onde a nova pasta será criada.
+
+        Returns:
+            str: ID da pasta criada.
+        """
+        try:
+            CreateFolderValidator(name=name, parent_folder_id=parent_folder_id)
+        except ValidationError as e:
+            raise ValueError(
+                "Erro na validação dos dados de input da inicialização da instância:",
+                e.errors(),
+            )
+
+        try:
+            folder_metadata = {
+                "name": name,
+                "parents": [parent_folder_id],
+                "mimeType": "application/vnd.google-apps.folder",
+            }
+            folder = (
+                self.service.files()
+                .create(body=folder_metadata, fields="id", supportsAllDrives=True)
+                .execute()
+            )
+            return {"success": True, "result": folder}
+        except Exception as e:
+            return {"success": False, "result": None, "error": str(e)}
+
+    def list_items_folder(
+        self,
+        query: str = "",
+        spaces: str = "drive",
+        fields: str = "nextPageToken, files(id, name)",
+    ):
+        """
+        Lista os arquivos e pastas no Google Drive com base nos critérios fornecidos.
+
+        Args:
+            query (str, optional): Critério de busca para os arquivos ou pastas no Google Drive.
+                                Consulte https://developers.google.com/drive/api/v3/ref-search-terms.
+                                Defaults to "".
+                                exemplo: query = 'ID_DA_PASTA_NO_GOOGLE_DRIVE' in parents and trashed=false"
+            spaces (str, optional): Especifica os locais de armazenamento a serem consultados. Pode ser 'drive',
+                                    'appDataFolder', ou 'photos'. Defaults to 'drive'.
+            fields (str, optional): Campos a serem retornados na resposta. Consulte a documentação para os campos disponíveis.
+                                    Defaults to "nextPageToken, files(id, name)".
+
+        Returns:
+            dict: Dicionário contendo o resultado da busca.
+        """
+        try:
+            ListFolderValidator(query=query, fields=fields, spaces=spaces)
+        except ValidationError as e:
+            raise ValueError(
+                "Erro na validação dos dados de input da lista:", e.errors()
+            )
+        try:
+            results = (
+                self.service.files()
+                .list(
+                    q=query,
+                    spaces=spaces,
+                    pageSize=self.page_size,
+                    fields=fields,
+                    supportsAllDrives=True,
+                    includeItemsFromAllDrives=True,
+                )
+                .execute()
+            )
+            return {"success": True, "result": results}
+        except HttpError as hr:
+            return {"success": False, "result": None, "error": str(hr)}
+        except Exception as e:
+            return {"success": False, "result": None, "error": str(e)}
+
+    def download_file(self, file: str, mimeType: str):
+        """
+        Obtém o conteúdo de um arquivo armazenado no Google Drive.
+
+        Esta função acessa o Google Drive usando a API e lê os dados do arquivo especificado, retornando-os como um objeto binário de memória (`BytesIO`).
+
+        Parâmetros:
+            - file (str): Dicionário contendo informações do arquivo no Google Drive, incluindo as chaves:
+                - `"name"`: Nome do arquivo.
+                - `"id"`: ID do arquivo.
+
+        Retorna:
+            - BytesIO: Objeto em memória contendo os dados do arquivo.
+            - None: Caso ocorra um erro ao tentar abrir ou ler o arquivo.
+
+        Logs:
+            - Registra mensagens indicando o início e o término da leitura do arquivo.
+            - Em caso de falha, registra o erro ocorrido.
+
+        Exceções:
+            - Qualquer erro durante o processo será capturado e registrado no log. A função retornará `None` nesses casos.
+
+        Dependências:
+            - A função assume a existência de um atributo `self.service` configurado para interagir com a API do Google Drive.
+        """
+        try:
+            request = self.service.files().export_media(
+                fileId=file.get("id"), mimeType=mimeType
+            )
+            with open(file["name"], "wb") as f:
+                f.write(request.execute())
+            return {
+                "success": True,
+                "result": f"Arquivo baixado com sucesso. Diretório: {file}",
+            }
+
+        except Exception as e:
+            return {"success": False, "result": None}
+
+    def get_base_data(self, id_sheet: str, page: str) -> list:
+        """
+        Retorna os dados da planilha especificada.
+        Parâmetros:
+        - drive_client: Cliente do Google Drive.
+        - id_sheet: ID da planilha.
+        - page: Nome da página da planilha.
+        Retorna:
+        - Uma lista contendo os valores da planilha.
+        Exemplo de uso:
+        >>> drive_client = ...
+        >>> id_sheet = "abc123"
+        >>> page = "Sheet1"
+        >>> data = get_base_data(drive_client, id_sheet, page)
+        """
+        try:
+            sheet = self.service.spreadsheets()
+            result = sheet.values().get(spreadsheetId=id_sheet, range=page).execute()
+            values = result.get("values", [])
+            return {"success": True, "result": values}
+        except Exception as e:
+            return {"success": False, "result": None, "error": str(e)}

{csc_cia_stne-0.0.67 → csc_cia_stne-0.0.68}/src/csc_cia_stne.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: csc_cia_stne
-Version: 0.0.67
+Version: 0.0.68
 Summary: Biblioteca do time CSC-CIA utilizada no desenvolvimento de RPAs
 License: MIT
 Keywords: karavela,csc,cia,stone,rpa,botcity,stne

csc_cia_stne-0.0.67/src/csc_cia_stne/google_drive.py

@@ -1,289 +0,0 @@
-import os, logging
-from googleapiclient.discovery import build
-from googleapiclient.http import MediaFileUpload
-from googleapiclient.errors import HttpError
-from io import BytesIO
-from google.oauth2 import service_account
-from .utilitarios.validations.GoogleDriveValidator import InitParamsValidator, CreateFolderValidator, ListFolderValidator, UploadValidator
-from pydantic import ValidationError
-
-
-class GoogleDrive():
-    
-    """
-        Classe responsável por gerenciar operações no Google Drive, como upload de arquivos, criação de pastas
-        e listagem de conteúdo. Utiliza a API do Google Drive para realizar essas operações.
-
-        Args:
-            key (str): Chave de autenticação para acessar a API do Google Drive.
-    """
-    _instance = None  # Atributo de classe para armazenar a única instância.
-
-    def __new__(cls, *args, **kwargs):
-        # Verifica se já existe uma instância da classe.
-        if cls._instance is None:
-            # Cria e armazena a instância na primeira chamada.
-            cls._instance = super().__new__(cls)
-        return cls._instance
-    
-    def __init__(self, token : dict, with_subject : str, scopes : list = ["https://www.googleapis.com/auth/drive"], version : str = "v3"):
-        """
-        Inicializa uma instância da classe GoogleDrive.
-        Parâmetros:
-        - key (str): A chave para acessar o segredo necessário para autenticação.
-        - with_subject (str): O assunto para o qual a autenticação será realizada.
-        - scopes (list): Uma lista de escopos de permissão para acesso ao Google Drive. O valor padrão é ["https://www.googleapis.com/auth/drive"].
-        - version (str): A versão da API do Google Drive a ser utilizada. O valor padrão é "v3".
-        Raises:
-        - ValueError: Se ocorrer um erro na validação dos dados de input da inicialização da instância.
-        Exemplo de uso:
-        ```
-        google_drive = GoogleDrive(key="chave_secreta", with_subject="assunto", scopes=["https://www.googleapis.com/auth/drive"], version="v3")
-        ```
-        """
-        
-        try:
-            InitParamsValidator(token=token, with_subject=with_subject, scopes=scopes, version=version)
-        except ValidationError as e:
-            raise ValueError("Erro na validação dos dados de input da inicialização da instância:", e.errors())
-        self.__token = token
-        self.version = version
-        self.scopes = scopes
-        self.with_subject = with_subject
-        self.page_size = 1000
-        self.service = self.__create_service()
-
-
-    def __create_service(self):
-        """
-        Cria um serviço do Google Drive.
-        Returns:
-            cred: Objeto de credenciais do Google Drive.
-            False: Caso ocorra algum erro ao criar o serviço.
-        Raises:
-            Exception: Caso ocorra algum erro ao criar o serviço do Google Drive.
-        Exemplo de uso:
-            service = create_service()
-            if service:
-                # Fazer algo com o serviço do Google Drive
-            else:
-                # Tratar o erro de criação do serviço
-        """
-        
-        try:
-            auth = self.__autentica(self.with_subject)
-            service = build(f"drive", f"{self.version}", credentials=auth)
-            logging.info(f"Serviço do Google drive criado")
-            return service
-        except Exception as e:
-            logging.info(f"Erro ao criar o serviço do Google drive: Error: {e}")
-            return False
-
-
-    def __autentica(self, with_subject : str):
-        """
-        Autentica o usuário com as credenciais fornecidas e retorna as credenciais delegadas para o assunto especificado.
-        Args:
-            with_subject (str): O assunto para o qual as credenciais serão delegadas.
-        Returns:
-            google.auth.credentials.Credentials: As credenciais delegadas para o assunto especificado.
-        Raises:
-            Exception: Se ocorrer um erro durante a autenticação.
-        Example:
-            # Autenticar com o assunto "user@example.com"
-            credentials = self.__autentica("user@example.com")
-        """
-        
-
-        try:
-            credentials = service_account.Credentials.from_service_account_info(self.__token, scopes=self.scopes)
-            delegated_credencial = credentials.with_subject(with_subject)
-            return delegated_credencial
-
-        except Exception as e:
-            logging.debug(f"Erro ao tentar autenticar. Verifique o erro: {e}")
-            return False
-
-
-    def upload(self, folder_id: str, name: str, file_path: str, mimetype: str):
-        """
-            Faz o upload de um arquivo para o Google Drive em uma pasta especificada.
-
-            Args:
-                folder_id (str): ID da pasta no Google Drive onde o arquivo será armazenado.
-                name (str): Nome do arquivo que será carregado.
-                file_path (str): Caminho completo do arquivo no sistema local.
-                mimetype (str): Tipo MIME do arquivo a ser carregado.
-                    exemplos:   text/plain
-                                text/html
-                                image/jpeg
-                                image/png
-                                audio/mpeg
-                                audio/ogg
-                                audio/*
-                                video/mp4
-                                application/octet-stream
-
-            Returns:
-                dict: Informações sobre o arquivo carregado, incluindo o ID do arquivo.
-                None: Caso o caminho do arquivo não seja encontrado.
-        """
-        try:
-            UploadValidator(folder_id=folder_id, name=name, file_path=file_path, mimetype=mimetype)
-        except ValidationError as e:
-            raise ValueError("Erro na validação dos dados para realizar o upload do arquivo", e.errors())
-        
-
-        
-        file_metadata = {"name": name, "parents": [folder_id]}
-        if not os.path.exists(file_path):
-            logging.debug(f"Pasta {file_path} não encontrada")           
-            return {"success" : False, "result" : None, "error" : "Diretório ou arquivo não encontrado"}
-        
-        try:
-            logging.debug(f"Realizando o upload do arquivo")
-            media = MediaFileUpload(file_path, mimetype=mimetype, resumable=True)
-            file = (
-                self.service.files()
-                .create(body=file_metadata, media_body=media, fields="id", supportsAllDrives=True)
-                .execute()
-            )
-
-            logging.debug(f"Upload realizado com sucesso")
-            return {"success" : True, "result" : file}
-        except Exception as e:
-            logging.debug(f"Erro ao realizar o upload do arquivo {name} no google drive. Erro: {e}")
-            return {"success" : False, "result" : None, "error" : str(e)}
-   
-
-    def create_folder(self, name: str, parent_folder_id: str):
-        """
-            Cria uma pasta no Google Drive dentro de uma pasta existente.
-
-            Args:
-                name (str): Nome da pasta a ser criada.
-                parent_folder_id (int): ID da pasta pai onde a nova pasta será criada.
-
-            Returns:
-                str: ID da pasta criada.
-        """
-        try:
-            CreateFolderValidator(name=name, parent_folder_id=parent_folder_id)
-        except ValidationError as e:
-            raise ValueError("Erro na validação dos dados de input da inicialização da instância:", e.errors())
-            
-        try:
-            folder_metadata = {
-                "name": name,
-                "parents": [parent_folder_id],
-                "mimeType": "application/vnd.google-apps.folder",
-            }
-            folder = (
-                self.service.files().create(body=folder_metadata, fields="id", supportsAllDrives=True).execute()
-            )
-            return {"success" : True, "result": folder}
-        except Exception as e:
-            logging.debug(f"Não foi possível criar a pasta {name}")
-            return {"success" : False, "result": None, "error" : str(e)}
-
-
-    def list_items_folder(self, query: str = "", spaces: str = "drive", fields: str = "nextPageToken, files(id, name)"):
-        """
-            Lista os arquivos e pastas no Google Drive com base nos critérios fornecidos.
-
-            Args:
-                query (str, optional): Critério de busca para os arquivos ou pastas no Google Drive. 
-                                    Consulte https://developers.google.com/drive/api/v3/ref-search-terms.
-                                    Defaults to "".
-                                    exemplo: query = 'ID_DA_PASTA_NO_GOOGLE_DRIVE' in parents and trashed=false"
-                spaces (str, optional): Especifica os locais de armazenamento a serem consultados. Pode ser 'drive', 
-                                        'appDataFolder', ou 'photos'. Defaults to 'drive'.
-                fields (str, optional): Campos a serem retornados na resposta. Consulte a documentação para os campos disponíveis.
-                                        Defaults to "nextPageToken, files(id, name)".
-
-            Returns:
-                dict: Dicionário contendo o resultado da busca.
-        """
-        try:
-            ListFolderValidator(query=query, fields=fields, spaces=spaces)
-        except ValidationError as e:
-            raise ValueError("Erro na validação dos dados de input da lista:", e.errors())
-        try: 
-            results = (
-                self.service.files()
-                .list(q=query,
-                      spaces=spaces,
-                      pageSize=self.page_size,
-                      fields=fields,
-                      supportsAllDrives=True,
-                      includeItemsFromAllDrives=True)
-                .execute()
-            )
-            return {"success" : True, "result" : results}
-        except HttpError as hr:
-            logging.debug(f"Ocorreu um de http. Erro: {hr}")
-            return {"success" : False, "result" : None, "error" : str(hr)}
-        except Exception as e:
-            logging.error(f"Ocorreu um erro ao fazer a requisição. Error: {e}")
-    
-
-    def download_file(self, file : str, mimeType : str):
-        """
-            Obtém o conteúdo de um arquivo armazenado no Google Drive.
-
-            Esta função acessa o Google Drive usando a API e lê os dados do arquivo especificado, retornando-os como um objeto binário de memória (`BytesIO`).
-
-            Parâmetros:
-                - file (str): Dicionário contendo informações do arquivo no Google Drive, incluindo as chaves:
-                    - `"name"`: Nome do arquivo.
-                    - `"id"`: ID do arquivo.
-
-            Retorna:
-                - BytesIO: Objeto em memória contendo os dados do arquivo.
-                - None: Caso ocorra um erro ao tentar abrir ou ler o arquivo.
-
-            Logs:
-                - Registra mensagens indicando o início e o término da leitura do arquivo.
-                - Em caso de falha, registra o erro ocorrido.
-
-            Exceções:
-                - Qualquer erro durante o processo será capturado e registrado no log. A função retornará `None` nesses casos.
-
-            Dependências:
-                - A função assume a existência de um atributo `self.service` configurado para interagir com a API do Google Drive.
-        """
-        try:
-            request = self.service.files().export_media(fileId=file.get("id"), mimeType=mimeType)
-            with open (file["name"], "wb") as f:
-                f.write(request.execute())
-            return {"success" : True, "result" : f"Arquivo baixado com sucesso. Diretório: {file}"}
-    
-        except Exception as e:
-            logging.debug(f"Erro ao tentar abrir o arquivo. Erro {e}")
-            return {"success" : False, "result" : None}
-    
-
-    def get_base_data(self, id_sheet:str,page:str) -> list:
-        """
-        Retorna os dados da planilha especificada.
-        Parâmetros:
-        - drive_client: Cliente do Google Drive.
-        - id_sheet: ID da planilha.
-        - page: Nome da página da planilha.
-        Retorna:
-        - Uma lista contendo os valores da planilha.
-        Exemplo de uso:
-        >>> drive_client = ...
-        >>> id_sheet = "abc123"
-        >>> page = "Sheet1"
-        >>> data = get_base_data(drive_client, id_sheet, page)
-        """
-        try:
-            sheet = self.service.spreadsheets()
-            result = sheet.values().get(spreadsheetId=id_sheet, range=page).execute()
-            values = result.get('values', [])
-            return {"success" : True, "result" : values}
-        except Exception as e:
-            return {"success" : False, "result" : None, "error" : str(e)}
-        
-