openbot-id 1.0.0__tar.gz

openbot_id-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kafnik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

openbot_id-1.0.0/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: openbot-id
+Version: 1.0.0
+Summary: Python client for the Openbot ID authorization API
+Author: Kafnik
+License-Expression: MIT
+Keywords: telegram,authorization,fastapi,telebot
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Openbot ID — Python-библиотека
+
+Релиз `1.0.0`. Библиотека проверяет права пользователей Telegram через защищённый Openbot ID API. База пользователей хранится только на сервере.
+
+Лицензия: MIT. Автор: Kafnik.
+
+## Установка из исходной папки
+
+```bash
+python -m pip install .
+```
+
+Используй виртуальное окружение (`python3 -m venv venv`).
+
+## С pyTelegramBotAPI
+
+```python
+import os
+import telebot
+from openbot_id import OpenbotID
+
+bot = telebot.TeleBot(os.environ["TELEGRAM_BOT_TOKEN"])
+openbot = OpenbotID(api_key=os.environ["OPENBOT_API_KEY"], bot=bot)
+
+@bot.message_handler(commands=["test"])
+@openbot.check_level("tester", level=2)
+def test(message):
+    bot.reply_to(message, "✅ Доступ разрешён")
+
+@bot.message_handler(commands=["panel"])
+@openbot.require_access()
+def panel(message):
+    bot.reply_to(message, "Панель доступна")
+
+bot.infinity_polling()
+```
+
+Декоратор `@bot.message_handler` должен стоять выше `@openbot.check_level` и `@openbot.require_access`.
+
+## Другие функции
+
+```python
+openbot.get_user(123456789)                # словарь с user_id, exists, status, level
+openbot.get_status(123456789)              # статус
+openbot.get_level(123456789)               # числовой уровень
+openbot.has_level(123456789, "tester", 2)  # bool
+openbot.check_access(123456789)            # bool
+```
+
+При отсутствии доступа команда не выполняется. Если API недоступен, проверка также не пропускает команду. При переданном `bot=bot` библиотека отвечает пользователю сообщением.
+
+Сервер по умолчанию: `https://server.tail116c85.ts.net`. При смене сервера можно передать `api_url="https://..."`.
+
+## Безопасность
+
+- Выдавай разработчикам только их собственные ключи `ob_live_...`.
+- Не публикуй главный секрет сервера, токены ботов или SQLite-базу.
+- Для реального бота храни секреты в переменных окружения.
+- Библиотека требует HTTPS.
+- При отключении домашнего интернета API временно недоступен.
+
+## Совпадение имён
+
+На Linux-сервере есть локальный `openbot_id.py`, который управляет SQLite. Не устанавливай клиентский пакет в то же Python-окружение, пока серверный модуль не переименован или не вынесен в отдельный пакет.
+
+## Тесты
+
+```bash
+python -m unittest discover -s tests -v
+```

openbot_id-1.0.0/README.md

@@ -0,0 +1,70 @@
+# Openbot ID — Python-библиотека
+
+Релиз `1.0.0`. Библиотека проверяет права пользователей Telegram через защищённый Openbot ID API. База пользователей хранится только на сервере.
+
+Лицензия: MIT. Автор: Kafnik.
+
+## Установка из исходной папки
+
+```bash
+python -m pip install .
+```
+
+Используй виртуальное окружение (`python3 -m venv venv`).
+
+## С pyTelegramBotAPI
+
+```python
+import os
+import telebot
+from openbot_id import OpenbotID
+
+bot = telebot.TeleBot(os.environ["TELEGRAM_BOT_TOKEN"])
+openbot = OpenbotID(api_key=os.environ["OPENBOT_API_KEY"], bot=bot)
+
+@bot.message_handler(commands=["test"])
+@openbot.check_level("tester", level=2)
+def test(message):
+    bot.reply_to(message, "✅ Доступ разрешён")
+
+@bot.message_handler(commands=["panel"])
+@openbot.require_access()
+def panel(message):
+    bot.reply_to(message, "Панель доступна")
+
+bot.infinity_polling()
+```
+
+Декоратор `@bot.message_handler` должен стоять выше `@openbot.check_level` и `@openbot.require_access`.
+
+## Другие функции
+
+```python
+openbot.get_user(123456789)                # словарь с user_id, exists, status, level
+openbot.get_status(123456789)              # статус
+openbot.get_level(123456789)               # числовой уровень
+openbot.has_level(123456789, "tester", 2)  # bool
+openbot.check_access(123456789)            # bool
+```
+
+При отсутствии доступа команда не выполняется. Если API недоступен, проверка также не пропускает команду. При переданном `bot=bot` библиотека отвечает пользователю сообщением.
+
+Сервер по умолчанию: `https://server.tail116c85.ts.net`. При смене сервера можно передать `api_url="https://..."`.
+
+## Безопасность
+
+- Выдавай разработчикам только их собственные ключи `ob_live_...`.
+- Не публикуй главный секрет сервера, токены ботов или SQLite-базу.
+- Для реального бота храни секреты в переменных окружения.
+- Библиотека требует HTTPS.
+- При отключении домашнего интернета API временно недоступен.
+
+## Совпадение имён
+
+На Linux-сервере есть локальный `openbot_id.py`, который управляет SQLite. Не устанавливай клиентский пакет в то же Python-окружение, пока серверный модуль не переименован или не вынесен в отдельный пакет.
+
+## Тесты
+
+```bash
+python -m unittest discover -s tests -v
+```

openbot_id-1.0.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "openbot-id"
+version = "1.0.0"
+description = "Python client for the Openbot ID authorization API"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = []
+authors = [{name = "Kafnik"}]
+license = "MIT"
+license-files = ["LICENSE"]
+keywords = ["telegram", "authorization", "fastapi", "telebot"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]

openbot_id-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

openbot_id-1.0.0/src/openbot_id/__init__.py

@@ -0,0 +1,5 @@
+"""Openbot ID client library (not the server's SQLite module)."""
+
+from .client import AccessDenied, APIError, OpenbotID
+
+__all__ = ["OpenbotID", "APIError", "AccessDenied"]

openbot_id-1.0.0/src/openbot_id/client.py

@@ -0,0 +1,122 @@
+"""HTTPS-only client for Openbot ID API."""
+
+import functools
+import json
+import os
+from urllib.error import HTTPError, URLError
+from urllib.parse import urlencode
+from urllib.request import Request, urlopen
+
+
+DEFAULT_API_URL = "https://server.tail116c85.ts.net"
+
+
+class APIError(Exception):
+    """The API could not complete the verification."""
+
+
+class AccessDenied(Exception):
+    """The checked user does not have permission."""
+
+
+class OpenbotID:
+    def __init__(self, api_key=None, *, api_url=DEFAULT_API_URL, timeout=5, bot=None):
+        self.api_key = api_key or os.getenv("OPENBOT_API_KEY")
+        if not self.api_key:
+            raise ValueError("An API key is required")
+        self.api_url = api_url.rstrip("/")
+        if not self.api_url.startswith("https://"):
+            raise ValueError("API URL must use HTTPS")
+        if timeout <= 0:
+            raise ValueError("timeout must be positive")
+        self.timeout = timeout
+        self.bot = bot
+
+    def _get(self, path, params=None):
+        url = self.api_url + path
+        if params:
+            url += "?" + urlencode(params)
+        request = Request(url, headers={"X-API-Key": self.api_key, "Accept": "application/json"})
+        try:
+            with urlopen(request, timeout=self.timeout) as response:
+                result = json.load(response)
+        except HTTPError as exc:
+            raise APIError(f"API returned HTTP {exc.code}") from exc
+        except (URLError, TimeoutError, OSError, ValueError) as exc:
+            raise APIError("Openbot ID API is unavailable or returned invalid JSON") from exc
+        if not isinstance(result, dict):
+            raise APIError("Unexpected API response")
+        return result
+
+    @staticmethod
+    def _valid_user_id(user_id):
+        if type(user_id) is not int or user_id <= 0:
+            raise ValueError("user_id must be a positive integer")
+        return user_id
+
+    def get_user(self, user_id):
+        return self._get(f"/api/user/{self._valid_user_id(user_id)}")
+
+    def get_status(self, user_id):
+        return self.get_user(user_id)["status"]
+
+    def get_level(self, user_id):
+        return self.get_user(user_id)["level"]
+
+    def check_access(self, user_id):
+        result = self._get(f"/api/check_access/{self._valid_user_id(user_id)}")
+        if type(result.get("allowed")) is not bool:
+            raise APIError("API response lacks an allowed flag")
+        return result["allowed"]
+
+    def has_level(self, user_id, status, level=1):
+        if not isinstance(status, str) or not status.strip():
+            raise ValueError("status must be a non-empty string")
+        if type(level) is not int or level < 1:
+            raise ValueError("level must be a positive integer")
+        result = self._get(
+            f"/api/check_level/{self._valid_user_id(user_id)}",
+            {"status": status, "level": level},
+        )
+        if type(result.get("allowed")) is not bool:
+            raise APIError("API response lacks an allowed flag")
+        return result["allowed"]
+
+    def check_level(self, status, level=1, *, on_denied=None, on_error=None):
+        """Decorator for handlers whose first argument has .from_user.id.
+
+        Rejection is fail-closed: the wrapped handler never executes without
+        a successful permission check. Provide a bot at construction time or
+        callbacks to notify users of denial and service outages.
+        """
+        return self._decorate_permission(
+            lambda user_id: self.has_level(user_id, status, level),
+            on_denied=on_denied, on_error=on_error,
+        )
+
+    def require_access(self, *, on_denied=None, on_error=None):
+        """Decorator requiring the server's general access policy."""
+        return self._decorate_permission(self.check_access, on_denied=on_denied, on_error=on_error)
+
+    def _decorate_permission(self, verify, *, on_denied, on_error):
+        def decorate(handler):
+            @functools.wraps(handler)
+            def wrapped(message, *args, **kwargs):
+                try:
+                    user_id = message.from_user.id
+                    allowed = verify(user_id)
+                except APIError as exc:
+                    if on_error:
+                        return on_error(message, exc)
+                    if self.bot:
+                        return self.bot.reply_to(message, "⚠️ Openbot ID недоступен. Попробуйте позже.")
+                    raise
+                if not allowed:
+                    if on_denied:
+                        return on_denied(message)
+                    if self.bot:
+                        return self.bot.reply_to(message, "⛔ Недостаточно прав для этой команды.")
+                    raise AccessDenied("User is not permitted")
+                return handler(message, *args, **kwargs)
+            return wrapped
+        return decorate

openbot_id-1.0.0/src/openbot_id.egg-info/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: openbot-id
+Version: 1.0.0
+Summary: Python client for the Openbot ID authorization API
+Author: Kafnik
+License-Expression: MIT
+Keywords: telegram,authorization,fastapi,telebot
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Openbot ID — Python-библиотека
+
+Релиз `1.0.0`. Библиотека проверяет права пользователей Telegram через защищённый Openbot ID API. База пользователей хранится только на сервере.
+
+Лицензия: MIT. Автор: Kafnik.
+
+## Установка из исходной папки
+
+```bash
+python -m pip install .
+```
+
+Используй виртуальное окружение (`python3 -m venv venv`).
+
+## С pyTelegramBotAPI
+
+```python
+import os
+import telebot
+from openbot_id import OpenbotID
+
+bot = telebot.TeleBot(os.environ["TELEGRAM_BOT_TOKEN"])
+openbot = OpenbotID(api_key=os.environ["OPENBOT_API_KEY"], bot=bot)
+
+@bot.message_handler(commands=["test"])
+@openbot.check_level("tester", level=2)
+def test(message):
+    bot.reply_to(message, "✅ Доступ разрешён")
+
+@bot.message_handler(commands=["panel"])
+@openbot.require_access()
+def panel(message):
+    bot.reply_to(message, "Панель доступна")
+
+bot.infinity_polling()
+```
+
+Декоратор `@bot.message_handler` должен стоять выше `@openbot.check_level` и `@openbot.require_access`.
+
+## Другие функции
+
+```python
+openbot.get_user(123456789)                # словарь с user_id, exists, status, level
+openbot.get_status(123456789)              # статус
+openbot.get_level(123456789)               # числовой уровень
+openbot.has_level(123456789, "tester", 2)  # bool
+openbot.check_access(123456789)            # bool
+```
+
+При отсутствии доступа команда не выполняется. Если API недоступен, проверка также не пропускает команду. При переданном `bot=bot` библиотека отвечает пользователю сообщением.
+
+Сервер по умолчанию: `https://server.tail116c85.ts.net`. При смене сервера можно передать `api_url="https://..."`.
+
+## Безопасность
+
+- Выдавай разработчикам только их собственные ключи `ob_live_...`.
+- Не публикуй главный секрет сервера, токены ботов или SQLite-базу.
+- Для реального бота храни секреты в переменных окружения.
+- Библиотека требует HTTPS.
+- При отключении домашнего интернета API временно недоступен.
+
+## Совпадение имён
+
+На Linux-сервере есть локальный `openbot_id.py`, который управляет SQLite. Не устанавливай клиентский пакет в то же Python-окружение, пока серверный модуль не переименован или не вынесен в отдельный пакет.
+
+## Тесты
+
+```bash
+python -m unittest discover -s tests -v
+```

openbot_id-1.0.0/src/openbot_id.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+src/openbot_id/__init__.py
+src/openbot_id/client.py
+src/openbot_id.egg-info/PKG-INFO
+src/openbot_id.egg-info/SOURCES.txt
+src/openbot_id.egg-info/dependency_links.txt
+src/openbot_id.egg-info/top_level.txt
+tests/test_client.py

openbot_id-1.0.0/src/openbot_id.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

openbot_id-1.0.0/src/openbot_id.egg-info/top_level.txt

@@ -0,0 +1 @@
+openbot_id

openbot_id-1.0.0/tests/test_client.py

@@ -0,0 +1,73 @@
+import io
+import json
+import unittest
+from types import SimpleNamespace
+from unittest.mock import patch
+
+from openbot_id import AccessDenied, APIError, OpenbotID
+
+
+class Response(io.BytesIO):
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *args):
+        self.close()
+
+
+class ClientTests(unittest.TestCase):
+    def setUp(self):
+        self.client = OpenbotID(api_key="test-only-token")
+
+    @patch("openbot_id.client.urlopen")
+    def test_check_uses_auth_header_and_query(self, mock_urlopen):
+        mock_urlopen.return_value = Response(json.dumps({"allowed": True}).encode())
+        self.assertTrue(self.client.has_level(123, "tester", 2))
+        request = mock_urlopen.call_args.args[0]
+        self.assertEqual(request.get_header("X-api-key"), "test-only-token")
+        self.assertIn("status=tester&level=2", request.full_url)
+
+    @patch("openbot_id.client.urlopen")
+    def test_denied_never_executes_handler(self, mock_urlopen):
+        mock_urlopen.return_value = Response(b'{"allowed": false}')
+        executed = []
+
+        @self.client.check_level("tester", 2)
+        def handler(message):
+            executed.append(True)
+
+        with self.assertRaises(AccessDenied):
+            handler(SimpleNamespace(from_user=SimpleNamespace(id=123)))
+        self.assertEqual(executed, [])
+
+    @patch("openbot_id.client.urlopen", side_effect=OSError("offline"))
+    def test_offline_never_executes_handler(self, mock_urlopen):
+        executed = []
+
+        @self.client.check_level("tester", 2)
+        def handler(message):
+            executed.append(True)
+
+        with self.assertRaises(APIError):
+            handler(SimpleNamespace(from_user=SimpleNamespace(id=123)))
+        self.assertEqual(executed, [])
+
+    def test_http_required(self):
+        with self.assertRaises(ValueError):
+            OpenbotID(api_key="token", api_url="http://localhost:8000")
+
+    @patch("openbot_id.client.urlopen")
+    def test_general_access_decorator(self, mock_urlopen):
+        mock_urlopen.return_value = Response(b'{"allowed": true}')
+        executed = []
+
+        @self.client.require_access()
+        def handler(message):
+            executed.append(message.from_user.id)
+
+        handler(SimpleNamespace(from_user=SimpleNamespace(id=321)))
+        self.assertEqual(executed, [321])
+
+
+if __name__ == "__main__":
+    unittest.main()