csc-cia-stne 0.0.53__py3-none-any.whl → 0.0.55__py3-none-any.whl

csc_cia_stne/karavela.py

@@ -1,5 +1,7 @@
 import os
 from botcity.maestro import *
+from typing import Optional
+
 
 class Karavela():
 
@@ -81,65 +83,67 @@ class Karavela():
         
             raise e
     
-    def get_secret(self,name:str, maestro: bool = None)->str:
-        """Extrai a secret do ambiente
+    
+    # def get_secret(self, name: str, maestro: Optional[BotMaestroSDK] = None) -> str:
+    #     """Extrai a secret do ambiente
 
-        Args:
-            name (str): nome da variavel ou arquivo da secret
+    #     Args:
+    #         name (str): nome da variavel ou arquivo da secret
+    #         maestro ( Optional[BotMaestroSDK]): Recebe o Maestro da Botcity. e opcional.
 
-        Returns:
-            str: string da secret armazenada na variável de ambiente ou no arquivo de secret
-        """
+    #     Returns:
+    #         str: string da secret armazenada na variável de ambiente ou no arquivo de secret
+    #     """
         
-        # Tentando extrair da variavel de ambiente
-        secret = os.getenv(name)
+    #     # Tentando extrair da variavel de ambiente
+    #     secret = os.getenv(name)
         
-        # secret não encontrada em variavel de ambiente, tentando extrair do arquivo em /secret
-        if secret is None:
+    #     # secret não encontrada em variavel de ambiente, tentando extrair do arquivo em /secret
+    #     if secret is None:
 
-            # verifica na pasta ./secrets
-            if os.path.exists(f"./secrets/{name}"):
+    #         # verifica na pasta ./secrets
+    #         if os.path.exists(f"./secrets/{name}"):
 
-                with open(f"./secrets/{name}",'r') as secret_file:
+    #             with open(f"./secrets/{name}",'r') as secret_file:
             
-                    secret = secret_file.read()
+    #                 secret = secret_file.read()
 
-            # verifica na pasta ./.secrets
-            elif os.path.exists(f"./.secrets/{name}"):
+    #         # verifica na pasta ./.secrets
+    #         elif os.path.exists(f"./.secrets/{name}"):
 
-                with open(f"./.secrets/{name}",'r') as secret_file:
+    #             with open(f"./.secrets/{name}",'r') as secret_file:
             
-                    secret = secret_file.read()
+    #                 secret = secret_file.read()
 
-            # verifica na pasta ./private
-            elif os.path.exists(f"./private/{name}"):
+    #         # verifica na pasta ./private
+    #         elif os.path.exists(f"./private/{name}"):
 
-                with open(f"./private/{name}",'r') as secret_file:
+    #             with open(f"./private/{name}",'r') as secret_file:
             
-                    secret = secret_file.read()
+    #                 secret = secret_file.read()
 
-            # verifica na pasta ./.private
-            elif os.path.exists(f"./.private/{name}"):
+    #         # verifica na pasta ./.private
+    #         elif os.path.exists(f"./.private/{name}"):
 
-                with open(f"./.private/{name}",'r') as secret_file:
+    #             with open(f"./.private/{name}",'r') as secret_file:
             
-                    secret = secret_file.read()
+    #                 secret = secret_file.read()
 
-            # verifica na pasta /secrets
-            elif os.path.exists(f"/secrets/{name}"):
+    #         # verifica na pasta /secrets
+    #         elif os.path.exists(f"/secrets/{name}"):
 
-                with open(f"/secrets/{name}",'r') as secret_file:
+    #             with open(f"/secrets/{name}",'r') as secret_file:
             
-                    secret = secret_file.read()
+    #                 secret = secret_file.read()
 
-            elif maestro and isinstance(maestro, BotMaestroSDK):
-                try:
+    #         elif maestro and isinstance(maestro, BotMaestroSDK):
+    #             try:
                 
-                    secret = maestro.get_credential(label=name, key=name)
+    #                 secret = maestro.get_credential(label=name, key=name)
                 
-                except Exception as e:
+    #             except Exception as e:
                     
-                    secret = None
+    #                 secret = None
 
-        return secret
+    #     return secret
     

csc_cia_stne/utilitarios/__init__.py

@@ -1,9 +1,10 @@
-from .functions import titulo, recriar_pasta, b64encode, b64decode, convert_bquery_result_to_json,get_config
+from .functions import titulo, recriar_pasta, b64encode, b64decode, convert_bquery_result_to_json,get_config, get_secret
 __all__ = [
     "titulo", 
     "recriar_pasta", 
     "b64encode", 
     "b64decode", 
     "convert_bquery_result_to_json",
-    "get_config"
+    "get_config",
+    "get_secret"
     ]

csc_cia_stne/utilitarios/functions/__init__.py

@@ -3,6 +3,7 @@ from .func_recriar_pastas import recriar_pasta
 from .func_b64 import b64decode, b64encode
 from .func_converters import convert_bquery_result_to_json
 from .func_settings import get_config
+from .func_get_secret import get_secret
 
 __all__ = [
     "titulo", 
@@ -10,5 +11,6 @@ __all__ = [
     "b64encode", 
     "b64decode", 
     "convert_bquery_result_to_json",
-    "get_config"
+    "get_config",
+    "get_secret"
     ]

csc_cia_stne/utilitarios/functions/func_get_secret.py

@@ -0,0 +1,67 @@
+import os
+from botcity.maestro import *
+from typing import Optional
+
+def get_secret(name: str, maestro: Optional[BotMaestroSDK] = None) -> str:
+        """
+        Extrai a secret do ambiente
+
+        Args:
+            name (str): nome da variavel ou arquivo da secret
+            maestro ( Optional[BotMaestroSDK]): Recebe o Maestro da Botcity. e opcional.
+
+        Returns:
+            str: string da secret armazenada na variável de ambiente ou no arquivo de secret
+        """
+        
+        # Tentando extrair da variavel de ambiente
+        secret = os.getenv(name)
+        
+        # secret não encontrada em variavel de ambiente, tentando extrair do arquivo em /secret
+        if secret is None:
+
+            # verifica na pasta ./secrets
+            if os.path.exists(f"./secrets/{name}"):
+
+                with open(f"./secrets/{name}",'r') as secret_file:
+            
+                    secret = secret_file.read()
+
+            # verifica na pasta ./.secrets
+            elif os.path.exists(f"./.secrets/{name}"):
+
+                with open(f"./.secrets/{name}",'r') as secret_file:
+            
+                    secret = secret_file.read()
+
+            # verifica na pasta ./private
+            elif os.path.exists(f"./private/{name}"):
+
+                with open(f"./private/{name}",'r') as secret_file:
+            
+                    secret = secret_file.read()
+
+            # verifica na pasta ./.private
+            elif os.path.exists(f"./.private/{name}"):
+
+                with open(f"./.private/{name}",'r') as secret_file:
+            
+                    secret = secret_file.read()
+
+            # verifica na pasta /secrets
+            elif os.path.exists(f"/secrets/{name}"):
+
+                with open(f"/secrets/{name}",'r') as secret_file:
+            
+                    secret = secret_file.read()
+
+            elif maestro and isinstance(maestro, BotMaestroSDK):
+                try:
+                
+                    secret = maestro.get_credential(label=name, key=name)
+                
+                except Exception as e:
+                    
+                    secret = None
+
+        return secret

csc_cia_stne/utilitarios/validations/web_validator.py

@@ -10,6 +10,7 @@ class InitParamsValidator(BaseModel):
         disable_gpu (bool): Define se a aceleração de hardware será desabilitada.
         no_sandbox (bool): Define se o sandbox do navegador será desabilitado.
         timeout (int): O tempo limite para a execução de operações.
+        security (bool): Define se a segurança do navegador será habilitada.
     Métodos:
         check_str_basic(cls, value, info): Valida se o valor é uma string não vazia e se está dentro das opções permitidas.
         check_bool_input(cls, value, info): Valida se o valor é um booleano.
@@ -20,6 +21,7 @@ class InitParamsValidator(BaseModel):
     disable_gpu:bool
     no_sandbox:bool
     timeout:int
+    security:bool
 
     @field_validator('model')
     def check_str_basic(cls, value, info):
@@ -35,7 +37,7 @@ class InitParamsValidator(BaseModel):
             raise ValueError(f"O parametro 'model' deve ser um int e não um {type(value)} e não vazio")
         return value
     
-    @field_validator('headless','disable_gpu','no_sandbox')
+    @field_validator('headless','disable_gpu','no_sandbox','security')
     def check_bool_input(cls, value, info):
         if not isinstance(value, bool):
             raise ValueError(f"O parametro '{info.field_name}' deve ser um boleano")
@@ -97,6 +99,60 @@ class SelectValueValidator():
     target:str
 
     @field_validator('target')
+    def check_str_basic(cls, value, info):
+        if not isinstance(value, str) or not value.strip():
+            raise ValueError(f"O parametro 'target' deve ser uma string e não um {type(value)} e não vazio")
+        return value
+    
+
+class VerifyServerValueValidator():
+    """
+    Classe responsável por validar o valor do servidor.
+    Atributos:
+        url (str): A URL a ser validada.
+    Métodos:
+        check_str_basic(value, info): Verifica se o valor é uma string não vazia.
+    """
+    url: str
+    """
+    Verifica se o valor é uma string não vazia.
+    Parâmetros:
+        value: O valor a ser verificado.
+        info: Informações adicionais.
+    Retorna:
+        str: O valor verificado.
+    Lança:
+        ValueError: Se o valor não for uma string ou se for vazio.
+    """
+
+    @field_validator('url')
+    def check_str_basic(cls, value, info):
+        if not isinstance(value, str) or not value.strip():
+            raise ValueError(f"O parametro 'target' deve ser uma string e não um {type(value)} e não vazio")
+        return value
+    
+    
+class NavigateValidator():
+    """
+    Classe responsável por validar a navegação em uma URL.
+    Atributos:
+        url (str): A URL a ser validada.
+    Métodos:
+        check_str_basic(value, info): Valida se o valor fornecido é uma string não vazia.
+    """
+    url: str
+    """
+    Valida se o valor fornecido é uma string não vazia.
+    Parâmetros:
+        value: O valor a ser validado.
+        info: Informações adicionais.
+    Retorna:
+        str: O valor validado.
+    Lança:
+        ValueError: Se o valor não for uma string ou se for uma string vazia.
+    """
+
+    @field_validator('url')
     def check_str_basic(cls, value, info):
         if not isinstance(value, str) or not value.strip():
             raise ValueError(f"O parametro 'target' deve ser uma string e não um {type(value)} e não vazio")

csc_cia_stne/web.py

@@ -11,17 +11,20 @@ from selenium.webdriver.support import expected_conditions as EC
 from botcity.web import WebBot, Browser
 from botcity.web.util import element_as_select
 
+# Externa
+import requests
+
 # Validador
 from pydantic import ValidationError
 
 # Validadores de parametros
-from .utilitarios.validations.web_validator import InitParamsValidator,ClickOnScreenValidator,InputValueValidator,SelectValueValidator
+from .utilitarios.validations.web_validator import InitParamsValidator,ClickOnScreenValidator,InputValueValidator,SelectValueValidator,VerifyServerValueValidator,NavigateValidator
 
 
 class web_screen():
 
 
-    def __init__(self,model:str="selenium",timeout:int=60,headless:bool=True,disable_gpu:bool=True,no_sandbox:bool=True):
+    def __init__(self,model:str="selenium",timeout:int=60,headless:bool=True,disable_gpu:bool=True,no_sandbox:bool=True,security:bool=True):
         """
         Inicializa a instância da classe Web.
         Parâmetros:
@@ -30,16 +33,18 @@ class web_screen():
         - headless (bool): Define se o navegador será executado em modo headless (sem interface gráfica).
         - disable_gpu (bool): Define se a aceleração de hardware do GPU será desabilitada.
         - no_sandbox (bool): Define se o sandbox do navegador será desabilitado.
+        - security (bool): Define se a segurança do navegador será habilitada.
         Raises:
         - ValueError: Se ocorrer um erro na validação dos dados de entrada da inicialização da instância.
         """
         
         self.model = model
         self.timeout = timeout
+        self.security = security
 
         try:
         
-            InitParamsValidator(model=model,timeout=timeout, headless=headless, disable_gpu=disable_gpu, no_sandbox=no_sandbox)
+            InitParamsValidator(model=model,timeout=timeout, headless=headless, disable_gpu=disable_gpu, no_sandbox=no_sandbox, security=security)
 
         except ValidationError as e:
         
@@ -97,6 +102,105 @@ class web_screen():
 
         return self.web_bot
 
+
+    def verify_server(self,url:str):
+        """
+        Verifica se o servidor está ativo e acessível.
+        Args:
+            url (str): A URL do servidor a ser verificado.
+        Returns:
+            bool: True se o servidor estiver ativo e acessível, False caso contrário.
+        """
+
+        try:
+
+            VerifyServerValueValidator(url=url)
+
+        except ValidationError as e:
+
+            raise ValueError("Erro na validação dos dados de input:", e.errors())
+
+        try:
+
+            reply = requests.get(url, verify=self.security)
+
+        except:
+
+            return False
+        
+        if reply.status_code == 200:
+
+            return True
+        
+        return False
+
+
+    def navigate(self,url:str):
+        """
+        Navega para a URL especificada.
+        Args:
+            url (str): A URL para navegar.
+        Returns:
+            dict: Um dicionário contendo informações sobre o sucesso da navegação.
+                - 'success' (bool): Indica se a navegação foi bem-sucedida.
+                - 'details' (str): Detalhes adicionais sobre a navegação, caso haja algum erro.
+                - 'error' (Exception): A exceção ocorrida durante a navegação, caso haja algum erro.
+        """
+
+        try:
+
+            NavigateValidator(url=url)
+
+        except ValidationError as e:
+
+            raise ValueError("Erro na validação dos dados de input:", e.errors())
+
+        if not self.verify_server(url):
+
+            return {
+                'success': False,
+                'details': f"Não foi possível acessar o endereço {url}."
+            }
+        
+        if self.model.upper() == "SELENIUM":
+
+            try:
+
+                self.bot.get(url)
+
+                return {
+                        "success": True,
+                        "error": None
+                    }
+                        
+            except Exception as e:
+
+                return {
+                    "success": False,
+                    "details":None,
+                    "error": e
+                }
+
+        else:
+
+            try:
+
+                self.bot.browse(url)
+
+                return {
+                        "success": True,
+                        "error": None
+                    }
+                        
+            except Exception as e:
+
+                return {
+                    "success": False,
+                    "details":None,
+                    "error": e
+                }
+
+
     def click_on_screen(self, target:str):
         """
         Clica em um elemento na tela.
@@ -347,4 +451,63 @@ class web_screen():
                     "success": False,
                     "details":None,
                     "error": e
+                }
+            
+    
+    def close(self):
+        """
+        Fecha o navegador web.
+        Retorna um dicionário com as seguintes chaves:
+        - 'success': Indica se o fechamento foi bem-sucedido (True) ou não (False).
+        - 'details': Detalhes adicionais, caso ocorra algum erro durante o fechamento.
+        - 'error': Exceção ocorrida durante o fechamento, caso haja.
+        Se o modelo for 'SELENIUM', o método utiliza o método 'quit()' do objeto 'web_bot' para fechar o navegador.
+        Caso contrário, utiliza o método 'stop_browser()'.
+        Exemplo de retorno em caso de sucesso:
+        {
+            'success': True,
+            'error': None
+        Exemplo de retorno em caso de erro:
+        {
+            'success': False,
+            'details': None,
+            'error': Exception
+        """
+
+        if self.model.upper() == "SELENIUM":
+
+            try:
+
+                self.web_bot.quit()
+
+                return {
+                    "success": True,
+                    "error": None
+                }
+            
+            except Exception as e:
+
+                return {
+                    "success": False,
+                    "details": None,
+                    "error": e
+                }
+            
+        else:
+
+            try:
+
+                self.web_bot.stop_browser()
+
+                return {
+                    "success": True,
+                    "error": None
+                }
+            
+            except Exception as e:
+
+                return {
+                    "success": False,
+                    "details": None,
+                    "error": e
                 }

{csc_cia_stne-0.0.53.dist-info → csc_cia_stne-0.0.55.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.2
 Name: csc_cia_stne
-Version: 0.0.53
+Version: 0.0.55
 Summary: Biblioteca do time CSC-CIA utilizada no desenvolvimento de RPAs
 License: MIT
-Keywords: karavela,csc,cia,stone,rpa,botcity
+Keywords: karavela,csc,cia,stone,rpa,botcity,stne
 Description-Content-Type: text/markdown
 License-File: LICENCE
 Requires-Dist: setuptools

{csc_cia_stne-0.0.53.dist-info → csc_cia_stne-0.0.55.dist-info}/RECORD

@@ -4,18 +4,19 @@ csc_cia_stne/bc_sta.py,sha256=f75HJ7FLIDSJFLDTvvSvCYo9z0HchzP7rDY5WIdiKXY,16830
 csc_cia_stne/email.py,sha256=RK_TzWBVnUfpP-s5NvjTJJjzhICy8e2fME9EuaiySMY,8162
 csc_cia_stne/gcp_bigquery.py,sha256=jYxvqrWDOPkxc05U4aef7V5lL8ptqsE93lfn0dLFyvc,7385
 csc_cia_stne/google_drive.py,sha256=JcXKlRBSxf5CKM-alT4ZpqWVWLZQfIYIX42_nENoTgU,11896
-csc_cia_stne/karavela.py,sha256=6pau3OtMY7Lf3EM29FYPOXs50xKuzpmXvn5dOsBKKNw,4572
+csc_cia_stne/karavela.py,sha256=jJCYX43D49gGuzmwwK6bN9XVnv2dXdp9iHnnV5H1LMQ,4794
 csc_cia_stne/logger_json.py,sha256=CXxSCOFGMymDi8XE9SKnPKjW4D0wJLqDLnxqePS26i8,3187
 csc_cia_stne/logger_rich.py,sha256=WlMqxH1lMy-tzK0I4NpBRgSzPdHc2-YSU71N3SsKM5A,8338
 csc_cia_stne/provio.py,sha256=G-pDnHYLSp97joc7S7dvwjNvl3omnTmvdi3rOPQf5GA,3987
 csc_cia_stne/servicenow.py,sha256=cJtNtLZ8glWfs3OAzl78ZFlPyPz39CSBxHqpTdUU7i0,32136
 csc_cia_stne/slack.py,sha256=33_UNF7M529eIuWjmzSJFEZ4RmVNkFkuVxvxwsKY1tQ,8126
 csc_cia_stne/stne_admin.py,sha256=vnGSEzcmqWE42vg71oEuoRg6ENaGsZsXFOjxduSH4KU,23561
-csc_cia_stne/web.py,sha256=Qpe63EISJ4wWu59ljLLtO7KW9YuGtT9Io-lTpllcyqQ,11089
-csc_cia_stne/utilitarios/__init__.py,sha256=oWxCOFL2wxjs8KBgxoeA6-gVe4ulicVGDgdaw8jzvsY,253
-csc_cia_stne/utilitarios/functions/__init__.py,sha256=iSLKxM8lgPM1lJ51WZ1mwy36IW5iitfMRc_AnEtzpxg,364
+csc_cia_stne/web.py,sha256=_pc6BzPy2x0RvqtZsByjtKcSuUqlVTevfmmmKbVWLhA,15417
+csc_cia_stne/utilitarios/__init__.py,sha256=0FrfH9XklutPS4QlbGjNYPulNfO2LFQoFXRnJQm-pKE,283
+csc_cia_stne/utilitarios/functions/__init__.py,sha256=rdEp4-g0hGu6QF0q6t9VtyedCpYqvQLf7xXlYKxnrrs,422
 csc_cia_stne/utilitarios/functions/func_b64.py,sha256=XGU34BIQQXWXBS0yM2B4A2wDlcrMl1unIJXjq4lpLnk,1254
 csc_cia_stne/utilitarios/functions/func_converters.py,sha256=EY1zvlBaRX7G1MceVSiRXwwKDQDZwUO9iECBL0fe5iU,481
+csc_cia_stne/utilitarios/functions/func_get_secret.py,sha256=khTtUTE-acdA9lIM8l7weejDSqoTYlf59ypBdC_F_lw,2150
 csc_cia_stne/utilitarios/functions/func_recriar_pastas.py,sha256=4whZpB3aJQaCPJ3osMAQpKrzEhqYtJbljGWlx_OvKIM,826
 csc_cia_stne/utilitarios/functions/func_settings.py,sha256=XwlfqdcfocXQ8kTsDKZ6GsAtpzr0_u44AOTIMtdem7U,2059
 csc_cia_stne/utilitarios/functions/func_titulo.py,sha256=bH4tYxovTARF-g2kWUK_GIzzXt8egbVdp6mWD6fc_3I,5345
@@ -23,9 +24,9 @@ csc_cia_stne/utilitarios/validations/GcpBigQueryValidator.py,sha256=PfCeeQquheZk
 csc_cia_stne/utilitarios/validations/GoogleDriveValidator.py,sha256=PBo-AV2bjR__4o9jYxuXO-UyxjAZvVwYgMbtsrFK2sI,4537
 csc_cia_stne/utilitarios/validations/ServiceNowValidator.py,sha256=yleKUIo1ZfyloP9fDPNjv3JJXdLcocT81WIgRSYmqEA,14423
 csc_cia_stne/utilitarios/validations/__init__.py,sha256=O_qyEU2ji3u6LHUXZCXvUFsMpoMWL625qqHTXyXivTA,106
-csc_cia_stne/utilitarios/validations/web_validator.py,sha256=JzmTm8i_3A_2Sauu_UrYQG-rzwx0t5_Kd6w5VofpVWs,3919
-csc_cia_stne-0.0.53.dist-info/LICENCE,sha256=LPGMtgKki2C3KEZP7hDhA1HBrlq5JCHkIeStUCLEMx4,1073
-csc_cia_stne-0.0.53.dist-info/METADATA,sha256=e2asZWi_bhiAQ1P2DRNrz-BywcWPq7dPXlGV20MVpuc,1260
-csc_cia_stne-0.0.53.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-csc_cia_stne-0.0.53.dist-info/top_level.txt,sha256=ldo7GVv3tQx5KJvwBzdZzzQmjPys2NDVVn1rv0BOF2Q,13
-csc_cia_stne-0.0.53.dist-info/RECORD,,
+csc_cia_stne/utilitarios/validations/web_validator.py,sha256=HYKYSpDv1RvRjZIuwTPt-AbEz-9392MxM_O329iYuSA,5722
+csc_cia_stne-0.0.55.dist-info/LICENCE,sha256=LPGMtgKki2C3KEZP7hDhA1HBrlq5JCHkIeStUCLEMx4,1073
+csc_cia_stne-0.0.55.dist-info/METADATA,sha256=3Q1E-ueROR-Se1r9Lkq2u0by3auQKevQAdk9Ofw3IqY,1265
+csc_cia_stne-0.0.55.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+csc_cia_stne-0.0.55.dist-info/top_level.txt,sha256=ldo7GVv3tQx5KJvwBzdZzzQmjPys2NDVVn1rv0BOF2Q,13
+csc_cia_stne-0.0.55.dist-info/RECORD,,