xc-bot 1.0.0__tar.gz

xc_bot-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Xaneo Team
+
+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.

xc_bot-1.0.0/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: xc-bot
+Version: 1.0.0
+Summary: Python SDK for XaneoConnect Bot API
+Author: Xaneo Team
+Author-email: Xaneo Team <ltpddwk@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/saneome2/xc-bot
+Project-URL: Documentation, https://xaneo.com/bot-api
+Project-URL: Repository, https://github.com/saneome2/xc-bot
+Keywords: xaneo,bot,api,sdk,async
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: AsyncIO
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.0
+Requires-Dist: grpcio>=1.60.0
+Requires-Dist: protobuf>=4.25.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: aioresponses>=0.7.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-python
+
+# xc-bot
+
+Python SDK for XaneoConnect Bot API
+
+## Installation
+
+```bash
+pip install xc-bot
+```
+
+## Quick Start
+
+```python
+from xc_bot import Bot
+
+bot = Bot("xbot_12345_abc...")
+
+@bot.command('start')
+async def start(message):
+    await message.reply("Hello! I'm a bot.")
+
+bot.run()
+```
+
+## Features
+
+- Async-only API (Python 3.8+)
+- Decorator-based handlers: `@bot.command()`, `@bot.hears()`, `@bot.message()`
+- Message object with `.reply()`, `.edit()`, `.delete()` methods
+- Webhook server with HMAC signature verification
+- Automatic retry with exponential backoff
+
+## API Methods
+
+| Method                           | Description           |
+| -------------------------------- | --------------------- |
+| `get_me()`                       | Get bot information   |
+| `send_message(chat_id, text)`    | Send a message        |
+| `edit_message(message_id, text)` | Edit a message        |
+| `delete_message(message_id)`     | Delete a message      |
+| `get_chat(chat_id)`              | Get chat info         |
+| `get_chat_members(chat_id)`      | Get chat members      |
+| `leave_chat(chat_id)`            | Leave a chat          |
+| `set_commands(commands)`         | Register bot commands |
+| `set_webhook(url)`               | Set webhook URL       |
+| `delete_webhook()`               | Remove webhook        |
+
+## Handlers
+
+### Commands
+
+```python
+@bot.command(['start', 'help'])
+async def start_handler(message):
+    await message.reply("Welcome!")
+```
+
+### Regex
+
+```python
+@bot.hears(r"^/echo (.+)$")
+async def echo_handler(message, match):
+    await message.reply(match.group(1))
+```
+
+### All Messages
+
+```python
+@bot.message
+async def log_message(message):
+    print(f"[{message.chat_id}] {message.text}")
+```
+
+## Webhook
+
+```python
+from xc_bot import Bot, WebhookServer
+
+bot = Bot("xbot_token")
+
+@bot.command("start")
+async def start(message):
+    await message.reply("Hello!")
+
+# Set webhook
+await bot.set_webhook("https://your-server.com/webhook", secret="your-secret")
+
+# Start webhook server
+server = WebhookServer(bot, port=8443, secret="your-secret")
+server.run()
+```
+
+## Getting a Token
+
+1. Open chat with @BotConstructor in XaneoConnect
+2. Send `/newbot`
+3. Follow the instructions
+
+## License
+
+MIT

xc_bot-1.0.0/README.md

@@ -0,0 +1,101 @@
+# xc-bot
+
+Python SDK for XaneoConnect Bot API
+
+## Installation
+
+```bash
+pip install xc-bot
+```
+
+## Quick Start
+
+```python
+from xc_bot import Bot
+
+bot = Bot("xbot_12345_abc...")
+
+@bot.command('start')
+async def start(message):
+    await message.reply("Hello! I'm a bot.")
+
+bot.run()
+```
+
+## Features
+
+- Async-only API (Python 3.8+)
+- Decorator-based handlers: `@bot.command()`, `@bot.hears()`, `@bot.message()`
+- Message object with `.reply()`, `.edit()`, `.delete()` methods
+- Webhook server with HMAC signature verification
+- Automatic retry with exponential backoff
+
+## API Methods
+
+| Method                           | Description           |
+| -------------------------------- | --------------------- |
+| `get_me()`                       | Get bot information   |
+| `send_message(chat_id, text)`    | Send a message        |
+| `edit_message(message_id, text)` | Edit a message        |
+| `delete_message(message_id)`     | Delete a message      |
+| `get_chat(chat_id)`              | Get chat info         |
+| `get_chat_members(chat_id)`      | Get chat members      |
+| `leave_chat(chat_id)`            | Leave a chat          |
+| `set_commands(commands)`         | Register bot commands |
+| `set_webhook(url)`               | Set webhook URL       |
+| `delete_webhook()`               | Remove webhook        |
+
+## Handlers
+
+### Commands
+
+```python
+@bot.command(['start', 'help'])
+async def start_handler(message):
+    await message.reply("Welcome!")
+```
+
+### Regex
+
+```python
+@bot.hears(r"^/echo (.+)$")
+async def echo_handler(message, match):
+    await message.reply(match.group(1))
+```
+
+### All Messages
+
+```python
+@bot.message
+async def log_message(message):
+    print(f"[{message.chat_id}] {message.text}")
+```
+
+## Webhook
+
+```python
+from xc_bot import Bot, WebhookServer
+
+bot = Bot("xbot_token")
+
+@bot.command("start")
+async def start(message):
+    await message.reply("Hello!")
+
+# Set webhook
+await bot.set_webhook("https://your-server.com/webhook", secret="your-secret")
+
+# Start webhook server
+server = WebhookServer(bot, port=8443, secret="your-secret")
+server.run()
+```
+
+## Getting a Token
+
+1. Open chat with @BotConstructor in XaneoConnect
+2. Send `/newbot`
+3. Follow the instructions
+
+## License
+
+MIT

xc_bot-1.0.0/pyproject.toml

@@ -0,0 +1,64 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xc-bot"
+version = "1.0.0"
+description = "Python SDK for XaneoConnect Bot API"
+readme = "README.md"
+authors = [{name = "Xaneo Team", email = "ltpddwk@gmail.com"}]
+license = {text = "MIT"}
+requires-python = ">=3.8"
+dependencies = [
+    "aiohttp>=3.8.0",
+    "grpcio>=1.60.0",
+    "protobuf>=4.25.0",
+]
+
+
+keywords = ["xaneo", "bot", "api", "sdk", "async"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Framework :: AsyncIO",
+]
+
+[project.urls]
+Homepage = "https://github.com/saneome2/xc-bot"
+Documentation = "https://xaneo.com/bot-api"
+Repository = "https://github.com/saneome2/xc-bot"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.21.0",
+    "aioresponses>=0.7.0",
+    "black>=23.0.0",
+    "mypy>=1.0.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["xc_bot*"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.black]
+line-length = 100
+target-version = ["py38"]

xc_bot-1.0.0/setup.cfg

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

xc_bot-1.0.0/setup.py

@@ -0,0 +1,15 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="xc-bot",
+    version="1.0.0",
+    description="Python SDK for XaneoConnect Bot API with gRPC support",
+    author="Xaneo Team",
+    packages=find_packages(include=["xc_bot", "xc_bot.*"]),
+    install_requires=[
+        "aiohttp>=3.8.0",
+        "grpcio>=1.60.0",
+        "protobuf>=4.25.0",
+    ],
+    python_requires=">=3.8",
+)

xc_bot-1.0.0/tests/test_api.py

@@ -0,0 +1,92 @@
+"""Tests for API client"""
+import pytest
+from aioresponses import aioresponses
+
+from xc_bot.api import ApiClient
+from xc_bot.exceptions import ApiError, RateLimitError, WebhookConflictError
+
+
+@pytest.mark.asyncio
+async def test_get_me():
+    client = ApiClient("xbot_123_test", "https://test.com/bot")
+    
+    with aioresponses() as m:
+        m.get(
+            "https://test.com/bot/getMe",
+            payload={"ok": True, "result": {"id": 123, "username": "test_bot"}},
+        )
+        
+        result = await client.get_me()
+        assert result["id"] == 123
+        assert result["username"] == "test_bot"
+    
+    await client.close()
+
+
+@pytest.mark.asyncio
+async def test_send_message():
+    client = ApiClient("xbot_123_test", "https://test.com/bot")
+    
+    with aioresponses() as m:
+        m.post(
+            "https://test.com/bot/sendMessage",
+            payload={"ok": True, "result": {"message_id": 1, "chat_id": "personal_1_2"}},
+        )
+        
+        result = await client.send_message("personal_1_2", "Hello!")
+        assert result["message_id"] == 1
+    
+    await client.close()
+
+
+@pytest.mark.asyncio
+async def test_api_error():
+    client = ApiClient("xbot_123_test", "https://test.com/bot")
+    
+    with aioresponses() as m:
+        m.get(
+            "https://test.com/bot/getMe",
+            payload={"ok": False, "error_code": 401, "description": "Unauthorized"},
+            status=401,
+        )
+        
+        with pytest.raises(ApiError) as exc_info:
+            await client.get_me()
+        
+        assert exc_info.value.error_code == 401
+    
+    await client.close()
+
+
+@pytest.mark.asyncio
+async def test_rate_limit_error():
+    client = ApiClient("xbot_123_test", "https://test.com/bot")
+    
+    with aioresponses() as m:
+        m.get(
+            "https://test.com/bot/getMe",
+            payload={"ok": False, "error_code": 429, "description": "Too many requests"},
+            status=429,
+        )
+        
+        with pytest.raises(RateLimitError):
+            await client.get_me()
+    
+    await client.close()
+
+
+@pytest.mark.asyncio
+async def test_webhook_conflict_error():
+    client = ApiClient("xbot_123_test", "https://test.com/bot")
+    
+    with aioresponses() as m:
+        m.post(
+            "https://test.com/bot/getUpdates",
+            payload={"ok": False, "error_code": 409, "description": "Webhook active"},
+            status=409,
+        )
+        
+        with pytest.raises(WebhookConflictError):
+            await client.get_updates()
+    
+    await client.close()

xc_bot-1.0.0/tests/test_bot.py

@@ -0,0 +1,84 @@
+"""Tests for Bot class"""
+import pytest
+from aioresponses import aioresponses
+
+from xc_bot import Bot
+from xc_bot.types import BotAccount
+
+
+@pytest.mark.asyncio
+async def test_bot_get_me(bot):
+    with aioresponses() as m:
+        m.get(
+            "https://test.xaneo.com/bot/getMe",
+            payload={
+                "ok": True,
+                "result": {
+                    "id": 12345,
+                    "username": "test_bot",
+                    "display_name": "Test Bot",
+                    "can_join_groups": True,
+                },
+            },
+        )
+        
+        result = await bot.get_me()
+        assert isinstance(result, BotAccount)
+        assert result.id == 12345
+        assert result.username == "test_bot"
+    
+    await bot.close()
+
+
+@pytest.mark.asyncio
+async def test_bot_send_message(bot):
+    with aioresponses() as m:
+        m.post(
+            "https://test.xaneo.com/bot/sendMessage",
+            payload={
+                "ok": True,
+                "result": {"message_id": 1, "chat_id": "personal_1_2", "date": 1234567890},
+            },
+        )
+        
+        message = await bot.send_message("personal_1_2", "Hello!")
+        assert message.id == 1
+        assert message.chat_id == "personal_1_2"
+    
+    await bot.close()
+
+
+@pytest.mark.asyncio
+async def test_bot_command_registration():
+    bot = Bot("xbot_test", "https://test.com/bot")
+    
+    @bot.command("start")
+    async def start_handler(message):
+        pass
+    
+    assert "start" in bot._handlers._command_handlers
+    await bot.close()
+
+
+@pytest.mark.asyncio
+async def test_bot_hears_registration():
+    bot = Bot("xbot_test", "https://test.com/bot")
+    
+    @bot.hears(r"^/echo (.+)$")
+    async def echo_handler(message, match):
+        pass
+    
+    assert len(bot._handlers._regex_handlers) == 1
+    await bot.close()
+
+
+@pytest.mark.asyncio
+async def test_bot_message_registration():
+    bot = Bot("xbot_test", "https://test.com/bot")
+    
+    @bot.message
+    async def all_messages(message):
+        pass
+    
+    assert len(bot._handlers._message_handlers) == 1
+    await bot.close()

xc_bot-1.0.0/tests/test_handlers.py

@@ -0,0 +1,111 @@
+"""Tests for handler system"""
+import pytest
+
+from xc_bot import Bot
+from xc_bot.handlers import HandlerRegistry
+from xc_bot.types import Message, User
+
+
+@pytest.fixture
+def handler_registry():
+    return HandlerRegistry()
+
+
+@pytest.fixture
+def sample_message():
+    return Message(
+        id=1,
+        chat_id="personal_1_2",
+        author=User(id=1, username="user"),
+        text="/start",
+        created_at=None,
+    )
+
+
+@pytest.mark.asyncio
+async def test_command_handler(handler_registry, sample_message):
+    called = False
+    
+    async def start_handler(message):
+        nonlocal called
+        called = True
+    
+    handler_registry.add_command("start", start_handler)
+    await handler_registry.process(sample_message)
+    
+    assert called
+
+
+@pytest.mark.asyncio
+async def test_regex_handler(handler_registry):
+    message = Message(
+        id=1,
+        chat_id="test",
+        author=User(id=1, username="user"),
+        text="/echo hello world",
+        created_at=None,
+    )
+    
+    captured_match = None
+    
+    async def echo_handler(message, match):
+        nonlocal captured_match
+        captured_match = match
+    
+    handler_registry.add_regex(r"^/echo (.+)$", echo_handler)
+    await handler_registry.process(message)
+    
+    assert captured_match is not None
+    assert captured_match.group(1) == "hello world"
+
+
+@pytest.mark.asyncio
+async def test_message_handler(handler_registry):
+    message = Message(
+        id=1,
+        chat_id="test",
+        author=User(id=1, username="user"),
+        text="Hello",
+        created_at=None,
+    )
+    
+    called = False
+    
+    async def all_handler(message):
+        nonlocal called
+        called = True
+    
+    handler_registry.add_message(all_handler)
+    await handler_registry.process(message)
+    
+    assert called
+
+
+@pytest.mark.asyncio
+async def test_command_priority(handler_registry):
+    command_called = False
+    message_called = False
+    
+    async def start_handler(message):
+        nonlocal command_called
+        command_called = True
+    
+    async def all_handler(message):
+        nonlocal message_called
+        message_called = True
+    
+    handler_registry.add_command("start", start_handler)
+    handler_registry.add_message(all_handler)
+    
+    message = Message(
+        id=1,
+        chat_id="test",
+        author=User(id=1, username="user"),
+        text="/start",
+        created_at=None,
+    )
+    
+    await handler_registry.process(message)
+    
+    assert command_called
+    assert not message_called

xc_bot-1.0.0/xc_bot/__init__.py

@@ -0,0 +1,42 @@
+"""xc-bot - Python SDK for XaneoConnect Bot API"""
+
+__version__ = "1.0.0"
+
+from .bot import Bot
+from .grpc_client import GrpcBotClient
+from .exceptions import (
+    XcBotError,
+    ApiError,
+    NetworkError,
+    RateLimitError,
+    WebhookConflictError,
+)
+from .types import (
+    User,
+    BotAccount,
+    Message,
+    Chat,
+    ChatType,
+    Update,
+    UpdateType,
+)
+from .webhook import WebhookServer
+
+__all__ = [
+    "Bot",
+    "GrpcBotClient",
+    "WebhookServer",
+    "XcBotError",
+    "ApiError",
+    "NetworkError",
+    "RateLimitError",
+    "WebhookConflictError",
+    "User",
+    "BotAccount",
+    "Message",
+    "Chat",
+    "ChatType",
+    "Update",
+    "UpdateType",
+]
+