chatrix-bot 1.0.0.pre

data/chatrix-bot.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chatrix/bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'chatrix-bot'
+  spec.version       = Chatrix::Bot::VERSION
+  spec.authors       = ['Adam Hellberg']
+  spec.email         = ['sharparam@sharparam.com']
+
+  spec.summary       = 'A Ruby chatbot for Matrix with plugin support'
+  # spec.description   = %q{}
+  spec.homepage      = 'https://github.com/Sharparam/chatrix-bot'
+  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.required_ruby_version = '>= 2.3.0'
+
+  spec.add_runtime_dependency 'chatrix', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+end

data/exe/chatrix-bot

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'optparse'
+
+require 'chatrix'
+require 'chatrix/bot'
+
+require 'pp'
+
+defaults = {
+  config: Chatrix::Bot::Config::DEFAULT_CONFIG_PATH
+}
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: chatrix-bot [options]'
+
+  opts.on(
+    '-g',
+    '--generate [FILE]',
+    'Generate config to specified file and exit.',
+    "  FILE defaults to '#{defaults[:config]}'"
+  ) do |file|
+    file ||= defaults[:config]
+    data = Chatrix::Bot::Config.defaults
+    Chatrix::Bot::Config.new(file, data).save
+    exit
+  end
+
+  opts.on(
+    '-c',
+    '--config FILE',
+    'Specify the config file to use',
+    "  (uses '#{defaults[:config]}' if not specified)"
+  ) do |c|
+    options[:config] = c
+  end
+
+  opts.on_tail('-v', '--version', 'Print version and exit') do
+    puts "chatrix-bot v#{Chatrix::Bot::VERSION}, chatrix v#{Chatrix::VERSION}"
+    exit
+  end
+
+  opts.on_tail('-h', '--help', 'Shows this help message and exits') do
+    puts opts
+    exit
+  end
+end.parse!
+
+pp options

data/lib/chatrix/bot.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+require 'chatrix/bot/errors'
+require 'chatrix/bot/version'
+require 'chatrix/bot/config'
+require 'chatrix/bot/plugin_manager'
+
+require 'chatrix'
+
+module Chatrix
+  # The Chatrix bot class.
+  class Bot
+    # Config object containing the bot config.
+    attr_reader :config
+
+    # The Logger instance for the bot.
+    attr_reader :log
+
+    # The PluginManager for this bot.
+    attr_reader :plugin_manager
+
+    # Initializes a new Bot instance.
+    # @param file [String] File to load config from.
+    def initialize(file = Config::DEFAULT_CONFIG_PATH)
+      @started_at = (Time.now.to_f * 1e3).round
+
+      @config = Config.load file
+
+      init_logger
+
+      log.debug 'Initializing plugin manager'
+      @plugin_manager = PluginManager.new self
+
+      log.debug 'bot finished initializing'
+    end
+
+    def admin?(user)
+      @config[:admins].member? user.id
+    end
+
+    # Starts the bot (starts syncing with the homeserver).
+    def start
+      init_client unless @client
+
+      log.info 'Bot starting to sync'
+
+      @client.start_syncing
+    end
+
+    # Stops the bot (stops syncing with the homeserver).
+    def stop
+      log.info 'Bot stopping sync'
+      @client.stop_syncing
+    end
+
+    def on_room_message(room, message)
+      # Do not process messages sent before we joined, or if we sent
+      # them ourselves
+      return if message.sender == @client.me || message.timestamp < @started_at
+      plugin_manager.parse_message room, message
+    end
+
+    def on_sync_error(error)
+      log.error "SYNC ERROR: #{error.inspect}"
+    end
+
+    private
+
+    def init_logger
+      if @config[:debug]
+        @log = Logger.new $stdout
+        @log.level = Logger::DEBUG
+      else
+        @log = Logger.new @config[:log_file], 'daily'
+        @log.level = @config[:log_level]
+      end
+
+      @log.progname = 'chatrix-bot'
+    end
+
+    def init_client
+      log.debug 'Client initialization'
+
+      @client = Chatrix::Client.new(
+        @config[:access_token],
+        @config[:user_id],
+        homeserver: @config[:homeserver]
+      )
+
+      log.debug 'Client event registrations'
+
+      @client.subscribe(self, prefix: :on)
+    end
+  end
+end

data/lib/chatrix/bot/command.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'chatrix/bot/parameter'
+
+module Chatrix
+  class Bot
+    # Describes a plugin command.
+    class Command
+      PREFIX = '!'
+
+      attr_reader :name
+
+      attr_reader :syntax
+
+      attr_reader :help
+
+      attr_reader :handler
+
+      attr_reader :required_power
+
+      def initialize(name, syntax, help, opts = {})
+        @name = name
+        @syntax = syntax
+        @help = help
+        @aliases = opts[:aliases] || []
+        @handler = opts[:handler]
+        @required_power = opts[:power] || 0
+
+        configure_parameters syntax, opts
+      end
+
+      def self.command?(message)
+        !message.match(/^#{PREFIX}[^\s]/).nil?
+      end
+
+      def self.extract_name(message)
+        message.match(/^#{PREFIX}([^\s]+)/)[1]
+      end
+
+      def self.stylize(name)
+        "#{PREFIX}#{name}" unless command? name
+      end
+
+      def self.parse(message)
+        return nil unless command? message
+
+        name = message.match(/^#{PREFIX}([^\s]+)/)[1]
+        rest = message.match(/ (.+)$/)
+        body = rest.is_a?(MatchData) ? rest[1].to_s : ''
+
+        { name: name, body: body }
+      end
+
+      def name_or_alias?(name)
+        @name == name || @aliases.member?(name)
+      end
+
+      def parse(message)
+        data = {}
+
+        @parameters.each_with_index do |param, index|
+          last = index == @parameters.count - 1
+          parsed = param.parse message, last ? Parameter::MATCHERS[:rest] : nil
+
+          break if parsed.nil?
+
+          data[param.name] = parsed[:content]
+          message = parsed[:rest]
+        end
+
+        data
+      end
+
+      def usage
+        <<~EOF
+        Usage: #{self.class.stylize(name)} #{syntax}
+        #{help}
+        Required power level to use: #{required_power}
+        EOF
+      end
+
+      def test(user, room)
+        raise PermissionError unless user.power_in(room) >= required_power
+      end
+
+      private
+
+      def configure_parameters(syntax, options = {})
+        @parameters = []
+        syntax.scan(/([<\[])([\w\ ]+)[>\]]/) do |match|
+          param = match[1].gsub(/\s+/, '_').to_sym
+          required = match[0] == '<'
+          matcher = options[:matchers][param] if options.key? :matchers
+          @parameters.push Parameter.new param, required, matcher
+        end
+      end
+    end
+  end
+end

data/lib/chatrix/bot/config.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'yaml'
+
+module Chatrix
+  class Bot
+    # Manages configuration for the bot.
+    #
+    # Storage location for other data is based on the directory
+    # containing the file for the config. I.E: If the config file is stored
+    # as `~/.chatrix-bot/config.yaml`, then `~/.chatrix-bot` will be used
+    # as the data directory for the bot.
+    class Config
+      DEFAULT_CONFIG_PATH = '~/.config/chatrix-bot/config.yaml'
+
+      attr_reader :file
+
+      def initialize(file = DEFAULT_CONFIG_PATH, data = nil)
+        @file = File.expand_path file
+        @dir = File.dirname @file
+        @data = data || {}
+
+        FileUtils.mkpath @dir unless File.exist? @dir
+      end
+
+      def [](key)
+        @data[key]
+      end
+
+      def []=(key, value)
+        @data[key] = value
+      end
+
+      def self.load(file)
+        YAML.load_file File.expand_path(file)
+      end
+
+      def self.defaults
+        {
+          access_token: '<ACCESS TOKEN>',
+          user_id: '<MY USER ID>',
+          admins: ['GLOBAL ADMINS', '@user:example.com'],
+          homeserver: 'https://server.example.com:1234',
+          log_file: 'chatrix-bot.log',
+          log_level: Logger::INFO
+        }
+      end
+
+      def get(key, default)
+        self[key] = default if self[key].nil?
+        self[key]
+      end
+
+      def save(file = @file)
+        File.open(file, 'w') { |f| f.write to_yaml }
+      end
+    end
+  end
+end

data/lib/chatrix/bot/errors.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Chatrix
+  class Bot
+    # General bot error.
+    class BotError < RuntimeError
+    end
+
+    # Error raised while parsing a command.
+    class CommandError < BotError
+    end
+
+    class PermissionError < CommandError
+    end
+  end
+end

data/lib/chatrix/bot/parameter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Chatrix
+  class Bot
+    # Describes a parameter in a command.
+    class Parameter
+      MATCHERS = {
+        normal: /[^\s]+/,
+        quoted: /"(?:\\"|[^"])*?"/,
+        rest: /.+$/
+      }.freeze
+
+      attr_reader :name
+
+      attr_reader :required
+
+      def initialize(name, required, matcher = nil)
+        @name = name
+        @required = required
+        @matcher = matcher || MATCHERS[:normal]
+      end
+
+      def required?
+        required
+      end
+
+      def match(text, matcher = nil)
+        (matcher || @matcher).match text
+      end
+
+      def parse(text, matcher = nil)
+        if required && text.empty?
+          raise CommandError, "Missing required parameter #{name}"
+        end
+
+        return nil if text.empty?
+
+        match = match text.gsub(/^\s+/, '').gsub(/\s+$/, ''), matcher
+
+        return nil unless valid_match? match
+
+        {
+          content: match.to_s,
+          rest: match.post_match.gsub(/^\s+/, '').gsub(/\s+$/, '')
+        }
+      end
+
+      private
+
+      def valid_match?(match)
+        return true unless match.nil?
+        raise CommandError, "Missing required parameter #{name}" if required
+        false
+      end
+    end
+  end
+end

data/lib/chatrix/bot/pattern.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Chatrix
+  class Bot
+    # Describes a pattern used for matching messages.
+    class Pattern
+      attr_reader :pattern
+
+      attr_reader :handler
+
+      def initialize(pattern, handler = nil)
+        @pattern = pattern
+        @handler = handler
+      end
+
+      def match?(text)
+        !match(text).nil?
+      end
+
+      def match(text)
+        @pattern.match text
+      end
+    end
+  end
+end