Rocket-Ruby-Bot

Features

A very crude and ill documented RocketChat ruby bot framework.

Disclaimer

I code for fun, I'm not and will never be a good developer.

A simple bot

Gemfile

source 'https://rubygems.org'

gem 'rocket-ruby-bot', :git => 'https://github.com/nbc/rocket-ruby-bot.git'

pongbot.rb

# coding: utf-8
$:.unshift File.expand_path('../lib', __dir__)

require 'rocket-ruby-bot'

RocketRubyBot.configure do |config|
  config.url    = 'http://localhost:3000'
  config.user   = 'mybot'
end

RocketRubyBot::UserStore.configure do |user_store|
  user_store.room_name = 'general'
end

class PongBot < RocketRubyBot::Bot
  # subscribe to new messages in the general room
  setup do |client|
    ret = client.get_room_id(room: user_store.room_name)
    client.stream_room_messages(room_id: ret.room_id)
  end

  # reply pong to "mybot ping"
  command 'ping' do |client, message, _match|
    client.send_message(room_id: message.rid, msg: "pong")
  end

  # reply pong to "! ping"
  match(/!\s*ping/) do |client, message, _match|
    client.send_message(room_id: message.rid, msg: "pong")
  end
end

PongBot.run

To run it, just do :

ROCKET_API_TOKEN=<my_token> ruby examples/pong.rb

To get your token you can use curl :

curl -H "Content-type:application/json" \
      https://rocket-chat-url/api/v1/login \
      -d '{ "username": "<username>", "password": "<password>" }'

More examples [here](examples)

Bot interaction

setup

setup is called just after authentication. You can use it to initialize your bot (subscribing to stream...).

command

command allow you to wait for commands on channel/room on :room_message events.

command 'ping' do |client, message, match|
  client.send_message(room_id: message.rid, msg: "pong")
end

match has 3 named captures :

• bot : bot name
• command : command name
• text : text after the command name

match

match allow lower level interaction on :room_message message type of events.

match /!duck\s+(?<text>\S.*)/ do |client, message, match|
  # some code to search on duckduckgo
end

on_event

The lowest level command is on_event :event_type. With it you can access all types of events.

on_event :authenticated do |client, data|
	# ...
end

client is used to speak with the server data is the data return by the event.

You can find the list of events here

For your information, command and match are based on :room_message event and setup is just syntactic sugar around on_event :authenticated.

RocketChat API

All the methods of the realtime API are available. The beginning of a documentation here. For more information, read the code for the moment.

client.stream_notify_user user_id: "user_id", sub: "message"

config

In your bot, you can access configuration with the config command. It has three useful methods:

• config.url : RocketChat server URL
• config.user : the name of your bot
• config.user_id : the user_id of your bot

client.stream_notify_user user_id: config.user_id, sub: "message"

other useful methods

You have access to two useful methods in your bot:

web_client

a fully fonctionnal RocketChat::Session already logged to do REST interaction. See https://github.com/abrom/rocketchat-ruby for documentation

user_store

useful to store things. It's a hash and Hashie::Mash subclass so you can use keys as methods to access value.

user_store.my_value
user_store['my_value']

Inspiration

Thanks to the following projects, I've been able to understand a little bit better the Rocket.Chat realtime API https://bitbucket.org/EionRobb/purple-rocketchat https://github.com/mathieui/unha2/blob/master/docs/methods.rst

Thanks to slack-ruby-bot, I've been able to produce a little less awful code https://github.com/slack-ruby/slack-ruby-bot/