notifica-govbr 0.1.0__tar.gz

notifica_govbr-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

notifica_govbr-0.1.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: notifica-govbr
+Version: 0.1.0
+Summary: Biblioteca para o serviço de notificações do gov.br
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: django>=6.1.2 ; extra == 'django'
+Requires-Dist: fastapi>=0.162.0 ; extra == 'fastapi'
+Requires-Dist: pydantic-settings>=2.16.1 ; extra == 'fastapi'
+Requires-Python: >=3.12
+Provides-Extra: django
+Provides-Extra: fastapi
+Description-Content-Type: text/markdown
+
+# notifica-govbr
+
+Biblioteca Python para envio de notificações à **Caixa Postal Digital do cidadão**,
+com entrega opcional por **push no aplicativo gov.br**, via API do SERPRO.
+
+> **Público-alvo:** órgãos e entidades da Administração Pública com acesso à API
+> de envio de mensagens da Caixa Postal.
+
+## Instalação
+
+```bash
+pip install notifica-govbr
+```
+
+## Pré-requisitos
+
+- **API key** fornecida pelo SERPRO para o seu órgão.
+- **Template cadastrado** previamente no serviço. A biblioteca referencia um
+  `template_id`; ela não cria templates.
+
+## Uso básico
+
+```python
+from notifica_govbr import (
+    HttpNotificationAdapter,
+    NotificaClient,
+    Notification,
+    Recipient,
+)
+
+adapter = HttpNotificationAdapter(
+    base_url="https://h-api-orgaos-cxpostal.np.estaleiro.serpro.gov.br",  # homologação
+    api_key="sua-api-key",
+)
+
+client = NotificaClient(adapter)
+
+response = client.send(
+    Notification(
+        subject="Olá, cidadão",
+        recipients=[
+            Recipient(cpf="12345678901", tags={"nome": "Maria"}),
+        ],
+        has_push=True,
+        template_id=42,
+        version=1,
+        tags={"documento": "CNH"},
+    )
+)
+
+print(response.cpf_successes)   # ['12345678901']
+print(response.failed)          # []  ou  [FailedSend(cpfs=[...], reason='...')]
+```
+
+O adaptador HTTP gerencia o ciclo de vida da conexão e pode ser usado como
+_context manager_:
+
+```python
+with HttpNotificationAdapter(base_url=..., api_key=...) as adapter:
+    client = NotificaClient(adapter)
+    client.send(...)
+```
+
+## Testes com a API fake
+
+A biblioteca inclui um adaptador em memória para testar o seu código sem rede.
+Ele implementa a mesma porta do adaptador HTTP e registra o que foi enviado:
+
+```python
+from notifica_govbr import FakeNotificationAdapter, NotificaClient
+
+fake = FakeNotificationAdapter()
+client = NotificaClient(fake)
+
+client.send(...)
+
+assert fake.sent[0].subject == "Olá, cidadão"
+```
+
+Para simular falhas por CPF:
+
+```python
+fake = FakeNotificationAdapter(
+    failing_cpfs={"98765432100"},
+    failure_reason="CPF não encontrado",
+)
+response = NotificaClient(fake).send(...)
+
+assert response.failed[0].cpfs == ["98765432100"]
+assert response.failed[0].reason == "CPF não encontrado"
+```
+
+## Formato da resposta
+
+`SendResponse` reflete o contrato da API (`falhas`/`sucessos`):
+
+- `response.cpf_successes: list[str]` — CPFs processados com sucesso.
+- `response.failed: list[FailedSend]` — falhas agrupadas por motivo.
+  - `FailedSend.cpfs: list[str]`
+  - `FailedSend.reason: str`
+
+Falhas **por destinatário** vêm no `SendResponse`. Falhas **de transporte**
+(timeout, `401`, `5xx`) viram exceções `httpx.HTTPError` — o usuário trata
+os dois casos em lugares diferentes, sem misturar.
+
+## API pública
+
+```python
+from notifica_govbr import (
+    FailedSend,
+    FakeNotificationAdapter,
+    HttpNotificationAdapter,
+    NotificaClient,
+    Notification,
+    NotificationPort,
+    Recipient,
+    SendResponse,
+)
+```
+
+`NotificationPort` é o `Protocol` que qualquer adaptador precisa cumprir. Use-o
+apenas se quiser implementar um adaptador próprio (ex: cache, fila, outro
+transporte). Para o uso comum, basta `HttpNotificationAdapter` ou
+`FakeNotificationAdapter`.
+
+## Status
+
+Versão **0.1.0** — adaptador síncrono (`httpx.Client`). Versão assíncrona
+(`httpx.AsyncClient`) planejada para uma versão futura, sem quebrar a API atual.
+
+## Licença
+
+Este projeto está licenciado sob a **Apache License 2.0**.
+Veja o arquivo [LICENSE](LICENSE) para o texto completo.

notifica_govbr-0.1.0/README.md

@@ -0,0 +1,134 @@
+# notifica-govbr
+
+Biblioteca Python para envio de notificações à **Caixa Postal Digital do cidadão**,
+com entrega opcional por **push no aplicativo gov.br**, via API do SERPRO.
+
+> **Público-alvo:** órgãos e entidades da Administração Pública com acesso à API
+> de envio de mensagens da Caixa Postal.
+
+## Instalação
+
+```bash
+pip install notifica-govbr
+```
+
+## Pré-requisitos
+
+- **API key** fornecida pelo SERPRO para o seu órgão.
+- **Template cadastrado** previamente no serviço. A biblioteca referencia um
+  `template_id`; ela não cria templates.
+
+## Uso básico
+
+```python
+from notifica_govbr import (
+    HttpNotificationAdapter,
+    NotificaClient,
+    Notification,
+    Recipient,
+)
+
+adapter = HttpNotificationAdapter(
+    base_url="https://h-api-orgaos-cxpostal.np.estaleiro.serpro.gov.br",  # homologação
+    api_key="sua-api-key",
+)
+
+client = NotificaClient(adapter)
+
+response = client.send(
+    Notification(
+        subject="Olá, cidadão",
+        recipients=[
+            Recipient(cpf="12345678901", tags={"nome": "Maria"}),
+        ],
+        has_push=True,
+        template_id=42,
+        version=1,
+        tags={"documento": "CNH"},
+    )
+)
+
+print(response.cpf_successes)   # ['12345678901']
+print(response.failed)          # []  ou  [FailedSend(cpfs=[...], reason='...')]
+```
+
+O adaptador HTTP gerencia o ciclo de vida da conexão e pode ser usado como
+_context manager_:
+
+```python
+with HttpNotificationAdapter(base_url=..., api_key=...) as adapter:
+    client = NotificaClient(adapter)
+    client.send(...)
+```
+
+## Testes com a API fake
+
+A biblioteca inclui um adaptador em memória para testar o seu código sem rede.
+Ele implementa a mesma porta do adaptador HTTP e registra o que foi enviado:
+
+```python
+from notifica_govbr import FakeNotificationAdapter, NotificaClient
+
+fake = FakeNotificationAdapter()
+client = NotificaClient(fake)
+
+client.send(...)
+
+assert fake.sent[0].subject == "Olá, cidadão"
+```
+
+Para simular falhas por CPF:
+
+```python
+fake = FakeNotificationAdapter(
+    failing_cpfs={"98765432100"},
+    failure_reason="CPF não encontrado",
+)
+response = NotificaClient(fake).send(...)
+
+assert response.failed[0].cpfs == ["98765432100"]
+assert response.failed[0].reason == "CPF não encontrado"
+```
+
+## Formato da resposta
+
+`SendResponse` reflete o contrato da API (`falhas`/`sucessos`):
+
+- `response.cpf_successes: list[str]` — CPFs processados com sucesso.
+- `response.failed: list[FailedSend]` — falhas agrupadas por motivo.
+  - `FailedSend.cpfs: list[str]`
+  - `FailedSend.reason: str`
+
+Falhas **por destinatário** vêm no `SendResponse`. Falhas **de transporte**
+(timeout, `401`, `5xx`) viram exceções `httpx.HTTPError` — o usuário trata
+os dois casos em lugares diferentes, sem misturar.
+
+## API pública
+
+```python
+from notifica_govbr import (
+    FailedSend,
+    FakeNotificationAdapter,
+    HttpNotificationAdapter,
+    NotificaClient,
+    Notification,
+    NotificationPort,
+    Recipient,
+    SendResponse,
+)
+```
+
+`NotificationPort` é o `Protocol` que qualquer adaptador precisa cumprir. Use-o
+apenas se quiser implementar um adaptador próprio (ex: cache, fila, outro
+transporte). Para o uso comum, basta `HttpNotificationAdapter` ou
+`FakeNotificationAdapter`.
+
+## Status
+
+Versão **0.1.0** — adaptador síncrono (`httpx.Client`). Versão assíncrona
+(`httpx.AsyncClient`) planejada para uma versão futura, sem quebrar a API atual.
+
+## Licença
+
+Este projeto está licenciado sob a **Apache License 2.0**.
+Veja o arquivo [LICENSE](LICENSE) para o texto completo.

notifica_govbr-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "notifica-govbr"
+version = "0.1.0"
+description = "Biblioteca para o serviço de notificações do gov.br"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = ["httpx>=0.28.1"]
+
+[project.optional-dependencies]
+fastapi = [
+    "fastapi>=0.162.0",
+    "pydantic-settings>=2.16.1",
+]
+django = ["django>=6.1.2"]
+
+[build-system]
+requires = ["uv_build>=0.13.5,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "mypy>=2.4.0",
+    "pytest>=9.1.1",
+    "respx>=0.23.1",
+]

notifica_govbr-0.1.0/pyproject.toml.orig

@@ -0,0 +1,21 @@
+[project]
+name = "notifica-govbr"
+version = "0.1.0"
+description = "Biblioteca para o serviço de notificações do gov.br"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = ["httpx>=0.28.1"]
+
+[project.optional-dependencies]
+fastapi = ["fastapi>=0.162.0", "pydantic-settings>=2.16.1"]
+django = ["django>=6.1.2"]
+
+
+[build-system]
+requires = ["uv_build>=0.13.5,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = ["mypy>=2.4.0", "pytest>=9.1.1", "respx>=0.23.1"]

notifica_govbr-0.1.0/src/notifica_govbr/__init__.py

@@ -0,0 +1,31 @@
+"""Biblioteca de integração com a Caixa Postal Digital do gov.br.
+
+Envie notificações para a Caixa Postal do cidadão, com push opcional no
+aplicativo gov.br.
+"""
+
+from notifica_govbr.adapters.fake import FakeNotificationAdapter
+from notifica_govbr.adapters.http import HttpNotificationAdapter
+from notifica_govbr.client import NotificaClient
+from notifica_govbr.domain import (
+    FailedSend,
+    Notification,
+    Recipient,
+    SendResponse,
+)
+from notifica_govbr.ports import NotificationPort
+
+__version__ = "0.1.0"
+__license__ = "Apache-2.0"
+
+__all__ = [
+    "FailedSend",
+    "FakeNotificationAdapter",
+    "HttpNotificationAdapter",
+    "NotificaClient",
+    "Notification",
+    "NotificationPort",
+    "Recipient",
+    "SendResponse",
+    "__version__",
+]

notifica_govbr-0.1.0/src/notifica_govbr/adapters/_parse.py

@@ -0,0 +1,11 @@
+from typing import Any
+
+from notifica_govbr.domain import FailedSend, SendResponse
+
+
+def parse_response(data: dict[str, Any]) -> SendResponse:
+    failed = [
+        FailedSend(cpfs=f["cpfs"], reason=f["motivo"]) for f in data.get("falhas", [])
+    ]
+    successes = list(data.get("sucessos", []))
+    return SendResponse(failed=failed, cpf_successes=successes)

notifica_govbr-0.1.0/src/notifica_govbr/adapters/_payload.py

@@ -0,0 +1,16 @@
+from typing import Any
+
+from notifica_govbr.domain import Notification
+
+
+def build_payload(notification: Notification) -> dict[str, Any]:
+    return {
+        "assunto": notification.subject,
+        "destinatarios": [
+            {"cpf": r.cpf, "tags": r.tags} for r in notification.recipients
+        ],
+        "has_push": notification.has_push,
+        "tags": notification.tags,
+        "template_id": notification.template_id,
+        "versao": notification.version,
+    }

notifica_govbr-0.1.0/src/notifica_govbr/adapters/fake.py

@@ -0,0 +1,32 @@
+from notifica_govbr.domain import FailedSend, Notification, SendResponse
+
+
+class FakeNotificationAdapter:
+    def __init__(
+        self,
+        failing_cpfs: set[str] | None = None,
+        failure_reason: str = "simulated_failure",
+    ) -> None:
+        self.sent: list[Notification] = []
+        self._failing_cpfs = failing_cpfs or set()
+        self._failure_reason = failure_reason
+
+    def send(self, notification: Notification) -> SendResponse:
+        self.sent.append(notification)
+
+        successes: list[str] = []
+        failed_cpfs: list[str] = []
+
+        for recipient in notification.recipients:
+            if recipient.cpf in self._failing_cpfs:
+                failed_cpfs.append(recipient.cpf)
+            else:
+                successes.append(recipient.cpf)
+
+        failed = (
+            [FailedSend(cpfs=failed_cpfs, reason=self._failure_reason)]
+            if failed_cpfs
+            else []
+        )
+
+        return SendResponse(failed=failed, cpf_successes=successes)

notifica_govbr-0.1.0/src/notifica_govbr/adapters/http.py

@@ -0,0 +1,44 @@
+from typing import Self
+
+import httpx
+
+from notifica_govbr.adapters._parse import parse_response
+from notifica_govbr.adapters._payload import build_payload
+from notifica_govbr.domain import Notification, SendResponse
+
+SEND_PATH = "/orgao/mensagem/enviar"
+
+
+class HttpNotificationAdapter:
+    def __init__(
+        self,
+        base_url: str,
+        api_key: str,
+        *,
+        api_key_header: str = "Authorization",
+        auth_scheme: str | None = None,
+        timeout: float = 30.0,
+    ) -> None:
+        header_value = f"{auth_scheme} {api_key}" if auth_scheme else api_key
+        self._client = httpx.Client(
+            base_url=base_url,
+            headers={api_key_header: header_value},
+            timeout=timeout,
+        )
+
+    def send(self, notification: Notification) -> SendResponse:
+        response = self._client.post(
+            SEND_PATH,
+            json=build_payload(notification),
+        )
+        response.raise_for_status()
+        return parse_response(response.json())
+
+    def close(self) -> None:
+        self._client.close()
+
+    def __enter__(self) -> Self:
+        return self
+
+    def __exit__(self, *exc_info) -> None:
+        self.close()

notifica_govbr-0.1.0/src/notifica_govbr/client.py

@@ -0,0 +1,10 @@
+from notifica_govbr.domain import Notification, SendResponse
+from notifica_govbr.ports import NotificationPort
+
+
+class NotificaClient:
+    def __init__(self, port: NotificationPort) -> None:
+        self._port = port
+
+    def send(self, notification: Notification) -> SendResponse:
+        return self._port.send(notification)

notifica_govbr-0.1.0/src/notifica_govbr/domain.py

@@ -0,0 +1,44 @@
+from dataclasses import dataclass, field
+
+
+@dataclass(frozen=True)
+class Recipient:
+    cpf: str
+    tags: dict[str, str] = field(default_factory=dict)
+
+    def __post_init__(self) -> None:
+        if len(self.cpf) != 11 or not self.cpf.isdigit():
+            raise ValueError("CPF must have 11 digits")
+
+
+@dataclass(frozen=True)
+class Notification:
+    subject: str
+    recipients: list[Recipient]
+    has_push: bool
+    template_id: int
+    version: int
+    tags: dict[str, str] = field(default_factory=dict)
+
+    def __post_init__(self) -> None:
+        if not self.recipients:
+            raise ValueError("Notification must have at least one recipient")
+        if not self.subject.strip():
+            raise ValueError("subject must not be empty")
+        seen: set[str] = set()
+        for r in self.recipients:
+            if r.cpf in seen:
+                raise ValueError(f"duplicate CPF in recipients: {r.cpf}")
+            seen.add(r.cpf)
+
+
+@dataclass(frozen=True)
+class FailedSend:
+    cpfs: list[str]
+    reason: str
+
+
+@dataclass(frozen=True)
+class SendResponse:
+    failed: list[FailedSend]
+    cpf_successes: list[str]

notifica_govbr-0.1.0/src/notifica_govbr/integration/django.py

@@ -0,0 +1,33 @@
+"""Integração com Django.
+
+Uso:
+    # settings.py
+    NOTIFICA_BASE_URL = "https://..."
+    NOTIFICA_API_KEY = "..."
+
+    # views.py
+    from notifica_govbr.integration.django import get_notifica_client
+
+    def minha_view(request):
+        client = get_notifica_client()
+        client.send(...)
+"""
+
+from notifica_govbr.adapters.http import HttpNotificationAdapter
+from notifica_govbr.client import NotificaClient
+
+
+def get_notifica_client() -> NotificaClient:
+    """Monta o NotificaClient a partir de django.conf.settings.
+
+    O import é preguiçoso: este módulo pode ser importado mesmo sem Django
+    instalado; só a chamada desta função exige Django configurado.
+    """
+    from django.conf import settings
+
+    return NotificaClient(
+        HttpNotificationAdapter(
+            base_url=settings.NOTIFICA_BASE_URL,
+            api_key=settings.NOTIFICA_API_KEY,
+        )
+    )

notifica_govbr-0.1.0/src/notifica_govbr/integration/fastapi.py

@@ -0,0 +1,50 @@
+"""Integração com FastAPI usando pydantic-settings.
+
+Uso:
+    from notifica_govbr.integration.fastapi import get_notifica_client
+
+    @app.post("/notificar")
+    def notificar(client: NotificaClient = Depends(get_notifica_client)):
+        return client.send(...)
+
+Variáveis de ambiente esperadas (prefixo NOTIFICA_):
+    NOTIFICA_BASE_URL   URL da API (produção ou homologação)
+    NOTIFICA_API_KEY    Chave de acesso fornecida pelo SERPRO
+"""
+
+from functools import lru_cache
+
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+from notifica_govbr.adapters.http import HttpNotificationAdapter
+from notifica_govbr.client import NotificaClient
+
+
+class NotificaSettings(BaseSettings):
+    """Configurações do cliente Notifica, carregadas do ambiente ou de .env."""
+
+    base_url: str
+    api_key: str
+
+    model_config = SettingsConfigDict(
+        env_prefix="NOTIFICA_",
+        env_file=".env",
+        env_file_encoding="utf-8",
+        case_sensitive=False,
+    )
+
+
+@lru_cache
+def get_settings() -> NotificaSettings:
+    """Retorna as settings, com cache para não reler o ambiente a cada request."""
+    return NotificaSettings()  # type: ignore[call-arg]
+
+
+def get_notifica_client() -> NotificaClient:
+    """Dependency do FastAPI que monta o NotificaClient a partir das settings."""
+    settings = get_settings()
+    adapter = HttpNotificationAdapter(
+        base_url=settings.base_url,
+        api_key=settings.api_key,
+    )
+    return NotificaClient(adapter)

notifica_govbr-0.1.0/src/notifica_govbr/ports.py

@@ -0,0 +1,7 @@
+from typing import Protocol
+
+from notifica_govbr.domain import Notification, SendResponse
+
+
+class NotificationPort(Protocol):
+    def send(self, notification: Notification) -> SendResponse: ...