Развлечения с роботами, Литой и HipChat

Лита-reminder.rb

 module Lita module Handlers class Reminder < Handler end end Lita.register_handler(Reminder) end 

Обработчик теперь будет зарегистрирован при загрузке робота. Настало время конкретизировать это. Давайте реализуем три действия:

• добавить todo
• уничтожить (отметить как выполненное) todo
• список задач

Маршрут чата потребуется, чтобы сообщить нашему роботу, когда выполнять какое действие. По сути, маршрут чата является регулярным выражением. Если Лита находит совпадение в одном из сообщений, она выполняет соответствующую операцию. Давайте создадим один:

Лита-reminder.rb

 [...] class Reminder < Handler route(/^remind plz$/, :index, command: true, help: { "remind plz" => "Remind about your todos." }) end [...] 

Когда Лита видит сообщение, которое начинается с «remind plz», она вызывает метод index , который будет создан в ближайшее время. Команда command: true здесь означает, что этот маршрут будет запускаться только в том случае, если в сообщении упоминается бот (сообщение является личным или имеет префикс с именем бота). help содержит пример вызова маршрута и того, что он делает. В нашем случае введите

 @lita help remind plz 

чтобы увидеть это сообщение помощи. Обратите внимание, что ответ с помощью всегда будет отправляться как личное сообщение — не уверен, является ли это ошибкой или ожидаемым поведением.

Теперь мы можем реализовать метод index и некоторые служебные методы:

Лита-reminder.rb

 [...] def index(response) todos = parse get("http://127.0.0.1:3000/todos.json") if todos.any? response.reply("Your todos:") todos.each do |todo| response.reply("# #{todo['id']}: #{todo['title']}") end else response.reply('You have done all the todos! Good job!') end end private def get(url) Net::HTTP.get make_uri(url) end def parse(obj) MultiJson.load(obj) end def make_uri(url) URI(url) end [...] 

Эти служебные методы просты: get используется для отправки запроса GET на предоставленный URI, анализирует JSON-ответ ( MultiJson подключен в ядре Lita), а make_uri создает URI из предоставленного URL-адреса.

Какой параметр response передается в метод index ? Это экземпляр класса Lita::Response и является основным интерфейсом для проверки деталей сообщения и ответа на него. У него есть пара полезных методов. Здесь мы используем только один — reply , который отвечает обратно предоставленной строкой.

По сути, метод index отправляет запрос GET по http://127.0.0.1:3000/todos.json , анализирует ответ и либо отображает список задач в формате ID - title , либо сообщает, что задачи не найдены.

Что если в будущем наше приложение todos будет перенесено на рабочий сервер? Нам нужно изменить ссылку на него везде, где он используется. Не могли бы мы просто создать какую-то настройку, чтобы пользователь мог предоставить там ссылку на приложение todo? Похоже, мы можем!

Лита-reminder.rb

 [...] config :server [...] def index(response) todos = parse get("#{config.server}/todos.json") [...] end [...] 

Здесь config :server означает, что server является опцией, доступной для пользователей. Затем к нему можно получить доступ с помощью config.server (кстати, все переменные конфигурации заморожены во время выполнения). Укажите этот новый параметр:

lita_config.rb

 [...] Lita.configure do |config| [...] config.handlers.reminder.server = 'http://127.0.0.1:3000' end 

Ницца! Теперь добавьте маршрут для добавления новой задачи:

Лита-reminder.rb

 [...] module Lita module Handlers class Reminder < Handler route(/^todo\s+(.+)$/, :create, command: true, help: { "todo TODO" => "Adds new todo to the list." }) def create(response) todo = response.match_data[1] result = post "#{config.server}/todos.json", 'todo[title]' => todo if result.code.to_i.success? response.reply("#{todo} was added.") else response.reply("I've encountered the following errors while saving your todo: #{parse(result.body)}") end end private def post(url, data = {}) Net::HTTP.post_form(make_uri(url), data) end end Lita.register_handler(Reminder) end end class Numeric def success? self > 199 && self < 300 end end 

В маршруте я использую группу захвата, чтобы получить имя новой задачи. Метод create использует response.match_data[1] для извлечения этой группы захвата из данных о совпадении ( match_data — еще один метод, доступный из response ). Остальная часть кода довольно проста: мы выдаем POST-запрос, предоставляющий заголовок задачи.

Наконец, маршрут уничтожения:

Лита-reminder.rb

 [...] route(/^done todo\s+(\d+)$/, :destroy, command: true, help: { "done todo TODO_ID" => "Marks todo with the specified number as done." }) [...] def destroy(response) todo_id = response.match_data[1] result = delete "#{config.server}/todos/#{todo_id}.json" if result.code.to_i.success? response.reply("Todo # #{todo_id} was marked as done.") else response.reply("I've encountered an error while marking your todo as done.") end end private def delete(url) uri = make_uri(url) http = Net::HTTP.new(uri.host, uri.port) request = Net::HTTP::Delete.new(uri.path) http.request(request) end [...] 

Должен быть указан идентификатор уничтожаемой задачи. Позже, todo выбирается с использованием конструкции match_data[1] . Затем отправляется запрос DELETE.

Кстати, если вы не хотите, чтобы ваши задачи были полностью уничтожены, тогда может быть реализовано действие Act_as_paranoid или подобное решение.

Загрузите своего робота и попробуйте управлять своими задачами. Не было бы здорово, если бы Лита тоже приготовила для тебя ужин?

Вывод

В этой статье мы познакомились с Lita, расширяемым компаньоном-роботом. Мы интегрировали его с HitChat, добавили несколько плагинов и даже написали собственный дескриптор для взаимодействия с API-интерфейсом приложения todo. Не стесняйтесь экспериментировать с этим кодом или создавать что-то более сложное (не забудьте поделиться ссылкой в ​​комментариях!). Также, пожалуйста, поделитесь своим опытом, если вы когда-либо использовали Lita в производстве для выполнения каких-то реальных задач — это было бы интересно!