kanal 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a651f7ffee3a091afafa59e96d5c4e90d3f15ebd8fe5c0991ef0f3d25559cb5
-  data.tar.gz: 80a337f6047a542982f5167a1a15c73a9df90ffa95d6d24dc07bba881a4f575e
+  metadata.gz: 17fda67309b135e40e75787a8b2aba0908259bf25b55f3da4ad7170082090745
+  data.tar.gz: 0f751de312d93913c2f81e3b69eaee000359fa01327c873c64a128e46d88286c
 SHA512:
-  metadata.gz: 69b67d9f7886722abe0cc0b8ba27e30daecde925a275e3147b38c5b80bb1b9d041d1acdd33151be97c8e4a668888fbcf1819192dceb763e52104bfaa97a56ce4
-  data.tar.gz: fb12441c0c5797397cbc40e4517cc23c6a70c6604a0314961d4c9b203c02130464baefda7c6671cd31733112d4f131076de3d92482d695f10b7898c7b5c7b2c8
+  metadata.gz: 8523d9eeed98f12107d9550cdc6e823707df37a817ed055229fa7b4b45c12d99e2786e83e1fd3be74acf98e4c01d2312aab37fa86f52869b7583ad3885c1def2
+  data.tar.gz: aa2272b6afcbf4f1dc655c7ed91e57df4caa0e046e4e420c0ddb5985d6cc7b470d05aa3bf372b656004aa5519e1071307d9de84ac1c4e0d6dfb4fe43a70ac6b4

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [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)
+- internal: output hook :output_before_returned is executed after it was enqueued into the output_input_pair_queue. Meaning hook executed not right after processing respond blocks and creating output, but after it was enqueued to the queue which purpose is to ship output further into the `.output_ready(&block)` consumer. It was done so router public method `.provide_output_with_input(output, input)` was possible (avoiding router but not end hook)
+
+## [0.4.3] 2023-03-30
+- New condition for button pressed
+- Input property button_pressed
+
 ## [0.4.2] 2023-03-22
 - Adding any number of loggers can be now done with core.add_logger(l) - where l is logger that have same methods as default ruby logger (debug, warn, fatal, etc)
 - To get logger into your class you can include Kanal::Core::Logging::Logger - this will give you method .logger to get logger

data/Gemfile.lock

@@ -1,94 +1,94 @@
 PATH
   remote: .
   specs:
-    kanal (0.4.2)
+    kanal (0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     backport (1.2.0)
-    benchmark (0.2.0)
+    benchmark (0.2.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
     e2mmap (0.1.0)
     jaro_winkler (1.5.4)
-    json (2.6.2)
+    json (2.6.3)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    mini_portile2 (2.8.0)
-    nokogiri (1.13.8)
+    mini_portile2 (2.8.1)
+    nokogiri (1.14.3)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.8-x86_64-darwin)
+    nokogiri (1.14.3-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
-    racc (1.6.0)
+    racc (1.6.2)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    rbs (2.8.4)
+    regexp_parser (2.7.0)
     reverse_markdown (2.1.1)
       nokogiri
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.33.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.19.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.19.1)
-      parser (>= 3.1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
     ruby-debug-ide (0.7.3)
       rake (>= 0.8.1)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    solargraph (0.45.0)
+    solargraph (0.49.0)
       backport (~> 1.2)
       benchmark
-      bundler (>= 1.17.2)
+      bundler (~> 2.0)
       diff-lcs (~> 1.4)
       e2mmap
       jaro_winkler (~> 1.5)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
       parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
     thor (1.2.1)
-    tilt (2.0.11)
-    unicode-display_width (2.2.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    tilt (2.1.0)
+    unicode-display_width (2.4.2)
+    yard (0.9.33)
 
 PLATFORMS
   ruby
@@ -105,4 +105,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.3.19
+   2.4.5

data/README.md

@@ -1,18 +1,142 @@
-# Kanal
 
-Welcome to kanal!
+# Kanal
 
-TODO: Delete this and the text above, and describe your gem
+Welcome to Kanal!
+
+Kanal is a platform to create chat-bots with it's own DSL. As a key feature Kanal provides router which is configured by you, the developer. Configuration of router implies setting specific responses to specific inputs. Router can consume input (text, images, audio, files) and prepare response (or several responses) to it to be processed further. Configured router defines chat-bot's communication logic that can be used by different types of chat-platforms (Telegram, Discord, etc.)
+
+Core functionality of Kanal can be extended with plugins. For example, plugins can provide database to store data; user system that allows storing and working with data of end-users of chat-bot;  integration with telegram or discord to receive messages from end-users and responses to be sent to them. Kanal has Batteries plugin that allows input and output to have text and also image, audio or file attached.
+
+## Overview of Kanal components
+#### Core
+Core is is a key Kanal component. To create the Kanal app is to create Core.
+```
+core = Kanal::Core::Core.new
+```
+#### Input and Output
+Input is an object representing information received from end-user. To store data inside Input and access it later you need to register parameter for it. Then you can pass your data to it.
+```
+core.register_input_parameter :test_parameter
+input = core.create_input  
+input.test_parameter = "test_value"
+```
+Batteries plugin provides pre-made parameters, such as body and source.
+```
+input.body = <Your string>
+# Source should be of Symbol type
+input.source = :telegram
+input.audio = 
+input.image = 
+input.file = 
+```
+TODO: Describe image, audio and file parameters. Are they supposed to contain url strings?
+
+Output is an object representing information ready to be sent to end-user. As with Input, you can register your own parameters. Batteries provides same parameters for Output as for Input.
+#### Conditions
+Condition is a true/false blocks that will tell the router if particular route should be used. Conditions are registered within the `condition pack` that has specific name.
+```
+core.add_condition_pack :contains_day_of_week do
+  add_condition :friday
+    met? do |input, core, argument|
+      # Rememer how you registered .body parameter of input? It will be accessible in condition here!
+      input.body.include? "friday"
+    end
+  end
+
+  add_condition :monday
+    met? do |input, core, argument|
+      input.body.include? "monday"
+    end
+  end
+end
+```
+#### Router
+Router is a collection of responses to specific conditions defined by user. Upon meeting the condition router will create output (or outputs). Using previously made conditions we can specify what operation will be performed and what the output (outputs) will contain.
+```
+core.router.configure do
+  on :contains_day_of_week :friday do
+    respond do
+      body "What, already?"
+    end
+  end
+
+  on :contains_day_of_week :tuesday do
+    respond do
+      body "Start of the week huh"
+    end
+    
+    respond_async do
+	    <http request or database call here>
+      body "I will work tirelessly!"
+    end
+  end
+end
+```
+In respond block you can do anything besides setting output parameters.
+
+_It is advised to make database calls, http requests or other time-consuming operations in respond_async block._
+
+Router has built-in default response for when none of the conditions are met. You can set your own default response.
+```
+core.router.default_response do
+  body "Custom default message here"
+end
+```
+
+Router has built-in error response for when there is an error during constructing of output. You can set your own error response.
+```
+core.router.error_response do
+  body "Custom error message here"
+end
+```
+
+#### Hooks
+Hooks can be used to intercept the execution flow in specific places in your code and do something with data provided to it. Hooks are registered in the Core. You can attach to hook, specifying arguments and block of code to be executed. When the hook will be called, the argument will be passed to provided block and it will be executed.
+```
+core.hook_storage.register :on_something
+val = nil
+hooks.attach :on_something do |value|  
+	val = value  
+end
+hooks.call :on_something, "testy"
+puts val # "testy"
+```
+
+By default core has 3 hooks.
+```
+:input_just_created # input  
+:input_before_router # input  
+:output_before_returned # input, output
+```
+
+#### Attachments
+Batteries plugin provides Attachments functionality.
+```
+attachment = ::Attachment.new "https://website.com/filename.jpg"
+# Get the url value
+attachment.url # "https://website.com/filename.jpg"
+# Get url file extension
+attachment.extension # "jpg"
+# Different helper methods for different multimedia types.
+attachment.jpg? # True
+attachment.image? # True
+attachment.mp3? # False
+attachment.audio? # False
+```
+#### Interfaces
+#### Plugins
+#### Interfaces
+#### Plugins
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add kanal
+$ bundle add kanal
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install kanal
+$ gem install kanal
 
 ## Usage
 
@@ -20,13 +144,13 @@ TODO: Write usage instructions here
 
 ## TODO
 
-- [DONE] ~provide default response for branch with subbranches because default response could be handy~
-    Provided with the :flow condition pack with condition :any
+- [DONE] ~provide default response for branch with subbranches because default response could be handy~  
+  Provided with the :flow condition pack with condition :any
 - [DONE] ~rework hooks storage, make hooks without arguments validation~
-- provide default logger with base class. this logger service should be used by every other service/plugin etc
-- provide default response on error, when router node fails with error
-- [DONE] ~provide :source condition for :source~
-    Created :source condition pack
+- ~provide default logger with base class. this logger service should be used by every other service/plugin etc~
+- ~provide default response on error, when router node fails with error~
+- [DONE] ~provide :source condition for :source~  
+  Created :source condition pack
 - Allow to "append" conditions to condition packs
 
 

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kanal
+  module Core
+    module Helpers
+      #
+      # Objects of this class are constructed by router to be put into #router.input_output_pair_queue
+      # It is needed so we don't keep input directly in output as a parameter
+      # Upon queueing these objects processed in item_added hook, for which input might be needed
+      #
+      class InputOutputPair
+        attr_reader :input, :output
+
+        def initialize(input, output)
+          @input = input
+          @output = output
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../logging/composite_logger"
+
 module Kanal
   module Core
     module Helpers
@@ -8,22 +10,32 @@ module Kanal
       # get(name)
       # transforms unknown methods to setters/getters for parameters
       module ParameterFinderWithMethodMissingMixin
-        def method_missing(symbol, *args)
+        include Logging::Logger
+
+        def method_missing(symbol, *args, &block)
+          if block && !args.first.nil?
+            logger.error "Block and arg given simultaneously. Parameter name: '#{symbol.to_s}, arg: #{args.first}'"
+
+            raise "Block and arg given simultaneously for parameter #{symbol.to_s}"
+          end
+
           parameter_name = symbol.to_s
           parameter_name.sub! "=", ""
 
           parameter_name = parameter_name.to_sym
 
+          value = block_given? ? block : args.first
+
           # standard workflow with settings properties with
           # input.prop = 123
           if symbol.to_s.include? "="
-            @parameter_bag.set parameter_name, args.first
-          elsif !args.empty?
+            @parameter_bag.set parameter_name, value
+          elsif !args.empty? || block_given?
             # this approach can be used also in dsl
             # like that
             # setters: prop value
             # getters: prop
-            @parameter_bag.set parameter_name, args.first
+            @parameter_bag.set parameter_name, value
           # means it is used as setter in dsl,
           # method call with argument
           else

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

@@ -2,6 +2,7 @@
 
 require_relative "../output/output"
 require_relative "../logging/logger"
+require_relative "../helpers/input_output_pair"
 
 module Kanal
   module Core
@@ -19,16 +20,16 @@ module Kanal
           @error_node = error_node
         end
 
-        def execute(core, output_queue)
+        def execute(core, input_output_pair_queue)
           if response_block.async?
-            # NOTE: Thread doesnt just die here - it's execution is continued in output_queue.enqueue in router
+            # NOTE: Thread doesnt just die here - it's execution is continued in input_output_pair_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)
+              input_output_pair_queue.enqueue InputOutputPair.new(@input, construct_output(core))
             end
           else
-            output_queue.enqueue construct_output(core)
+            input_output_pair_queue.enqueue InputOutputPair.new(@input, construct_output(core))
           end
         end
 
@@ -37,18 +38,16 @@ module Kanal
         def construct_output(core)
           logger.info "Constructing output for input ##{input.__id__}"
 
-          output = Output::Output.new core.output_parameter_registrator, input, core
+          output = Output::Output.new core.output_parameter_registrator, core
 
           begin
             core.hooks.call :output_just_created, input, output
 
             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
+            output = Output::Output.new core.output_parameter_registrator, core
 
             error_node = @error_node || @default_error_node
 
@@ -56,16 +55,12 @@ module Kanal
 
             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
 

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

@@ -12,10 +12,9 @@ module Kanal
         include Helpers
         include Helpers::ParameterFinderWithMethodMissingMixin
 
-        attr_reader :input, :core
+        attr_reader :core
 
-        def initialize(parameter_registrator, input, core)
-          @input = input
+        def initialize(parameter_registrator, core)
           @core = core
           @parameter_bag = ParameterBagWithRegistrator.new parameter_registrator
         end

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

@@ -3,6 +3,7 @@
 require_relative "./router_node"
 require_relative "../helpers/queue"
 require_relative "../helpers/response_execution_block"
+require_relative "../helpers/input_output_pair"
 require_relative "../logging/composite_logger"
 
 module Kanal
@@ -35,20 +36,30 @@ module Kanal
           end
           @error_node = nil
           @response_execution_queue = Queue.new
-          @output_queue = Queue.new
+          @input_output_pair_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}'"
+          _input_output_pair_queue = @input_output_pair_queue
+          # Attaching to the queue hook to capture enqueued output and move it
+          # 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}'"
 
             begin
-              _this.output_ready_block.call output
-              _output_queue.remove(output)
+              _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}"
+              return
+            end
+
+            begin
+              _this.output_ready_block.call input_output_pair.output
+              _input_output_pair_queue.remove(input_output_pair)
             rescue
-              _output_queue.remove(output)
+              _input_output_pair_queue.remove(input_output_pair)
               raise "Error in output_ready block!"
             end
           end
@@ -85,6 +96,45 @@ module Kanal
           @error_node.respond(&block)
         end
 
+        # Method allows to pass output with input directly to the end step,
+        # when outputs are processed after router. Meaning it will not go
+        # through router, but will have all hooks in :output_before_returned executed for it.
+        # Input is needed for hooks to work properly.
+        #
+        # WARNING: this method AVOIDS router whatsoever
+        # Why use this method? If you want router to give out (through output_ready(&block) method) output without
+        # passing through router but with hooks called (many plugins use hooks to alter the output) - you
+        # use this method.
+        #
+        # This method adds input-output pair into input_output_pair_queue for it to be processed in item_queued hook
+        #
+        # param [Kanal::Core::Output::Output] output <description>
+        # param [Kanal::Core::Input::Input] input <description>
+        #
+        def provide_output_with_input(output, input)
+          @input_output_pair_queue.enqueue InputOutputPair.new input, output
+        end
+
+        #
+        # Method allows to pass output directly to the end output
+        # consumer (code which uses .output_ready(&block). Without passing router and
+        # without passing hooks attached to :output_before_ready
+        #
+        # WARNING: output provided via this method will avoid any alteration by the
+        # router inner machinery and will go directly to the output consumer
+        #
+        # Why use this method? If you want to pass output with your manually defined
+        # properties to the output consumer (which uses .output_ready(&block))
+        # without any alternations by the router system.
+        #
+        # This method calls output_ready_block on pre-formed output right away
+        #
+        # param [Kanal::Core::Output] output <description>
+        #
+        def provide_output(output)
+          @output_ready_block.call output
+        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__}."
@@ -139,7 +189,7 @@ module Kanal
           until @response_execution_queue.empty?
             response_execution = @response_execution_queue.dequeue
 
-            response_execution.execute core, @output_queue
+            response_execution.execute core, @input_output_pair_queue
           end
         end
 

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

@@ -15,76 +15,25 @@ module Kanal
             @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"
+          # Extension checks like jpg?, mp3?, mp4?, doc? etc. fall here
+          def method_missing(method)
+            extension == method.to_s.delete("?")
           end
 
           def image?
-            jpg? || jpeg? || png? || bpm? || gif?
-          end
-
-          def jpg?
-            extension == "jpg"
-          end
-
-          def jpeg?
-            extension == "jpeg"
-          end
-
-          def png?
-            extension == "png"
+            [jpg?, jpeg?, png?, bmp?, gif?].any?
           end
 
-          def bpm?
-            extension == "bpm"
-          end
-
-          def gif?
-            extension == "gif"
+          def audio?
+            [mp3?, wav?, ogg?].any?
           end
 
           def video?
-            mp4? || mov? || mkv?
-          end
-
-          def mp4?
-            extension == "mp4"
+            [mp4?, mov?, mkv?].any?
           end
 
-          def mov?
-            extension == "mov"
-          end
-
-          def mkv?
-            extension == "mkv"
+          def document?
+            [doc?, docx?, odf?].any?
           end
 
           #

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

@@ -9,6 +9,8 @@ module Kanal
     module Batteries
       # Plugin with some batteries like .body property etc
       class BatteriesPlugin < Core::Plugins::Plugin
+
+
         def name
           :batteries
         end
@@ -19,6 +21,8 @@ module Kanal
           flow_batteries core
           attachments_batteries core
           keyboard_batteries core
+          username_batteries core
+          button_batteries core
         end
 
         def flow_batteries(core)
@@ -117,11 +121,95 @@ module Kanal
         def attachments_batteries(core)
           core.register_input_parameter :image
           core.register_input_parameter :audio
-          core.register_input_parameter :file
+          core.register_input_parameter :video
+          core.register_input_parameter :document
 
           core.register_output_parameter :image
           core.register_output_parameter :audio
-          core.register_output_parameter :file
+          core.register_output_parameter :video
+          core.register_output_parameter :document
+
+          _this = self
+
+          core.add_condition_pack :image do
+            add_condition :exists do
+              met? do |input, _core, _argument|
+                !input.image.nil?
+              end
+            end
+
+            add_condition :is do
+              with_argument
+
+              met? do |input, _, argument|
+                if input.image.image? && input.image.send((argument.to_s + "?").to_sym)
+                  true
+                else
+                  false
+                end
+              end
+            end
+          end
+
+          core.add_condition_pack :audio do
+            add_condition :exists do
+              met? do |input, _core, _argument|
+                !input.audio.nil?
+              end
+            end
+
+            add_condition :is do
+              with_argument
+
+              met? do |input, _, argument|
+                if input.audio.audio? && input.audio.send((argument.to_s + "?").to_sym)
+                  true
+                else
+                  false
+                end
+              end
+            end
+          end
+
+          core.add_condition_pack :video do
+            add_condition :exists do
+              met? do |input, _core, _argument|
+                !input.video.nil?
+              end
+            end
+
+            add_condition :is do
+              with_argument
+
+              met? do |input, _, argument|
+                if input.video.video? && input.video.send((argument.to_s + "?").to_sym)
+                  true
+                else
+                  false
+                end
+              end
+            end
+          end
+
+          core.add_condition_pack :document do
+            add_condition :exists do
+              met? do |input, _core, _argument|
+                !input.document.nil?
+              end
+            end
+
+            add_condition :is do
+              with_argument
+
+              met? do |input, _, argument|
+                if input.document.document? && input.document.send((argument.to_s + "?").to_sym)
+                  true
+                else
+                  false
+                end
+              end
+            end
+          end
         end
 
         def keyboard_batteries(core)
@@ -131,6 +219,24 @@ module Kanal
             output.keyboard = Keyboard.new
           end
         end
+
+        def username_batteries(core)
+          core.register_input_parameter :username
+        end
+
+        def button_batteries(core)
+          core.register_input_parameter :button_pressed
+
+          core.add_condition_pack :button do
+            add_condition :pressed do
+              with_argument
+
+              met? do |input, _, argument|
+                input.button_pressed == argument
+              end
+            end
+          end
+        end
       end
     end
   end

data/lib/kanal/version.rb

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

data/lib/kanal.rb

@@ -3,6 +3,7 @@
 require_relative "kanal/version"
 require_relative "kanal/core/core"
 require_relative "kanal/core/plugins/plugin"
+require_relative "shortcuts"
 
 # This module used as a main entry point into kanal-core library
 module Kanal

data/lib/shortcuts.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "./kanal/core/logging/logger"
+
+module Kanal
+  module Logger
+    include Kanal::Core::Logging::Logger
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanal
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - idchlife
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-04-14 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
@@ -37,6 +37,7 @@ files:
 - lib/kanal/core/conditions/condition_storage.rb
 - lib/kanal/core/core.rb
 - lib/kanal/core/helpers/condition_finder.rb
+- lib/kanal/core/helpers/input_output_pair.rb
 - lib/kanal/core/helpers/parameter_bag.rb
 - lib/kanal/core/helpers/parameter_bag_with_registrator.rb
 - lib/kanal/core/helpers/parameter_finder_with_method_missing_mixin.rb
@@ -63,6 +64,7 @@ files:
 - lib/kanal/plugins/batteries/batteries_plugin.rb
 - lib/kanal/plugins/batteries/keyboard.rb
 - lib/kanal/version.rb
+- lib/shortcuts.rb
 - sig/kanal.rbs
 - sig/kanal/core/conditions/condition_pack.rbs
 - sig/kanal/core/conditions/condition_storage.rbs