sagace.auth.interfaces package — sagace 2025 documentation

# sagace.auth.interfaces package

## Submodules

## sagace.auth.interfaces.authentication_service module

### Descrição:

Este módulo fornece um serviço de autenticação para facilitar o uso do sistema SAGACE. A classe AuthenticationService encapsula a lógica de autenticação, delegando o processo para a classe de caso de uso AuthenticateUser, que por sua vez utiliza AuthenticationAPI.

Principais funcionalidades:

- Abstrai a autenticação de usuários, simplificando a interface.

- Delegação do fluxo de autenticação conforme o princípio Single Responsibility (S - SOLID).

- Facilita a reutilização da lógica de autenticação em diferentes partes do sistema.

Classes:

- `AuthenticationService`: Serviço de autenticação de usuários.

Exemplo de uso:

    from sagace.application import AuthenticationService
    from sagace.core import TokenStorage

    service = AuthenticationService()
    token_storage = TokenStorage()
    token = service.login("https://api.sagace.online", "usuario", "senha", "app_token", token_storage)
    print(token)

Autor: Diego Yosiura Última Atualização: 27/02/2025 15:32 Criado em: 27/02/2025 15:32 Copyright: (c) Ampere Consultoria Ltda Projeto Original: sagace-v2-package IDE: PyCharm

class sagace.auth.interfaces.authentication_service.AuthenticationService

  Bases: `object`

  Serviço de autenticação para facilitar o uso do sistema.

  Esta classe abstrai a autenticação de usuários, centralizando o fluxo em AuthenticateUser. Segue o princípio Dependency Inversion (D - SOLID), garantindo que a implementação de autenticação possa ser alterada sem impactar os consumidores do serviço.

  login(base_url: str, username: str, password: str, application_token: str, token_storage: TokenStorage) → str

    Realiza login e retorna o token JWT.

    Parameters:

      - base_url (str) – URL base da API de autenticação.

      - username (str) – Nome de usuário para autenticação.

      - password (str) – Senha do usuário.

      - application_token (str) – Token da aplicação para autenticação.

      - token_storage (TokenStorage) – Instância responsável por armazenar o token JWT.

    Returns:

      Token de autenticação JWT.

    Return type:

      str

## Module contents

### Description:

Obs.:

Author: @diego.yosiura Last Update: 27/02/2025 15:29 Created: 27/02/2025 15:29 Copyright: (c) Ampere Consultoria Ltda Original Project: sagace-v2-package IDE: PyCharm