module BotMob
# BotMob
BotMob
base module namespace
Constants
- VERSION
Public Class Methods
env()
click to toggle source
## `env`
The specified environment for your bot's runtime
# File lib/bot_mob.rb, line 55 def self.env @environment ||= BotMob::Environment.new(ENV['MOB_ENV']) end
logger()
click to toggle source
## `logger`
Provide a logger for the BotMob
gem, silences test env output by default
# File lib/bot_mob.rb, line 62 def self.logger @logger ||= begin buffer = BotMob::Logger.new(ENV['MOB_ENV'] == 'test' ? '/dev/null' : STDOUT) if buffer buffer.level = ($PROGRAM_NAME == 'irb' ? Logger::DEBUG : Logger::INFO) buffer.formatter = proc { |_s, _d, _p, msg| "#{msg}\n" } end buffer end end
root()
click to toggle source
## `root`
Provide the base root path of the gem directory
# File lib/bot_mob.rb, line 48 def self.root File.expand_path('../..', __FILE__) end
start!() { |roster| ... }
click to toggle source
## `start!`
Start the bot mob server
Usage:
BotMob.start! do |app| app.register MyBot end
# File lib/bot_mob.rb, line 39 def self.start! roster = BotMob::Roster.new yield(roster) BotMob::Server.run! roster: roster end