Este documento descreve os modelos de dados dos apps cohort, integrador e django.contrib.auth.

App integrador¶

Ambiente¶

Representa uma instância de Moodle de destino. O Integrador pode ser configurado para rotear requisições para diferentes Moodles com base em regras avaliadas sobre o payload recebido.

Campos¶

# Exemplo de uso
ambiente = Ambiente.objects.seleciona_ambiente({"campus": {"sigla": "ZL"}})

Solicitacao¶

Registra cada requisição de integração recebida pelo Integrador: o payload recebido do SGA, o payload enviado ao Moodle e a resposta obtida. Funciona como log auditável de todas as operações.

Campos¶

{id}={status}, {tipo}[{ambiente}]: {campus_sigla}-{diario_id}

App cohort¶

Os modelos são definidos em src/cohort/models.py.

MoodleUser¶

Representa um usuário do Moodle que pode ser vinculado a coortes. Não corresponde ao usuário Django (auth.User); é um espelho do usuário criado/gerenciado no Moodle.

Role¶

Representa uma role (papel) do Moodle associada a uma coorte. Possui histórico de alterações via simple_history.

Cohort¶

Representa uma coorte do Moodle. Contém regras rule_engine que determinam se um diário ou sala de coordenação pertence a esta coorte.

Enrolment¶

Registra o vínculo entre um MoodleUser e uma Cohort (matrícula na coorte).

App django.contrib.auth¶

O Django provê o modelo User para autenticação e autorização no painel administrativo. Não há FK direta dos modelos de negócio para auth.User, mas simple_history registra em cohort_historicalrole.history_user o usuário que realizou cada alteração em Role.

Diagramas¶

Entidade-Relacionamento¶

erDiagram
    AUTH_USER {
        int id PK
        string username
        string email
        string first_name
        string last_name
        bool is_staff
        bool is_active
        datetime date_joined
    }

    COHORT_MOODLE_USER {
        int id PK
        string fullname
        string email
        string login
        bool active
    }

    COHORT_ROLE {
        int id PK
        string name
        string shortname
        bool active
    }

    COHORT_HISTORICAL_ROLE {
        int history_id PK
        int id
        string name
        string shortname
        bool active
        datetime history_date
        char history_type
        int history_user_id FK
    }

    COHORT_COHORT {
        int id PK
        string name
        string idnumber
        bool active
        int role_id FK
        text rule_diario
        text rule_coordenacao
        text description
    }

    COHORT_ENROLMENT {
        int id PK
        int user_id FK
        int cohort_id FK
    }

    INTEGRADOR_AMBIENTE {
        int id PK
        string nome
        string url
        string token
        text expressao_seletora
        int ordem
        bool active
    }

    INTEGRADOR_SOLICITACAO {
        int id PK
        int ambiente_id FK
        datetime timestamp
        string campus_sigla
        string diario_codigo
        string diario_id
        string operacao
        string tipo
        string status
        string status_code
        json recebido
        json enviado
        json respondido
    }

    AUTH_USER ||--o{ COHORT_HISTORICAL_ROLE : "registra alteracoes em"
    COHORT_ROLE ||--o{ COHORT_COHORT : "categoriza"
    COHORT_ROLE ||--o{ COHORT_HISTORICAL_ROLE : "auditado em"
    COHORT_MOODLE_USER ||--o{ COHORT_ENROLMENT : "possui"
    COHORT_COHORT ||--o{ COHORT_ENROLMENT : "agrupa"
    INTEGRADOR_AMBIENTE ||--o{ INTEGRADOR_SOLICITACAO : "processa"

Diagrama de classes¶

classDiagram
    class ActiveMixin {
        <>
        +bool active
        +active_icon() str
    }

    class MoodleUser {
        +int id
        +str fullname
        +str email
        +str login
        +bool active
        +__str__() str
    }

    class Role {
        +int id
        +str name
        +str shortname
        +bool active
        +HistoricalRecords history
        +__str__() str
    }

    class Cohort {
        +int id
        +str name
        +str idnumber
        +bool active
        +Role role
        +RuleField rule_diario
        +RuleField rule_coordenacao
        +str description
        +__str__() str
    }

    class Enrolment {
        +int id
        +MoodleUser user
        +Cohort cohort
        +__str__() str
    }

    class Ambiente {
        +int id
        +str nome
        +str url
        +str token
        +str expressao_seletora
        +int ordem
        +bool active
        +base_url() str
        +valid_expressao_seletora() bool
        +AmbienteManager objects
        +__str__() str
    }

    class AmbienteManager {
        +seleciona_ambiente(sync_json) Ambiente
    }

    class Solicitacao {
        +int id
        +Ambiente ambiente
        +datetime timestamp
        +str campus_sigla
        +str diario_codigo
        +str diario_id
        +str operacao
        +str tipo
        +str status
        +str status_code
        +dict recebido
        +dict enviado
        +dict respondido
        +status_merged() str
        +save() None
        +__str__() str
    }

    class User {
        <>
        +int id
        +str username
        +str email
        +str first_name
        +str last_name
        +bool is_staff
        +bool is_active
        +datetime date_joined
    }

    ActiveMixin <|-- MoodleUser
    ActiveMixin <|-- Role
    ActiveMixin <|-- Cohort
    Role "1" --> "N" Cohort : role
    Cohort "1" --> "N" Enrolment : cohort
    MoodleUser "1" --> "N" Enrolment : user
    Ambiente "1" --> "N" Solicitacao : ambiente
    AmbienteManager --* Ambiente
    User ..> Role : auditoria via simple_history