Rubka 4.4.6__tar.gz → 4.4.8__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. rubka-4.4.8/PKG-INFO +1019 -0
  2. rubka-4.4.8/README.md +986 -0
  3. rubka-4.4.8/Rubka.egg-info/PKG-INFO +1019 -0
  4. rubka-4.4.8/Rubka.egg-info/requires.txt +3 -0
  5. rubka-4.4.8/rubka/adaptorrubka/network/socket.py +31 -0
  6. {rubka-4.4.6 → rubka-4.4.8}/rubka/api.py +8 -5
  7. {rubka-4.4.6 → rubka-4.4.8}/setup.py +7 -4
  8. rubka-4.4.6/PKG-INFO +0 -315
  9. rubka-4.4.6/README.md +0 -284
  10. rubka-4.4.6/Rubka.egg-info/PKG-INFO +0 -315
  11. rubka-4.4.6/Rubka.egg-info/requires.txt +0 -1
  12. rubka-4.4.6/rubka/adaptorrubka/network/socket.py +0 -24
  13. {rubka-4.4.6 → rubka-4.4.8}/Rubka.egg-info/SOURCES.txt +0 -0
  14. {rubka-4.4.6 → rubka-4.4.8}/Rubka.egg-info/dependency_links.txt +0 -0
  15. {rubka-4.4.6 → rubka-4.4.8}/Rubka.egg-info/top_level.txt +0 -0
  16. {rubka-4.4.6 → rubka-4.4.8}/rubka/__init__.py +0 -0
  17. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/__init__.py +0 -0
  18. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/client/__init__.py +0 -0
  19. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/client/client.py +0 -0
  20. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/crypto/__init__.py +0 -0
  21. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/crypto/crypto.py +0 -0
  22. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/enums.py +0 -0
  23. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/exceptions.py +0 -0
  24. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/methods/__init__.py +0 -0
  25. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/methods/methods.py +0 -0
  26. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/network/__init__.py +0 -0
  27. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/network/helper.py +0 -0
  28. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/network/network.py +0 -0
  29. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/sessions/__init__.py +0 -0
  30. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/sessions/sessions.py +0 -0
  31. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/types/__init__.py +0 -0
  32. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/types/socket/__init__.py +0 -0
  33. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/types/socket/message.py +0 -0
  34. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/utils/__init__.py +0 -0
  35. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/utils/configs.py +0 -0
  36. {rubka-4.4.6 → rubka-4.4.8}/rubka/adaptorrubka/utils/utils.py +0 -0
  37. {rubka-4.4.6 → rubka-4.4.8}/rubka/button.py +0 -0
  38. {rubka-4.4.6 → rubka-4.4.8}/rubka/config.py +0 -0
  39. {rubka-4.4.6 → rubka-4.4.8}/rubka/context.py +0 -0
  40. {rubka-4.4.6 → rubka-4.4.8}/rubka/decorators.py +0 -0
  41. {rubka-4.4.6 → rubka-4.4.8}/rubka/exceptions.py +0 -0
  42. {rubka-4.4.6 → rubka-4.4.8}/rubka/jobs.py +0 -0
  43. {rubka-4.4.6 → rubka-4.4.8}/rubka/keyboards.py +0 -0
  44. {rubka-4.4.6 → rubka-4.4.8}/rubka/keypad.py +0 -0
  45. {rubka-4.4.6 → rubka-4.4.8}/rubka/logger.py +0 -0
  46. {rubka-4.4.6 → rubka-4.4.8}/rubka/rubino.py +0 -0
  47. {rubka-4.4.6 → rubka-4.4.8}/rubka/utils.py +0 -0
  48. {rubka-4.4.6 → rubka-4.4.8}/setup.cfg +0 -0
rubka-4.4.8/PKG-INFO ADDED
@@ -0,0 +1,1019 @@
1
+ Metadata-Version: 2.4
2
+ Name: Rubka
3
+ Version: 4.4.8
4
+ Summary: A Python library for interacting with Rubika Bot API.
5
+ Home-page: https://github.com/Mahdy-Ahmadi/Rubka
6
+ Download-URL: https://github.com/Mahdy-Ahmadi/rubka/blob/main/project_library.zip
7
+ Author: Mahdi Ahmadi
8
+ Author-email: mahdiahmadi.1208@gmail.com
9
+ Maintainer: Mahdi Ahmadi
10
+ Maintainer-email: mahdiahmadi.1208@gmail.com
11
+ Classifier: Programming Language :: Python :: 3
12
+ Classifier: License :: OSI Approved :: MIT License
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Topic :: Communications :: Chat
15
+ Classifier: Topic :: Software Development :: Libraries
16
+ Requires-Python: >=3.6
17
+ Description-Content-Type: text/markdown
18
+ Requires-Dist: requests
19
+ Requires-Dist: Pillow
20
+ Requires-Dist: websocket-client
21
+ Dynamic: author
22
+ Dynamic: author-email
23
+ Dynamic: classifier
24
+ Dynamic: description
25
+ Dynamic: description-content-type
26
+ Dynamic: download-url
27
+ Dynamic: home-page
28
+ Dynamic: maintainer
29
+ Dynamic: maintainer-email
30
+ Dynamic: requires-dist
31
+ Dynamic: requires-python
32
+ Dynamic: summary
33
+
34
+ # 📚 Rubka Bot Python Library Documentation
35
+
36
+ ## 🧠 Introduction
37
+ `rubka` is a Python library to interact with the [Rubika Bot API](https://rubika.ir/). This library helps you create Telegram-like bots with support for messages, inline buttons, chat keypads, and callback handling.
38
+
39
+ ---
40
+
41
+ ## ⚙️ Installation
42
+
43
+ ```bash
44
+ pip install rubka
45
+ ```
46
+
47
+ If `importlib.metadata` is not available, it installs `importlib-metadata` automatically.
48
+
49
+ ---
50
+
51
+ ## 🚀 Getting Started
52
+
53
+ ```python
54
+ from rubka import Robot
55
+ from rubka.context import Message
56
+
57
+ bot = Robot(token="YOUR_TOKEN_HERE")
58
+
59
+ @bot.on_message(commands=["start"])
60
+ def start(bot: Robot, message: Message):
61
+ message.reply("سلام! خوش آمدید!")
62
+
63
+ bot.run()
64
+ ```
65
+
66
+ ---
67
+
68
+ ## 📬 Handling Messages
69
+
70
+ You can handle incoming text messages using `@bot.on_message()`:
71
+
72
+ ```python
73
+ @bot.on_message(commands=["hello"])
74
+ def greet(bot: Robot, message: Message):
75
+ message.reply("سلام کاربر عزیز 👋")
76
+ ```
77
+
78
+ You can also add filters.
79
+
80
+ ---
81
+
82
+ ## 🎮 Handling Callback Buttons
83
+
84
+ ```python
85
+ from rubka.keypad import ChatKeypadBuilder
86
+
87
+ @bot.on_message(commands=["gender"])
88
+ def gender(bot: Robot, message: Message):
89
+ keypad = ChatKeypadBuilder().row(
90
+ ChatKeypadBuilder().button(id="male", text="👨 مرد"),
91
+ ChatKeypadBuilder().button(id="female", text="👩 زن")
92
+ ).build()
93
+ message.reply_keypad("جنسیت خود را انتخاب کنید:", keypad)
94
+
95
+ @bot.on_callback("male")
96
+ def on_male(bot: Robot, message: Message):
97
+ message.reply("شما مرد هستید")
98
+
99
+ @bot.on_callback("female")
100
+ def on_female(bot: Robot, message: Message):
101
+ message.reply("شما زن هستید")
102
+ ```
103
+
104
+ ---
105
+
106
+ ## 🔘 Inline Button Builder
107
+
108
+ ```python
109
+ from rubka.button import InlineBuilder
110
+
111
+ builder = InlineBuilder().row(
112
+ InlineBuilder().button_simple(id="info", text="اطلاعات")
113
+ ).build()
114
+ ```
115
+
116
+ ---
117
+
118
+ ## 🔄 Check if User Joined a Channel
119
+
120
+ ```python
121
+ channel_guid = "c0xABCDEF..."
122
+
123
+ @bot.on_message(commands=["check"])
124
+ def check(bot: Robot, message: Message):
125
+ if bot.check_join(channel_guid, message.chat_id):
126
+ message.reply("✅ شما عضو کانال هستید")
127
+ else:
128
+ message.reply("❌ لطفاً ابتدا در کانال عضو شوید")
129
+ ```
130
+
131
+ ---
132
+
133
+ ## 💬 Utility Methods
134
+
135
+ | Method | Description |
136
+ |--------|-------------|
137
+ | `get_chat(chat_id)` | دریافت اطلاعات چت |
138
+ | `get_name(chat_id)` | دریافت نام کاربر |
139
+ | `get_username(chat_id)` | دریافت نام‌کاربری |
140
+ | `send_message(...)` | ارسال پیام متنی |
141
+ | `edit_message_text(...)` | ویرایش پیام |
142
+ | `delete_message(...)` | حذف پیام |
143
+ | `send_location(...)` | ارسال موقعیت مکانی |
144
+ | `send_poll(...)` | ارسال نظرسنجی |
145
+ | `send_contact(...)` | ارسال مخاطب |
146
+ | `forward_message(...)` | فوروارد پیام |
147
+
148
+ ---
149
+
150
+ ## 🎛 Inline Query Support
151
+
152
+ ```python
153
+ @bot.on_inline_query()
154
+ def inline(bot: Robot, message: InlineMessage):
155
+ message.answer("نتیجه اینلاین")
156
+ ```
157
+
158
+ ---
159
+
160
+ ## 🧱 Button Types
161
+
162
+ Supported inline button types include:
163
+
164
+ - `Simple`
165
+ - `Payment`
166
+ - `Calendar`
167
+ - `Location`
168
+ - `CameraImage`, `CameraVideo`
169
+ - `GalleryImage`, `GalleryVideo`
170
+ - `File`, `Audio`, `RecordAudio`
171
+ - `MyPhoneNumber`, `MyLocation`
172
+ - `Textbox`, `Barcode`, `Link`
173
+
174
+ See `InlineBuilder` for more.
175
+
176
+ ---
177
+
178
+ ## 🧩 Dynamic Chat Keypad
179
+
180
+ ```python
181
+ builder = ChatKeypadBuilder()
182
+ keypad = builder.row(
183
+ builder.button(id="play", text="🎮 بازی کن"),
184
+ builder.button(id="exit", text="❌ خروج")
185
+ ).build()
186
+ ```
187
+
188
+ ---
189
+
190
+ ## 🧪 Set Commands
191
+
192
+ ```python
193
+ bot.set_commands([
194
+ {"command": "start", "description": "شروع"},
195
+ {"command": "help", "description": "راهنما"}
196
+ ])
197
+ ```
198
+
199
+ ---
200
+
201
+ ## 🔄 Update Offset Automatically
202
+
203
+ Bot updates are handled using `get_updates()` and `offset_id` is managed internally.
204
+
205
+ ---
206
+
207
+ ## 🛠 Advanced Features
208
+
209
+ - `update_bot_endpoint()` – تنظیم webhook یا polling
210
+ - `remove_keypad()` – حذف صفحه‌کلید چت
211
+ - `edit_chat_keypad()` – ویرایش یا افزودن صفحه‌کلید چت
212
+
213
+ ---
214
+
215
+ # 📘 Rubka Bot Method Reference
216
+
217
+ مستندات مربوط به متدهای اصلی کلاس `Robot` در کتابخانه Rubka.
218
+
219
+ ---
220
+
221
+ ## ✅ پیام‌ها و هندلرها
222
+
223
+ ### `on_message(filters=None, commands=None)`
224
+ **توضیح:** ثبت هندلر برای پیام‌های ورودی.
225
+ - `filters`: تابع شرطی برای فیلتر پیام‌ها (اختیاری)
226
+ - `commands`: لیست دستورهایی که شروع با `/` هستند (اختیاری)
227
+
228
+ ### `on_callback(button_id=None)`
229
+ **توضیح:** ثبت هندلر برای دکمه‌های فشرده‌شده
230
+ - `button_id`: آیدی دکمه‌ای که باید هندل شود (اختیاری)
231
+
232
+ ### `on_inline_query()`
233
+ **توضیح:** ثبت هندلر برای پیام‌های اینلاین (inline query)
234
+
235
+ ---
236
+
237
+ ## 📨 ارسال پیام
238
+
239
+ ### `send_message(...)`
240
+ **توضیح:** ارسال پیام متنی به چت
241
+ - `chat_id`: آیدی چت مقصد *(str)* ✅
242
+ - `text`: محتوای پیام *(str)* ✅
243
+ - `chat_keypad`: کی‌پد معمولی *(dict)*
244
+ - `inline_keypad`: کی‌پد اینلاین *(dict)*
245
+ - `reply_to_message_id`: پاسخ به پیام خاص *(str)*
246
+ - `disable_notification`: بدون نوتیف *(bool)*
247
+ - `chat_keypad_type`: حالت کی‌پد *("New" | "Removed")*
248
+
249
+ ---
250
+
251
+ ## 📁 ارسال فایل‌ها
252
+
253
+ ### متدهای مشترک (فایل، موزیک، ویس، گیف، عکس):
254
+ - `send_document(...)`
255
+ - `send_music(...)`
256
+ - `send_voice(...)`
257
+ - `send_gif(...)`
258
+ - `send_image(...)`
259
+
260
+ **پارامترهای اصلی:**
261
+ - `chat_id`: آیدی چت
262
+ - `path`: مسیر فایل یا URL (اختیاری)
263
+ - `file_id`: اگر فایل قبلاً آپلود شده باشد
264
+ - `text`: کپشن فایل
265
+ - `file_name`: نام فایل
266
+ - `inline_keypad`, `chat_keypad`, `reply_to_message_id`, `disable_notification`, `chat_keypad_type`
267
+
268
+ ---
269
+
270
+ ## 📍 سایر متدهای مهم
271
+
272
+ ### `get_me()`
273
+ دریافت اطلاعات ربات
274
+
275
+ ### `get_chat(chat_id)`
276
+ دریافت اطلاعات یک چت
277
+
278
+ ### `get_name(chat_id)`
279
+ دریافت نام مخاطب بر اساس `first_name` و `last_name`
280
+
281
+ ### `get_username(chat_id)`
282
+ دریافت نام کاربری چت (در صورت وجود)
283
+
284
+ ### `check_join(channel_guid, chat_id)`
285
+ بررسی عضویت کاربر در کانال خاص
286
+
287
+ ### `remove_keypad(chat_id)`
288
+ حذف کی‌پد معمولی چت
289
+
290
+ ### `edit_chat_keypad(chat_id, chat_keypad)`
291
+ ویرایش یا اضافه کردن کی‌پد چت
292
+
293
+ ### `edit_message_text(chat_id, message_id, text)`
294
+ ویرایش متن پیام ارسال‌شده
295
+
296
+ ### `edit_inline_keypad(chat_id, message_id, inline_keypad)`
297
+ ویرایش کی‌پد اینلاین پیام
298
+
299
+ ### `delete_message(chat_id, message_id)`
300
+ حذف پیام از چت
301
+
302
+ ### `send_poll(chat_id, question, options)`
303
+ ارسال نظرسنجی به چت
304
+
305
+ ### `send_location(chat_id, latitude, longitude, ...)`
306
+ ارسال موقعیت مکانی به چت
307
+
308
+ ### `send_contact(chat_id, first_name, last_name, phone_number)`
309
+ ارسال مخاطب به چت
310
+
311
+ ### `forward_message(from_chat_id, message_id, to_chat_id)`
312
+ فروارد کردن پیام از یک چت به چت دیگر
313
+
314
+ ### `set_commands(bot_commands)`
315
+ تنظیم دستورات رسمی ربات (برای `/help` و ...)
316
+
317
+ ### `update_bot_endpoint(url, type)`
318
+ تنظیم وب‌هوک یا polling برای دریافت پیام‌ها
319
+
320
+ ---
321
+
322
+ ## 📦 مدیریت فایل و آپلود
323
+
324
+ ### `get_upload_url(media_type)`
325
+ دریافت آدرس آپلود فایل برای انواع مختلف: File, Image, Voice, Music, Gif
326
+
327
+ ### `upload_media_file(upload_url, name, path)`
328
+ آپلود فایل از مسیر محلی یا URL به Rubika و دریافت `file_id`
329
+
330
+ ---
331
+
332
+ ## 🔄 دریافت بروزرسانی‌ها
333
+
334
+ ### `get_updates(offset_id=None, limit=None)`
335
+ دریافت بروزرسانی‌ها (برای polling)
336
+
337
+
338
+ ---
339
+
340
+ # 📦 Rubka `Message` Class & Media Reply API Documentation
341
+
342
+ ## 🧾 معرفی کلاس `Message`
343
+
344
+ کلاس `Message` در کتابخانه Rubka ابزاری کلیدی برای مدیریت پیام‌های دریافتی در ربات است. این کلاس، قابلیت‌هایی همچون پاسخ به پیام، ارسال مدیا، حذف یا ویرایش پیام، و استفاده از صفحه‌کلید و دکمه‌های اینلاین را فراهم می‌کند.
345
+
346
+ ---
347
+
348
+ ## ⚙️ مشخصات کلاس `Message`
349
+
350
+ ```python
351
+ Message(bot, chat_id, message_id, sender_id, text=None, raw_data=None)
352
+ ```
353
+
354
+ ### پارامترها:
355
+
356
+ | پارامتر | توضیح |
357
+ | ------------ | ---------------------------------------- |
358
+ | `bot` | نمونه‌ی شی ربات |
359
+ | `chat_id` | شناسه چت |
360
+ | `message_id` | آیدی پیام |
361
+ | `sender_id` | شناسه فرستنده |
362
+ | `text` | متن پیام |
363
+ | `raw_data` | داده‌ی خام پیام (دیکشنری دریافتی از API) |
364
+
365
+ ### ویژگی‌ها (Attributes):
366
+
367
+ - `reply_to_message_id` – اگر پیام در پاسخ ارسال شده باشد، آیدی پیام اولیه
368
+ - `file`, `sticker`, `poll`, `contact_message`, `location`, ... – داده‌های مربوطه اگر وجود داشته باشند
369
+
370
+ ---
371
+
372
+ ## 📩 متدهای پاسخ‌دهی
373
+
374
+ ### ✉️ `reply(text: str, **kwargs)`
375
+
376
+ پاسخ متنی به پیام با قابلیت ارسال دکمه و گزینه‌های اضافی.
377
+
378
+ ### 📊 `reply_poll(question, options, **kwargs)`
379
+
380
+ ارسال نظرسنجی در پاسخ به پیام.
381
+
382
+ ### 📎 `reply_document(...)`
383
+
384
+ ارسال فایل یا سند با متن اختیاری و دکمه.
385
+
386
+ ### 🖼 `reply_image(...)`
387
+
388
+ ارسال تصویر با قابلیت reply همراه دکمه‌های chat یا inline.
389
+
390
+ ### 🎵 `reply_music(...)`
391
+
392
+ ارسال موزیک در پاسخ.
393
+
394
+ ### 🎤 `reply_voice(...)`
395
+
396
+ ارسال پیام صوتی (voice).
397
+
398
+ ### 🎞 `reply_gif(...)`
399
+
400
+ ارسال گیف در پاسخ به پیام.
401
+
402
+ ### 🗺 `reply_location(latitude, longitude, **kwargs)`
403
+
404
+ ارسال لوکیشن در پاسخ.
405
+
406
+ ### 📇 `reply_contact(first_name, last_name, phone_number, **kwargs)`
407
+
408
+ ارسال مخاطب در پاسخ.
409
+
410
+ ---
411
+
412
+ ## 🔘 پاسخ با دکمه‌ها
413
+
414
+ ### `reply_keypad(text, keypad, **kwargs)`
415
+
416
+ ارسال پیام با صفحه‌کلید چتی (ChatKeypad).
417
+
418
+ ### `reply_inline(text, inline_keypad, **kwargs)`
419
+
420
+ ارسال پیام با دکمه‌های شیشه‌ای (Inline).
421
+
422
+ ---
423
+
424
+ ## 📦 پاسخ با فایل‌ها و استیکر
425
+
426
+ ### `reply_sticker(sticker_id, **kwargs)`
427
+
428
+ ارسال استیکر در پاسخ به پیام.
429
+
430
+ ### `reply_file(file_id, **kwargs)`
431
+
432
+ ارسال فایل بر اساس File ID.
433
+
434
+ ---
435
+
436
+ ## ✏️ ویرایش و حذف
437
+
438
+ ### `edit(new_text)`
439
+
440
+ ویرایش متن پیام.
441
+
442
+ ### `delete()`
443
+
444
+ حذف پیام فعلی.
445
+
446
+ ---
447
+
448
+ ## 📤 مثال کاربردی کامل
449
+
450
+ ```python
451
+ @bot.on_message()
452
+ def handler(bot: Robot, message: Message):
453
+ # پاسخ با تصویر و دکمه‌های مختلف
454
+ message.reply_image(
455
+ path="https://s6.uupload.ir/files/sample.png",
456
+ text="📷 تصویر پاسخ‌داده‌شده با دکمه‌ها",
457
+ inline_keypad=inline_keypad
458
+ )
459
+
460
+ message.reply_image(
461
+ path="https://s6.uupload.ir/files/sample.png",
462
+ text="📷 تصویر دوم با صفحه‌کلید",
463
+ chat_keypad=chat_keypad,
464
+ chat_keypad_type="New"
465
+ )
466
+
467
+ @bot.on_callback()
468
+ def callback_handler(bot: Robot, message: Message):
469
+ data = message.aux_data.button_id
470
+ if data == "btn_male":
471
+ message.reply("سلام آقا 👨")
472
+ elif data == "btn_female":
473
+ message.reply("سلام خانم 👩")
474
+ else:
475
+ message.reply(f"دکمه ناشناخته: {data}")
476
+ ```
477
+
478
+ ---
479
+
480
+ ## 🧠 نکته
481
+
482
+ تمامی متدهای `reply_*` به‌صورت خودکار پیام جدید را در پاسخ به پیام اصلی ارسال می‌کنند (`reply_to_message_id` به‌صورت داخلی تنظیم می‌شود).
483
+
484
+ ---
485
+
486
+ ---
487
+
488
+ ## 📤 مثال کاربردی کامل
489
+
490
+ ```python
491
+ from rubka import Robot
492
+ from rubka.keypad import ChatKeypadBuilder
493
+ from rubka.button import InlineBuilder
494
+ from rubka.context import Message
495
+
496
+ chat_keypad = ChatKeypadBuilder().row(
497
+ ChatKeypadBuilder().button(id="btn_female", text="زن"),
498
+ ChatKeypadBuilder().button(id="btn_male", text="مرد")
499
+ ).build()
500
+
501
+ inline_keypad = (
502
+ InlineBuilder()
503
+ .row(
504
+ InlineBuilder().button_simple("btn_bets", "button1"),
505
+ InlineBuilder().button_simple("btn_rps", "button2")
506
+ )
507
+ .row(
508
+ InlineBuilder().button_simple("btn_chatid", "butthon3")
509
+ )
510
+ .build()
511
+ )
512
+
513
+ bot = Robot("توکن شما")
514
+
515
+ @bot.on_message()
516
+ def handler(bot: Robot, message: Message):
517
+ message.reply_image(
518
+ path="https://s6.uupload.ir/files/chatgpt_image_jul_20,_2025,_10_22_47_pm_oiql.png",
519
+ text="📷 عکس ریپلای شده دکمه شیشه ای",
520
+ inline_keypad=inline_keypad
521
+ )
522
+
523
+ message.reply_image(
524
+ path="https://s6.uupload.ir/files/chatgpt_image_jul_20,_2025,_10_22_47_pm_oiql.png",
525
+ text="📷 عکس ریپلای شده دکمه کیبوردی",
526
+ chat_keypad=chat_keypad,
527
+ chat_keypad_type="New"
528
+ )
529
+
530
+ @bot.on_callback()
531
+ def callback_handler(bot: Robot, message: Message):
532
+ data = message.aux_data.button_id
533
+ if data == "btn_male":
534
+ message.reply("سلام مرد")
535
+ elif data == "btn_female":
536
+ message.reply("سلام زن")
537
+ else:
538
+ message.reply(f"دکمه ناشناخته: {data}")
539
+
540
+ bot.run()
541
+ ```
542
+
543
+ ---
544
+
545
+ ## 🧱 مستندات کلاس `InlineBuilder`
546
+
547
+ کلاس `InlineBuilder` برای ساخت دکمه‌های اینلاین استفاده می‌شود که در پیام‌های ربات قابل استفاده هستند.
548
+
549
+ ### ✅ روش استفاده
550
+
551
+ ```python
552
+ from rubka.button import InlineBuilder
553
+
554
+ builder = InlineBuilder()
555
+ inline_keypad = builder.row(
556
+ builder.button_simple("btn_1", "دکمه ۱"),
557
+ builder.button_simple("btn_2", "دکمه ۲")
558
+ ).build()
559
+ ```
560
+
561
+ ### 📚 دکمه‌های پشتیبانی‌شده
562
+
563
+ - `button_simple(id, text)` – دکمه ساده
564
+ - `button_payment(id, title, amount, description=None)` – پرداخت
565
+ - `button_calendar(id, title, type_, ...)` – انتخاب تاریخ
566
+ - `button_location(id, type_, image_url, ...)` – ارسال موقعیت مکانی
567
+ - `button_string_picker(...)` – انتخاب گزینه از لیست
568
+ - `button_number_picker(...)` – انتخاب عدد از بازه
569
+ - `button_textbox(...)` – فیلد ورود متنی
570
+ - `button_selection(...)` – انتخاب چندگزینه‌ای پیشرفته
571
+ - `button_camera_image(...)`, `button_camera_video(...)`
572
+ - `button_gallery_image(...)`, `button_gallery_video(...)`
573
+ - `button_file(...)`, `button_audio(...)`, `button_record_audio(...)`
574
+ - `button_my_phone_number(...)`, `button_my_location(...)`
575
+ - `button_ask_my_phone_number(...)`, `button_ask_location(...)`
576
+ - `button_barcode(...)`
577
+ - `button_link(id, title, url)` – لینک خارجی
578
+
579
+ ### 🧱 ساخت نهایی
580
+
581
+ ```python
582
+ keypad = builder.build()
583
+ ```
584
+
585
+ خروجی به صورت دیکشنری با کلید `rows` خواهد بود که می‌توانید در متد `send_message` یا `reply_*` استفاده کنید.
586
+
587
+ ---
588
+
589
+ ## ⌨️ مستندات کلاس `ChatKeypadBuilder`
590
+
591
+ کلاس `ChatKeypadBuilder` برای ساخت صفحه‌کلید چتی (chat keypad) استفاده می‌شود.
592
+
593
+ ### 🛠 روش استفاده
594
+
595
+ ```python
596
+ from rubka.keypad import ChatKeypadBuilder
597
+
598
+ keypad = ChatKeypadBuilder().row(
599
+ ChatKeypadBuilder().button("btn_1", "دکمه ۱"),
600
+ ChatKeypadBuilder().button("btn_2", "دکمه ۲")
601
+ ).build()
602
+ ```
603
+
604
+ ### 📋 متدها
605
+
606
+ - `button(id, text, type="Simple")` – ساخت یک دکمه ساده یا از نوع خاص
607
+ - `row(*buttons)` – افزودن یک ردیف به کیبورد (دکمه‌ها باید با `button()` ساخته شوند)
608
+ - `build(resize_keyboard=True, on_time_keyboard=False)` – ساخت خروجی نهایی برای ارسال به کاربر
609
+
610
+ ### 📦 خروجی `build()`
611
+
612
+ ```json
613
+ {
614
+ "rows": [
615
+ {"buttons": [
616
+ {"id": "btn_1", "type": "Simple", "button_text": "دکمه ۱"},
617
+ {"id": "btn_2", "type": "Simple", "button_text": "دکمه ۲"}
618
+ ]}
619
+ ],
620
+ "resize_keyboard": true,
621
+ "on_time_keyboard": false
622
+ }
623
+ ```
624
+
625
+ ---
626
+
627
+ # مستندات پروژه: تایمر پیام در ربات Rubika
628
+
629
+ این پروژه یک ربات بر پایه کتابخانه‌ی `rubka` است که به کاربر امکان می‌دهد با استفاده از کی‌پد، یک تایمر تنظیم کرده و پس از پایان تایمر، پیامی برای او ارسال شود. تمرکز اصلی این مستند، بر روی کلاس `Job` است که برای زمان‌بندی اجرای دستورات استفاده شده است.
630
+
631
+ ## ساختار کلی پروژه
632
+ - استفاده از کتابخانه `rubka` برای ارتباط با Rubika Bot API
633
+ - تعریف یک کی‌پد با گزینه‌های تاخیر زمانی مختلف (۱۰ الی ۱۵۰ ثانیه)
634
+ - استفاده از کلاس `Job` برای مدیریت اجرای زمان‌بندی‌شده یک تابع
635
+ - نمایش شمارش معکوس با به‌روزرسانی مداوم پیام
636
+
637
+ ---
638
+
639
+ ## کلاس `Job` چیست؟
640
+ کلاس `Job` در فایل `rubka.jobs` تعریف شده و هدف آن اجرای یک تابع خاص پس از گذشت یک بازه زمانی مشخص است.
641
+
642
+ ### نحوه استفاده:
643
+ ```python
644
+ from rubka.jobs import Job
645
+
646
+ job = Job(delay_in_seconds, callback_function)
647
+ ```
648
+
649
+ ### پارامترها:
650
+ | پارامتر | نوع | توضیح |
651
+ |--------|-----|-------|
652
+ | `delay_in_seconds` | `int` | مدت زمانی که باید قبل از اجرای تابع منتظر بماند |
653
+ | `callback_function` | `function` | تابعی که بعد از پایان زمان باید اجرا شود |
654
+
655
+ ### ویژگی‌ها:
656
+ - اجرای غیرهمزمان (با استفاده از Thread داخلی)
657
+ - مناسب برای سناریوهایی مانند تایمرها، یادآورها و اعلان‌های زمان‌بندی شده
658
+
659
+ ---
660
+
661
+ ## مثال از استفاده در پروژه:
662
+
663
+ ```python
664
+ def delayed_send():
665
+ if user_id not in active_jobs:
666
+ return
667
+ bot.send_message(
668
+ message.chat_id,
669
+ f"✅ کاربر {user_id} : زمان {seconds} ثانیه گذشت و دستور اجرا شد! ⏰"
670
+ )
671
+ active_jobs.pop(user_id, None)
672
+
673
+ job = Job(seconds, delayed_send)
674
+ active_jobs[user_id] = job
675
+ ```
676
+
677
+ در این مثال، پس از انتخاب تاخیر زمانی توسط کاربر، یک شی از کلاس `Job` ساخته می‌شود که تابع `delayed_send` را پس از `seconds` ثانیه اجرا می‌کند.
678
+
679
+ ---
680
+
681
+ ## تابع `countdown_edit`
682
+ این تابع تایمر فعال را به صورت زنده باقیمانده زمان را به‌روزرسانی می‌کند:
683
+ ```python
684
+ def countdown_edit(chat_id, message_id, duration_sec):
685
+ # اجرای یک Thread برای به‌روزرسانی پیام در هر ثانیه
686
+ ```
687
+
688
+ ---
689
+ ## نمونه کد ساخته شده
690
+ ```python
691
+ from rubka import Robot
692
+ from rubka.context import Message
693
+ from rubka.keypad import ChatKeypadBuilder
694
+ from rubka.jobs import Job
695
+ from datetime import datetime, timedelta
696
+ import threading
697
+ import time
698
+
699
+ bot = Robot("token")
700
+
701
+ active_jobs = {}
702
+
703
+ def build_delay_keypad():
704
+ delays = [10, 20, 30, 40, 50, 60, 75, 90, 120, 150]
705
+ builder = ChatKeypadBuilder()
706
+ buttons = []
707
+ for sec in delays:
708
+ buttons.append(builder.button(id=f"delay_{sec}", text=f"⏳ بعد از {sec} ثانیه"))
709
+ buttons.append(builder.button(id="cancel", text="❌ انصراف"))
710
+
711
+ rows = [buttons[i:i+3] for i in range(0, len(buttons), 3)]
712
+ keypad = ChatKeypadBuilder()
713
+ for row in rows:
714
+ keypad.row(*row)
715
+ return keypad.build()
716
+
717
+ def countdown_edit(chat_id: str, message_id: str, duration_sec: int):
718
+ start_time = datetime.now()
719
+ end_time = start_time + timedelta(seconds=duration_sec)
720
+
721
+ def run():
722
+ while True:
723
+ now = datetime.now()
724
+ if now >= end_time:
725
+ try:
726
+ bot.edit_message_text(chat_id, message_id, "⏰ زمان تمام شد!")
727
+ except Exception as e:
728
+ print("خطا در ویرایش پیام:", e)
729
+ break
730
+
731
+ remaining = end_time - now
732
+ text = (
733
+ f"⏳ تایمر فعال است...\n"
734
+ f"🕰 شروع: {start_time.strftime('%H:%M:%S')}\n"
735
+ f"⏲ پایان: {end_time.strftime('%H:%M:%S')}\n"
736
+ f"⌛ باقی‌مانده: {str(remaining).split('.')[0]}"
737
+ )
738
+ try:
739
+ bot.edit_message_text(chat_id, message_id, text)
740
+ except Exception as e:
741
+ print("خطا در ویرایش پیام:", e)
742
+ time.sleep(1)
743
+
744
+ threading.Thread(target=run, daemon=True).start()
745
+
746
+ @bot.on_message(commands=["start"])
747
+ def start_handler(bot: Robot, message: Message):
748
+ keypad = build_delay_keypad()
749
+ message.reply_keypad(
750
+ "سلام 👋\n"
751
+ "یک زمان برای ارسال پیام انتخاب کنید:\n"
752
+ "📅 تاریخ و ساعت فعلی: " + datetime.now().strftime("%Y/%m/%d %H:%M:%S"),
753
+ keypad
754
+ )
755
+
756
+ @bot.on_callback()
757
+ def callback_delay(bot: Robot, message: Message):
758
+ btn_id = message.aux_data.button_id
759
+ user_id = message.sender_id
760
+
761
+ if btn_id == "cancel":
762
+ if user_id in active_jobs:
763
+ active_jobs.pop(user_id)
764
+ message.reply("❌ همه ارسال‌های زمان‌بندی شده لغو شدند.")
765
+ else:
766
+ message.reply("⚠️ شما هیچ ارسال زمان‌بندی شده‌ای ندارید.")
767
+ return
768
+
769
+ if not btn_id.startswith("delay_"):
770
+ message.reply("❌ دکمه نامعتبر است!")
771
+ return
772
+
773
+ seconds = int(btn_id.split("_")[1])
774
+
775
+ if user_id in active_jobs:
776
+ active_jobs.pop(user_id)
777
+
778
+ sent_msg = bot.send_message(
779
+ message.chat_id,
780
+ f"⏳ تایمر {seconds} ثانیه‌ای شروع شد...\n🕰 زمان شروع: {datetime.now().strftime('%H:%M:%S')}"
781
+ )
782
+
783
+ countdown_edit(message.chat_id, sent_msg['data']['message_id'], seconds)
784
+ def delayed_send():
785
+ if user_id not in active_jobs:
786
+ return
787
+ bot.send_message(
788
+ message.chat_id,
789
+ f"✅ کاربر {user_id} : زمان {seconds} ثانیه گذشت و دستور اجرا شد! ⏰"
790
+ )
791
+ active_jobs.pop(user_id, None)
792
+
793
+ job = Job(seconds, delayed_send)
794
+ active_jobs[user_id] = job
795
+
796
+ message.reply(
797
+ f"⏳ ثبت شد! پیام شما پس از {seconds} ثانیه ارسال خواهد شد.\n"
798
+ f"🕰 زمان شروع ثبت شده: {datetime.now().strftime('%H:%M:%S')}"
799
+ )
800
+ bot.run()
801
+ ```
802
+
803
+ ##مثال ساده تر
804
+ ```python
805
+ from rubka import Robot
806
+ from rubka.context import Message
807
+ from rubka.jobs import Job
808
+ from datetime import datetime
809
+
810
+ bot = Robot("")
811
+
812
+ active_jobs = {}
813
+
814
+ @bot.on_message(commands=["timer"])
815
+ def timer_handler(bot: Robot, message: Message):
816
+ user_id = message.sender_id
817
+ chat_id = message.chat_id
818
+ parts = message.text.split()
819
+
820
+ if len(parts) != 2 or not parts[1].isdigit():
821
+ return message.reply("⚠️ لطفاً مدت زمان را به صورت صحیح وارد کنید. مثل: `/timer 30`", parse_mode="markdown")
822
+
823
+ seconds = int(parts[1])
824
+ if user_id in active_jobs:
825
+ active_jobs.pop(user_id)
826
+
827
+ message.reply(f"⏳ تایمر {seconds} ثانیه‌ای شروع شد!\n🕰 زمان شروع: {datetime.now().strftime('%H:%M:%S')}")
828
+
829
+ def after_delay():
830
+ if user_id not in active_jobs:
831
+ return
832
+ bot.send_message(chat_id, f"✅ تایمر {seconds} ثانیه‌ای تمام شد! ⏰")
833
+ active_jobs.pop(user_id, None)
834
+
835
+ job = Job(seconds, after_delay)
836
+ active_jobs[user_id] = job
837
+
838
+ bot.run()
839
+
840
+ ```
841
+
842
+ ##نمونه کد ادیت تایم و کرون جاب با اینلاین کیبورد
843
+
844
+ ```python
845
+ from rubka import Robot
846
+ from rubka.context import Message
847
+ from rubka.keypad import ChatKeypadBuilder
848
+ from rubka.jobs import Job
849
+ from datetime import datetime, timedelta
850
+ import threading
851
+ import time
852
+
853
+ bot = Robot("token")
854
+ bot.edit_inline_keypad
855
+ active_jobs = {}
856
+
857
+ def build_delay_keypad():
858
+ delays = [10, 20, 30, 40, 50, 60, 75, 90, 120, 150]
859
+ builder = ChatKeypadBuilder()
860
+ buttons = []
861
+ for sec in delays:
862
+ buttons.append(builder.button(id=f"delay_{sec}", text=f"⏳ بعد از {sec} ثانیه"))
863
+ buttons.append(builder.button(id="cancel", text="❌ انصراف"))
864
+
865
+ rows = [buttons[i:i+3] for i in range(0, len(buttons), 3)]
866
+ keypad = ChatKeypadBuilder()
867
+ for row in rows:
868
+ keypad.row(*row)
869
+ return keypad.build()
870
+
871
+ def countdown_edit(chat_id: str, message_id: str, duration_sec: int):
872
+ start_time = datetime.now()
873
+ end_time = start_time + timedelta(seconds=duration_sec)
874
+
875
+ def run():
876
+ while True:
877
+ now = datetime.now()
878
+ if now >= end_time:
879
+ try:
880
+ bot.edit_message_text(chat_id, message_id, "⏰ زمان تمام شد!")
881
+ except Exception as e:
882
+ print("خطا در ویرایش پیام:", e)
883
+ break
884
+
885
+ remaining = end_time - now
886
+ text = (
887
+ f"⏳ تایمر فعال است...\n"
888
+ f"🕰 شروع: {start_time.strftime('%H:%M:%S')}\n"
889
+ f"⏲ پایان: {end_time.strftime('%H:%M:%S')}\n"
890
+ f"⌛ باقی‌مانده: {str(remaining).split('.')[0]}"
891
+ )
892
+ try:
893
+ bot.edit_message_text(chat_id, message_id, text)
894
+ except Exception as e:
895
+ print("خطا در ویرایش پیام:", e)
896
+ time.sleep(1)
897
+
898
+ threading.Thread(target=run, daemon=True).start()
899
+
900
+ @bot.on_message(commands=["start"])
901
+ def start_handler(bot: Robot, message: Message):
902
+ keypad = build_delay_keypad()
903
+ message.reply_keypad(
904
+ "سلام 👋\n"
905
+ "یک زمان برای ارسال پیام انتخاب کنید:\n"
906
+ "📅 تاریخ و ساعت فعلی: " + datetime.now().strftime("%Y/%m/%d %H:%M:%S"),
907
+ keypad
908
+ )
909
+
910
+ @bot.on_callback()
911
+ def callback_delay(bot: Robot, message: Message):
912
+ btn_id = message.aux_data.button_id
913
+ user_id = message.sender_id
914
+
915
+ if btn_id == "cancel":
916
+ if user_id in active_jobs:
917
+ active_jobs.pop(user_id)
918
+ message.reply("❌ همه ارسال‌های زمان‌بندی شده لغو شدند.")
919
+ else:
920
+ message.reply("⚠️ شما هیچ ارسال زمان‌بندی شده‌ای ندارید.")
921
+ return
922
+ if not btn_id.startswith("delay_"):
923
+ message.reply("❌ دکمه نامعتبر است!")
924
+ return
925
+ seconds = int(btn_id.split("_")[1])
926
+ if user_id in active_jobs:
927
+ active_jobs.pop(user_id)
928
+ sent_msg = bot.edit_inline_keypad(
929
+ message.chat_id,
930
+ f"⏳ تایمر {seconds} ثانیه‌ای شروع شد...\n🕰 زمان شروع: {datetime.now().strftime('%H:%M:%S')}"
931
+ )
932
+ print(sent_msg)
933
+ countdown_edit(message.chat_id, sent_msg['data']['message_id'], seconds)
934
+ def delayed_send():
935
+ if user_id not in active_jobs:
936
+ return
937
+
938
+ bot.send_message(
939
+ message.chat_id,
940
+ f"✅ کاربر {user_id} : زمان {seconds} ثانیه گذشت و دستور اجرا شد! ⏰"
941
+ )
942
+ active_jobs.pop(user_id, None)
943
+
944
+ job = Job(seconds, delayed_send)
945
+ active_jobs[user_id] = job
946
+
947
+ message.reply(
948
+ f"⏳ ثبت شد! پیام شما پس از {seconds} ثانیه ارسال خواهد شد.\n"
949
+ f"🕰 زمان شروع ثبت شده: {datetime.now().strftime('%H:%M:%S')}"
950
+ )
951
+
952
+ bot.run()
953
+ ```
954
+ # ✅ Force Join (اجبار به عضویت در کانال) — Rubka Bot
955
+
956
+ این مستند نحوه استفاده از قابلیت **اجبار به عضویت در یک کانال (Force Join)** در ربات‌های ساخته‌شده با کتابخانه Rubka را توضیح می‌دهد.
957
+
958
+ ---
959
+
960
+ ## 🎯 هدف
961
+
962
+ اطمینان از اینکه کاربر عضو یک کانال خاص است، قبل از ادامه تعامل با ربات. اگر عضو نبود، به او اطلاع داده شود یا لینک عضویت ارسال گردد.
963
+
964
+ ---
965
+
966
+ ## 📦 پیش‌نیازها
967
+
968
+ - نصب و راه‌اندازی کتابخانه `rubka`
969
+ - توکن معتبر ربات Rubika
970
+ - دسترسی به `channel_guid` (شناسه عددی کانال)
971
+ - ربات باید در کانال، **ادمین** باشد
972
+
973
+ ---
974
+
975
+ ## 💡 نحوه استفاده
976
+
977
+ ### کد بهینه‌شده:
978
+
979
+ ```python
980
+ from rubka import Robot
981
+ from rubka.context import Message
982
+
983
+ bot = Robot(token="your_token")
984
+ CHANNEL_GUID = "c0xABCDEF..." # GUID کانال هدف
985
+
986
+ @bot.on_message()
987
+ def handle_force_join(bot: Robot, message: Message):
988
+ name = bot.get_name(message.chat_id)
989
+
990
+ if bot.check_join(CHANNEL_GUID, message.chat_id):
991
+ message.reply(f"سلام {name} 👋\nشما عضو کانال هستید ✅")
992
+ else:
993
+ join_link = "https://rubika.ir/rubka_library"
994
+ message.reply(
995
+ f"سلام {name} 👋\nشما عضو کانال نیستید ❌\n\n"
996
+ f"لطفاً ابتدا عضو کانال شوید سپس دوباره تلاش کنید:\n{join_link}"
997
+ )
998
+
999
+ bot.run()
1000
+ ```
1001
+
1002
+ ---
1003
+
1004
+ ## 🔍 شرح متدها
1005
+
1006
+ | متد | کاربرد |
1007
+ | ------------------------------------- | ------------------------------------ |
1008
+ | `check_join(channel_guid, user_guid)` | بررسی عضویت کاربر در کانال مشخص‌شده |
1009
+ | `get_name(user_guid)` | دریافت نام نمایشی کاربر از طریق GUID |
1010
+ | `message.reply(text)` | پاسخ مستقیم به پیام دریافت‌شده |
1011
+
1012
+ ---
1013
+
1014
+ ## 🔐 نکات مهم امنیتی
1015
+
1016
+ - ربات باید حتماً **ادمین کانال** باشد.
1017
+ - در صورت عدم عضویت، بهتر است لینک دعوت به کانال نمایش داده شود.
1018
+
1019
+ ##Mahdi Ahmadi