protonbot 0.1.0

data/lib/protonbot/plug_events.rb

@@ -0,0 +1,51 @@
+class ProtonBot::Plug
+  # Emits passed event - calls first matching hook from each plugin
+  # @param dat [Hash] Event hash
+  # @return [Plug] self
+  def emit(dat = {})
+    bot.plugins.each do |_, p|
+      worked = []
+      p.hooks.each do |h|
+        next unless dat >= h.pattern && !worked.include?(h.object_id) && worked.empty?
+        canrun = true
+        h.chain.each do |l|
+          next unless canrun
+          canrun = l.call(dat, h)
+        end
+        worked << h.object_id
+        h.block.call(dat) if canrun
+      end
+      worked = []
+    end
+    event_locks.each_with_index do |el, k|
+      if dat >= el.pattern
+        event_locks.delete_at(k)
+        el.unlock
+      end
+    end
+    self
+  end
+
+  # Emits passed event in new thread
+  # @param dat [Hash] Event hash
+  # @return [Plug] self
+  def emitt(dat = {})
+    d = dat.clone
+    Thread.new do
+      begin
+        emit(d)
+      rescue => e
+        log_err(e)
+      end
+    end
+    self
+  end
+
+  # Creates EventLock with given pattern.
+  # @param pattern [Hash]
+  # @return [Plug] self
+  def wait_for(pattern)
+    ProtonBot::EventLock.new(self, pattern)
+    self
+  end
+end

data/lib/protonbot/plug_io.rb

@@ -0,0 +1,99 @@
+class ProtonBot::Plug
+  # Main read-loop. Reads data from socket and emits event `raw`
+  def readloop
+    while @running
+      if s = @sock.gets
+        s = s.force_encoding(@conf['encoding'])
+        s = s[0..-3]
+        log.info "R > #{s}"
+        begin
+          emit(type: :raw, raw_data: s.clone, plug: self, db: db, bot: bot, core: bot.plugins['core'])
+        rescue => e
+          log_err(e)
+        end
+      else
+        @running = false
+      end
+    end
+    log.info 'Connection closed.'
+  end
+
+  # Main write-loop. Reads data from queue and sends it to server
+  def writeloop
+    while @running || !@wqueue.empty?
+      s = @queue.pop
+      write_(s)
+      sleep(@conf['queue_delay'])
+    end
+  end
+
+  # Adds given message to the queue
+  # @param s [String] Message
+  # @return [Plug] self
+  def write(s)
+    @queue << s
+    self
+  end
+
+  # Sends message to server without using queue.
+  # @param s [String] Message
+  # @return [Plug] self
+  def write_(s)
+    s = s.encode(@conf['encoding'], s.encoding)
+    @sock.puts s
+    log.info "W > #{s}"
+  end
+
+  # Sends credentials to server (PASS, NICK, USER).
+  def introduce
+    write_("PASS #{@conf['pass']}") if @conf['pass']
+    write_("NICK #{@conf['nick']}")
+    write_("USER #{@conf['user']} 0 * :#{@conf['rnam']}")
+  end
+
+  # Splits given string each 399 bytes and on newlines
+  # @param string [String]
+  # @return [String] Output
+  def self.ssplit(string)
+    out = []
+    arr = string.split("\n\r")
+    arr.each do |i|
+      items = i.scan(/.{,399}/)
+      items.delete('')
+      items.each do |i2|
+        out << i2
+      end
+    end
+    out
+  end
+
+  # Colorizes given string.
+  # @param string [String]
+  # @return [String] Output
+  def self.process_colors(string)
+    string
+      .gsub("%C%",     "%C?")
+      .gsub(",%",      ",?")
+      .gsub("%C",      "\x03")
+      .gsub("%B",      "\x02")
+      .gsub("%I",      "\x10")
+      .gsub("%U",      "\x1F")
+      .gsub("%N",      "\x0F")
+      .gsub("?WHITE",  "0")
+      .gsub("?BLACK",  "1")
+      .gsub("?BLUE",   "2")
+      .gsub("?GREEN",  "3")
+      .gsub("?RED",    "4")
+      .gsub("?BROWN",  "5")
+      .gsub("?PURPLE", "6")
+      .gsub("?ORANGE", "7")
+      .gsub("?YELLOW", "8")
+      .gsub("?LGREEN", "9")
+      .gsub("?CYAN"  , "10")
+      .gsub("?LCYAN",  "11")
+      .gsub("?LBLUE",  "12")
+      .gsub("?PINK",   "13")
+      .gsub("?GREY",   "14")
+      .gsub("?LGREY",  "15")
+  end
+end

data/lib/protonbot/plug_utils.rb

@@ -0,0 +1,242 @@
+class ProtonBot::Plug
+  # Sends WHOIS message to the server
+  # @param nick [String]
+  # @return [Plug] self
+  def whois(nick)
+    write("WHOIS #{nick}")
+    self
+  end
+
+  # Gets hostname for given nickname using WHOIS and event lock
+  # @param nick [String]
+  # @return [String] host
+  def gethost(nick)
+    if @users[nick] and @users[nick][:host]
+      @users[nick][:host]
+    else
+      Thread.new do
+        sleep(1)
+        whois(nick)
+      end
+      wait_for(type: :code_whoisuser, nick: nick)
+    end
+    @users[nick][:host]
+  end
+
+  # Gets username for given nickname using WHOIS and event lock
+  # @param nick [String]
+  # @return [String] user
+  def getuser(nick)
+    if @users[nick] and @users[nick][:user]
+      @users[nick][:user]
+    else
+      Thread.new do
+        sleep(1)
+        whois(nick)
+      end
+      wait_for(type: :code, code: ProtonBot::Numeric::WHOISUSER)
+      @users[nick][:user]
+    end
+  end
+
+  # Changes current nick to given. If successful, `unick` event will be emitted
+  # @param to [String]
+  # @return [Plug] self
+  def change_nick(to)
+    write("NICK #{to}")
+    self
+  end
+
+  # Joins given channel and uses password if it's provided
+  # @param chan [String]
+  # @param pass [String] Password
+  # @return [Plug] self
+  def join(chan, pass = '')
+    write("JOIN #{chan} #{pass}")
+    self
+  end
+
+  # Parts given channel with given reason
+  # @param chan [String]
+  # @param reason [String]
+  def part(chan, reason = 'Parting...')
+    write("PART #{chan} :#{reason}")
+    self
+  end
+
+  # Sends message to given target. Splits it each 399 bytes.
+  # @param target [String]
+  # @param msg [String]
+  # @return [Plug] self
+  def privmsg(target, msg)
+    self.class.ssplit(self.class.process_colors(msg)).each do |m|
+      write("PRIVMSG #{target} :\u200B#{m}")
+    end
+    self
+  end
+
+  # Sends notice to given target. Splits it each 399 bytes.
+  # @param target [String]
+  # @param msg [String]
+  # @return [Plug] self
+  def notice(target, msg)
+    self.class.ssplit(self.class.process_colors(msg)).each do |m|
+      write("NOTICE #{target} :\u200B#{m}")
+    end
+    self
+  end
+
+  # Sends CTCP to given target.
+  # @param target [String]
+  # @param msg [String]
+  # @return [Plug] self
+  def ctcp(target, msg)
+    write("PRIVMSG #{target} :\x01#{msg}\x01")
+    self
+  end
+
+  # Sends NCTCP to given target.
+  # @param target [String]
+  # @param msg [String]
+  # @return [Plug] self
+  def nctcp(target, msg)
+    write("NOTICE #{target} :\x01#{msg}\x01")
+    self
+  end
+
+  # Invites user to given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def invite(chan, nick)
+    write("INVITE #{nick} #{chan}")
+    self
+  end
+
+  # Sets mode on given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @param mode [String]
+  # @return [Plug] self
+  def usermode(chan, nick, mode)
+    write("MODE #{chan} #{mode} #{nick}")
+    self
+  end
+
+  # Sets mode on given channel
+  # @param chan [String]
+  # @param mode [String]
+  # @return [Plug] self
+  def chanmode(chan, mode)
+    write("MODE #{chan} #{mode}")
+    self
+  end
+
+  # Sets quiet on given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def quiet(chan, nick)
+    usermode(chan, nick, '+q')
+    self
+  end
+
+  # Removes quiet on given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def unquiet(chan, nick)
+    usermode(chan, nick, '-q')
+    self
+  end
+
+  # Sets ban on given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def ban(chan, nick)
+    usermode(chan, nick, '+b')
+    self
+  end
+
+  # Removes ban on given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def unban(chan, nick)
+    usermode(chan, nick, '-b')
+    self
+  end
+
+  # Sets excempt on given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def excempt(chan, nick)
+    usermode(chan, nick, '+e')
+    self
+  end
+
+  # Removes excempt on given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def unexcempt(chan, nick)
+    usermode(chan, nick, '-e')
+    self
+  end
+
+  # Ops given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def op(chan, nick)
+    usermode(chan, nick, '+o')
+    self
+  end
+
+  # Deops given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def deop(chan, nick)
+    usermode(chan, nick, '-o')
+    self
+  end
+
+  # Voices given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def voice(chan, nick)
+    usermode(chan, nick, '+v')
+    self
+  end
+
+  # Devoices on given user at given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def devoice(chan, nick)
+    usermode(chan, nick, '-v')
+    self
+  end
+
+  # Kicks given user from given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def kick(chan, nick, reason = 'Default Kick Reason')
+    write("KICK #{chan} #{nick} :#{reason}")
+    self
+  end
+
+  # Removes given user from given channel
+  # @param chan [String]
+  # @param nick [String]
+  # @return [Plug] self
+  def remove(chan, nick, reason = 'Default Remove Reason')
+    write("REMOVE #{chan} #{nick} :#{reason}")
+    self
+  end
+end

data/lib/protonbot/plugin.rb

@@ -0,0 +1,101 @@
+# Plugin object. Use it to alter bot's behavior
+# @see http://www.rubydoc.info/gems/protonbot/file/plugin-demo.md
+# @!attribute [r] name
+#   @return [String] Plugin's name
+# @!attribute [r] version
+#   @return [String] Plugin's version
+# @!attribute [r] description
+#   @return [String] Plugin's description
+# @!attribute [r] name
+#   @return [String] Plugin's name
+# @!attribute [r] hooks
+#   @return [Array<Hook>] Plugin's hooks
+# @!attribute [rw] bot
+#   @return [Bot] Bot
+# @!attribute [rw] Log
+#   @return [LogWrapper] Log
+# @!attribute [rw] path
+#   @return [String] Path
+# @!attribute [r] core
+#   @return [Plugin] Core plugin
+class ProtonBot::Plugin
+  attr_reader :name, :version, :description, :plugins, :hooks, :core
+  attr_accessor :bot, :log, :path
+
+  # @param block [Proc]
+  def initialize(&block)
+    @hooks = []
+    @block = block
+    @numeric = ProtonBot::Numeric
+  end
+
+  # Starts plugin
+  # @return [Plugin] self
+  def launch
+    @plugins = @bot.plugins
+    @core    = @bot.plugins['core']
+    instance_exec(&@block)
+    raise ProtonBot::PluginError, 'Plugin-name is not set!' unless
+      @name
+    raise ProtonBot::PluginError, 'Plugin-description is not set!' unless
+      @description
+    raise ProtonBot::PluginError, 'Plugin-description is not set!' unless
+      @description
+    log.info("Started plugin `#{@name} v#{@version}` successfully!")
+  end
+
+  # Creates hook and returns it
+  # @param pattern [Hash<Symbol>]
+  # @param block [Proc]
+  # @return [Hook] hook
+  def hook(pattern = {}, &block)
+    h = ProtonBot::Hook.new(pattern, &block)
+    @hooks << h
+    h
+  end
+
+  # Shortcut for `hook(type: :command, ...) {}`
+  # @param pattern [Hash<Symbol>]
+  # @param block [Proc]
+  # @return [Hook] hook
+  def cmd(pattern = {}, &block)
+    hook(pattern.merge(type: :command), &block)
+  end
+
+  # Emits passed event
+  # @param dat [Hash<Symbol>]
+  def emit(dat = {})
+    dat[:plug].emit(dat) if dat[:plug]
+  end
+
+  # Emits passed event in other thread
+  # @param dat [Hash<Symbol>]
+  def emitt(dat = {})
+    dat[:plug].emitt(dat) if dat[:plug]
+  end
+
+  # Runs given file (.rb is appended automatically)
+  # @param fname [String]
+  def run(fname)
+    if @name == 'Core'
+      instance_eval File.read("#{Gem.loaded_specs['protonbot'].lib_dirs_glob}/" \
+        "protonbot/core_plugin/#{fname}.rb"), "#{name}/#{fname}.rb"
+    else
+      instance_exec do
+        instance_eval File.read(File.expand_path("#{path}/#{fname}.rb")), "#{name}/#{fname}.rb"
+      end
+    end
+  end
+
+  # Shortcut for `define_singleton_method(...)`
+  # @param name [String,Symbol]
+  # @param block [Proc]
+  def fun(name, &block)
+    define_singleton_method(name, &block)
+  end
+
+  # @return [String] Output
+  def inspect
+    %(<#ProtonBot::Plugin:#{object_id.to_s(16)} @name=#{name} @version=#{version}>)
+  end
+end

data/lib/protonbot/version.rb

@@ -0,0 +1,4 @@
+module ProtonBot
+  # ProtonBot's version
+  VERSION = '0.1.0'.freeze
+end

data/lib/protonbot.rb

@@ -0,0 +1,38 @@
+require 'English'
+
+require 'date'
+
+require 'pastel'
+require 'tty'
+require 'irb'
+
+require 'heliodor'
+
+require 'open3'
+
+require 'socket'
+require 'openssl'
+
+module ProtonBot
+end
+
+require 'protonbot/version'
+
+require 'protonbot/numeric'
+
+require 'protonbot/log'
+require 'protonbot/log_wrapper'
+
+require 'protonbot/bot'
+require 'protonbot/bot_conf'
+require 'protonbot/bot_plugins'
+
+require 'protonbot/event_lock'
+
+require 'protonbot/plug'
+require 'protonbot/plug_io'
+require 'protonbot/plug_utils'
+require 'protonbot/plug_events'
+
+require 'protonbot/plugin'
+require 'protonbot/hook'

data/protonbot.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'protonbot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'protonbot'
+  spec.version       = ProtonBot::VERSION
+  spec.authors       = ['Nickolay']
+  spec.email         = ['nickolay02@inbox.ru']
+
+  spec.summary       = 'An IRC bot library'
+  spec.description   = 'Library for writing cross-server IRC bots'
+  spec.homepage      = 'https://github.com/handicraftsman/ProtonBot'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47'
+
+  spec.add_runtime_dependency 'pastel', '~> 0.7.1'
+  spec.add_runtime_dependency 'tty', '~> 0.6.1'
+  spec.add_runtime_dependency 'heliodor', '~> 0.2.0'
+end