Project

qbot

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Tiny chatbot flamework.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 1.16

Runtime

~> 2.5
~> 0.14
~> 0.1
~> 10.0
~> 4.1
 Project Readme

Qbot

Qbot is a tiny bot flamework written in Ruby.
Qbot comes with the Slack adapter and the Mattermost adapter.

Installation

Add this line to your application's Gemfile:

gem 'qbot'

And then execute:

$ bundle

Or install it yourself as:

$ gem install qbot

Usage

Write your bot in bot.rb.

require 'qbot'
require 'qbot/adapter/slack'

on /^ping/ do
  post 'pong'
end

on /^echo (.+)$/ do |msg|
  post msg[1]
end

cron '*/5 * * * *' do
  post 'hello?', channel_name: 'random'
end

Then put your Slack API Token in .env.

QBOT_SLACK_API_TOKEN=xoxb-############-########################

And now start your bot with the following command.

ruby bot.rb

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/haccht/qbot. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Qbot project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.