kybus-bot 0.7.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5c13b85c7bdfcde5cf2aabfa9c07e78a59da781c06d86ca91842605e3467b61
-  data.tar.gz: ef7f22cea28720b25bbbee6930b397b28eb5890e1e470bb66155c691050ed101
+  metadata.gz: c7c076fdf29d45a346d07aa5639349a66cff1a83ed15f0cfbafc4e6d4698cbd9
+  data.tar.gz: 0fa6891cd37efd3a37b87b59e3dc90fd1628384c43863237e70ea6f757f2086a
 SHA512:
-  metadata.gz: c01b8aadc1b567f9181ad731baa7861882ec535482c79c51eb45fee0257ab443ee9fc8857e133eab1b4dd814b725b4170fff2513484a1759f08ed1add74741ad
-  data.tar.gz: e80319c534274c58df1cf58e8794a56c44100ac46c0483e0d7b9a193e612944efbf610dc3b6da24f91648ad764fa45fb8e7503f4a0774c5b1c541e8c41be3b6b
+  metadata.gz: f620f4d3674eb392f61f7a50abf378c1fa2fef5b718a93cf4ec1c340f906b1d924948f374fc0214d817664c26a97e4d5cdfa301c6588ba0c2e30bf5af8d7fb75
+  data.tar.gz: f2b708234bb392bfaf98d75f29720ea081ead5e3ea4cba36a7703abd9dcc7516e8328eb8f2583604c0de819e15c391ba1a7066cb3b74bf4ef39c0713186f6e96

data/lib/kybus/bot/adapters/debug.rb

@@ -11,7 +11,7 @@ module Kybus
       # Wraps a debugging message inside a class.
       class DebugMessage < Kybus::Bot::Message
         # It receives a string with the raw text and the id of the channel
-        attr_reader :attachment
+        attr_reader :attachment, :message_id
 
         class DebugFile
           def initialize(path)
@@ -40,6 +40,9 @@ module Kybus
           @text = text
           @channel = channel
           @attachment = attachment
+          @@message_id ||= 0
+          @@message_id += 1
+          @message_id = @@message_id + 1
         end
 
         # Returns the channel id
@@ -110,6 +113,7 @@ module Kybus
         def answer(message, attachment = nil)
           send_data(message, attachment)
           @state = :open
+          DebugMessage.new(message, @name)
         end
       end
 
@@ -144,8 +148,8 @@ module Kybus
           loop do
             raise NoMoreMessageException if @channels.values.all?(&:empty?)
 
-            msg = @channels.values.find(&:open?)
-            return @last_message = msg.read_message if msg
+            open_channel = @channels.values.find(&:open?)
+            return @last_message = open_channel.read_message if open_channel
           end
         end
 
@@ -155,12 +159,12 @@ module Kybus
         end
 
         # interface for sending messages
-        def send_message(channel_name, contents, attachment = nil)
+        def send_message(contents, channel_name, attachment = nil)
           channel(channel_name).answer(contents, attachment)
         end
 
         # interface for sending video
-        def send_video(channel_name, video_url, caption = nil)
+        def send_video(channel_name, video_url, _caption = nil)
           channel(channel_name).answer("VIDEO: #{video_url}")
         end
 
@@ -170,7 +174,7 @@ module Kybus
         end
 
         # interface for sending image
-        def send_image(channel_name, image_url, caption = nil)
+        def send_image(channel_name, image_url, _caption = nil)
           channel(channel_name).answer("IMG: #{image_url}")
         end
 
@@ -188,6 +192,13 @@ module Kybus
           end
         end
 
+        include Kybus::Logger
+
+        def message_builder(msg)
+          log_info('Building message object', msg:, msg_class: msg.class.name)
+          msg
+        end
+
         def mention(user)
           "@#{user}"
         end

data/lib/kybus/bot/adapters/discord.rb

@@ -80,7 +80,7 @@ module Kybus
         end
 
         # interface for sending messages
-        def send_message(channel_name, contents, caption = nil)
+        def send_message(channel_name, contents, _caption = nil)
           puts "#{channel_name} => #{contents}" if @config['debug']
           channel = @client.channel(channel_name)
           if channel

data/lib/kybus/bot/adapters/telegram.rb

@@ -47,12 +47,12 @@ module Kybus
         end
 
         # interface for sending messages
-        def send_message(channel_name, contents)
+        def send_message(contents, channel_name)
           puts "#{channel_name} => #{contents}" if @config['debug']
-          @client.api.send_message(chat_id: channel_name, text: contents)
+          @client.api.send_message(chat_id: channel_name.to_i, text: contents, parse_mode: @config['parse_mode'])
           # :nocov:
         rescue ::Telegram::Bot::Exceptions::ResponseError => e
-          return if e[:error_code] == '403'
+          return if e.error_code == '403'
         end
         # :nocov:
 
@@ -80,6 +80,10 @@ module Kybus
           @client.api.send_document(chat_id: channel_name, document: file)
         end
 
+        def message_builder(raw_message)
+          TelegramMessage.new(raw_message)
+        end
+
         def file_builder(file)
           TelegramFile.new(file)
         end

data/lib/kybus/bot/adapters/telegram_file.rb

@@ -43,6 +43,10 @@ module Kybus
           meta.dig('result', 'file_name')
         end
 
+        def file_name
+          original_name
+        end
+
         def download
           token = cli.api.token
           file_path = meta.dig('result', 'file_path')

data/lib/kybus/bot/adapters/telegram_message.rb

@@ -17,7 +17,7 @@ module Kybus
         end
 
         def reply?
-          !!@message.reply_to_message
+          @message.respond_to?(:reply_to_message) && @message.reply_to_message
         end
 
         def replied_message
@@ -29,6 +29,10 @@ module Kybus
           @message.chat.id
         end
 
+        def message_id
+          @message.respond_to?(:message_id) ? @message.message_id : @message['result']['message_id']
+        end
+
         # Returns the message contents
         def raw_message
           @message.to_s
@@ -43,7 +47,9 @@ module Kybus
         end
 
         def attachment
-          @message.document || @message.photo&.last || @message.audio
+          (@message.respond_to?(:document) && @message&.document) ||
+            (@message.respond_to?(:photo) && @message.photo&.last) ||
+            (@message.respond_to?(:audio) && @message&.audio)
         end
 
         def user

data/lib/kybus/bot/base.rb

@@ -63,6 +63,10 @@ module Kybus
         end
       end
 
+      def dsl
+        @executor.dsl
+      end
+
       # Starts the bot execution, this is a blocking call.
       def run
         # TODO: Implement an interface for killing the process
@@ -72,6 +76,15 @@ module Kybus
         # :nocov: #
       end
 
+      def redirect(command, *params)
+        @executor.invoke(command, params)
+      end
+
+      def send_message(contents, channel)
+        log_debug('Sending message', contents:, channel:)
+        provider.message_builder(@provider.send_message(contents, channel))
+      end
+
       def register_command(klass, params = [], &block)
         definitions.register_command(klass, params, &block)
       end

data/lib/kybus/bot/command/command.rb

@@ -6,13 +6,21 @@ module Kybus
     # it currently only gets a param list, but it will be extended to a more
     # complex DSL.
     class Command
-      attr_reader :block, :params, :name
+      attr_accessor :name
+      attr_reader :block, :params
 
       # Receives a list of params as symbols and the lambda with the block.
-      def initialize(name, params, &block)
+      def initialize(name, params_config, &block)
         @name = name
-        @params = params
         @block = block
+        case params_config
+        when Array
+          @params = params_config
+          @params_config = {}
+        when Hash
+          @params = params_config.keys
+          @params_config = params_config
+        end
       end
 
       # Checks if the params object given contains all the needed values
@@ -24,6 +32,14 @@ module Kybus
       def next_missing_param(current_params)
         params.find { |key| !current_params.key?(key) }.to_s
       end
+
+      def params_ask_label(param)
+        @params_config[param.to_sym]
+      end
+
+      def params_size
+        @params.size
+      end
     end
   end
 end

data/lib/kybus/bot/command/command_state.rb

@@ -17,7 +17,7 @@ module Kybus
       end
 
       def ready?
-        command.ready?(params)
+        command&.ready?(params)
       end
 
       # validates which is the following parameter required
@@ -66,7 +66,6 @@ module Kybus
         %i[params files].each do |param|
           @data[param] = @data[param].to_json
         end
-
         @data.store
         %i[params files].each do |param|
           @data[param] = backup[param]

data/lib/kybus/bot/command/command_state_factory.rb

@@ -14,8 +14,22 @@ module Kybus
         @definitions = definitions
       end
 
-      def command(name)
-        @definitions[name]
+      def command(search)
+        @definitions.each do |name, command|
+          case name
+          when String
+            return command if name == search
+          when Class
+            return command if search.is_a?(name)
+          when Regexp
+            if search.is_a?(String) && name.match?(search)
+              storable_command = command.clone
+              storable_command.name = search
+              return storable_command
+            end
+          end
+        end
+        nil
       end
 
       def default_command
@@ -28,17 +42,27 @@ module Kybus
 
       def command_with_inline_arg(name_with_arg)
         @definitions.each do |name, command|
-          next unless name.is_a?(String)
-          return [command, name_with_arg.gsub(name, '')] if name_with_arg.start_with?(name)
+          case name
+          when Class
+            return [command, []] if name_with_arg.is_a?(name)
+          when String
+            return [command, name_with_arg.gsub(name, '').split('__')] if name_with_arg.start_with?(name)
+          when Regexp
+            next unless name_with_arg.match?(name)
+
+            storable_command = command.dup
+            storable_command.name = name_with_arg
+            return [storable_command, [name_with_arg]]
+          end
         end
         nil
       end
 
       def load_state(channel)
-        data = factory.get(channel)
-        CommandState.new(data, command_or_default(data[:cmd]))
+        data = factory.get(channel.to_s)
+        CommandState.new(data, command(data[:cmd]))
       rescue Kybus::Storage::Exceptions::ObjectNotFound
-        CommandState.new(factory.create(channel_id: channel, params: '{}'), nil)
+        CommandState.new(factory.create(channel_id: channel.to_s, params: '{}'), nil)
       end
     end
   end

data/lib/kybus/bot/command/execution_context.rb

@@ -17,8 +17,9 @@ module Kybus
 
       def call!(context)
         context.state = state
-        context.instance_eval(&block)
+        statement = context.instance_eval(&block)
         clear_command
+        statement
       end
 
       def initialize(channel_id, channel_factory)
@@ -35,6 +36,10 @@ module Kybus
         state.store_param(param.to_sym, value)
       end
 
+      def expecting_command?
+        state.command.nil?
+      end
+
       def add_file(file)
         param = state.requested_param
         return unless param

data/lib/kybus/bot/command_executor.rb

@@ -22,7 +22,7 @@ module Kybus
       def initialize(bot, channel_factory, inline_args)
         @bot = bot
         @channel_factory = channel_factory
-        @dsl = DSLMethods.new(bot.provider, state)
+        @dsl = DSLMethods.new(bot.provider, state, bot)
         @inline_args = inline_args
         @precommand_hook = proc {}
       end
@@ -32,8 +32,9 @@ module Kybus
       def process_message(message)
         @execution_context = ExecutionContest.new(message.channel_id, @channel_factory)
         save_token!(message)
-        run_command_or_prepare!
+        msg = run_command_or_prepare!
         save_execution_context!
+        msg
       end
 
       def save_param!(message)
@@ -45,18 +46,20 @@ module Kybus
       end
 
       def search_command_with_inline_arg(message)
-        command, value = @channel_factory.command_with_inline_arg(message.raw_message)
+        command, values = @channel_factory.command_with_inline_arg(message.raw_message)
         if command
           execution_context.command = command
-          execution_context.next_param = execution_context.next_missing_param
-          execution_context.add_param(value)
+          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 message.command?
+        if execution_context.expecting_command?
           command = @channel_factory.command(message.command)
           if @inline_args && !command
             search_command_with_inline_arg(message)
@@ -74,9 +77,12 @@ module Kybus
         if execution_context.ready?
           @dsl.state = execution_context.state
           @dsl.instance_eval(&@precommand_hook)
-          run_command!
+          msg = run_command!
+          execution_context.clear_command
+          msg
         else
-          ask_param(execution_context.next_missing_param)
+          param = execution_context.next_missing_param
+          ask_param(param, execution_context.state.command.params_ask_label(param))
         end
       end
 
@@ -85,7 +91,7 @@ module Kybus
       end
 
       def fallback(error)
-        catch = @channel_factory.command(error.class)
+        catch = @channel_factory.command(error)
         log_error('Unexpected error', error)
         execution_context.command = catch if catch
       end
@@ -96,15 +102,28 @@ module Kybus
       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)
+      def ask_param(param, label = nil)
         provider = bot.provider
-        msg = "I need you to tell me #{param}"
-        log_debug(msg)
-        provider.send_message(provider.last_message.channel_id, msg)
+        msg = label || "I need you to tell me #{param}"
+        bot.send_message(msg, provider.last_message.channel_id)
         execution_context.next_param = param
       end
     end

data/lib/kybus/bot/dsl_methods.rb

@@ -6,15 +6,16 @@ module Kybus
       attr_accessor :state
       attr_reader :provider
 
-      def initialize(provider, state)
+      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)
+        @bot.send_message(content, channel || current_channel)
       end
 
       def send_image(content, channel = nil, caption: nil)
@@ -65,6 +66,14 @@ module Kybus
       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/test.rb

@@ -21,12 +21,17 @@ module Kybus
       }.freeze
 
       def self.make_test_bot(extra_configs = {})
-        new(CONFIG.merge(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)
         attachments = Adapter::DebugMessage::DebugFile.new(attachments) if attachments
-        msg = Adapter::DebugMessage.new(msg, 'testing', 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

data/lib/kybus/bot/version.rb

@@ -2,6 +2,6 @@
 
 module Kybus
   module Bot
-    VERSION = '0.7.0'
+    VERSION = '0.8.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kybus-bot
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Gilberto Vargas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kybus-core
@@ -253,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Provides a framework for building bots with ruby