django-telegram-q2 1.0.0__tar.gz

django_telegram_q2-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 computer 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 evidently 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 2026 Dmitrii Safronov
+
+   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.

django_telegram_q2-1.0.0/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: django-telegram-q2
+Version: 1.0.0
+Summary: Django reusable app — Telegram Bot pipeline backed by django-q2
+Keywords: django,telegram,bot,django-q2,pipeline
+Author: Dmitrii Safronov
+Author-email: Dmitrii Safronov <dhameoelin+django-telegram-q2@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Communications :: Chat
+Requires-Dist: django>=5.2.15,<6.0
+Requires-Dist: django-q2>=1.0.0,<2.0.0
+Requires-Dist: httpx>=0.28.0,<1.0.0
+Requires-Dist: cryptography>=44.0.0,<49.0.0
+Requires-Python: >=3.11, <3.15
+Project-URL: Source, https://github.com/disafronov/django-telegram-q2
+Project-URL: Issues, https://github.com/disafronov/django-telegram-q2/issues
+Description-Content-Type: text/markdown
+
+# django-telegram-q2
+
+A reusable Django app that turns a Telegram bot into a durable, queue-backed
+pipeline: inbound messages are buffered, turned into `Job` records, processed by
+a worker you supply, and the result is delivered back to the chat — all driven by
+[django-q2](https://github.com/django-q2/django-q2) task scheduling.
+
+```
+Telegram ──► intake (webhook or polling) ──► IntakeBuffer (debounce)
+                                                   │
+                                                   ▼
+                                                Job ──► processing worker (your code)
+                                                   │                 │
+                                                   │                 ▼
+                                                   │            raw_output / error
+                                                   ▼                 │
+                                          telegram_deliver ◄────────┘
+                                                   │
+                                                   ▼
+                                              Telegram
+```
+
+## Features
+
+- **At-least-once, resumable pipeline.** Every message becomes a `Job` with
+  explicit `processing_*` / `delivery_*` timestamps and database-level
+  check constraints, so a crashed worker or dropped task is safe to retry.
+- **Webhook *and* long-polling ingest.** `telegram_setup` heals/registers the
+  webhook and transparently falls back to polling when Telegram reports errors
+  or the public `BASE_URL` is unavailable. The two never race (a `409` from
+  Telegram is tolerated).
+- **Message debouncing.** Consecutive messages in the same chat within
+  `TELEGRAM_INTAKE_DEBOUNCE_SECONDS` are concatenated into a single `Job`, so a
+  multi-line thought is processed as one unit.
+- **Encrypted secrets at rest.** Bot API tokens and webhook secrets are stored
+  with deterministic AES-SIV encryption (`FIELD_ENCRYPTION_KEY`), while still
+  allowing exact-match lookups.
+- **Shipped admin + migrations.** `Bot`/`Job`/`IntakeBuffer` are registered with
+  the admin, including "retry job", "retry delivery" and "rotate webhook secret"
+  actions. Migrations are included.
+- **Zero worker assumptions.** The package owns transport and scheduling; you
+  implement `process()` and point `Q2_PROCESSING_FUNC` at it.
+
+## Requirements
+
+- Python **3.11**, **3.12**, **3.13**, or **3.14**
+- Django **>= 5.2, < 6.0**
+- django-q2 **>= 1.0, < 2.0** (and its broker — Redis/ORM/…)
+- `cryptography` and `httpx` (declared as dependencies)
+- **PostgreSQL recommended** for production (the pipeline relies on
+  `SELECT … SKIP LOCKED`; SQLite works for local development and tests).
+
+## Installation
+
+```console
+uv add django-telegram-q2
+# or
+pip install django-telegram-q2
+```
+
+## Quick start
+
+### 1. Apps and URLs
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # … Django apps …
+    "django_q",                       # django-q2
+    "django_telegram_q2.telegram",    # this app (app label: "telegram")
+]
+
+# urls.py
+from django.urls import include, path
+
+urlpatterns = [
+    path("", include("django_telegram_q2.telegram.urls")),  # exposes /webhook/
+]
+```
+
+The webhook endpoint is exposed at `/webhook/` (no `app_name` namespace).
+
+### 2. Configure django-q2
+
+The package schedules its work through django-q2, so a `Q_CLUSTER` config is
+required. See the django-q2 docs for broker options (Redis/ORM/etc.) and run a
+cluster (`manage.py qcluster`).
+
+### 3. Required settings
+
+```python
+import os
+
+# 32-byte key, hex-encoded (64 hex chars).
+# Generate: python -c "import secrets; print(secrets.token_bytes(32).hex())"
+os.environ["FIELD_ENCRYPTION_KEY"] = "…64-hex-chars…"
+
+# Public base URL used to register webhooks. Leave empty to use polling only.
+BASE_URL = "https://bot.example.com"
+
+# Processing function — dotted path to a callable taking one int (job_pk).
+Q2_PROCESSING_FUNC = "myproject.workers.process_job"
+
+# Managed Q2 schedule intervals (in minutes).
+Q2_TELEGRAM_SETUP_MINUTES = 5
+Q2_TELEGRAM_INGEST_MINUTES = 1
+Q2_TELEGRAM_DELIVER_MINUTES = 1
+Q2_TELEGRAM_INTAKE_FLUSH_MINUTES = 1
+Q2_PROCESSING_MINUTES = 1
+
+# Webhook health management.
+WEBHOOK_COOLDOWN_SECONDS = 300
+WEBHOOK_FALLBACK_PENDING_THRESHOLD = 100
+
+# How long a claimed-but-unfinished Job stays stuck before being reset (seconds).
+Q2_PROCESSING_STALE_JOB_SECONDS = 3600
+
+# Emoji sent to acknowledge receipt; empty string disables the reaction.
+TELEGRAM_ACK_REACTION = "🤖"
+```
+
+### 4. Migrate
+
+```console
+python manage.py migrate
+```
+
+Migrations for the `telegram` app are shipped, so no `makemigrations` is needed
+for the package models.
+
+## Models
+
+| Model            | Purpose                                                                 |
+| ---------------- | ----------------------------------------------------------------------- |
+| `Bot`            | A Telegram bot identity: encrypted `telegram_api_token`, `webhook_secret`, poll `telegram_update_offset`, webhook state. |
+| `Job`            | One pipeline execution: `raw_input` → (`raw_output` \| `processing_error`) → delivery state. Carries DB-level check constraints and partial indexes for queue queries. |
+| `IntakeBuffer`   | Mutable accumulator of consecutive chat messages before a `Job` is created; one open buffer per `bot`+`chat`. |
+
+`Job.objects` is a `JobQuerySet` with `ready_for_processing()`,
+`stale_processing(cutoff)` and `ready_for_delivery()` for queue queries.
+
+## How the pipeline runs
+
+1. **Intake.** Either the `/webhook/` view (when a webhook is registered) or
+   `telegram_ingest` (long-polling) calls `accept_telegram_message`. Messages
+   within `TELEGRAM_INTAKE_DEBOUNCE_SECONDS` of the last one are appended to the
+   open `IntakeBuffer`; otherwise the buffer is flushed into a `Job` first.
+2. **Processing.** A `post_save` signal on the new `Job` enqueues
+   `Q2_PROCESSING_FUNC(job_pk)`. Your worker runs `process()`, stores the result
+   on the `Job`, and a second signal enqueues `telegram_deliver`.
+3. **Delivery.** `telegram_deliver` sends `raw_output` back to the chat as a
+   text document (format auto-detected as HTML/Markdown/plain text), or the
+   `processing_error` as a plain message. On failure it records `delivery_error`
+   and re-raises; it deliberately does **not** auto-resend an already-started
+   delivery, because Telegram sends are not idempotent.
+
+`telegram_setup`, `telegram_ingest`, `telegram_deliver`,
+`telegram_flush_intake_buffers` and your processing function are all managed
+**Q2 schedules** created on `post_migrate` and protected from admin drift (any
+edit is reverted, any delete is recreated) via `pre_save`/`post_delete`
+handlers.
+
+## Implementing a worker
+
+Subclass `django_telegram_q2.telegram.worker.Worker` and implement `process()`:
+
+```python
+# myproject/workers.py
+from django_telegram_q2.telegram.worker import Worker
+
+
+class EchoWorker(Worker):
+    # Optional: restrict which Jobs are polled, and what to select_related.
+    poll_filters: dict = {}
+    poll_select_related: tuple[str, ...] = ()
+    pk_select_related: tuple[str, ...] = ()
+
+    def process(self, *, bot_id: int, raw_input: str) -> tuple[str | None, str | None]:
+        # Return (result, None) on success,
+        # return (None, "error message") on a handled error (no re-raise),
+        # or raise on an unexpected failure (re-raised by run()).
+        return f"You said: {raw_input}", None
+
+
+def process_job(job_pk: int) -> None:
+    EchoWorker().run(job_pk)
+```
+
+```python
+# settings.py
+Q2_PROCESSING_FUNC = "myproject.workers.process_job"
+```
+
+`Worker.run` handles Job selection, locking (`skip_locked`), transaction
+management, stale-Job reset, and persisting the outcome.
+
+## Webhook vs polling
+
+- Set `BASE_URL` to a publicly reachable HTTPS URL. `telegram_setup` registers
+  the webhook (with the per-bot `webhook_secret` sent as the
+  `X-Telegram-Bot-Api-Secret-Token` header, which the view verifies).
+- If `BASE_URL` is empty, or Telegram reports a webhook error / too many pending
+  updates, the app deletes the webhook and falls back to `telegram_ingest`
+  long-polling. After `WEBHOOK_COOLDOWN_SECONDS` it retries webhook
+  registration.
+- The view rejects any request without a matching secret header with `404`.
+
+## Settings reference
+
+| Setting                              | Required | Default | Description                                                        |
+| ------------------------------------ | -------- | ------- | ------------------------------------------------------------------ |
+| `Q2_PROCESSING_FUNC`                 | yes      | —       | Dotted path to the processing entry function `(job_pk: int) -> None`. |
+| `Q2_TELEGRAM_SETUP_MINUTES`          | yes      | —       | Interval for `telegram_setup` (webhook health).                    |
+| `Q2_TELEGRAM_INGEST_MINUTES`         | yes      | —       | Interval for `telegram_ingest` (polling).                          |
+| `Q2_TELEGRAM_DELIVER_MINUTES`        | yes      | —       | Interval for `telegram_deliver` (drain deliveries).               |
+| `Q2_TELEGRAM_INTAKE_FLUSH_MINUTES`   | yes      | —       | Interval for the intake-buffer safety flush.                       |
+| `Q2_PROCESSING_MINUTES`              | yes      | —       | Interval for your processing schedule.                             |
+| `WEBHOOK_COOLDOWN_SECONDS`           | yes      | —       | Quiet period after falling back to polling before retrying webhook. |
+| `WEBHOOK_FALLBACK_PENDING_THRESHOLD` | yes      | —       | `pending_update_count` above which the webhook is considered unhealthy. |
+| `Q2_PROCESSING_STALE_JOB_SECONDS`    | yes      | —       | Age after which a claimed-but-unfinished Job is reset for retry.    |
+| `TELEGRAM_ACK_REACTION`              | yes      | —       | Emoji acknowledgement; `""` disables it.                          |
+| `BASE_URL`                           | no       | `""`    | Public base URL for webhook registration (empty ⇒ polling only).   |
+| `TELEGRAM_INTAKE_DEBOUNCE_SECONDS`   | no       | `10`    | Window for grouping consecutive chat messages into one `Job`.      |
+
+| Env var             | Required | Description                                            |
+| ------------------- | -------- | ------------------------------------------------------ |
+| `FIELD_ENCRYPTION_KEY` | yes   | 32-byte (16/24/32 accepted) key, hex-encoded, for AES-SIV field encryption. |
+
+## Development
+
+This repository ships its own dev tooling:
+
+```console
+make install      # install deps + pre-commit hooks
+make lint         # black, isort, flake8, mypy, bandit
+make test         # pytest with 100% branch coverage
+make dead-code    # vulture
+make audit        # pip-audit
+make all          # lint → test → dead-code
+```
+
+Tests run against SQLite in-memory by default, and against PostgreSQL when
+`DATABASE_HOST` is set (e.g. via `compose.yml`).
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).