kanal 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36d8d91a78e9f227b53d4b8f2221fed9890670c327477d4ce1e2506e70e7ac3d
-  data.tar.gz: 66bb506e933b59e5de10595a5f9a08e5225048d71d75d9c605a3a60e7fc2bf45
+  metadata.gz: 22224712e17434c60d3b437d44a35a5a997dd739cddcf53eb365d588fdf19fcd
+  data.tar.gz: f6677a4a8bc6eacf2e41469ba4a36da1b324d3b7d9092ae9271aa1b9f3fa8be6
 SHA512:
-  metadata.gz: 2baebfec99a7f2b973a37b07f681743cb6778856012a2530bfc5421a4d9eea6d7be1882881dc777e78fd660374c660e0d51a3f9bede04a1b2b0c47b050eebf52
-  data.tar.gz: b904037d8384582b2802ff714df534451642a3811981257619520584e486beaed43b9a22ee76a3ef81344921b9829ae8bc9950c7a26553b891f318b19ec29d13
+  metadata.gz: 5e1416fb809513b53627cb120d8b09dfb76cae30f952de0212a1c2edde48e01d733afb122189230d0e6426dba812d143a8b2fc35b8561fba95954ea0b0bccbe2
+  data.tar.gz: 3dcc90d49fa16f4df0482d77a94f3f21a7ddc12742983a8925714199100284bfb4d84a96bef19aa289c3ad1ebcc21996d3a27fb9874837b24ca343ba53f700d6

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [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

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/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.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanal
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - idchlife
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-10 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
@@ -58,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