django-resaas 0.0.227

Django SAAS Framework

🚀 django_resaas

django_resaas é um framework modular para construção de aplicações SaaS multi-tenant em Django, com:

• 🔐 Controle de permissões (RBAC)
• 🏢 Multi-tenant (Entity / Branch)
• 🧩 Módulos ativáveis por cliente
• 💰 Billing por plano (SaaS ready)
• ♻️ Soft delete + restore
• 🔎 Busca dinâmica automática
• ⚡ BaseAPIView inteligente (DRF)

---

🧠 Arquitetura

User
 ↓
Person
 ↓
Employee (RH)
 ↓
Entity (tenant)
 ↓
Branch
 ↓
Groups + Permissões

---

🧩 Conceitos principais

🏢 Entity (Tenant)

Representa o cliente (empresa)

🏬 Branch

Unidade da entity

👤 Person

Dados humanos (name, email, etc.)

🔐 User

Autenticação

👥 BranchUserGroup

Relaciona:

• User
• Branch
• Group (Django)

👉 Permite múltiplos groups por branch

---

🔐 Sistema de Permissões (RBAC)

Baseado em:

User + Group + Permission (Django)
+ contexto (Entity + Branch)

Headers obrigatórios:

ET → entity_type
E  → entity
S  → branch
G  → group
L  → language

---

🧱 BaseModel

Todos os models herdam:

from django_resaas import BaseModel

Inclui:

• entity
• branch
• created_at / updated_at
• soft delete
• created_by / updated_by

---

🔁 Soft Delete

obj.delete()        # soft delete
obj.restore()       # restore
obj.hard_delete()   # delete real

Managers disponíveis:

Model.objects          # ativos
Model.deleted_objects  # apagados
Model.all_objects      # todos

---

⚡ BaseAPIView

CRUD automático com:

• multi-tenant automático
• permissões automáticas
• search dinâmica
• soft delete
• restore
• hard delete

Uso:

from django_resaas import BaseAPIView, register_view

@register_view(module="hr")
class EmployeeView(BaseAPIView):
    queryset = Employee.objects.all()
    serializer_class = EmployeeSerializer

---

🔍 Busca dinâmica

GET /api/employees/?search=joao

Busca automaticamente em:

• name
• email
• código
• relações (FK)

---

🧩 Sistema de Módulos

Permite ativar/desativar funcionalidades por cliente.

Models:

• App
• EntityApp

Exemplo:

Entity	Módulo	Estado
Empresa A	RH	✅
Empresa A	CRM	❌

---

🔐 Proteção automática por módulo

@register_view(module="hr")
class EmployeeView(BaseAPIView):
    ...

👉 Se módulo não estiver ativo → acesso bloqueado

---

💰 Billing (SaaS)

Models:

• Plano
• PlanoApp
• EntityPlano

Fluxo:

Plano → módulos → EntityPlano → ativa módulos automaticamente

---

🔄 Sync automático de módulos

Ao mudar plano:

sync_apps_entity(entity)

---

📦 BaseSerializer

Proteção automática de arquivos:

{
  "file": {
    "url": "...",
    "name": "...",
    "ext": "pdf",
    "size": 12345
  }
}

---

🌐 Middleware

TenantContextMiddleware

Captura headers:

request.entity_id
request.branch_id
request.group_id

---

FrontEndMiddleware

Protege acesso por:

• chave frontend (FEK/FEP)
• permissões por URL
• permissões por método HTTP

---

🧪 Exemplo completo

Model

from django_resaas import BaseModel

class Employee(BaseModel):
    person = models.ForeignKey('django_resaas.Person', on_delete=models.CASCADE)
    cargo = models.CharField(max_length=100)

---

Serializer

from django_resaas import BaseSerializer

class EmployeeSerializer(BaseSerializer):
    class Meta:
        model = Employee
        fields = "__all__"

---

View

from django_resaas import BaseAPIView, register_view

@register_view(module="hr")
class EmployeeView(BaseAPIView):
    queryset = Employee.objects.all()
    serializer_class = EmployeeSerializer

---

⚙️ Instalação

pip install django_resaas

ou local:

pip install -e .

---

🔧 Configuração

INSTALLED_APPS

INSTALLED_APPS = [
    "django_resaas",
    "hr",
]

---

Middleware

MIDDLEWARE = [
    "django_resaas.core.middleware.tenant.TenantContextMiddleware",
    "django_resaas.core.middleware.frontend.FrontEndMiddleware",
]

---

🚀 Roadmap

• Integração com Stripe
• Dashboard de billing
• Auto-router
• Auditoria de ações
• Logs multi-tenant
• Cache de permissões (Redis)

---

🧠 Filosofia

"Construir SaaS não deve ser repetitivo."

django_resaas resolve:

• multi-tenant
• permissões
• módulos
• billing

👉 para você focar no negócio

---

🤝 Contribuição

PRs são bem-vindos 🚀

---

📄 Licença

MIT License

---

👨‍💻 Autor

Metano Chavana