Merge pull request #7 from buserbrasil/refactor-global-configuration

refactor: replace global config with dependency injection

Author: ecarrara

README.MD

@@ -14,21 +14,26 @@ pip install santander-python-sdk
 ## Uso
 
 ```python
-# Configure os dados de autenticação uma vez
-set_configuration(SantanderClientConfiguration(
+from decimal import Decimal
+from santander_client import SantanderApiClient, SantanderClientConfiguration
+
+client = SantanderApiClient(SantanderClientConfiguration(
   client_id="client_id",
   client_secret="client_pk",
   cert="certificate_path",
   base_url="api_url"
 ))
 
-# Realizar um pix para uma chave
-transfer = transfer_pix_payment("[email protected]", 9.99, "pix de teste")
-
-# Obter informações de um pix
-pix_info = get_transfer("id-da-transferencia-pix")
+# Realizar um PIX para uma chave
+transfer = transfer_pix_payment(
+    client,
+    pix_info="[email protected]", # PIX key
+    value=Decimal(0.99),
+    description="My first pix payment"
+)
 
-# Uso em atualização
+pix_info = get_transfer(transfer["id"])
+# ...
 ```
 
 ## Em desenvolvimento
@@ -48,4 +53,4 @@ Este projeto está licenciado sob a licença MIT. Veja o arquivo [LICENSE](LICEN
 
 ## Aviso Legal
 
-Este projeto não é afiliado, endossado ou patrocinado pelo Santander.
+Este projeto não é afiliado, endossado ou patrocinado pelo Santander.

santander_client/__init__.py

@@ -0,0 +1,6 @@
+from santander_client.api_client.client import SantanderApiClient
+from santander_client.api_client.client_configuration import (
+    SantanderClientConfiguration,
+)
+
+__all__ = ["SantanderApiClient", "SantanderClientConfiguration"]

santander_client/api_client/__init__.py

@@ -1,48 +0,0 @@
-import logging
-from santander_client.api_client.exceptions import (
-    SantanderConfigurationException,
-    SantanderWorkspaceException,
-)
-from santander_client.api_client.workspaces import get_first_workspace_id_of_type
-from santander_client.api_client.client import SantanderApiClient
-from santander_client.api_client.client_configuration import (
-    SantanderClientConfiguration,
-)
-
-logger = logging.getLogger("santanderLogger")
-
-santander_client_configuration = None
-
-
-def set_configuration(configuration: SantanderClientConfiguration) -> None:
-    if not isinstance(configuration, SantanderClientConfiguration):
-        raise SantanderConfigurationException("Configuração inválida fornecida.")
-
-    global santander_client_configuration
-    santander_client_configuration = configuration
-
-
-def get_client() -> SantanderApiClient:
-    """
-    Creates and returns an instance of SantanderApiClient based on the provided configuration.
-    """
-    if not santander_client_configuration:
-        raise SantanderConfigurationException(
-            "Configuração do client (SantanderClientConfiguration) não foi denida."
-        )
-
-    santander_client_instance = SantanderApiClient(santander_client_configuration)
-
-    if not santander_client_configuration.workspace_id:
-        workspace_id = get_first_workspace_id_of_type(
-            santander_client_instance, "PAYMENTS"
-        )
-        if not workspace_id:
-            raise SantanderWorkspaceException(
-                "Conta sem configuração de workspace na configuração e na conta."
-            )
-
-        logger.info(f"Workspace obtido e configurado com sucesso: {workspace_id}")
-        santander_client_configuration.set_workspace_id(workspace_id)
-
-    return santander_client_instance

santander_client/api_client/client.py

@@ -1,16 +1,25 @@
 from datetime import datetime, timedelta
+import logging
 from urllib.parse import urljoin
 import requests
 
+from santander_client.api_client.workspaces import get_first_workspace_id_of_type
+
 from .helpers import get_status_code_description, try_parse_response_to_json
 
 from .abstract_client import SantanderAbstractApiClient
 from .client_configuration import SantanderClientConfiguration
-from .exceptions import SantanderRequestException, SantanderClientException
+from .exceptions import (
+    SantanderRequestException,
+    SantanderClientException,
+    SantanderWorkspaceException,
+)
 
 BEFORE_EXPIRE_TOKEN_SECONDS = timedelta(seconds=60)
 TOKEN_ENDPOINT = "/auth/oauth/v2/token"
 
+logger = logging.getLogger(__name__)
+
 
 class SantanderApiClient(SantanderAbstractApiClient):
     """
@@ -35,15 +44,25 @@ class SantanderApiClient(SantanderAbstractApiClient):
     """
 
     def __init__(self, config: SantanderClientConfiguration):
-        if not isinstance(config, SantanderClientConfiguration):
-            raise SantanderClientException("Objeto de autenticação inválido")
-
         self.base_url = config.base_url.rstrip("/")
         self.config = config
         self.session = requests.Session()
         self.token = None
         self.token_expires_at = datetime.now()
 
+        self._set_default_workspace_id()
+
+    def _set_default_workspace_id(self):
+        if not self.config.workspace_id:
+            workspace_id = get_first_workspace_id_of_type(self, "PAYMENTS")
+            if not workspace_id:
+                raise SantanderWorkspaceException(
+                    "Conta sem configuração de workspace na configuração e na conta."
+                )
+
+            logger.info(f"Workspace obtido e configurado com sucesso: {workspace_id}")
+            self.config.set_workspace_id(workspace_id)
+
     def get(self, endpoint: str, params: dict | None = None) -> dict:
         return self._request("GET", endpoint, params=params)
 

santander_client/api_client/workspaces.py

@@ -7,13 +7,13 @@
     Para ter acesso ao sistema cliente e consumir as APIs, se faz necessário ter o cadastro de
     uma ou mais Workspaces, sendo a Workspace a “porta de entrada” para ter o acesso ao Hub de
     Pagamentos transacional. Rotas de pagamentos, geração de pix, etc, vão precisar do id do workspace.
-    
+
     Existem os seguintes tipos de workspaces
     - PAYMENTS para o cliente que deseja fazer pagamentos próprios;
     - DIGITAL_CORBAN para o cliente que deseja fazer pagamentos de terceiros de maneira digital;
     - PHYSICAL_CORBAN para o cliente que deseja fazer pagamentos e ser correspondente bancário
     de maneira subestabelecida ou direta.
-    
+
     ### No nosso caso, o uso será para o tipo PAYMENTS.
 """
 WorkspaceType = Literal["PHYSICAL_CORBAN", "PAYMENTS", "DIGITAL_CORBAN"]

santander_client/pix.py

@@ -3,7 +3,7 @@
 from time import sleep
 from typing import List, Literal, cast
 
-from santander_client.api_client import get_client
+from santander_client.api_client.client import SantanderApiClient
 from santander_client.api_client.exceptions import (
     SantanderClientException,
     SantanderRejectedTransactionException,
@@ -43,7 +43,11 @@
 
 
 def transfer_pix_payment(
-    pix_info: str | BeneficiaryDataDict, value: D, description: str, tags=[]
+    client: SantanderApiClient,
+    pix_info: str | BeneficiaryDataDict,
+    value: D,
+    description: str,
+    tags: list[str] = [],
 ) -> TransferPixResult:
     """Realiza uma transferência PIX para uma chave PIX ou para um beneficiário
         -   Se for informado uma chave PIX, o valor deve ser uma string com a chave CPF, CNPJ, EMAIL, CELULAR ou chave aleatória
@@ -65,7 +69,7 @@ def transfer_pix_payment(
             )
 
         create_pix_response = _request_create_pix_payment(
-            pix_info, value, description, tags
+            client, pix_info, value, description, tags
         )
         pix_id = create_pix_response.get("id")
         logger.info("Santander - PIX criado com sucesso: {pix_id}")
@@ -81,7 +85,7 @@ def transfer_pix_payment(
                 "Status do pagamento não retornado na criação"
             )
 
-        confirm_response = _confirm_pix_payment(pix_id, value, payment_status)
+        confirm_response = _confirm_pix_payment(client, pix_id, value, payment_status)
 
         return {"success": True, "data": confirm_response, "error": ""}
     except Exception as e:
@@ -91,17 +95,18 @@ def transfer_pix_payment(
 
 
 def _pix_payment_status_polling(
+    client: SantanderApiClient,
     pix_id: str,
     until_status: List[str],
     context: Literal["CREATE", "CONFIRM"],
     max_attempts: int,
 ) -> SantanderPixResponse:
-    response = _request_pix_payment_status(pix_id, context)
+    response = _request_pix_payment_status(client, pix_id, context)
     if response.get("status") in until_status:
         return response
 
     for attempt in range(max_attempts - 1):
-        response = _request_pix_payment_status(pix_id, context)
+        response = _request_pix_payment_status(client, pix_id, context)
         payment_status = response.get("status")
         logger.info(
             f"Santander - Verificando status do pagamento PIX por polling: {pix_id} - {payment_status}"
@@ -122,7 +127,7 @@ def _pix_payment_status_polling(
 
 
 def _confirm_pix_payment(
-    pix_id: str, value: D, payment_status: OrderStatusType
+    client: SantanderApiClient, pix_id: str, value: D, payment_status: OrderStatusType
 ) -> SantanderPixResponse:
     """Confirma o pagamento PIX, realizando polling até que o status seja PAYED ou permaneça PENDING_CONFIRMATION.
 
@@ -134,19 +139,20 @@ def _confirm_pix_payment(
     if payment_status != CreateOrderStatus.READY_TO_PAY:
         logger.info(f"Santander - PIX não está pronto para pagamento: {pix_id}")
         _pix_payment_status_polling(
+            client,
             pix_id=pix_id,
             until_status=[CreateOrderStatus.READY_TO_PAY],
             context="CREATE",
             max_attempts=MAX_UPDATE_STATUS_ATTEMPTS,
         )
 
     try:
-        confirm_response = _request_confirm_pix_payment(pix_id, value)
+        confirm_response = _request_confirm_pix_payment(client, pix_id, value)
     except SantanderRequestException as e:
         logger.error(
             f"Santander - Erro ao confirmar pagamento PIX: {str(e)}, {pix_id}, verificando status atual"
         )
-        confirm_response = _request_pix_payment_status(pix_id, "CONFIRM")
+        confirm_response = _request_pix_payment_status(client, pix_id, "CONFIRM")
 
     if confirm_response.get("status") == ConfirmOrderStatus.PAYED:
         return confirm_response
@@ -158,6 +164,7 @@ def _confirm_pix_payment(
 
     try:
         confirm_response = _pix_payment_status_polling(
+            client,
             pix_id=pix_id,
             until_status=[ConfirmOrderStatus.PAYED],
             context="CONFIRM",
@@ -177,7 +184,11 @@ def _confirm_pix_payment(
 
 
 def _request_create_pix_payment(
-    pix_info: BeneficiaryDataDict | str, value: D, description: str, tags=[]
+    client: SantanderApiClient,
+    pix_info: BeneficiaryDataDict | str,
+    value: D,
+    description: str,
+    tags: list[str] = [],
 ) -> SantanderPixResponse:
     """Cria uma ordem de pagamento. Caso o status seja REJECTED, a exceção SantanderRejectedTransactionException é lançada.
     Regra de negócio aqui: pagamento por beneficiário na request deve ser informado o bank_code ou ispb, nunca os dois."""
@@ -219,13 +230,14 @@ def _request_create_pix_payment(
     else:
         raise SantanderValueErrorException("Chave PIX ou Beneficiário não informado")
 
-    client = get_client()
     response = cast(SantanderPixResponse, client.post(PIX_ENDPOINT, data=data))
     _check_for_rejected_exception(response, "Criação do pagamento PIX")
     return response
 
 
-def _request_confirm_pix_payment(pix_payment_id: str, value: D) -> SantanderPixResponse:
+def _request_confirm_pix_payment(
+    client: SantanderApiClient, pix_payment_id: str, value: D
+) -> SantanderPixResponse:
     """Confirma o pagamento PIX através do PATCH e status AUTHORIZED
     O HTTP code de sucesso é 200, mesmo que o status seja REJECTED
     Caso o status seja REJECTED, a exceção SantanderRejectedTransactionException é lançada
@@ -236,7 +248,6 @@ def _request_confirm_pix_payment(pix_payment_id: str, value: D) -> SantanderPixR
     if not value:
         raise SantanderValueErrorException("Valor não informado")
 
-    client = get_client()
     data = {
         "status": "AUTHORIZED",
         "paymentValue": truncate_value(value),
@@ -249,7 +260,7 @@ def _request_confirm_pix_payment(pix_payment_id: str, value: D) -> SantanderPixR
 
 @retry_one_time_on_request_exception
 def _request_pix_payment_status(
-    pix_payment_id: str, step_description: str
+    client: SantanderApiClient, pix_payment_id: str, step_description: str
 ) -> SantanderPixResponse:
     """
     Retorna o estado atual do processamento de um pagamento PIX
@@ -259,7 +270,6 @@ def _request_pix_payment_status(
     if not pix_payment_id:
         raise SantanderValueErrorException("pix_payment_id não informado")
 
-    client = get_client()
     response = client.get(f"{PIX_ENDPOINT}/{pix_payment_id}")
     response = cast(SantanderPixResponse, response)
     _check_for_rejected_exception(response, step_description)

tests/conftest.py

@@ -0,0 +1,19 @@
+import pytest
+
+from santander_client.api_client.client import SantanderApiClient
+from santander_client.api_client.client_configuration import (
+    SantanderClientConfiguration,
+)
+
+
+@pytest.fixture
+def api_client():
+    return SantanderApiClient(
+        SantanderClientConfiguration(
+            client_id="test_client_id",
+            client_secret="test_client_secret",
+            cert="certificate_path",
+            base_url="https://trust-sandbox.api.santander.com.br",
+            workspace_id="8e33d56c-204f-461e-aebe-08baaab6479e",
+        )
+    )