[Slackify] – удобный уведомлятор в Slack для MODX

Привет, друзья.



На прошлой неделе меня однажды утром осенила мысль «а что, если» и не отпускала, пока не доделал все, что хотел. А сделал вот что: написал компонент, который добавляет набор классов, используя которые можно удобно настроить уведомления с сайта на MODX в чат Slack. Особенная фишка пакета — это уже готовые плагины для 404 ошибок, Tickets и miniShop2. Но, по порядку.

В основном репозитории – modx.com/extras/package/slackify
В репозитории modstore.pro – modstore.pro/packages/alerts-mailing/slackify



Кому не терпится, то документация на английском доступна на GitHub – github.com/Alroniks/modx-slackify. Там же и исходники и последний пакет во вкладке Релизы.

ВАЖНО! Данный плагин не работает на php ниже версии 5.4. Он даже не установится. Делать версию для 5.3 или ниже не буду, даже не просите. Обновляйте свои дырявые ведра до нормальных версий.

API у Slack довольно простое и по сути, чтобы отправить сообщение в него, нужно на заданный URL (incoming-hook) отправить POST-запрос с переменной payload, в которой в JSON формате передать сообщение и возможные параметры. По сути, все так и происходит, но для удобства и наглядности я создал несколько классов, которые отвечают за определенные куски сообщения.

Подробно расписывать по каждому не буду, так как все есть в readme на GitHub (мой английский прост, разберетесь что к чему). Расскажу лишь о базовых вещах.

Перед созданием и отправкой сообщения нужно обязательно подключить сервис Slackify. Делается это так:

$slackify = $modx->getService('slackify');

Можно так же переопределить от кого и куда слать сообщение.

$message->from('Дядя Ваня')->to('@alroniks');

Для того, чтобы отправить сообщение, достаточно создать объект сообщения и отправить его. Довольно просто.

$message = new Message('I am Message');
$slackify->send($message);

Кроме простых текстовых сообщений Slack умеет еще так называемые «вложения» (attachment). Это что-то вроде блоков внутри сообщения. Для работы с ними создан класс Attachment, методы которого могут добавлять в него дополнительную информацию.

Например, создадим плагин, который будет писать в чат о том, что на сайте добавили новый комментарий в Tickets (полный код плагина есть в пакете, некоторые детали я опустил).

$a = new Attachment();
$a->setPretext('Кто-то оставил комментарий в важной теме на сайте');

$a->setColor(new Color('#00FF00')); // green
$a->setAuthor(new Author($comment->get('name'), 'mailto:' . $comment->get('email')));

$a->setTitle(new Title("оставил комментарий к тикету '{$ticket->get('pagetitle')}'"));
$a->setText($comment->get('text'));

$a->addField(new Field('Дата', $comment->get('createdon'), true));
$a->addField(new Field('Опубликован', $comment->get('published') ? 'True' : 'False', true));
$a->addField(new Field('Тикет', new Link($modx->makeUrl($ticket->get('id'), 'web', '', 'full'), $ticket->get('pagetitle'))));

$message = new Message('*Новый комментарий*');
$message->attach($a);

$slackify->send($message);

Все довольно просто. Классы, отвечающие за отдельные поля следуют паттерну value-object. Так же используется type hinting в методах, что гарантирует целостность данных.

Данный компонент уже содержит несколько готовых к употреблению плагинов, но в первую очередь он нужен для того, чтобы на базе него делать свои уведомления, заточенные под конкретные нужны. Примеры всех плагинов можно посмотреть тут – github.com/Alroniks/modx-slackify/tree/master/core/components/slackify/elements/plugins.

Установка и настройка

Для того, чтобы отправлять сообщения в чаты или конкретным участникам, нужно создать incoming-webhook в Slack. Как это делается можно почитать тут – api.slack.com/incoming-webhooks. Хук можно настроить прямо в Slack, но API при этом позволяет переопределить заданные по умолчанию параметры.

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

Как это выглядит в Slack

Уведомление о 404 ошибке


Уведомление о новом тикете


Уведомление о новом комментарии


Уведомление о новом заказе


Уведомление об изменении статуса заказа. Цвета берутся из статусов в настройках MS2.


Пакет пока проходит все нужные процедуры в репозиториях, но собранный архив можно скачать на странице релизов на GitHub – github.com/Alroniks/modx-slackify/releases.

Либо можно собрать пакет самому. Для этого не нужно даже иметь установленный MODX. Да-да, я решил эту проблемку, расскажу в отдельной заметке. Делаем как указано ниже и забираем готовый zip в папке _packages.

git clone --recursive git@github.com:Alroniks/modx-slackify.git
cd modx-slackify/_build && php build.transport.php

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

$link = new Link(rtrim(MODX_SITE_URL, '/') . MODX_MANAGER_URL . "index.php?a={$action->get('id')}#&order={$order->get('id')}", $order->get('num'));