kybus-bot 0.5.1 → 0.8.1

data/lib/kybus/bot/command_executor.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative 'command/command'
+require_relative 'command/command_definition'
+require_relative 'command/execution_context'
+
+module Kybus
+  module Bot
+    class CommandExecutor
+      extend Forwardable
+
+      include Kybus::Logger
+      attr_reader :dsl, :bot, :execution_context
+
+      def_delegator :execution_context, :save!, :save_execution_context!
+
+      def state
+        execution_context&.state
+      end
+
+      def initialize(bot, channel_factory, inline_args)
+        @bot = bot
+        @channel_factory = channel_factory
+        @dsl = DSLMethods.new(bot.provider, state, bot)
+        @inline_args = inline_args
+        @precommand_hook = proc {}
+      end
+
+      # Process a single message, this method can be overwriten to enable
+      # more complex implementations of commands. It receives a message object.
+      def process_message(message)
+        @execution_context = ExecutionContest.new(message.channel_id, @channel_factory)
+        save_token!(message)
+        msg = run_command_or_prepare!
+        save_execution_context!
+        msg
+      end
+
+      def save_param!(message)
+        execution_context.add_param(message.raw_message)
+        return unless message.has_attachment?
+
+        file = bot.provider.file_builder(message.attachment)
+        execution_context.add_file(file)
+      end
+
+      def search_command_with_inline_arg(message)
+        command, values = @channel_factory.command_with_inline_arg(message.raw_message)
+        if command
+          execution_context.command = command
+          values.each do |value|
+            execution_context.next_param = execution_context.next_missing_param
+            execution_context.add_param(value)
+          end
+        else
+          execution_context.command = @channel_factory.default_command
+        end
+      end
+
+      def save_token!(message)
+        if execution_context.expecting_command?
+          command = @channel_factory.command(message.command)
+          if @inline_args && !command
+            search_command_with_inline_arg(message)
+          elsif !@inline_args && !command
+            execution_context.command = @channel_factory.default_command
+          else
+            execution_context.command = command
+          end
+        else
+          save_param!(message)
+        end
+      end
+
+      def run_command_or_prepare!
+        if execution_context.ready?
+          @dsl.state = execution_context.state
+          @dsl.instance_eval(&@precommand_hook)
+          msg = run_command!
+          execution_context.clear_command
+          msg
+        else
+          param = execution_context.next_missing_param
+          ask_param(param, execution_context.state.command.params_ask_label(param))
+        end
+      end
+
+      def precommand_hook(&block)
+        @precommand_hook = proc(&block)
+      end
+
+      def fallback(error)
+        catch = @channel_factory.command(error)
+        log_error('Unexpected error', error)
+        execution_context.command = catch if catch
+      end
+
+      # Method for triggering command
+      def run_command!
+        execution_context.call!(@dsl)
+      rescue StandardError => e
+        raise unless fallback(e)
+
+        execution_context.state.store_param(:_last_exception, e)
+        retry
+      end
+
+      def invoke(command_name, args)
+        command = @channel_factory.command(command_name)
+        if command.nil? || command.params_size != args.size
+          raise "Wrong redirect #{command_name}, #{bot.registered_commands}"
+        end
+
+        state.command = command
+        command.params.zip(args).each do |param, value|
+          state.store_param(param, value)
+        end
+        run_command_or_prepare!
+      end
+
+      # Sends a message to get the next parameter from the user
+      def ask_param(param, label = nil)
+        provider = bot.provider
+        msg = label || "I need you to tell me #{param}"
+        bot.send_message(provider.last_message.channel_id, msg)
+        execution_context.next_param = param
+      end
+    end
+  end
+end

data/lib/kybus/bot/dsl_methods.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Kybus
+  module Bot
+    class DSLMethods
+      attr_accessor :state
+      attr_reader :provider
+
+      def initialize(provider, state, bot)
+        @provider = provider
+        @state = state
+        @bot = bot
+      end
+
+      def send_message(content, channel = nil)
+        raise(Base::EmptyMessageError) unless content
+
+        provider.send_message(channel || current_channel, content)
+      end
+
+      def send_image(content, channel = nil, caption: nil)
+        provider.send_image(channel || current_channel, content, caption)
+      end
+
+      def send_video(content, channel = nil, caption: nil)
+        provider.send_video(channel || current_channel, content, caption)
+      end
+
+      def send_audio(content, channel = nil)
+        provider.send_audio(channel || current_channel, content)
+      end
+
+      def send_document(content, channel = nil)
+        provider.send_document(channel || current_channel, content)
+      end
+
+      def params
+        state.params
+      end
+
+      def files
+        state.files
+      end
+
+      def file(name)
+        (file = files[name]) && provider.file_builder(file)
+      end
+
+      def mention(name)
+        provider.mention(name)
+      end
+
+      def current_user
+        provider.last_message.user
+      end
+
+      def is_private?
+        provider.last_message.is_private?
+      end
+
+      def last_message
+        provider.last_message
+      end
+
+      # returns the current_channel from where the message was sent
+      def current_channel
+        state.channel_id
+      end
+
+      def command_name
+        state&.command&.name
+      end
+
+      def method_missing(method, *args, &block)
+        @bot.send(method, *args, &block)
+      end
+    end
+  end
+end

data/lib/kybus/bot/message.rb

@@ -8,17 +8,14 @@ module Kybus
     # Base implementation for messages from distinct providers
     class Message
       # Converts the messages into a hash
-      def to_h
-        {
-          text: raw_message,
-          channel: channel_id
-        }
-      end
-
       # Returns true when the received message is a command. Convention states
       # that messages should start with '/' to be considered commands
       def command?
-        raw_message&.split(' ')&.first&.start_with?('/')
+        command&.start_with?('/')
+      end
+
+      def command
+        raw_message&.split(' ')&.first
       end
     end
   end

data/lib/kybus/bot/test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 require_relative 'adapters/debug'
 
@@ -13,19 +15,29 @@ module Kybus
         'pool_size' => 1,
         'provider' => {
           'name' => 'debug',
-          'echo' => true,
+          'echo' => false,
           'channels' => { 'testing' => [] }
         }
       }.freeze
 
-      def self.make_test_bot
-        new(CONFIG)
+      def self.make_test_bot(extra_configs = {})
+        conf = CONFIG.merge(extra_configs)
+        conf['provider']['channels'] = { conf['channel_id'] => [] } if conf['channel_id']
+        bot = new(conf)
+        bot.instance_variable_set(:@default_channel_id, conf['provider']['channels'].keys.first)
+        bot
       end
 
       def receives(msg, attachments = nil)
-        msg = ::Kybus::Bot::Adapter::DebugMessage.new(msg, 'testing', attachments)
-        @last_message = msg
-        process_message(msg)
+        attachments = Adapter::DebugMessage::DebugFile.new(attachments) if attachments
+        msg = Adapter::DebugMessage.new(msg, @default_channel_id, attachments)
+        log_info('Received message', channel: @default_channel_id, msg:)
+        provider.last_message = msg
+        executor.process_message(msg)
+      end
+
+      def expects(method)
+        executor.dsl.expects(method)
       end
     end
   end

data/lib/kybus/bot/version.rb

@@ -2,6 +2,6 @@
 
 module Kybus
   module Bot
-    VERSION = '0.5.1'
+    VERSION = '0.8.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kybus-bot
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Gilberto Vargas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-16 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kybus-core
@@ -218,8 +218,16 @@ files:
 - lib/kybus/bot/adapters/debug.rb
 - lib/kybus/bot/adapters/discord.rb
 - lib/kybus/bot/adapters/telegram.rb
+- lib/kybus/bot/adapters/telegram_file.rb
+- lib/kybus/bot/adapters/telegram_message.rb
 - lib/kybus/bot/base.rb
-- lib/kybus/bot/command_definition.rb
+- lib/kybus/bot/command/command.rb
+- lib/kybus/bot/command/command_definition.rb
+- lib/kybus/bot/command/command_state.rb
+- lib/kybus/bot/command/command_state_factory.rb
+- lib/kybus/bot/command/execution_context.rb
+- lib/kybus/bot/command_executor.rb
+- lib/kybus/bot/dsl_methods.rb
 - lib/kybus/bot/message.rb
 - lib/kybus/bot/migrator.rb
 - lib/kybus/bot/test.rb
@@ -228,7 +236,8 @@ files:
 homepage: https://github.com/tachomex/kybus
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -244,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Provides a framework for building bots with ruby