csc-cia-stne 0.0.37__py3-none-any.whl → 0.0.39__py3-none-any.whl

csc_cia_stne/slack.py

@@ -0,0 +1,227 @@
+import base64
+from slack_sdk import WebClient
+from pydantic import BaseModel, ValidationError, field_validator
+from typing import Union
+
+
+class InitParamsValidator(BaseModel):
+    """
+    Classe para validar os parâmetros de inicialização.
+    Atributos:
+    - token_slack: Union[str, dict] - O token do Slack, que pode ser uma string ou um dicionário.
+    - channel_id: str - O ID do canal do Slack.
+    - on_base64: bool - Indica se o token do Slack está em base64.
+    Métodos:
+    - validate_token_slack(value, info): Valida o token do Slack.
+    - validate_token_slack_dict(value, info): Valida o token do Slack quando é um dicionário.
+    - validate_token_slack(value, info): Valida o valor de on_base64.
+    """
+        
+    token_slack: Union[str, dict]
+    channel_id:str
+    on_base64:bool
+
+    """
+    Valida o token do Slack.
+    Parâmetros:
+    - value: str - O valor do token do Slack.
+    - info: dict - Informações adicionais sobre o campo.
+    Retorna:
+    - str: O valor do token do Slack, se for válido.
+    Lança:
+    - ValueError: Se o valor não for uma string ou estiver vazio.
+    """
+    @field_validator('channel_id')
+    def validate_token_slack(cls, value, info):
+        if not isinstance(value, str) or not value.strip():
+            raise ValueError(f"O campo '{info.field_name}' deve ser strings e não {type(value)}")
+        return value
+
+    """
+    Valida o token do Slack quando é um dicionário.
+    Parâmetros:
+    - value: dict - O valor do token do Slack.
+    - info: dict - Informações adicionais sobre o campo.
+    Retorna:
+    - dict: O valor do token do Slack, se for válido.
+    Lança:
+    - ValueError: Se o valor não for um dicionário ou uma string vazia.
+    """
+    @field_validator('token_slack')
+    def validate_token_slack_dict(cls, value, info):
+        if not isinstance(value, dict) or (not isinstance(value, str) or not value.strip()):
+            raise ValueError(f"O campo '{info.field_name}' deve ser strings e não {type(value)}")
+        return value
+    
+    """
+    Valida o valor de on_base64.
+    Parâmetros:
+    - value: bool - O valor de on_base64.
+    - info: dict - Informações adicionais sobre o campo.
+    Retorna:
+    - bool: O valor de on_base64, se for válido.
+    Lança:
+    - ValueError: Se o valor não for um booleano.
+    """
+    @field_validator('on_base64')
+    def validate_token_slack(cls, value, info):
+        if not isinstance(value, bool):
+            raise ValueError(f"O campo '{info.field_name}' deve ser strings e não {type(value)}")
+        return value
+
+
+class SendSlackMessageParamsValidator(BaseModel):
+    """
+    Valida os parâmetros para enviar uma mensagem no Slack.
+    Atributos:
+    - message (str): A mensagem a ser enviada.
+    - highlights (list): Uma lista de destaques.
+    - files (list): Uma lista de arquivos.
+    Métodos:
+    - validate_message(value, info): Valida o campo 'message' para garantir que seja uma string não vazia.
+    - validate_list(value, info): Valida os campos 'highlights' e 'files' para garantir que sejam listas.
+    """
+
+    message:str
+    highlights:list
+    files:list
+
+    @field_validator('message')
+    def validate_message(cls, value, info):
+        if not isinstance(value, str) or not value.strip():
+            raise ValueError(f"O campo '{info.field_name}' deve ser strings e não {type(value)}")
+        return value
+    
+    @field_validator('highlights','files')
+    def validate_list(cls, value, info):
+        if not isinstance(value, list):
+            raise ValueError(f"O campo '{info.field_name}' deve ser strings e não {type(value)}")
+        return value
+
+
+class Slack():
+
+
+    def __init__(self, token_slack:Union[str, dict], channel_id, on_base64:bool=False):
+        """
+        Inicializa a classe Slack.
+        Parâmetros:
+        - token_slack (str): O token de autenticação do Slack.
+        - base64 (bool, opcional): Indica se o token_slack está codificado em base64. O padrão é False.
+        """
+        
+        self.token_slack = token_slack
+        self.on_base64 = on_base64
+        self.channel_id = channel_id
+
+        try:
+        
+            InitParamsValidator(token_slack=token_slack, on_base64=on_base64,channel_id=channel_id)
+
+        except ValidationError as e:
+        
+            raise ValueError("Erro na validação dos dados de input da inicialização da instância:", e.errors())
+
+        if self.on_base64:
+
+            self.token_slack = base64.b64decode(self.token_slack).decode('utf-8')
+
+        self.client = WebClient(self.token_slack)
+
+
+    def send_message(self, message:str, highlights:list=[] , files:list=[]):
+        """
+        Envia uma mensagem para o canal do Slack.
+        Parâmetros:
+        - message: str - A mensagem a ser enviada.
+        - highlights: list - Uma lista de destaques (attachments) a serem exibidos junto com a mensagem.
+        - files: list (opcional) - Uma lista de arquivos a serem anexados à mensagem.
+        Retorna:
+        Um dicionário com as seguintes chaves:
+        - status: bool - Indica se o envio da mensagem foi bem-sucedido.
+        - message: dict - A resposta da API do Slack contendo informações sobre a mensagem enviada.
+        - success_attachments: list - Uma lista dos anexos que foram enviados com sucesso.
+        - failed_success_attachments: list - Uma lista dos anexos que falharam ao serem enviados.
+        Caso ocorra algum erro durante o envio da mensagem, o dicionário terá a seguinte estrutura:
+        - status: bool - Indica se ocorreu um erro durante o envio da mensagem.
+        - error: dict - A resposta da API do Slack contendo informações sobre o erro ocorrido.
+        - success_attachments: list - Uma lista dos anexos que foram enviados com sucesso.
+        - failed_attachments: list - Uma lista dos anexos que falharam ao serem enviados.
+        """
+        
+        try:
+        
+            SendSlackMessageParamsValidator(message=message, highlights=highlights, files=files)
+
+        except ValidationError as e:
+        
+            raise ValueError("Erro na validação dos dados de input da inicialização da instância:", e.errors())
+
+
+        failed_attachments = []
+
+        success_attachments = []
+
+        result_message = self.client.chat_postMessage(
+            channel=self.channel_id,
+            text=message,
+            blocks=[
+                {
+                    "type": "section",
+                    "text": {
+                        "type": "mrkdwn",
+                        "text": message
+                    }
+                },
+            ],
+            attachments=highlights
+        )
+
+        if files is not None and len(files) > 0:
+
+            # validar os arquivos anexados
+
+            for file in files:
+
+                if 'title' in file and 'file' in file:
+
+                    if file['title'] is not None and len(str(file['title']).replace(" ","")) > 0 and file['file'] is not None and len(str(files['file']).replace(" ","")) > 0:
+
+                        success_attachments.append(file)
+
+                    else:
+
+                        failed_attachments.append(file)
+
+                else:
+
+                    failed_attachments.append(file)
+
+            if len(success_attachments) > 0:
+
+                # Enviar mensagem com anexos
+
+                result_message = self.client.files_upload_v2(
+                    channel=self.channel_id,
+                    initial_comment="anexos",
+                    file_uploads=success_attachments
+                )
+
+        if result_message.get('ok', True):
+
+            return {
+                'status':True,
+                'message':result_message,
+                'success_attachments':success_attachments,
+                'failed_success_attachments':failed_attachments
+            }
+        
+        else:
+
+            return {
+                'status':False,
+                'error':result_message,
+                'success_attachments':success_attachments,
+                'failed_attachments':failed_attachments
+            }
+        

csc_cia_stne/utilitarios/validations/GoogleDriveValidator.py

@@ -1,5 +1,5 @@
 
-from pydantic import BaseModel, field_validator
+from pydantic import BaseModel, field_validator, EmailStr
 
 class InitParamsValidator(BaseModel):
     """
@@ -14,8 +14,8 @@ class InitParamsValidator(BaseModel):
     - check_list_input(cls, value, info): Valida se o valor é uma lista.
     """
         
-    key: str
-    with_subject: str
+    token: dict
+    with_subject: EmailStr
     scopes : list
     version : str
 
@@ -29,11 +29,17 @@ class InitParamsValidator(BaseModel):
     Lança:
     - ValueError: Se o valor não for uma string ou estiver vazio.
     """
-    @field_validator('key','with_subject', "version")
+    @field_validator("version")
     def check_str_input(cls, value, info):
         if not isinstance(value, str) or not value.strip():
             raise ValueError(f"O campo '{info.field_name}' deve ser strings e não {type(value)}")
         return value
+    
+    @field_validator('token')
+    def check_dict_input(cls, value, info):
+        if not isinstance(value, dict):
+            raise ValueError(f"O campo '{info.field_name}' deve ser um dicionário e não {type(value)}")
+        return value
 
     """
     Valida se o valor é uma lista.
@@ -116,4 +122,23 @@ class ListFolderValidator(BaseModel):
     def check_str_input(cls, value, info):
         if not isinstance(value, str) or not value.strip():
             raise ValueError(f"O campo '{info.field_name}' deve ser strings e não {type(value)}")
-        return value
+        return value
+    
+class UploadValidator(BaseModel):
+    """
+    Validador para upload de arquivo no Google Drive.
+
+    Atributos:
+    - file_path (str): Caminho do arquivo a ser enviado.
+
+    """
+    folder_id: str
+    name: str
+    file_path: str
+    mimetype: str
+
+    @field_validator('folder_id','name','file_path', 'mimetype')
+    def check_str_input(cls, value, info):
+        if not isinstance(value, str) or not value.strip():
+            raise ValueError(f"O campo '{info.field_name}' deve ser strings e não {type(value)}")
+        return value

csc_cia_stne/utilitarios/validations/ServiceNowValidator.py

@@ -28,23 +28,24 @@ class InitParamsValidator(BaseModel):
     """
     @field_validator('username', 'password', 'env')
     def check_str_input(cls, value, info):
-        if not isinstance(value, str) or not value.strip():
-           raise ValueError(f"O campo '{info.field_name}' deve ser strings e não {type(value)}")
+        if not value.strip():
+            raise ValueError(f"O campo '{info.field_name}' não pode ser vazio")
+        if not isinstance(value, str):
+           raise ValueError(f"O campo '{info.field_name}' deve ser string e não ser do tipo: {type(value)}")
         return value
 
+
 class RequestValidator(BaseModel):
     """
     Classe para validar os campos de uma requisição.
     Atributos:
     - url (str): A URL da requisição.
-    - params (str): Os parâmetros da requisição.
     - timeout (int): O tempo limite da requisição em segundos. O valor padrão é 15.
     Métodos:
     - check_str_input(value, info): Valida se o valor é uma string não vazia.
     - check_input_basic(value, info): Valida se o valor é um inteiro.
     """
     url: str
-    params: str
     timeout: int = 15
     
 
@@ -58,7 +59,7 @@ class RequestValidator(BaseModel):
     Lança:
     - ValueError: Se o valor não for uma string ou estiver vazio.
     """
-    @field_validator('url', 'params')
+    @field_validator('url')
     def check_str_input(cls, value, info):
         if not isinstance(value, str) or not value.strip():
             raise ValueError(f"O campo '{info.field_name}' deve ser uma string e não um {type(value)} e não vazio")
@@ -81,6 +82,7 @@ class RequestValidator(BaseModel):
         
         return value
 
+
 class PutValidator(BaseModel):
     """
     Classe de validação para requisições PUT.
@@ -146,6 +148,7 @@ class PutValidator(BaseModel):
             raise ValueError(f"O campo '{info.field_name}' deve ser um dicionário e não um {type(value)}")
         return value
 
+
 class PostValidator(BaseModel):
     """
     Classe responsável por validar os dados de um post.
@@ -171,6 +174,7 @@ class PostValidator(BaseModel):
             raise ValueError(f"O campo '{info.field_name}' deve ser um dicionário e não um {type(value)}")
         return value
 
+
 class ListTicketValidator(BaseModel):
     """
     Classe para validar os campos de entrada da lista de tickets.
@@ -189,7 +193,7 @@ class ListTicketValidator(BaseModel):
     query : str
     campos : List[str]
     timeout : int
-    limit : int
+    limite : int
     
     @field_validator('tabela', 'query')
     def check_str_input(cls, value, info):
@@ -197,7 +201,7 @@ class ListTicketValidator(BaseModel):
             raise ValueError(f"O campo '{info.field_name}' deve ser uma string e não um {type(value)} e não vazio")
         return value
     
-    @field_validator('timeout', 'limit')
+    @field_validator('timeout', 'limite')
     def check_input_basic(cls, value, info):
         if not isinstance(value, int):
             raise ValueError(f"O campo '{info.field_name}' deve ser um inteiro e não um {type(value)}")
@@ -209,6 +213,7 @@ class ListTicketValidator(BaseModel):
             raise ValueError(f"O campo '{info.field_name}' deve ser uma lista e não um {type(value)}")
         return value
     
+
 class UpdateTicketValidator(BaseModel):
     """
     Classe responsável por validar os campos do ticket de atualização.
@@ -225,7 +230,7 @@ class UpdateTicketValidator(BaseModel):
         
     sys_id : str
     tabela : str
-    payload : List[str]
+    payload : dict
     timeout : int
 
     """
@@ -272,10 +277,41 @@ class UpdateTicketValidator(BaseModel):
     """
     @field_validator('payload')
     def check_list_input(cls, value, info):
-        if not isinstance(value, list):
+        if not isinstance(value, dict):
             raise ValueError(f"O campo '{info.field_name}' deve ser uma lista e não um {type(value)}")
         return value
 
+
+class DownloadFileValidator(BaseModel):
+    """
+    Classe responsável por validar os campos do ticket de download.
+    Atributos:
+    - sys_id_file (str): O ID do anexo dentro do formulário aberto.
+    - file_path (str): URL onde será salvo o arquivo.
+    Métodos:
+    - check_str_input(value, info): Valida se o valor fornecido é uma string não vazia.
+    """
+    sys_id_file : str
+    file_path : str
+    
+    
+    """
+    Valida se o valor fornecido é uma string não vazia.
+    Parâmetros:
+    - value (Any): O valor a ser validado.
+    - info (FieldInfo): Informações sobre o campo.
+    Retorna:
+    - value (Any): O valor validado.
+    Lança:
+    - ValueError: Se o valor não for uma string ou estiver vazio.
+    """
+    @field_validator('sys_id_file', 'file_path')
+    def check_str_input(cls, value, info):
+        if not isinstance(value, str) or not value.strip():
+            raise ValueError(f"O campo '{info.field_name}' deve ser uma string e não um {type(value)} e não vazio")
+        return value
+
+
 class AttachFileTicketValidator(BaseModel):
     """
     Classe responsável por validar os campos de entrada do anexo de um ticket no ServiceNow.
@@ -314,6 +350,7 @@ class AttachFileTicketValidator(BaseModel):
             raise ValueError(f"O campo '{info.field_name}' deve ser um dicionário e não um {type(value)}")
         return value
     
+
 class GetAttachValidator(BaseModel):
     """
     Classe responsável por validar os campos de entrada para a obtenção de anexos no ServiceNow.
@@ -330,7 +367,6 @@ class GetAttachValidator(BaseModel):
         
     sys_id : str
     tabela : str
-    campo :str
     download_dir : str
     timeout : int
 
@@ -344,7 +380,7 @@ class GetAttachValidator(BaseModel):
     Lança:
     - ValueError: Se o campo não for uma string ou estiver vazio.
     """
-    @field_validator('sys_id', 'tabela', 'campo', 'download_dir')
+    @field_validator('sys_id', 'tabela','download_dir')
     def check_str_input(cls, value, info):
         if not isinstance(value, str) or not value.strip():
             raise ValueError(f"O campo '{info.field_name}' deve ser uma string e não um {type(value)} e não vazio")

csc_cia_stne/utilitarios/validations/__init__.py

@@ -1,2 +1,3 @@
 from .GoogleDriveValidator import *
-from .GcpBigQueryValidator import *
+from .GcpBigQueryValidator import *
+from .ServiceNowValidator import *

{csc_cia_stne-0.0.37.dist-info → csc_cia_stne-0.0.39.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: csc_cia_stne
-Version: 0.0.37
+Version: 0.0.39
 Summary: Biblioteca do time CSC-CIA utilizada no desenvolvimento de RPAs
 License: MIT
 Keywords: karavela,csc,cia,stone,rpa
@@ -16,9 +16,11 @@ Requires-Dist: google-cloud-bigquery
 Requires-Dist: google-cloud-storage
 Requires-Dist: google-auth-oauthlib
 Requires-Dist: google-auth-httplib2
+Requires-Dist: google-api-python-client
 Requires-Dist: pyjwt
 Requires-Dist: PyYAML
 Requires-Dist: python-dotenv
+Requires-Dist: slack_sdk
 
 Essa biblioteca é desenvolvida e atualizada pelo time **CSC-CIA** da **Stone**
 

{csc_cia_stne-0.0.37.dist-info → csc_cia_stne-0.0.39.dist-info}/RECORD

@@ -1,14 +1,15 @@
-csc_cia_stne/__init__.py,sha256=Btr1EaCLDdKc8zRXX__Jz-Sf2yrhw67f80gr2CibEIU,2339
+csc_cia_stne/__init__.py,sha256=EpmmGz66fgGCdY2HoZtkNG9TRaqhOtjVFkXXI1lLGSk,2435
 csc_cia_stne/bc_correios.py,sha256=pQAnRrcXEMrx3N1MWydZVIhEQLerh3x8-0B045zZIzk,24174
 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=yNCx0yD1peoxOKEiu2Ml6FfDtXUTzcJGcypjWPH8QqE,7449
-csc_cia_stne/google_drive.py,sha256=yLfaAWcrOKk9YuI1qcOTkZEqyrSSEF68RmzYgC7dq-g,11569
+csc_cia_stne/google_drive.py,sha256=JcXKlRBSxf5CKM-alT4ZpqWVWLZQfIYIX42_nENoTgU,11896
 csc_cia_stne/karavela.py,sha256=LlpFiDu0ww7eh8F-oREWSQo2mVoQMibx0EGiHR6tznI,4231
 csc_cia_stne/logger_json.py,sha256=W6Fj0G1-TWXHdHoLLX5SbVV7BSpVvjHm1fkKI5Q69YQ,3129
 csc_cia_stne/logger_rich.py,sha256=FYO9tG-tEJJDP2EDYFTQYS8GayvbRMgRbKI9FcXvRCs,7812
-csc_cia_stne/provio.py,sha256=HU31l134U58wag3fx3A1X4pZxfubF5VoO4D-LQi6-Yg,3957
-csc_cia_stne/servicenow.py,sha256=QN7R49Bb8HcqfGT9iytbPaqwV2rtH4N7Nhvb_kfTsHU,36400
+csc_cia_stne/provio.py,sha256=yTRX4YJ6RdNc2ZCVPgsIEgsxe3wQgwnXns4bPX4plAI,3955
+csc_cia_stne/servicenow.py,sha256=3eifPWOIGv2udGpI3cr2SkMMKcQR4xHlA_fiOdw_fmg,32136
+csc_cia_stne/slack.py,sha256=QtF3zsHldDbsqJKT206jQ2EWTdvVg9FcZ1EhM_YVJWw,8071
 csc_cia_stne/stne_admin.py,sha256=vnGSEzcmqWE42vg71oEuoRg6ENaGsZsXFOjxduSH4KU,23561
 csc_cia_stne/utilitarios/__init__.py,sha256=oWxCOFL2wxjs8KBgxoeA6-gVe4ulicVGDgdaw8jzvsY,253
 csc_cia_stne/utilitarios/functions/__init__.py,sha256=iSLKxM8lgPM1lJ51WZ1mwy36IW5iitfMRc_AnEtzpxg,364
@@ -18,11 +19,11 @@ csc_cia_stne/utilitarios/functions/func_recriar_pastas.py,sha256=4whZpB3aJQaCPJ3
 csc_cia_stne/utilitarios/functions/func_settings.py,sha256=rlu4Ec5M-7UzrreiR92L_KLrpBSXv8Hlj4uuRYcPMUc,1709
 csc_cia_stne/utilitarios/functions/func_titulo.py,sha256=bH4tYxovTARF-g2kWUK_GIzzXt8egbVdp6mWD6fc_3I,5345
 csc_cia_stne/utilitarios/validations/GcpBigQueryValidator.py,sha256=PfCeeQquheZkrm07HTIjobleh3QQOjljRFGdxbQ1amQ,4630
-csc_cia_stne/utilitarios/validations/GoogleDriveValidator.py,sha256=cNuqQyQifxx3zIqDCljfcUhWCty9SyT9oGTVUKp-uWw,3752
-csc_cia_stne/utilitarios/validations/ServiceNowValidator.py,sha256=Vg4i9P7PV_qQ-gUDtSbSK4wOybt3deKG0OcotpufT7Y,13391
-csc_cia_stne/utilitarios/validations/__init__.py,sha256=VE49g8ExrBUyyUzhOUjsP9880L1PWCKPHckd848MQeo,71
-csc_cia_stne-0.0.37.dist-info/LICENCE,sha256=LPGMtgKki2C3KEZP7hDhA1HBrlq5JCHkIeStUCLEMx4,1073
-csc_cia_stne-0.0.37.dist-info/METADATA,sha256=KG5dCQwIri5BpfPPvxVMiG4pF786BNU-0DMrd8IV7ps,1025
-csc_cia_stne-0.0.37.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-csc_cia_stne-0.0.37.dist-info/top_level.txt,sha256=ldo7GVv3tQx5KJvwBzdZzzQmjPys2NDVVn1rv0BOF2Q,13
-csc_cia_stne-0.0.37.dist-info/RECORD,,
+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-0.0.39.dist-info/LICENCE,sha256=LPGMtgKki2C3KEZP7hDhA1HBrlq5JCHkIeStUCLEMx4,1073
+csc_cia_stne-0.0.39.dist-info/METADATA,sha256=x1jtu3_EK2rUxyVrLC8MtgddEFC0y8KDVLnNK8LorqU,1090
+csc_cia_stne-0.0.39.dist-info/WHEEL,sha256=A3WOREP4zgxI0fKrHUG8DC8013e3dK3n7a6HDbcEIwE,91
+csc_cia_stne-0.0.39.dist-info/top_level.txt,sha256=ldo7GVv3tQx5KJvwBzdZzzQmjPys2NDVVn1rv0BOF2Q,13
+csc_cia_stne-0.0.39.dist-info/RECORD,,

{csc_cia_stne-0.0.37.dist-info → csc_cia_stne-0.0.39.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.7.0)
 Root-Is-Purelib: true
 Tag: py3-none-any