kanal 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 103821024c6f83e5b37cdbfd488fef5c1b33424604b1d089478b26f585a70f77
-  data.tar.gz: 05ef0a2d55f73134e7a84613e7f65ceb44c253aa1808e22ea7e5acc1e8907824
+  metadata.gz: af8a33084b0e457be1bd9538405b4c885d624d71c67581dc1393474037e9c09b
+  data.tar.gz: 2ffae451a04fb4cd5c13079b8bbabcf14b2298fe3bbce681710409fc8da74c5f
 SHA512:
-  metadata.gz: 0c04a428a1f6275b06e6b2d9a49bddfa33be0a2f1ca871b4242d26b98b8f01cca563e8c184a587ce84e3961773fb27055a330a6f3dd83c0b9f417452807a1528
-  data.tar.gz: efc4734c9c5e700b3a35cda943c86b6361e8be1d037d8e2390fe10cb95b24d826fe8f639bc376692eea4c6f77ea34683144b12bbdaaaf332d7497a907467b3b1
+  metadata.gz: '0844b50cab451ba9eb5fd2632d2cdab50e8b8260e1a120697a637772be613fbc5cb9504e60c42acf131cc9ad9e84b167e768363b53255bd1b9a4ff172616b9d2'
+  data.tar.gz: 3efa7140827918ebc21c954bec87f57bd7dd57d2b3475d8be8ad065660af73cb7d7651cc0d7715f39a07a66accf8f4671707716c98e744eec50bfef9340396e6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.6.0] 2023-04-24
+- .composite_logger method for core now gives possibility to take that logger and provide it as ruby logger somewhere in the other library (usually to flow some libraries used in your kanal app logs into the kanal logs to have logs in the same place)
+- you can now get beautified router info in string format for debug purpose via router.routes_info_string method
+- better error handling in block specified for .output_ready
+- moved many logs from level INFO level to DEBUG to stop logs overflow of inner machinery when you just want to know some info
+
 ## [0.5.0] 2023-04-14
 - new router method: `provide_output(output)` for providing output directly to consumer of `.output_ready(&block)` avoiding router and final output hook `:output_before_returned`
 - new router method: `provide_output_with_input(output, input)` for providing output to consumer of `.output_ready(&block)` avoiding router but applying all hooks attached to the `:output_before_returned` (usually plugins attach to this hook to convert/transform output properties)

data/Gemfile

@@ -22,5 +22,6 @@ group :development do
 end
 
 group :test do
+  gem "httparty", "0.21.0"
   gem "simplecov", require: false
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kanal (0.5.1)
+    kanal (0.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -12,13 +12,18 @@ GEM
     diff-lcs (1.5.0)
     docile (1.4.0)
     e2mmap (0.1.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
     jaro_winkler (1.5.4)
     json (2.6.3)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
+    mini_mime (1.1.2)
     mini_portile2 (2.8.1)
+    multi_xml (0.6.0)
     nokogiri (1.14.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
@@ -95,6 +100,7 @@ PLATFORMS
   x86_64-darwin-21
 
 DEPENDENCIES
+  httparty (= 0.21.0)
   kanal!
   rake (~> 13.0)
   rspec (~> 3.0)
@@ -105,4 +111,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.4.9
+   2.4.5

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

@@ -17,7 +17,7 @@ module Kanal
         end
 
         def create(&block)
-          logger.info "Attempting to create condition '#{@name}'"
+          logger.debug "Attempting to create condition '#{@name}'"
 
           instance_eval(&block)
 
@@ -33,7 +33,7 @@ module Kanal
             raise "Please provide met? block for condition #{@name}"
           end
 
-          logger.info "Creating condition '#{@name}'"
+          logger.debug "Creating condition '#{@name}'"
 
           Condition.new @name, with_argument: @with_argument, &@met_block
         end

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

@@ -37,7 +37,7 @@ module Kanal
         end
 
         def register_condition(condition)
-          logger.info "Attempting to register condition '#{condition.name}'"
+          logger.debug "Attempting to register condition '#{condition.name}'"
 
           unless condition.is_a? Condition
             logger.fatal "Attempted to register condition which isn't of Condition class"
@@ -50,7 +50,7 @@ module Kanal
             return self
           end
 
-          logger.info "Registering condition '#{condition.name}'"
+          logger.debug "Registering condition '#{condition.name}'"
 
           @conditions.append condition
 

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

@@ -34,7 +34,7 @@ module Kanal
             raise "Please provide conditions for condition pack #{@name}"
           end
 
-          logger.info "Creating condition pack '#{@name}'"
+          logger.debug "Creating condition pack '#{@name}'"
 
           pack = ConditionPack.new(@name)
 

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

@@ -60,7 +60,7 @@ module Kanal
             raise "Condition pack should be descendant of ConditionPack class"
           end
 
-          logger.info "Registering condition pack '#{pack.name}'"
+          logger.debug "Registering condition pack '#{pack.name}'"
 
           @condition_packs.append pack
         end

data/lib/kanal/core/core.rb

@@ -67,6 +67,18 @@ module Kanal
         @services = ServiceContainer.new
       end
 
+      #
+      # This method provides access to composite logger in core.
+      # You can use it as a regular logger in your app to feed logs from external libraries into log rotation of Kanal.
+      # Example:
+      # HTTParty.get 'http://google.com', logger: core.composite_logger
+      #
+      # @return [Kanal::Core::Logging::CompositeLogger] <description>
+      #
+      def composite_logger
+        logger
+      end
+
       #
       # Method for registering plugins. Plugins should be of type
       # Kanal::Core::Plugins::Plugin. Meaning that any dervied types
@@ -167,7 +179,7 @@ module Kanal
       # @return [void] <description>
       #
       def register_input_parameter(name, readonly: false)
-        logger.info "Registering input parameter: '#{name}', readonly: '#{readonly}'"
+        logger.debug "Registering input parameter: '#{name}', readonly: '#{readonly}'"
 
         @input_parameter_registrator.register_parameter name, readonly: readonly
       end
@@ -181,7 +193,7 @@ module Kanal
       # @return [void] <description>
       #
       def register_output_parameter(name, readonly: false)
-        logger.info "Registering output parameter: '#{name}', readonly: '#{readonly}'"
+        logger.debug "Registering output parameter: '#{name}', readonly: '#{readonly}'"
         @output_parameter_registrator.register_parameter name, readonly: readonly
       end
 
@@ -196,7 +208,7 @@ module Kanal
       # @return [void] <description>
       #
       def add_condition_pack(name, &block)
-        logger.info "Starting to create condition pack '#{name}'"
+        logger.debug "Starting to create condition pack '#{name}'"
 
         creator = ConditionPackCreator.new name
 

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

@@ -37,7 +37,7 @@ module Kanal
             raise "Parameter named #{name} already registered!"
           end
 
-          logger.info "Registering parameter '#{name}'"
+          logger.debug "Registering parameter '#{name}'"
 
           registration = ParameterRegistration.new readonly
 

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

@@ -36,7 +36,7 @@ module Kanal
         private
 
         def construct_output(core)
-          logger.info "Constructing output for input ##{input.__id__}"
+          logger.debug "Constructing output for input ##{input.__id__}"
 
           output = Output::Output.new core.output_parameter_registrator, @input, core
 
@@ -51,20 +51,20 @@ module Kanal
 
             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?}"
+            logger.debug "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)
             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__}"
+              logger.debug "Trying to construct default error response for input ##{input.__id__}"
 
               output.instance_eval(&@default_error_node.response_blocks.first.block)
             end
           end
 
-          logger.info "Output ##{output.__id__} for input ##{input.__id__} constructed"
+          logger.debug "Output ##{output.__id__} for input ##{input.__id__} constructed"
 
           output
         end

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

@@ -38,7 +38,7 @@ module Kanal
             return
           end
 
-          logger.info "Registering hook '#{name}'"
+          logger.debug "Registering hook '#{name}'"
 
           @listeners[name] = []
         end
@@ -67,7 +67,7 @@ module Kanal
             l.method(:hook_block).call(*args)
           end
         rescue RuntimeError => e
-          raise "There was a problem with calling hooks #{name}. Args: #{args}. More info: #{e}"
+          raise "There was a problem with calling hook #{name}. More info: #{e.full_message}"
         end
 
         #

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

@@ -1,40 +1,68 @@
 # frozen_string_literal: true
 
+require "logger"
+
 module Kanal
   module Core
     module Logging
-      class CompositeLogger
+      #
+      # Object of this class us used to store and use several loggers.
+      # It inherits from standard Logger and overrides it's methods for accepting messages for every possible log level.
+      # Calling #debug (or any other loglevel) on this object results in calling #debug for every logger that it stores.
+      #
+      class CompositeLogger < ::Logger
         # Property allowed_methods defines which methods can be called.
         # These methods mirror standard Logger methods.
         def initialize
           @loggers = []
-          @allowed_methods = [:debug, :info, :warn, :error, :fatal, :unknown]
         end
 
         def add_logger(logger)
           @loggers << logger
         end
 
-        # This method gets called when calling any method in @allowed_methods.
-        # It passes message string to method call of every added logger.
-        #
-        # @param method [Symbol]
-        # @param message [String]
-        def method_missing(method, message)
-          # Getting caller class name to put into log message later.
+        def debug(message)
+          feed_message_to_loggers :debug, caller_class_name(caller.first), message
+        end
+
+        def info(message)
+          feed_message_to_loggers :info, caller_class_name(caller.first), message
+        end
+
+        def warn(message)
+          feed_message_to_loggers :warn, caller_class_name(caller.first), message
+        end
+
+        def error(message)
+          feed_message_to_loggers :error, caller_class_name(caller.first), message
+        end
+
+        def fatal(message)
+          feed_message_to_loggers :fatal, caller_class_name(caller.first), message
+        end
+
+        def unknown(message)
+          feed_message_to_loggers :unknown, caller_class_name(caller.first), message
+        end
+
+        private
+
+        def caller_class_name(caller)
           begin
-            caller_class_name = "[" + caller[0].split(".rb").first.split("/").last.split('_').collect(&:capitalize).join + "]"
+            caller_class_name = "[" + caller.split(".rb").first.split("/").last.split('_').collect(&:capitalize).join + "]"
           rescue
             caller_class_name = "[ErrorGettingClassName]"
           end
 
-          raise "Wrong method called for CompositeLogger" unless @allowed_methods.include? method
+          caller_class_name
+        end
 
+        def feed_message_to_loggers(method_name, caller_class_name, message)
           @loggers.each do |logger|
             # progname is a property of standard Logger. It is a prefix for log message.
             # In our case progname is used to store class name of class which calls for CompositeLogger methods.
             logger.progname = caller_class_name
-            logger.send method, message
+            logger.send method_name, message
           end
         end
       end

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

@@ -46,21 +46,21 @@ module Kanal
           # forward in the workflow: apply hooks in :output_before_ready and pass it to
           # the end consumer which uses .output_ready(&block)
           @input_output_pair_queue.hooks.attach :item_queued do |input_output_pair|
-            _this.logger.info "Calling output_ready block for input ##{input_output_pair.input.__id__} and output #{input_output_pair.output.__id__}. Output body is: '#{input_output_pair.output.body}'"
+            _this.logger.debug "Calling output_ready block for input ##{input_output_pair.input.__id__} and output #{input_output_pair.output.__id__}. Output body is: '#{input_output_pair.output.body}'"
 
             begin
               _this.core.hooks.call :output_before_returned, input_output_pair.input, input_output_pair.output
             rescue => e
-              logger.error "Error during output_before_returned call: #{e}"
+              _this.logger.error "Problem with some hooks inside :output_before_returned. More info: #{e.full_message}"
               return
             end
 
             begin
               _this.output_ready_block.call input_output_pair.output
               _input_output_pair_queue.remove(input_output_pair)
-            rescue
+            rescue => e
               _input_output_pair_queue.remove(input_output_pair)
-              raise "Error in output_ready block!"
+              _this.logger.error "Problem occurred in block provided in .output_ready(&block), here is more info: #{e.full_message}"
             end
           end
         end
@@ -137,7 +137,7 @@ module Kanal
 
         # 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__}."
+          logger.debug "Consuming input #{input.__id__}."
 
           # Checking if default node with output exists throw error if not
           unless @default_node
@@ -228,6 +228,19 @@ module Kanal
           end
         end
 
+        def routes_info_string
+          error_and_default_response_data = "Router Debug Info:
+
+Default response: #{variable_defined @default_node}
+Error response: #{variable_defined @error_node}
+
+Routes:
+"
+          router_data = get_data @root_node
+
+          error_and_default_response_data + router_data
+        end
+
         private :test_input_against_router_node
 
         def default_error_response(&block)
@@ -235,6 +248,38 @@ module Kanal
 
           @default_error_node.respond(&block)
         end
+
+        def get_data(node, depth = 0)
+          if node != @root_node
+            data = get_node_data_string node
+          else
+            data = ""
+          end
+
+          if node.children?
+            node.children.each do |c|
+              c.children? ? symbol = "↳ " : symbol = "⏺ "
+
+              data = data + ("  " * depth) + symbol + get_data(c, depth + 1)
+            end
+          end
+
+          data
+        end
+
+        def variable_defined(variable)
+          variable.nil? ? "not defined" : "defined"
+        end
+
+        def get_node_data_string(node)
+          data = "on :#{node.instance_variable_get(:@condition_pack_name)}, #{node.instance_variable_get(:@condition_name)}: #{node.instance_variable_get(:@condition_argument)}"
+
+          data = data + ", responses_total: #{node.instance_variable_get(:@response_blocks).count}" if node.instance_variable_get(:@response_blocks).count > 0
+
+          data = data + "
+"
+          data
+        end
       end
     end
   end

data/lib/kanal/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanal
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - idchlife
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-15 00:00:00.000000000 Z
+date: 2023-04-24 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