protonbot 0.1.0

data/lib/protonbot/core_plugin/hooks/nick.rb

@@ -0,0 +1,10 @@
+hook(type: :unick) do |dat|
+  u = dat[:plug].users[dat[:nick]].clone
+  dat[:plug].users.delete(dat[:nick])
+  dat[:plug].users[dat[:to]] = u
+  u[:nick] = dat[:to]
+  u[:user] = dat[:user]
+  u[:host] = dat[:host]
+
+  dat[:plug].nick = dat[:to] if dat[:nick] == dat[:plug].nick
+end

data/lib/protonbot/core_plugin/hooks/ping.rb

@@ -0,0 +1,3 @@
+hook(type: :ping) do |dat|
+  dat[:plug].write_("PONG :#{dat[:server]}")
+end

data/lib/protonbot/core_plugin/hooks/privmsg.rb

@@ -0,0 +1,62 @@
+fun :privmsg_patch do |h|
+  h.define_singleton_method :reply do |msg|
+    self[:plug].privmsg(self[:reply_to], msg) if self[:nick]
+  end
+  h.define_singleton_method :nreply do |msg|
+    self[:plug].notice(self[:nick], msg) if self[:nick]
+  end
+  h
+end
+
+hook(type: :privmsg) do |dat|
+  # User-data collector
+  dat[:plug].users[dat[:nick]] = {} unless dat[:plug].users[dat[:nick]]
+  u = dat[:plug].users[dat[:nick]]
+  u[:nick] = dat[:nick]
+  u[:user] = dat[:user]
+  u[:host] = dat[:host]
+  dat[:perms] = process_perms(getperms!(dat[:plug], dat[:host]))
+
+  # CTCP
+  if dat[:message][0] == "\x01" && dat[:message][-1] == "\x01"
+    dat[:type] = :ctcp
+    dat[:message] = dat[:message][1..(dat[:message].length - 2)]
+    s = dat[:message].split(' ')
+    dat[:cmd] = s[0]
+    (dat[:split] = s[1, s.length - 1]) || []
+    emit(privmsg_patch(dat))
+  end
+
+  # Command-checker
+  cl = dat[:plug].conf['cmdchar'].length
+  if dat[:message][0..(cl - 1)] == dat[:plug].conf['cmdchar']
+    cmd, *split = dat[:message][cl..-1].split(' ')
+    h = dat.merge(type: :command, cmd: cmd, split: split)
+    privmsg_patch(h)
+    begin
+      emit(h)
+    rescue => e
+      h.nreply("Err: #{e.message} | #{e.backtrace[0]}")
+      dat[:plug].log_err(e)
+    end
+  end
+end
+
+hook(type: :notice) do |dat|
+  # User-data collector
+  dat[:plug].users[dat[:nick]] = {} unless dat[:plug].users[dat[:nick]]
+  u = dat[:plug].users[dat[:nick]]
+  u[:nick] = dat[:nick]
+  u[:user] = dat[:user]
+  u[:host] = dat[:host]
+
+  # CTCP
+  if dat[:message][0] == "\x01" && dat[:message][-1] == "\x01"
+    dat[:type] = :nctcp
+    dat[:message] = dat[:message][1..(dat[:message].length - 2)]
+    s = dat[:message].split(' ')
+    dat[:cmd] = s[0]
+    (dat[:split] = s[1, s.length - 1]) || []
+    emit(dat)
+  end
+end

data/lib/protonbot/core_plugin/hooks/raw.rb

@@ -0,0 +1,32 @@
+hook(type: :raw) do |dat|
+  if    m = /^PING :(.+)/.match(dat[:raw_data])
+    emit(dat.merge(type: :ping, server: m[1]))
+  elsif m = /^:.+ (\d\d\d) .+? (.+)/.match(dat[:raw_data])
+    emit(dat.merge(type: :code, code: m[1], extra: m[2]))
+  elsif m = /^:(.+?)!(.+?)@(.+?) PRIVMSG (.+?) :(.+)/.match(dat[:raw_data])
+    rto =
+      if %w(! # & +).include? m[4][0]
+        m[4]
+      else
+        m[1]
+      end
+    emitt(dat.merge(type: :privmsg, nick: m[1], user: m[2], host: m[3],
+                    target: m[4], message: m[5], reply_to: rto))
+  elsif m = /^:(.+?)!(.+?)@(.+?) NOTICE (.+?) :(.+)/.match(dat[:raw_data])
+    emitt(dat.merge(type: :notice, nick: m[1], user: m[2], host: m[3],
+                    target: m[4], message: m[5]))
+  elsif m = /^:(.+?)!(.+?)@(.+?) TOPIC (.+?) :(.+)/.match(dat[:raw_data]) # NYI
+    emit(dat.merge(type: :utopic, nick: m[1], user: m[2], host: m[3],
+                   channel: m[4], topic: m[5]))
+  elsif m = /^:(.+?)!(.+?)@(.+?) JOIN :(.+)/.match(dat[:raw_data])
+    emit(dat.merge(type: :ujoin, nick: m[1], user: m[2], host: m[3], channel: m[4]))
+  elsif m = /^:(.+?)!(.+?)@(.+?) PART (.+) :(.*)/.match(dat[:raw_data])
+    emit(dat.merge(type: :upart, nick: m[1], user: m[2], host: m[3], channel: m[4], message: m[5]))
+  elsif m = /^:(.+?)!(.+?)@(.+?) QUIT :.*/.match(dat[:raw_data])
+    emit(dat.merge(type: :uquit, nick: m[1], user: m[2], host: m[3]))
+  elsif m = /^:(.+?)!(.+?)@(.+?) NICK :(.+)/.match(dat[:raw_data])
+    emit(dat.merge(type: :unick, nick: m[1], user: m[2], host: m[3], to: m[4]))
+  elsif m = /^:(.+?)!(.+?)@(.+?) KICK (.+?) (.+?) :.*/.match(dat[:raw_data])
+    emit(dat.merge(type: :ukick, nick: m[1], user: m[2], host: m[3], channel: m[4], target: m[5]))
+  end
+end

data/lib/protonbot/core_plugin/plugin.rb

@@ -0,0 +1,10 @@
+ProtonBot::Plugin.new do
+  @name        = 'Core'
+  @version     = ProtonBot::VERSION
+  @description = 'ProtonBot\'s core plugin'
+
+  run 'apis/index'
+  run 'commands/index'
+  run 'hooks/index'
+  run 'codes/index'
+end

data/lib/protonbot/event_lock.rb

@@ -0,0 +1,25 @@
+# Event lock. Locks current thread until matching event is emitted
+# @!attribute [r] plug
+#  @return [Plug] Plug
+# @!attribute [r] pattern
+#  @return [Hash<Symbol>] Pattern
+class ProtonBot::EventLock
+  attr_reader :plug, :pattern
+
+  # @param plug [Plug]
+  # @param pattern [Hash<Symbol>]
+  def initialize(plug, pattern)
+    @plug = plug
+    @plug.event_locks << self
+    @pattern = pattern
+    @unlock = false
+    sleep(0.01) until @unlock
+  end
+
+  # Unlocks current thread
+  # @return [NilClass]
+  def unlock
+    @unlock = true
+    nil
+  end
+end

data/lib/protonbot/hook.rb

@@ -0,0 +1,22 @@
+# Hook. Created by plugins, it's block is called if emitted event matches pattern
+# @!attribute [r] pattern
+#   @return [Hash<Symbol>] Hook's pattern
+# @!attribute [r] block
+#   @return [Proc] Block
+# @!attribute [r] extra
+#   @return [Hash] Extra data. Usually used by hook modifiers
+# @!attribute [r] chain
+#   @return [Array<Proc>] Proc array. These are executed before calling main block.
+#     If any returns false value, main block is not called
+class ProtonBot::Hook
+  attr_reader :pattern, :block, :extra, :chain
+
+  # @param pattern [Hash<Symbol>]
+  # @param block [Proc]
+  def initialize(pattern, &block)
+    @pattern = pattern
+    @block   = block
+    @extra   = {}
+    @chain   = []
+  end
+end

data/lib/protonbot/log.rb

@@ -0,0 +1,182 @@
+# Log - for colored logging.
+# @!attribute [rw] levels
+#   @return [Hash<String>] Colorscheme
+# @!attribute [rw] logging
+#   @return [Bool] If false, does not write messages.
+class ProtonBot::Log
+  attr_accessor :levels, :logging
+
+  def initialize
+    @pastel = Pastel.new
+
+    @queue = Queue.new
+
+    @fmt  = '[:date|:time] :name ▷ :lvl ▶ :text'
+    @dfmt = '%d.%m.%Y'
+    @tfmt = '%H:%M:%S'
+    @levels = DEFAULT_SCHEME
+
+    @logging = true
+
+    @stop = false
+
+    lloop
+  end
+
+  # Use it to get rid of appending name on each log-method-call
+  # @param name [String]
+  # @return [LogWrapper] wrapper
+  # @see ProtonBot::LogWrapper
+  def wrap(name)
+    ProtonBot::LogWrapper.new(self, name)
+  end
+
+  # @!group Logging
+  # @param msg [String]
+  # @param nam [String] Name
+  def info(msg, nam = 'log')
+    dat = gsub(msg.to_s, :info, nam)
+    @queue << dat
+    @pastel.strip(dat)
+  end
+
+  # @param msg [String]
+  # @param nam [String] Name
+  def debug(msg, nam = 'log')
+    dat = gsub(msg.to_s, :debug, nam)
+    @queue << dat
+    @pastel.strip(dat)
+  end
+
+  # @param msg [String]
+  # @param nam [String] Name
+  def warn(msg, nam = 'log')
+    dat = gsub(msg.to_s, :warning, nam)
+    @queue << dat
+    @pastel.strip(dat)
+  end
+
+  # @param msg [String]
+  # @param nam [String] Name
+  def error(msg, nam = 'log')
+    dat = gsub(msg.to_s, :error, nam)
+    @queue << dat
+    @pastel.strip(dat)
+  end
+
+  # @param msg [String]
+  # @param code [Integer]
+  # @param nam [String] Name
+  def crash(msg, code = 1, nam = 'log')
+    dat = gsub(msg.to_s, :crash, nam)
+    @queue << dat
+    @pastel.strip(dat)
+    exit code
+  end
+  # @!endgroup
+
+  # @return [String] Output
+  def inspect
+    %(<#ProtonBot::Log:#{object_id.to_s(16)} @logging=#{@logging}>)
+  end
+
+  # Stops log thread
+  def stop
+    @stop = true
+    @thr.join
+  end
+
+  private
+
+  # Formats message
+  # @param msg [String]
+  # @param sname [Symbol] Color-Scheme name
+  # @param nam [String] Log-Name
+  def gsub(msg, sname, nam)
+    dt = DateTime.now
+
+    date = dt.strftime(@dfmt)
+    time = dt.strftime(@tfmt)
+
+    dates = @pastel.decorate(date, *@levels[sname][:fmt][:datetime])
+    times = @pastel.decorate(time, *@levels[sname][:fmt][:datetime])
+
+    name = @pastel.decorate(nam, *@levels[sname][:fmt][:name])
+
+    lvl = @pastel.decorate(*@levels[sname][:chars],
+                           *@levels[sname][:fmt][:lvl])
+
+    @fmt
+      .gsub(':date', dates)
+      .gsub(':time', times)
+      .gsub(':name', name)
+      .gsub(':lvl',  lvl)
+      .gsub(':text', msg)
+      .gsub('▷', @pastel.decorate('▷', *@levels[sname][:fmt][:arrows]))
+      .gsub('▶', @pastel.decorate('▶', *@levels[sname][:fmt][:arrows]))
+  end
+
+  # Log-loop - reads messages from queue and writes them to STDOUT
+  def lloop
+    @thr = Thread.new do
+      loop do
+        break if @stop
+        d = begin
+              @queue.pop
+            rescue
+              nil
+            end
+        print("#{d}\n") if @logging && d
+      end
+    end
+  end
+
+  # Default colorcheme
+  DEFAULT_SCHEME = {
+    info: {
+      chars: 'I',
+      fmt: {
+        datetime: [:bright_cyan],
+        name:     [:cyan],
+        lvl:      [:cyan],
+        arrows:   [:bright_cyan]
+      }
+    },
+    debug: {
+      chars: 'D',
+      fmt: {
+        datetime: [:bright_green],
+        name:     [:green],
+        lvl:      [:green],
+        arrows:   [:bright_green]
+      }
+    },
+    warning: {
+      chars: 'W',
+      fmt: {
+        datetime: [:bright_yellow],
+        name:     [:yellow],
+        lvl:      [:yellow],
+        arrows:   [:bright_yellow]
+      }
+    },
+    error: {
+      chars: 'E',
+      fmt: {
+        datetime: [:bright_red],
+        name:     [:red],
+        lvl:      [:red],
+        arrows:   [:bright_red]
+      }
+    },
+    crash: {
+      chars: 'C',
+      fmt: {
+        datetime: [:bright_magenta],
+        name:     [:magenta],
+        lvl:      [:magenta],
+        arrows:   [:bright_magenta]
+      }
+    }
+  }.freeze
+end

data/lib/protonbot/log_wrapper.rb

@@ -0,0 +1,52 @@
+# Log wrapper
+# @!attribute [r] log
+#   @return [Log] Log
+# @!attribute [r] name
+#   @return [String] name
+class ProtonBot::LogWrapper
+  attr_reader :log, :name
+
+  # @param log [Log]
+  # @param name [String]
+  def initialize(log, name)
+    @log  = log
+    @name = name
+  end
+
+  # @param msg [String]
+  # @return [LogWrapper] self
+  def info(msg)
+    @log.info(msg, @name)
+  end
+
+  # @param msg [String]
+  # @return [LogWrapper] self
+  def debug(msg)
+    @log.debug(msg, @name)
+  end
+
+  # @param msg [String]
+  # @return [LogWrapper] self
+  def warn(msg)
+    @log.warn(msg, @name)
+  end
+
+  # @param msg [String]
+  # @return [LogWrapper] self
+  def error(msg)
+    @log.error(msg, @name)
+  end
+
+  # @param msg [String]
+  # @return [LogWrapper] self
+  # @return [Integer] code
+  def crash(msg, code)
+    @log.crash(msg, code, @name)
+  end
+
+  # @return [String] Output
+  def inspect
+    %(<#ProtonBot::LogWrapper:#{object_id.to_s(16)} @name='#{@name}') +
+      %( @log=#{@log}>)
+  end
+end

data/lib/protonbot/numeric.rb

@@ -0,0 +1,140 @@
+# Here you can find constants for almost all numerics defined in RFC (see link below).
+# You can use `@numeric` instead of `ProtonBot::Numeric` while developing plugins.
+# @see https://tools.ietf.org/html/rfc2812#section-5
+module ProtonBot::Numeric
+  WELCOME = '001'.freeze
+  YOURHOST = '002'.freeze
+  CREATED = '003'.freeze
+  MYINFO = '004'.freeze
+  BOUNCE = '005'.freeze
+  ISON = '303'.freeze
+  AWAY = '301'.freeze
+  UNAWAY = '305'.freeze
+  NOWAWAY = '306'.freeze
+  WHOISUSER = '311'.freeze
+  WHOISSERVER = '312'.freeze
+  WHOISOPERATOR = '313'.freeze
+  WHOISIDLE = '317'.freeze
+  WHOISCHANNELS = '319'.freeze
+  ENDOFWHOIS = '318'.freeze
+  WHOWASUSER = '314'.freeze
+  ENDOFWHOWAS = '369'.freeze
+  LISTSTART = '321'.freeze
+  LIST = '322'.freeze
+  LISTEND = '323'.freeze
+  USERHOST = '302'.freeze
+  UNIQOPIS = '325'.freeze
+  CHANNELMODEIS = '324'.freeze
+  NOTOPIC = '331'.freeze
+  TOPIC = '332'.freeze
+  INVITING = '341'.freeze
+  SUMMONING = '342'.freeze
+  INVITELIST = '346'.freeze
+  ENDOFINVITELIST = '347'.freeze
+  EXCEPTLIST = '348'.freeze
+  ENDOFEXCEPTLIST = '349'.freeze
+  VERSION = '351'.freeze
+  WHOREPLY = '352'.freeze
+  ENDOFWHO = '315'.freeze
+  NAMREPLY = '353'.freeze
+  ENDOFNAMES = '366'.freeze
+  LINKS = '364'.freeze
+  ENDOFLINKS = '365'.freeze
+  BANLIST = '367'.freeze
+  ENDOFBANLIST = '368'.freeze
+  INFO = '371'.freeze
+  ENDOFINFO = '374'.freeze
+  MOTDSTART = '375'.freeze
+  MOTD = '372'.freeze
+  ENDOFMOTD = '376'.freeze
+  YOUREOPER = '381'.freeze
+  REHASHING = '382'.freeze
+  YOURSERVICE = '383'.freeze
+  TIME = '391'.freeze
+  USERSTART = '392'.freeze
+  USERS = '393'.freeze
+  ENDOFUSERS = '394'.freeze
+  TRACELINK = '200'.freeze
+  TRACECONNECTING = '201'.freeze
+  TRACEHANDSHAKE = '202'.freeze
+  TRACEUNKNOWN = '203'.freeze
+  TRACEOPERATOR = '204'.freeze
+  TRACEUSER = '205'.freeze
+  TRACESERVER = '206'.freeze
+  TRACESERVICE = '207'.freeze
+  TRACENEWTYPE = '208'.freeze
+  TRACECLASS = '209'.freeze
+  TRACERECONNECT = '210'.freeze
+  TRACELOG = '261'.freeze
+  TRACEEND = '262'.freeze
+  STATSLINKINFO = '211'.freeze
+  STATSCOMMANDS = '212'.freeze
+  ENDOFSTATS = '219'.freeze
+  STATSUPTIME = '242'.freeze
+  STATSOLINE = '243'.freeze
+  UMDODEIS = '221'.freeze
+  SERVLIST = '234'.freeze
+  SERVLISTEND = '235'.freeze
+  LUSERCLIENT = '251'.freeze
+  LUSEROP = '252'.freeze
+  LUSERUNKNOWN = '253'.freeze
+  LUSERCHANNELS = '254'.freeze
+  LUSERME = '255'.freeze
+  ADMINME = '256'.freeze
+  ADMINLOC1 = '257'.freeze
+  ADMINLOC2 = '258'.freeze
+  ADMINEMAIL = '259'.freeze
+  TRYAGAIN = '263'.freeze
+  NOSUCHSERVER = '402'.freeze
+  NOSUCHCHANNEL = '403'.freeze
+  CANNOTSENDTOCHAN = '404'.freeze
+  TOOMANYCHANNELS = '405'.freeze
+  WASNOSUCHNICK = '406'.freeze
+  TOOMANYTARGETS = '407'.freeze
+  NOSUCHSERVICE = '408'.freeze
+  NOORIGIN = '409'.freeze
+  NORECIPIENT = '411'.freeze
+  NOTEXTTOSEND = '412'.freeze
+  NOTOPLEVEL = '413'.freeze
+  WILDTOPLEVEL = '414'.freeze
+  BADMASK = '415'.freeze
+  UNKNOWNCOMMAND = '421'.freeze
+  NOMOTD = '422'.freeze
+  NOADMININFO = '423'.freeze
+  FILEERROR = '424'.freeze
+  NONICKNAMEGIVEN = '431'.freeze
+  ERRONEUSNICKNAME = '432'.freeze
+  NICKNAMEINUSE = '433'.freeze
+  NICKCOLLISION = '436'.freeze
+  UNAVAILRESOURCE = '437'.freeze
+  USERNOTINCHANNEL = '441'.freeze
+  NOTONCHANNEL = '442'.freeze
+  USERONCHANNEL = '443'.freeze
+  NOLOGIN = '444'.freeze
+  SUMMONDISABLED = '445'.freeze
+  USERSDISABLED = '446'.freeze
+  NOTREGISTERED = '451'.freeze
+  NEEDMOREPARAMS = '461'.freeze
+  ALREADYREGISTRED = '462'.freeze
+  NOPERMFORHOST = '463'.freeze
+  PASSWDMISMATCH = '464'.freeze
+  YOUREBANNEDCREEP = '465'.freeze
+  YOUWILLBEBANNED = '466'.freeze
+  KEYSET = '467'.freeze
+  CHANNELISFULL = '471'.freeze
+  UNKNOWNMODE = '472'.freeze
+  INVITEONLYCHAN = '473'.freeze
+  BANNEDFROMCHAN = '474'.freeze
+  BADCHANNELKEY = '475'.freeze
+  BADCHANMASK = '476'.freeze
+  NOCHANMODES = '477'.freeze
+  BANLISTFULL = '478'.freeze
+  NOPRIVILEGES = '481'.freeze
+  CHANOPRIVSNEEDED = '482'.freeze
+  CANTKILLSERVER = '483'.freeze
+  RESTRICTED = '484'.freeze
+  UNIQOPPRIVSNEEDED = '485'.freeze
+  NOOPERHOST = '491'.freeze
+  UMODEUNKNOWNFLAG = '501'.freeze
+  USERSDONTMATCH = '502'.freeze
+end

data/lib/protonbot/plug.rb

@@ -0,0 +1,118 @@
+# Plug. This class includes socket, writer and reader threads, user&channel-data,
+# API for interacting with server etc.
+# @!attribute [r] bot
+#   @return [ProtonBot::Bot] Plug's bot.
+# @!attribute [r] db
+#   @return [Heliodor::DB] Plug's Heliodor-powered database.
+#   @see http://www.rubydoc.info/gems/heliodor
+# @!attribute [r] sock
+#   @return [TCPSocket,SSLSocket] Plug's socket. May be SSL-socket.
+# @!attribute [r] rsock
+#   @return [TCPSocket] Always non-SSL socket.
+# @!attribute [r] is_ssl
+#   @return [Boolean] True if connection is SSL-powered
+# @!attribute [r] name
+#   @return [String] Plug's name.
+# @!attribute [r] conf
+#   @return [Hash<String>] Config.
+# @!attribute [r] rloop
+#   @return [Thread] Reader-loop-thread.
+# @!attribute [r] wloop
+#   @return [Thread] Writer-loop-thread.
+# @!attribute [r] log
+#   @return [ProtonBot::LogWrapper] Log wrapper.
+# @!attribute [r] queue
+#   @return [Queue] Queue.
+# @!attribute [r] chans
+#   @return [Hash<String>] Channel data.
+# @!attribute [r] users
+#   @return [Hash<String>] User data (by nick).
+# @!attribute [r] event_locks
+#   @return [Array<EventLock>] Event locks.
+# @!attribute [rw] running
+#   @return [Boolean] Returns `true` if bot still runs 
+#     and processes messages from server.
+# @!attribute [r] user
+#   @return [String] Plug's username.
+# @!attribute [r] nick
+#   @return [String] Plug's nickname.
+# @!attribute [r] rnam
+#   @return [String] Plug's realname.
+class ProtonBot::Plug
+  attr_reader :bot, :db, :sock, :rsock, :name, :conf, :rloop, :wloop, :log, :queue, :chans, :users,
+              :event_locks, :user, :nick, :rnam, :is_ssl
+  attr_accessor :running
+
+  # @param bot [Bot]
+  # @param name [String]
+  # @param conf [Hash<String>]
+  def initialize(bot, name, conf)
+    @bot         = bot
+    @name        = name
+    @db          = @bot.dbs[@name]
+    @log         = @bot._log.wrap("!#{@name}")
+    @conf        = conf
+    @nick        = conf['nick']
+    @user        = conf['user']
+    @rnam        = conf['rnam']
+    @sock        = nil
+    @running     = false
+    @queue       = Queue.new
+    @chans       = {}
+    @users       = {}
+    @event_locks = []
+  end
+
+  # Connects to server, introduces and starts reader and writer threads.
+  # @return [Plug] self
+  def connect!
+    if @conf['ssl'] == nil or @conf['ssl'] == false
+      @sock = @rsock = TCPSocket.new(@conf['host'], @conf['port'])
+      @is_ssl = false
+    else
+      @rsock = TCPSocket.new(@conf['host'], @conf['port'])
+      @ssl_ctx = OpenSSL::SSL::SSLContext.new
+      @ssl_ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      @ssl_ctx.ssl_version = :SSLv23
+      @ssl_ctx.cert = OpenSSL::X509::Certificate.new(File.read(File.expand_path(@conf['ssl_crt']))) if
+        @conf['ssl_crt']
+      @ssl_ctx.key = OpenSSL::PKey::RSA.new(File.read(File.expand_path(@conf['ssl_key']))) if
+        @conf['ssl_key']
+      @sock = OpenSSL::SSL::SSLSocket.new(@rsock, @ssl_ctx)
+      @sock.sync = true
+      @sock.connect
+      @is_ssl = true
+    end
+
+    @running = true
+
+    @rloop = Thread.new { readloop }
+    @wloop = Thread.new { writeloop }
+
+    log.info("Started plug `#{name}` successfully!")
+
+    introduce
+
+    @rloop.join
+    @wloop.join
+    self
+  end
+
+  # Logs given error object to cosole
+  # @param e [Exception]
+  # @return [Plug] self
+  def log_err(e)
+    @log.error('Error!')
+    @log.error("> Message: #{e.message}")
+    @log.error('> Backtrace:')
+    e.backtrace.each do |i|
+      @log.error(">> #{i}")
+    end
+    self
+  end
+
+  # @return [String] out
+  def inspect
+    %(<#ProtonBot::Plug:#{object_id.to_s(16)} @name=#{name} @bot=#{bot}>)
+  end
+end