codex-team / codex.bot

Working team assistant

@codex_bot

Platform for integration of services into messengers. It's simple. Applications written with our SDK will be available in all supported messengers.

Messengers

Currently we support these messengers. We will add several ones soon.

• Telegram
• Slack

How to use

Add @codex_bot in your chat and type /apps to view the list of available applications.

How to create own application

Our Python SDK and Guide for creation an app will help you.

Available applications

Everyone can write own application with our SDK. That's what we've got now.

GitHub

https://github.com/codex-bot/github

Useful integration with github.com. Provides notifications about

• Opened/closed issues
• Assigned issues
• Opened/closed pull requests
• Code reviews
• Branch updates
• Commits

Usage

Type /github_start and follow instructions to add a new repository.

Yandex.Metrica

https://github.com/codex-bot/metrika

Get regular or instant reports with analytics data from Yandex.

Usage

• /metrika — shows application menu
• /metrika_add — add new counter
• /metrika_subscriptions — setting up a regular daily reports
• /metrika_stop — disable counter
• /metrika_counters — list of added counters
• /metrika_access — remove user from the chat

Webhooks

https://github.com/codex-bot/Webhooks

Easy-to-setup notifications scheme. You will get a special link that allows to send messages via simple POST requests.

Usage

• /notify_start — get webhook URL for sending messages to the chat
• Send POST request for the given URL with message field

Example:

curl -X POST https://notify.bot.codex.so/u/ABCD1234 -d "message=Hello world"

RSS Parser

https://github.com/codex-bot/rssparser

Subscribe to your favorite feeds and get notifications with updates.

Usage

• /rssparser — help message with a list of commands
• /rssparser_list — show a list of your subscriptions
• /rssparser_add <URL> — subscribe to the feed
• /rssparser_get — check your feed for updates
• /rssparser_remove <URL> — unsubscribe from the feed

Weather

https://github.com/codex-bot/weather

Allows you to be informed about weather conditions in your region via Telegram chat.

Usage

• /city <CITY_ID> — setting up your location
• /cities — view cities list
• /weather — get current weather conditions

Issues and improvements

• Ask a question or report a bug on the create issue page.
• Know how to improve the platform? Fork it and send a pull request.

About CodeX

We are a small team of passionate web-developers represented by students and graduates of ITMO University located in St. Petersburg, Russia. Fell free to give us a feedback on [email protected]

codex.bot's Issues

License

Hi!

Nice work!

But, what is your license for this project?

CodeX Team в стартовом сообщении

Убрать точку после токена, чтобы было удобно его копировать

Приложение успешно подключено. Токен — 7E642LI4.

Разобраться с логированием

Хотелось бы, чтобы в дебаге была чистота и порядок.

Разработка основы приложения GitHub

Добавить обработку миграций чата

ex: group to supergroup

pika does not support connection recovery

Provide smth like this
pika/pika#858

while True:
    connection = pika.BlockingConnection(parameters)

    channel = connection.channel()
    channel.basic_consume(on_message, 'queue')

    try:
        channel.start_consuming()
    except pika.exceptions.ConnectionClosed:
        LOGGER.info('Connection closed. Recovering')
        continue
    except KeyboardInterrupt:
        channel.stop_consuming()

    connection.close()
    break```

Append this code and create issue for SDK

Change submodule url from git to https

Тесты ядра (unittest)

Modify Dockerfile to copy all sources into image

Core-app communication bugs

• unhardcode RabbitMQ host. Get it from config
• fix bug with mongo document name (chat_hash). It must be a string
• fix bug with Service send method.

Портировать ядерный модуль Telegram

Логирование и перехват ошибок

Нужно реализовать логирование всех ключевых моментов.
Весь код обернуть в try/except и логировать попадания.
Логирование необходимо не просто выводить на экран, а сохранять в файл или БД.

Класс Settings

Разработка класса Settings, обеспечение передачи его инстанса во все модули, инициализация настроек callback c использованием этого модуля

Класс базы данных для Core

Класс должен обеспечивать подключение к базе данных и получение информации.
Можно положить это в lib/db/db.py с соответствующим конфигом. Предлагается использовать Mongo.
Заложить в лине основу для формирования дампов сообщений и логов.

First push to the branch is not triggered

This is due to GitHub method for new branch creation.

Supervisor для скринов приложений и ядра

После перезагрузки сервера, приложения и ядро должны автоматически запускаться в соответствующих скринах.

Добавить функцию-callback, ожидающую сообщения из чата

Реализовать прототип callback на языке Python.
Завязана на issue #3

Класс уникального пользователя системы

Класс пользователя системы.
Включает в себя указатели на профили пользователя во всех сервисах, осуществляет логирование и обновление/хранение состояний пользователя, его чатов и т.п.

Написать README к проекту

Добавить поддержку функций send_text, send_image, send_keyboard

Научиться отправлять в чат текст, изображения и клавиатуру.

Разобраться с layout клавиатуры для Slack (можно ли там в 2-3 колонки всё отображать).

Change submodules access rights for python sdk and modules

If you clone the sdk repo, you cannot init submodules due to the lack of access rights.

probably should change

[submodule "github/sdk"]
	path = github/sdk
	url = [email protected]:codex-bot/sdk-python.git

to

[submodule "github/sdk"]
	path = github/sdk
	url = https://github.com/codex-bot/sdk-python.git

But it needs additional research if there is another way to resolve the issue.

Автоматизация деплоя

• Написать скрипт автоматического обновления ядра, приложений, связанных с каждым приложением SDK из master веток.
• Написать скрипт, который будет разворачивать в screen соответствующие приложения и ядро.
• Написать скрипт, который будет сворачивать запущенные приложения, ядро.
• Написать скрипт бэкапов БД и конфигов

Add difference between merged and closed PR

Методы связанные с парсингом сообщения от Telegram

Извлекает основную информацию, обновляет профиль пользователя (через класс пользователя), сохраняет данные (через класс DB). Формирует на выходе JSON готовый к передаче в API класс.

test

Research какой из вариантов оповещений callback нам подходит наиболее

У Slack есть несколько вариантов получения сообщений из чата. Нужно осмыслить документацию и привести команде доводы какой из них нам наиболее подходит и какие варианты имеются.

Разработать class для Slack API

Продумать структуру класса, написать все необходимые конструкторы для него. Разобраться с получением API ключей и написать функцию авторизации приложения.

Если API Token получается как-то хитро, написать функцию, которая автоматизирует его получение.

Channel post. AttributeError: 'NoneType' object has no attribute 'username'

When sending message in channel, there are only update_id and channel_post params. No user.

web_protocol.py     :393         log_exception() 	 Error handling request 
Traceback (most recent call last):
  File "/usr/local/lib/python3.9/site-packages/aiohttp/web_protocol.py", line 422, in _handle_request
    resp = await self._request_handler(request)
  File "/usr/local/lib/python3.9/site-packages/aiohttp/web_app.py", line 499, in _handle
    resp = await handler(request)
  File "/home/app/codexbot/lib/server.py", line 16, in wrapper
    result = await function(self, {
  File "/home/app/codexbot/services/telegram/telegram.py", line 55, in telegram_callback
    await self.send_message_to_app(update)
  File "/home/app/codexbot/services/telegram/telegram.py", line 65, in send_message_to_app
    if update.message.user.username:
AttributeError: 'NoneType' object has no attribute 'username'

Implement features from RMQ production checklist

Verify https://www.rabbitmq.com/production-checklist.html

Especially, check disk and memory limits

Заложить SDK для разработчиков плагинов

Разработать прототип модуля ядра Facebook

Рассмотреть возможность подключения мессенджера фейсбука для нашего ядра. Если это возможно – реализовать прототип на основе существующих модулей с поддержкой set_webhook, callback и send_message

Исправление работы под нагрузкой

Fix Slack according to new async/await broker format

Probably just made send function async.

Рефакторинг класса MetrikaAPI

Взять модуль метрики из бота v3 (https://github.com/codex-team/codex.bot.v3).

Провести рефакторинг и получить на выходе один класс (MetrikaAPI), который умеет работать с новым API метрики.

Написать гайд по запуску и созданию простого приложения

Взаимодействие сервис-приложение

Выстроить коммуникацию мессенджеров с приложениями (через брокер) по предложенной схеме:

Process the exception of the bot being blocked

base.py             :66              decorator() 	 Error while sending Telegram message: b'{"ok":false,"error_code":403,"description":"Forbidden: bot was blocked by the user"}' 
broker.py           :46               callback() 	 Broker callback error 
broker.py           :47               callback() 	 'bool' object is not subscriptable 

Прототипирование схемы