kanal 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45f85bfae55ce0c37d296113ba2af2933667fd3fd7ec9e181ff12dd17105b524
-  data.tar.gz: 9f160009467a4cbf0412d266ae693b279064286ca91ec53e5ad55bb93582d31a
+  metadata.gz: 22224712e17434c60d3b437d44a35a5a997dd739cddcf53eb365d588fdf19fcd
+  data.tar.gz: f6677a4a8bc6eacf2e41469ba4a36da1b324d3b7d9092ae9271aa1b9f3fa8be6
 SHA512:
-  metadata.gz: f4275c770b3607a4617e5413a4634e2436fcb245af8dd3c6d3c5a86b39b64a70020f87ddb4c23323b9fcf3b640fd45bf572992edee3041bb5b918d6989fc79ab
-  data.tar.gz: 9c11421ecd4b230ab8d994b17a016b9e9649c9820ae9ad04503c8bbfa77798fd323fda5249c47cc6bd712d19493a7373d68dbb78fe559f08f53d4a36194776d3
+  metadata.gz: 5e1416fb809513b53627cb120d8b09dfb76cae30f952de0212a1c2edde48e01d733afb122189230d0e6426dba812d143a8b2fc35b8561fba95954ea0b0bccbe2
+  data.tar.gz: 3dcc90d49fa16f4df0482d77a94f3f21a7ddc12742983a8925714199100284bfb4d84a96bef19aa289c3ad1ebcc21996d3a27fb9874837b24ca343ba53f700d6

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 ## [Unreleased]
 
-## [0.3.0]
+## [0.4.1] 2023-03-16
+- Added Attachment that can be used inside new input parameters in Batteries plugin
+- New input and output parameters in Batteries plugin: image, audio, file
+
+## [0.4.0] 2023-03-10
+- Added logging feature to Kanal, for a time being - just stdout
+- Error response, now Kanal Router accepts error response block, when things go haywire inside constructing output
+- Async response available, now developers can utilize respond_async(&block) which will be executed in separate thread
+
+## [0.3.0] - 2023-01-10
 - Kanal::Core::Core.get_plugin method added to get plugins for additional configuration by other plugins or developer code, if needed
 - Kanal::Core::Plugins::Plugin.rake_tasks method introduced, for plugins to have their own rake tasks that can be merged inside
   some kind of parent rake tasks, whether it's users Rakefile or kanal framework/interface or something Rakefile

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kanal (0.3.0)
+    kanal (0.5.0)
 
 GEM
   remote: https://rubygems.org/
@@ -105,4 +105,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.3.12
+   2.3.19

data/kanal.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/kanal/core/conditions/condition.rb

@@ -1,15 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "../logger/logging"
+
 module Kanal
   module Core
     module Conditions
       # Base class for conditions
       # with this class you can
       class Condition
+        include Logging
+
         attr_reader :name
 
         def initialize(name, with_argument: false, &met_block)
           @name = name
 
-          raise "Cannot create condition without block" unless met_block
+          unless met_block
+            logger.fatal "Attempted to create condition #{name} without block"
+
+            raise "Cannot create condition without block"
+          end
 
           @with_argument = with_argument
 

data/lib/kanal/core/conditions/condition_creator.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../logger/logging"
+
 module Kanal
   module Core
     module Conditions
       # This class helps creating conditions in dsl way,
       # with using helper methods
       class ConditionCreator
+        include Logging
+
         def initialize(name)
           @name = name
           @met_block = nil
@@ -11,10 +17,23 @@ module Kanal
         end
 
         def create(&block)
+          logger.info "Attempting to create condition '#{@name}'"
+
           instance_eval(&block)
 
-          raise "Please provide name for condition" unless @name
-          raise "Please provide met? block for condition #{@name}" unless @met_block
+          unless @name
+            logger.fatal "Attempted to create condition without name"
+
+            raise "Please provide name for condition"
+          end
+
+          unless @met_block
+            logger.fatal "Attempted to create condition without met block"
+
+            raise "Please provide met? block for condition #{@name}"
+          end
+
+          logger.info "Creating condition '#{@name}'"
 
           Condition.new @name, with_argument: @with_argument, &@met_block
         end

data/lib/kanal/core/conditions/condition_pack.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require_relative "./condition"
 require_relative "./condition_creator"
+require_relative "../logger/logging"
 
 module Kanal
   module Core
@@ -8,6 +11,8 @@ module Kanal
       # It is served as some kind of namespace for conditions, with specific
       # name of pack and helper methods
       class ConditionPack
+        include Logging
+
         attr_reader :name
 
         def initialize(name)
@@ -18,7 +23,11 @@ module Kanal
         def get_condition_by_name!(name)
           condition = get_condition_by_name name
 
-          raise "Condition #{name} was not found in pack #{@name}. Maybe it was not added?" unless condition
+          unless condition
+            logger.fatal "Attempted to get condition #{name} in pack #{@name}"
+
+            raise "Condition #{name} was not found in pack #{@name}. Maybe it was not added?"
+          end
 
           condition
         end
@@ -28,9 +37,20 @@ module Kanal
         end
 
         def register_condition(condition)
-          raise "Can register only conditions that inherit Condition class" unless condition.is_a? Condition
+          logger.info "Attempting to register condition '#{condition.name}'"
+
+          unless condition.is_a? Condition
+            logger.fatal "Attempted to register condition which isn't of Condition class"
+
+            raise "Can register only conditions that inherit Condition class"
+          end
+
+          if condition_registered? condition
+            logger.warn "Condition '#{condition.name}' already registered"
+            return self
+          end
 
-          return self if condition_registered? condition
+          logger.info "Registering condition '#{condition.name}'"
 
           @conditions.append condition
 

data/lib/kanal/core/conditions/condition_pack_creator.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require_relative "./condition_pack"
 require_relative "./condition_creator"
+require_relative "../logger/logging"
 
 module Kanal
   module Core
@@ -7,6 +10,8 @@ module Kanal
       # This class helps in condition pack creation
       # with the help of dsl
       class ConditionPackCreator
+        include Logging
+
         TEMP_NAME = :temp_name
 
         def initialize(name)
@@ -17,9 +22,19 @@ module Kanal
         def create(&block)
           instance_eval(&block)
 
-          raise "Please provide condition pack name" unless @name
+          unless @name
+            logger.fatal "Attempted to create condition pack without name"
+
+            raise "Please provide condition pack name"
+          end
+
+          if @conditions.empty?
+            logger.fatal "Attempted to create condition pack #{@name} without conditions provided"
+
+            raise "Please provide conditions for condition pack #{@name}"
+          end
 
-          raise "Please provide conditions for condition pack #{@name}" if @conditions.empty?
+          logger.info "Creating condition pack '#{@name}'"
 
           pack = ConditionPack.new(@name)
 

data/lib/kanal/core/conditions/condition_storage.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../logger/logging"
+
 module Kanal
   module Core
     module Conditions
       # This class contains all needed functionality to store,
       # search conditions
       class ConditionStorage
+        include Logging
+
         def initialize
           @condition_packs = []
         end
@@ -11,7 +17,11 @@ module Kanal
         def get_condition_pack_by_name!(name)
           pack = get_condition_pack_by_name name
 
-          raise "Condition pack #{name} is not registered, but was requested from ConditionStorage" unless pack
+          unless pack
+            logger.fatal "Attempted to request unregistered condition pack #{name} from ConditionStorage"
+
+            raise "Condition pack #{name} is not registered, but was requested from ConditionStorage"
+          end
 
           pack
         end
@@ -44,7 +54,13 @@ module Kanal
         def register_condition_pack(pack)
           return if condition_pack_exists? pack
 
-          raise "Condition pack should be descendant of ConditionPack class" unless pack.is_a? ConditionPack
+          unless pack.is_a? ConditionPack
+            logger.fatal "Attempted to register condition pack which isn't of ConditionPack class"
+
+            raise "Condition pack should be descendant of ConditionPack class"
+          end
+
+          logger.info "Registering condition pack '#{pack.name}'"
 
           @condition_packs.append pack
         end

data/lib/kanal/core/core.rb

@@ -8,6 +8,8 @@ require_relative "./helpers/parameter_registrator"
 require_relative "./plugins/plugin"
 require_relative "./input/input"
 require_relative "./services/service_container"
+require_relative "./logger/logging"
+
 
 module Kanal
   module Core
@@ -34,6 +36,7 @@ module Kanal
       include Plugins
       include Hooks
       include Services
+      include Logging
 
       # @return [Kanal::Core::Conditions::ConditionStorage]
       attr_reader :condition_storage
@@ -74,6 +77,8 @@ module Kanal
       #
       def register_plugin(plugin)
         unless plugin.is_a? Plugin
+          logger.fatal "Attempted to register plugin that is not of type Kanal::Core::Plugin or a class that inherits base Plugin class"
+
           raise "Plugin must be of type Kanal::Core::Plugin or be a class that inherits base Plugin class"
         end
 
@@ -82,10 +87,16 @@ module Kanal
           name = plugin.name
 
           # TODO: _log that plugin already registered with such name
-          return if !name.nil? && plugin_registered?(name)
+          if !name.nil? && plugin_registered?(name)
+            logger.warn "Plugin '#{name}' already registered"
+
+            return
+          end
 
           plugin.setup(self)
 
+          logger.info "Registering plugin '#{name}'"
+
           @plugins.append plugin
           # NOTE: Catching here Exception because metho.name can raise ScriptError (derived from Exception)
           # and method .setup can raise ANY type of error.
@@ -101,6 +112,8 @@ module Kanal
           end
 
           # TODO: _log this info in critical error instead of raising exception
+          logger.fatal "There was a problem while registering plugin named: #{name}. Error: `#{e}`."
+
           raise "There was a problem while registering plugin named: #{name}. Error: `#{e}`.
           Remember, plugin errors are often due to .name method not overriden or
           having faulty code inside .setup overriden method"
@@ -153,6 +166,8 @@ module Kanal
       # @return [void] <description>
       #
       def register_input_parameter(name, readonly: false)
+        logger.info "Registering input parameter: '#{name}', readonly: '#{readonly}'"
+
         @input_parameter_registrator.register_parameter name, readonly: readonly
       end
 
@@ -165,6 +180,7 @@ module Kanal
       # @return [void] <description>
       #
       def register_output_parameter(name, readonly: false)
+        logger.info "Registering output parameter: '#{name}', readonly: '#{readonly}'"
         @output_parameter_registrator.register_parameter name, readonly: readonly
       end
 
@@ -179,6 +195,8 @@ module Kanal
       # @return [void] <description>
       #
       def add_condition_pack(name, &block)
+        logger.info "Starting to create condition pack '#{name}'"
+
         creator = ConditionPackCreator.new name
 
         pack = creator.create(&block)

data/lib/kanal/core/helpers/condition_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kanal
   module Core
     module Helpers
@@ -17,8 +19,7 @@ module Kanal
         end
 
         class ConditionFinder
-          def find_by_name(name)
-          end
+          def find_by_name(name); end
         end
       end
     end

data/lib/kanal/core/helpers/parameter_bag_with_registrator.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require_relative "parameter_bag"
+require_relative "../logger/logging"
 
 module Kanal
   module Core
@@ -7,6 +10,8 @@ module Kanal
       # and if they are has needed by registrator allowances, types etc, whatever
       # registrator rules are stored for property
       class ParameterBagWithRegistrator < ParameterBag
+        include Logging
+
         def initialize(registrator)
           super()
           @registrator = registrator
@@ -27,6 +32,9 @@ module Kanal
             value_exists = !get(name).nil?
 
             if value_exists
+              logger.fatal "Parameter #{name} is marked readonly! Attempted to set it's value, but
+              it already has value."
+
               raise "Parameter #{name} is marked readonly! You tried to set it's value, but
               it already has value."
             end
@@ -37,6 +45,8 @@ module Kanal
 
         def validate_parameter_registration(name)
           unless @registrator.parameter_registered? name
+            logger.fatal "Parameter #{name} was not registered! Did you forget to register that parameter?"
+
             raise "Parameter #{name} was not registered! Did you forget to register that parameter?"
           end
         end

data/lib/kanal/core/helpers/parameter_finder_with_method_missing_mixin.rb

@@ -18,18 +18,16 @@ module Kanal
           # input.prop = 123
           if symbol.to_s.include? "="
             @parameter_bag.set parameter_name, args.first
-          else
+          elsif !args.empty?
             # this approach can be used also in dsl
             # like that
             # setters: prop value
             # getters: prop
-            if !args.empty?
-              # means it is used as setter in dsl,
-              # method call with argument
-              @parameter_bag.set(parameter_name, *args)
-            else
-              @parameter_bag.get parameter_name
-            end
+            @parameter_bag.set(parameter_name, *args)
+          # means it is used as setter in dsl,
+          # method call with argument
+          else
+            @parameter_bag.get parameter_name
           end
         end
       end

data/lib/kanal/core/helpers/parameter_registrator.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "../logger/logging"
+
 module Kanal
   module Core
     module Helpers
@@ -17,6 +21,8 @@ module Kanal
       # Class holds parameter names that are allowed
       # to be used.
       class ParameterRegistrator
+        include Logging
+
         def initialize
           @parameters_by_name = {}
         end
@@ -25,7 +31,13 @@ module Kanal
         # be changed. handy for input parameters populated by interface or
         # whatever
         def register_parameter(name, readonly: false)
-          raise "Parameter named #{name} already registered!" if @parameters_by_name.key? name
+          if @parameters_by_name.key? name
+            logger.fatal "Attempted to register already registered parameter '#{name}'"
+
+            raise "Parameter named #{name} already registered!"
+          end
+
+          logger.info "Registering parameter '#{name}'"
 
           registration = ParameterRegistration.new readonly
 

data/lib/kanal/core/helpers/queue.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "../hooks/hook_storage"
+
+module Kanal
+  module Core
+    module Helpers
+      class Queue
+        include Hooks
+
+        attr_reader :hooks
+
+        def initialize
+          @items = []
+          @hooks = HookStorage.new
+          hooks.register(:item_queued) # args arguments: item
+        end
+
+        def enqueue(element)
+          @items.append element
+          @hooks.call :item_queued, element
+        end
+
+        def dequeue
+          @items.shift
+        end
+
+        def empty?
+          @items.empty?
+        end
+
+        def remove(element)
+          @items.delete(element)
+        end
+      end
+    end
+  end
+end

data/lib/kanal/core/helpers/response_block.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Kanal
+  module Core
+    module Helpers
+      class ResponseBlock
+        attr_reader :block
+
+        def initialize(block, async: false)
+          @block = block
+          @async = async
+        end
+
+        def async?
+          @async
+        end
+      end
+    end
+  end
+end

data/lib/kanal/core/helpers/response_execution_block.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "../output/output"
+require_relative "../logger/logging"
+
+module Kanal
+  module Core
+    module Helpers
+      class ResponseExecutionBlock
+        include Output
+        include Logging
+
+        attr_reader :response_block, :input
+
+        def initialize(response_block, input, default_error_node, error_node)
+          @response_block = response_block
+          @input = input
+          @default_error_node = default_error_node
+          @error_node = error_node
+        end
+
+        def execute(core, output_queue)
+          if response_block.async?
+            # NOTE: Thread doesnt just die here - it's execution is continued in output_queue.enqueue in router
+            # then :item_queued hook is called inside and subsequently output_ready_block gets called in this thread
+            # TODO: be aware that this can cause unexpected behaviour. Maybe think how to rework it.
+            Thread.new do
+              output_queue.enqueue construct_output(core)
+            end
+          else
+            output_queue.enqueue construct_output(core)
+          end
+        end
+
+        private
+
+        def construct_output(core)
+          logger.info "Constructing output for input ##{input.__id__}"
+
+          output = Output::Output.new core.output_parameter_registrator, input, core
+
+          begin
+            output.instance_eval(&@response_block.block)
+
+            core.hooks.call :output_before_returned, input, output
+          rescue => e
+            logger.error "Failed to construct output for input ##{input.__id__}. Error: '#{e}'"
+
+            output = Output::Output.new core.output_parameter_registrator, input, core
+
+            error_node = @error_node || @default_error_node
+
+            logger.info "Trying to construct error response for input ##{input.__id__}. Error response is default: #{@error_node.nil?}"
+
+            begin
+              output.instance_eval(&error_node.response_blocks.first.block)
+
+              core.hooks.call :output_before_returned, input, output
+            rescue => e
+              logger.error "Failed to construct error response for input ##{input.__id__}. Error: '#{e}'"
+
+              logger.info "Trying to construct default error response for input ##{input.__id__}"
+
+              output.instance_eval(&@default_error_node.response_blocks.first.block)
+
+              core.hooks.call :output_before_returned, input, output
+            end
+          end
+
+          logger.info "Output ##{output.__id__} for input ##{input.__id__} constructed"
+
+          output
+        end
+      end
+    end
+  end
+end

data/lib/kanal/core/helpers/router_proc_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "method_source"
 
 module Kanal

data/lib/kanal/core/hooks/hook_storage.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../logger/logging"
+
 module Kanal
   module Core
     module Hooks
@@ -8,6 +10,8 @@ module Kanal
       # attaching to hooks, calling hooks with arguments
       #
       class HookStorage
+        include Logging
+
         def initialize
           @listeners = {}
         end
@@ -29,7 +33,12 @@ module Kanal
         # Wondrous world of dynamic languages 🌈🦄
         #
         def register(name)
-          return if hook_exists? name
+          if hook_exists? name
+            logger.warn "Hook '#{name}' already exists"
+            return
+          end
+
+          logger.info "Registering hook '#{name}'"
 
           @listeners[name] = []
         end
@@ -81,9 +90,7 @@ module Kanal
         # @return [void] <description>
         #
         def attach(name, &block)
-          unless hook_exists? name
-            raise "You cannot listen to hook that does not exist! Hook in question: #{name}"
-          end
+          raise "You cannot listen to hook that does not exist! Hook in question: #{name}" unless hook_exists? name
 
           proc_to_lambda_object = Object.new
           proc_to_lambda_object.define_singleton_method(:hook_block, &block)

data/lib/kanal/core/interfaces/interface.rb

@@ -24,6 +24,11 @@ module Kanal
         #
         def initialize(core)
           @core = core
+
+          _this = self
+          @core.router.output_ready do |output|
+            _this.consume_output output
+          end
         end
 
         #
@@ -59,6 +64,14 @@ module Kanal
         def stop
           raise NotImplementedError
         end
+
+        def consume_input(input)
+          @core.router.consume_input input
+        end
+
+        def consume_output(output)
+          raise NotImplementedError
+        end
       end
     end
   end

data/lib/kanal/core/logger/logging.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Kanal
+  module Core
+    module Logging
+      # Logger instance will be saved inside class itself for future calls
+      @logger_instance
+
+      # Mixing in Logger in some class adds possibility to use logger instance method
+      def logger
+        @logger_instance ||= Logging.create_logger self.class.name
+      end
+
+      class << self
+        def create_logger(class_name)
+          logger = Logger.new STDOUT
+          logger.progname = class_name.rpartition(':').last
+          logger.datetime_format = "%d-%m-%Y %H:%M:%S"
+          logger
+        end
+      end
+    end
+  end
+end

data/lib/kanal/core/output/output_creator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kanal
   module Core
     module Output
@@ -8,9 +10,7 @@ module Kanal
           @input = input
         end
 
-        def create(&block)
-          
-        end
+        def create(&block); end
       end
     end
   end

data/lib/kanal/core/plugins/plugin.rb

@@ -31,7 +31,7 @@ module Kanal
 
         #
         # If plugins does have rake tasks available for execution,
-        # require them here. They will be used 
+        # require them here. They will be used
         #
         # @return [Array<Rake::TaskLib>] <description>
         #

data/lib/kanal/core/router/router.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "./router_node"
+require_relative "../helpers/queue"
+require_relative "../helpers/response_execution_block"
+require_relative "../logger/logging"
 
 module Kanal
   module Core
@@ -10,17 +13,50 @@ module Kanal
       # namespace. Basically class router stores all the
       # router nodes and have a name.
       class Router
-        attr_reader :name,
-                    :core
+        include Helpers
+        include Logging
+
+        attr_reader :name, :core, :output_ready_block
 
         def initialize(name, core)
+          logger.info "Initializing"
+
           @name = name
           @core = core
           @root_node = nil
           @default_node = nil
+          @default_error_node = nil
+          default_error_response do
+            if core.plugin_registered? :batteries
+              body "Unfortunately, error happened. Please consider contacting the creator of this bot to provide information about the circumstances of this error."
+            else
+              raise "Error occurred and there is no way to inform end user about it. You can override error response with router.error_response method or register :batteries plugin so default response will populate the .body output parameter"
+            end
+          end
+          @error_node = nil
+          @response_execution_queue = Queue.new
+          @output_queue = Queue.new
+          @output_ready_block = nil
+          @core.hooks.register(:output_ready) # arg
+
+          _this = self
+          _output_queue = @output_queue
+          @output_queue.hooks.attach :item_queued do |output|
+            _this.logger.info "Calling output_ready block for input ##{output.input.__id__} and output #{output.__id__}. Output body is: '#{output.body}'"
+
+            begin
+              _this.output_ready_block.call output
+              _output_queue.remove(output)
+            rescue
+              _output_queue.remove(output)
+              raise "Error in output_ready block!"
+            end
+          end
         end
 
         def configure(&block)
+          logger.info "Configuring"
+
           # Root node does not have parent
           @root_node ||= RouterNode.new router: self, parent: nil, root: true
 
@@ -28,24 +64,56 @@ module Kanal
         end
 
         def default_response(&block)
-          raise "default node for router #{@name} already defined" if @default_node
+          logger.info "Setting default response"
+
+          if @default_node
+            logger.fatal "Attempted to set default_response for a second time"
+
+            raise "default node for router #{@name} already defined"
+          end
 
           @default_node = RouterNode.new parent: nil, router: self, default: true
 
           @default_node.respond(&block)
         end
 
-        # Main method for creating output if it is found or going to default output
-        def create_output_for_input(input)
+        def error_response(&block)
+          raise "error node for router #{@name} already defined" if @error_node
+
+          @error_node = RouterNode.new parent: nil, router: self, error: true
+
+          @error_node.respond(&block)
+        end
+
+        # Main method for creating output(s) if it is found or going to default output
+        def consume_input(input)
+          logger.info "Consuming input #{input.__id__}."
+
           # Checking if default node with output exists throw error if not
-          raise "Please provide default response for router before you try and throw input against it ;)" unless @default_node
+          unless @default_node
+            logger.fatal "Attempted to consume input with no default response set"
+
+            raise "Please provide default response for router before you try and throw input against it ;)"
+          end
+
+          unless @root_node
+            logger.fatal "Attempted to consume input but router is not configured"
 
-          raise "You did not actually .configure router, didn't you? There is no even root node! Use .configure method" unless @root_node
+            raise "You did not actually .configure router, didn't you? There is no even root node! Use .configure method"
+          end
 
           unless @root_node.children?
+            logger.fatal "Attempted to consume input but router does not have any routes"
+
             raise "Hey your router actually does not have ANY routes to work with. Did you even try adding them?"
           end
 
+          unless @output_ready_block
+            logger.fatal "Attempted to consume input but output_ready block is not set"
+
+            raise "You must provide block via .output_ready for router to function properly"
+          end
+
           @core.hooks.call :input_before_router, input
 
           node = test_input_against_router_node input, @root_node
@@ -54,11 +122,31 @@ module Kanal
           # using default response
           node ||= @default_node
 
-          output = node.construct_response input
+          response_blocks = node.response_blocks
+
+          error_node = @error_node || @default_error_node
+
+          response_execution_blocks = response_blocks.map { |rb| ResponseExecutionBlock.new rb, input, @default_error_node, @error_node }
+
+          response_execution_blocks.each do |reb|
+            @response_execution_queue.enqueue reb
+          end
+
+          process_response_execution_queue
+        end
 
-          @core.hooks.call :output_before_returned, input, output
+        def process_response_execution_queue
+          until @response_execution_queue.empty?
+            response_execution = @response_execution_queue.dequeue
 
-          output
+            response_execution.execute core, @output_queue
+          end
+        end
+
+        def output_ready(&block)
+          logger.info "Setting output_ready block"
+
+          @output_ready_block = block
         end
 
         # Recursive method for searching router nodes
@@ -91,6 +179,12 @@ module Kanal
         end
 
         private :test_input_against_router_node
+
+        def default_error_response(&block)
+          @default_error_node = RouterNode.new parent: nil, router: self, error: true
+
+          @default_error_node.respond(&block)
+        end
       end
     end
   end

data/lib/kanal/core/router/router_node.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "../output/output"
+require_relative "../helpers/response_block"
+require_relative "../logger/logging"
 
 module Kanal
   module Core
@@ -11,6 +13,8 @@ module Kanal
       # tree, containing conditions and responses
       class RouterNode
         include Output
+        include Helpers
+        include Logging
 
         attr_reader :parent,
                     :children
@@ -18,13 +22,13 @@ module Kanal
         # parameter default: is for knowing that this node
         # is for default response
         # default response cannot have child nodes
-        def initialize(*args, router:, parent:, default: false, root: false)
+        def initialize(*args, router:, parent:, default: false, root: false, error: false)
           @router = router
           @parent = parent
 
           @children = []
 
-          @response_block = nil
+          @response_blocks = []
 
           @condition_pack_name = nil
           @condition_name = nil
@@ -32,7 +36,7 @@ module Kanal
 
           # We omit setting conditions because default router node does not need any conditions
           # Also root node does not have conditions so we basically omit them if arguments are empty
-          return if default || root
+          return if default || root || error
 
           # With this we attach names of condition pack and condition to this router
           # node, so we will be able to find them later at runtime and use them
@@ -48,24 +52,28 @@ module Kanal
           child.instance_eval(&block)
         end
 
-        def construct_response(input)
-          raise "no response block configured for this node. router: #{@router.name}. debug: #{debug_info}" unless @response_block
+        def response_blocks
+          if @response_blocks.empty?
+            raise "no response block configured for this node. router: #{@router.name}. debug: #{debug_info}"
+          end
 
-          output = Output::Output.new @router.core.output_parameter_registrator, input, @router.core
+          @response_blocks
+        end
 
-          output.instance_eval(&@response_block)
+        def respond(&block)
+          raise "Router node with children cannot have response" unless @children.empty?
 
-          output
+          @response_blocks.append ResponseBlock.new(block)
         end
 
-        def respond(&block)
+        def respond_async(&block)
           raise "Router node with children cannot have response" unless @children.empty?
 
-          @response_block = block
+          @response_blocks.append ResponseBlock.new(block, async: true)
         end
 
         def response?
-          !@response_block.nil?
+          !@response_blocks.empty?
         end
 
         # This method processes args to populate condition and condition pack
@@ -88,6 +96,8 @@ module Kanal
           condition = pack.get_condition_by_name! condition_name
 
           if condition.with_argument? && !@condition_argument
+            logger.fatal "Condition requires argument, but was provided as :symbol, not as positional_arg:"
+
             raise "Condition requires argument, though you wrote it as :symbol, not as positional_arg:
             Please check route with condition pack: #{condition_pack_name} and condition: #{condition_name}"
           end

data/lib/kanal/core/router/router_storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "./router"
 
 module Kanal

data/lib/kanal/core/services/service_container.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "../logger/logging"
+
 module Kanal
   module Core
     module Services
@@ -24,6 +28,8 @@ module Kanal
       # lifespan types.
       #
       class ServiceContainer
+        include Logging
+
         TYPE_SINGLETON = :singleton
         TYPE_TRANSIENT = :transient
 
@@ -45,12 +51,24 @@ module Kanal
         # @return [void] <description>
         #
         def register_service(name, service_class, type: TYPE_SINGLETON, &block)
-          return if @registrations.key? name
+          logger.info "Trying to register service '#{name}'"
 
-          raise "Unrecognized service type #{type}. Allowed types: #{allowed_types}" unless allowed_types.include? type
+          if @registrations.key? name
+            logger.warn "Attempted to register service '#{name}', but it is already registered"
+
+            return
+          end
+
+          unless allowed_types.include? type
+            logger.fatal "Attempted to register service type '#{type}'."
+
+            raise "Unrecognized service type #{type}. Allowed types: #{allowed_types}"
+          end
 
           registration = ServiceRegistration.new service_class, type, block
 
+          logger.info "Registering service '#{name}'"
+
           @registrations[name] = registration
         end
 
@@ -66,14 +84,13 @@ module Kanal
 
           registration = @registrations[name]
 
-          if registration.type == TYPE_SINGLETON
+          case registration.type
+          when TYPE_SINGLETON
             # Created once and reused after creation
-            if @services[name].nil?
-              @services[name] = create_service_from_registration registration
-            end
+            @services[name] = create_service_from_registration registration if @services[name].nil?
 
             @services[name]
-          elsif registration.type == TYPE_TRANSIENT
+          when TYPE_TRANSIENT
             # Created every time
             create_service_from_registration registration
           end

data/lib/kanal/plugins/batteries/attachments/attachment.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "uri"
+require 'open-uri'
+
+module Kanal
+  module Plugins
+    module Batteries
+      module Attachments
+        class Attachment
+          attr_reader :url
+
+          def initialize(url)
+            @url = url
+          end
+
+          def audio?
+            mp3? || wav? || ogg?
+          end
+
+          def mp3?
+            extension == "mp3"
+          end
+
+          def wav?
+            extension == "wav"
+          end
+
+          def ogg?
+            extension == "ogg"
+          end
+
+          def document?
+            doc? || docx? || odf?
+          end
+
+          def doc?
+            extension == "doc"
+          end
+
+          def docx?
+            extension == "docx"
+          end
+
+          def odf?
+            extension == "odf"
+          end
+
+          def image?
+            jpg? || jpeg? || png? || bpm? || gif?
+          end
+
+          def jpg?
+            extension == "jpg"
+          end
+
+          def jpeg?
+            extension == "jpeg"
+          end
+
+          def png?
+            extension == "png"
+          end
+
+          def bpm?
+            extension == "bpm"
+          end
+
+          def gif?
+            extension == "gif"
+          end
+
+          def video?
+            mp4? || mov? || mkv?
+          end
+
+          def mp4?
+            extension == "mp4"
+          end
+
+          def mov?
+            extension == "mov"
+          end
+
+          def mkv?
+            extension == "mkv"
+          end
+
+          #
+          # Method that returns extension of url file if possible
+          # For example calling extension https://123.txt?something=1 will return 'txt'
+          #
+          # @return [String, nil]
+          #
+          def extension
+            uri = URI.parse(@url)
+            return nil if uri.path.nil?
+
+            File.extname(uri.path).split(".").last if File.basename(uri.path).include? "."
+          end
+
+          #
+          # Saves file to specified path. End user provides full filepath.
+          #
+          # @param [String] <Full filepath>
+          # @param [Boolean] <Should directories be created or not>
+          #
+          # @return [void]
+          #
+          def save(filepath, create_dirs = false)
+            stream = URI.open(@url)
+
+            save_stream_to_file stream, filepath, create_dirs
+          end
+
+          #
+          # Saves file. End user provides directory only. Filename gets generated, extension is read from url.
+          #
+          # @param [String] <Directory>
+          # @param [Boolean] <Should directories be created or not>
+          # @param [Integer] <Length of filename to generate>
+          #
+          # @return [String] Full filepath to saved file
+          #
+          def quick_save(directory, create_dir = false, filename_length = 32)
+            filename = generate_filename filename_length, extension
+
+            return quick_save directory, create_dir, filename_length if File.exist? filename
+
+            save directory + filename, create_dir
+
+            directory + filename
+          end
+
+          private
+
+          def generate_filename(filename_length, extension = nil)
+            alphanumeric = "abcdefghijkmnopQRSTUVWNXYZW12345676789-".chars
+
+            name = ""
+
+            filename_length.times do
+              name += alphanumeric.sample
+            end
+
+            extension ? "#{name}.#{extension}" : name
+          end
+
+          def save_stream_to_file(stream, filepath, create_dirs)
+            raise "File with that name already exists!" if File.exist? filepath
+
+            if create_dirs == true
+              FileUtils.mkdir_p(File.dirname(filepath)) unless File.directory?(File.dirname(filepath))
+            end
+
+            IO.copy_stream stream, filepath
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kanal/plugins/batteries/batteries_plugin.rb

@@ -16,6 +16,8 @@ module Kanal
           source_batteries core
           body_batteries core
           flow_batteries core
+          attachments_batteries core
+          reply_markup_batteries core
         end
 
         def flow_batteries(core)
@@ -110,6 +112,20 @@ module Kanal
             end
           end
         end
+
+        def attachments_batteries(core)
+          core.register_input_parameter :image
+          core.register_input_parameter :audio
+          core.register_input_parameter :file
+
+          core.register_output_parameter :image
+          core.register_output_parameter :audio
+          core.register_output_parameter :file
+        end
+
+        def reply_markup_batteries(core)
+          core.register_output_parameter :reply_markup
+        end
       end
     end
   end

data/lib/kanal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kanal
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanal
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - idchlife
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-29 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies: []
 description: Thanks to the core library, ecosystem of Kanal tools can be extendted
   to use with input-output bot-like behaviour, with routing
@@ -42,11 +42,14 @@ files:
 - lib/kanal/core/helpers/parameter_bag_with_registrator.rb
 - lib/kanal/core/helpers/parameter_finder_with_method_missing_mixin.rb
 - lib/kanal/core/helpers/parameter_registrator.rb
+- lib/kanal/core/helpers/queue.rb
+- lib/kanal/core/helpers/response_block.rb
+- lib/kanal/core/helpers/response_execution_block.rb
 - lib/kanal/core/helpers/router_proc_parser.rb
 - lib/kanal/core/hooks/hook_storage.rb
 - lib/kanal/core/input/input.rb
 - lib/kanal/core/interfaces/interface.rb
-- lib/kanal/core/logger/logger.rb
+- lib/kanal/core/logger/logging.rb
 - lib/kanal/core/output/output.rb
 - lib/kanal/core/output/output_creator.rb
 - lib/kanal/core/plugins/plugin.rb
@@ -55,6 +58,7 @@ files:
 - lib/kanal/core/router/router_storage.rb
 - lib/kanal/core/services/service_container.rb
 - lib/kanal/interfaces/simple_cli/simple_cli_interface.rb
+- lib/kanal/plugins/batteries/attachments/attachment.rb
 - lib/kanal/plugins/batteries/batteries_plugin.rb
 - lib/kanal/version.rb
 - sig/kanal.rbs
@@ -68,6 +72,7 @@ metadata:
   homepage_uri: https://idchlife.github.io/kanal-documentation/
   source_code_uri: https://github.com/idchlife/kanal
   changelog_uri: https://github.com/idchlife/kanal/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/kanal/core/logger/logger.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "logger"
-
-module Kanal
-  module Core
-    module Logger
-      class Logger < ::Logger
-      end
-    end
-  end
-end