kanal-interfaces-telegram 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 214fdfb6f4940364c3169b9db39c19276bb9c435ac0204f81b7a2943fb90b1ed
-  data.tar.gz: 97f7f66f82039c0722ba552a8929739a04fa2b8f6e78a8142a6ec44bdbd4babe
+  metadata.gz: e2099dcf092fbe8f08c3d7238fce49192a5b473ee0cf9d3768fddc2831cfc444
+  data.tar.gz: 01f5d546c65176738d3e4b06ea526e906a63bfd78db53f774eb24a0e085a9afd
 SHA512:
-  metadata.gz: 8257d35fc51f48850dcf32707c92b25449470c121c28096178a19433cb62f33f2c89fd6f3dbea9934542de2d23d033ef12c6a4a8e44d9573cf68da3264bd8e34
-  data.tar.gz: 134c37797653dec0f74baa42e7e6db3a2ffbc238451bd55d607e74f9cc992f9a8ed0e5b71711bbaa1725980ea2ea55c38a8698ee59dd08b44b839e9eeea5a1e8
+  metadata.gz: 27db3b2693ac6ce49f93c85d82cf0c52f2dc8943c4b366952fb7c53a70c7d6643aca915120b1168fce7edee95b6418ad07d08461e340c59a8a1878a92250b152
+  data.tar.gz: 4b9691fa2117d2fc0b68ab2e45517ece35d9db66662270a843c0c9d6765d8b916beaad0408260ebf817048b9cb796d35dff3e6e527971f375126b82149b24d49

data/CHANGELOG.md

@@ -1,10 +1,10 @@
 ## [Unreleased]
 
-## [0.2.0] - 2023-01-30
+## [0.3.1] - 2023-03-31
+- Fixed parsing link for file attachments. Now file attachments parsing works
 
-- Library now can send images via .tg_image_path
-- Populating separate field in input
-- Using output.tg_chat_id and not the one inside interface, this is preparations for future sending outputs in separate methods... Probably
+## [0.3.0] - 2023-03-10
+- Reworked interface with the new Kanal release, now it uses Interface base class properly
 
 ## [0.1.0] - 2022-11-21
 

data/Gemfile

@@ -9,7 +9,7 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-gem "kanal"
+gem "kanal", "0.4.3"
 
 group :development do
   gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kanal-interfaces-telegram (0.2.1)
+    kanal-interfaces-telegram (0.3.1)
       telegram-bot-ruby
 
 GEM
@@ -31,7 +31,7 @@ GEM
     ice_nine (0.11.2)
     jaro_winkler (1.5.4)
     json (2.6.3)
-    kanal (0.3.0)
+    kanal (0.4.3)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -39,6 +39,8 @@ GEM
     multipart-post (2.3.0)
     nokogiri (1.14.0-x86_64-darwin)
       racc (~> 1.4)
+    nokogiri (1.14.0-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.22.1)
     parser (3.2.0.0)
       ast (~> 2.4.1)
@@ -118,9 +120,10 @@ GEM
 
 PLATFORMS
   x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
-  kanal
+  kanal (= 0.4.3)
   kanal-interfaces-telegram!
   rake (~> 13.0)
   rspec (~> 3.0)
@@ -131,4 +134,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.3.19
+   2.4.5

data/README.md

@@ -1,8 +1,14 @@
 # Kanal::Interfaces::Telegram
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kanal/interfaces/telegram`. To experiment with that code, run `bin/console` for an interactive prompt.
+Welcome to Telegram interface!
 
-TODO: Delete this and the text above, and describe your gem
+Integrate this interface into your Kanal app workflow and it will handle the incoming messages containing plain text or media (images, audio, videos, documents). You can attach media to your responses as well.
+
+This interface relies on telegram-bot-ruby wrapper (https://github.com/atipugin/telegram-bot-ruby) to handle the actual communication with Telegram API.
+
+Upon receiving a message or callback from end-user through telegram-bot-ruby, Telegram interface will transform incoming data into Kanal input with specific Telegram properties and feed it to router. Router will form an output (or outputs), which will be sent to Telegram interface. Telegram interface will send a message (or messages) through telegram-bot-ruby wrapper to end-user.
+
+It is advised to use Telegram interface with Telegram bridge which converts specific input/output properties to standard Kanal properties.
 
 ## Installation
 
@@ -16,7 +22,48 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+1. Create instance of Core:
+
+```core = Kanal::Core::Core.new```
+
+2. Create instance of Telegram interface
+
+```interface = Kanal::Interfaces::Telegram::TelegramInterface.new core, "YOUR_TOKEN"```
+
+3. You can use https://github.com/idchlife/kanal-plugins-batteries_bridge to convert Telegram interface specific properties to Kanal Batteries plugin properties. Batteries plugin properties are using generally known keywords such as :body, :image, :audio etc. More info you can get inside batteries bridge plugin repository
+
+```core.register_plugin Kanal::Plugins::Batteries::BatteriesPlugin.new```
+
+4. Add your condition packs (or use conditions provided by Batteries plugin)
+
+```
+# Conditions need to be coded for usage in routing
+core.add_condition_pack :tg_text do
+    add_condition :is do
+        with_argument
+        met? do |input, _core, argument| # 3 arguments provided to the block
+            input.tg_text == argument
+        end
+    end
+end
+
+core.router.configure do
+    # Response for condition created above
+    on :tg_text, is: "foo" do
+        respond do
+            tg_text "bar"
+        end
+    end
+end
+
+core.router.default_response do
+    tg_text "Default response"
+end
+```
+
+5. Start your bot
+
+```interface.start```
 
 ## Development
 

data/examples/telegram_bot.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "kanal/core/core"
+require "kanal/interfaces/telegram/telegram_interface"
+
+core = Kanal::Core::Core.new
+
+interface = Kanal::Interfaces::Telegram::TelegramInterface.new core, "replace-me-with-your-token"
+
+core.add_condition_pack :tg_text do
+  add_condition :is do
+    with_argument
+    met? do |input, _core, argument|
+      input.tg_text == argument
+    end
+  end
+end
+
+core.router.configure do
+  on :tg_text, is: "foo" do
+    respond do
+      tg_text "bar"
+    end
+  end
+end
+
+core.router.default_response do
+  tg_text "Default response"
+end
+
+interface.start

data/lib/kanal/interfaces/telegram/helpers/telegram_link_parser.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Kanal
+  module Interfaces
+    module Telegram
+      module Helpers
+        class TelegramLinkParser
+          def get_file_link(file_id, bot, bot_token)
+            file = bot.api.get_file(file_id: file_id)
+            file_path = file.dig('result', 'file_path')
+            "https://api.telegram.org/file/bot#{bot_token}/#{file_path}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kanal/interfaces/telegram/plugins/telegram_integration_plugin.rb

@@ -16,17 +16,22 @@ module Kanal
           end
 
           def register_parameters(core)
-            core.register_input_parameter :tg_message, readonly: true
-            core.register_input_parameter :tg_text, readonly: true
             core.register_input_parameter :tg_chat_id, readonly: true
             core.register_input_parameter :tg_username, readonly: true
+            core.register_input_parameter :tg_text, readonly: true
+            core.register_input_parameter :tg_button_pressed, readonly: true
+            core.register_input_parameter :tg_image_link, readonly: true
+            core.register_input_parameter :tg_audio_link, readonly: true
+            core.register_input_parameter :tg_video_link, readonly: true
+            core.register_input_parameter :tg_document_link, readonly: true
 
             core.register_output_parameter :tg_chat_id
             core.register_output_parameter :tg_text
-            core.register_output_parameter :tg_reply_markup
             core.register_output_parameter :tg_image_path
             core.register_output_parameter :tg_audio_path
+            core.register_output_parameter :tg_video_path
             core.register_output_parameter :tg_document_path
+            core.register_output_parameter :tg_reply_markup
           end
 
           def register_hooks(core)
@@ -34,12 +39,7 @@ module Kanal
               input.source = :telegram
             end
 
-            core.hooks.attach :input_before_router do |input|
-              input.body = input.tg_text
-            end
-
             core.hooks.attach :output_before_returned do |input, output|
-              output.tg_text = output.body
               output.tg_chat_id = input.tg_chat_id
             end
           end

data/lib/kanal/interfaces/telegram/telegram_interface.rb

@@ -3,6 +3,7 @@
 require "kanal/core/interfaces/interface"
 require "kanal/plugins/batteries/batteries_plugin"
 require_relative "./plugins/telegram_integration_plugin"
+require_relative "./helpers/telegram_link_parser"
 
 require "telegram/bot"
 
@@ -16,60 +17,138 @@ module Kanal
 
           @bot_token = bot_token
 
+          @bot = ::Telegram::Bot::Client.new(bot_token)
+
           @core.register_plugin Kanal::Plugins::Batteries::BatteriesPlugin.new
           @core.register_plugin Kanal::Interfaces::Telegram::Plugins::TelegramIntegrationPlugin.new
+
+          @link_parser = Kanal::Interfaces::Telegram::Helpers::TelegramLinkParser.new
         end
 
         def start
           ::Telegram::Bot::Client.run(@bot_token) do |bot|
             bot.listen do |message|
-              input = @core.create_input
+              router.consume_input create_input message
+            end
+          end
+        end
 
-              input.tg_message = message
-              input.tg_text = message.text
-              input.tg_chat_id = message.chat.id
-              input.tg_username = message.try(:chat).try(:username) || input.tg_message.try(:from).try(:username)
+        def consume_output(output)
+          send_output @bot, output
+        end
 
-              output = router.create_output_for_input input
+        def create_input(message)
+          input = @core.create_input
 
-              bot.api.send_message(
-                chat_id: output.tg_chat_id,
-                text: output.tg_text,
-                reply_markup: output.tg_reply_markup
-              )
+          if !message.instance_variable_defined?(:@data)
+            # Regular message received
+            input.tg_text = message.text
+            input.tg_chat_id = message.chat.id
+            input.tg_username = message.chat.username || message.from.username
 
-              image_path = output.tg_image_path
+            if message.photo.count > 0
+              # Array of images contains thumbnails, we take 3rd element to get the high-res image
+              input.tg_image_link = @link_parser.get_file_link message.photo[2].file_id, @bot, @bot_token
+            end
 
-              if image_path && File.exist?(image_path)
-                bot.api.send_photo(
-                  chat_id: message.chat.id,
-                  photo: Faraday::UploadIO.new(image_path, guess_mimetype(image_path))
-                )
-              end
+            if !message.audio.nil?
+              input.tg_audio_link = @link_parser.get_file_link message.audio.file_id, @bot, @bot_token
             end
+
+            if !message.video.nil?
+              input.tg_video_link = @link_parser.get_file_link message.video.file_id, @bot, @bot_token
+            end
+
+            if !message.document.nil?
+              input.tg_document_link = @link_parser.get_file_link message.document.file_id, @bot, @bot_token
+            end
+          else
+            # Inline button pressed
+            input.tg_button_pressed = message.data
+            input.tg_chat_id = message.from.id
+            input.tg_username = message.from.username
           end
+
+          input
         end
 
         private
 
+        def send_output(bot, output)
+          bot.api.send_message(
+            chat_id: output.tg_chat_id,
+            text: output.tg_text,
+            reply_markup: output.tg_reply_markup
+          )
+
+          image_path = output.tg_image_path
+
+          if !image_path.nil? && File.exist?(image_path)
+            bot.api.send_photo(
+              chat_id: output.tg_chat_id,
+              photo: Faraday::UploadIO.new(output.tg_image_path, guess_mimetype(output.tg_image_path))
+            )
+          end
+
+          audio_path = output.tg_audio_path
+
+          if !output.tg_audio_path.nil? && File.exist?(audio_path)
+            bot.api.send_audio(
+              chat_id: output.tg_chat_id,
+              audio: Faraday::UploadIO.new(output.tg_audio_path, guess_mimetype(output.tg_audio_path))
+            )
+          end
+
+          video_path = output.tg_video_path
+
+          if !output.tg_video_path.nil? && File.exist?(video_path)
+            bot.api.send_video(
+              chat_id: output.tg_chat_id,
+              video: Faraday::UploadIO.new(output.tg_video_path, guess_mimetype(output.tg_video_path))
+            )
+          end
+
+          document_path = output.tg_document_path
+
+          if !output.tg_document_path.nil? && File.exist?(document_path)
+            bot.api.send_document(
+              chat_id: output.tg_chat_id,
+              document: Faraday::UploadIO.new(output.tg_document_path, guess_mimetype(output.tg_document_path))
+            )
+          end
+        end
+
         def guess_mimetype(filename)
-          images = {
-            "image/jpeg" => %w[jpg jpeg],
-            "image/png" => ["png"],
-            "image/bmp" => ["bmp"]
-          }
-
-          # TODO: rewrite with .find or .each
-          for pack in [images] do
-            for mime, types in pack do
-              for type in types do
-                return mime if filename.include? type
+          media_types = [
+            images: {
+              "image/jpeg" => %w[jpg jpeg],
+              "image/png" => ["png"],
+              "image/bmp" => ["bmp"]
+            },
+            audios: {
+              "audio/mp3" => ["mp3"],
+              "audio/ogg" => ["ogg"],
+              "audio/vnd.wave" => ["wav"]
+            },
+            videos: {
+              "video/mp4" => ["mp4"],
+              "video/webm" => ["webm"]
+            },
+            documents: {
+              "application/msword" => %w[doc docx],
+              "application/pdf" => ["pdf"]
+            }
+          ]
+
+          media_types.each do |media_type|
+            media_type.each do |media_name, variant|
+              variant.each do |mime, extensions|
+                extensions.each do |extension|
+                  return mime if filename.include? extension
+                end
               end
             end
           end
-
-
-          "application/octet-stream"
         end
       end
     end

data/lib/kanal/interfaces/telegram/version.rb

@@ -3,7 +3,7 @@
 module Kanal
   module Interfaces
     module Telegram
-      VERSION = "0.2.1"
+      VERSION = "0.3.1"
     end
   end
 end

data/lib/kanal/interfaces/telegram.rb

@@ -2,6 +2,9 @@
 
 require_relative "telegram/version"
 
+require "kanal/core/core"
+require "kanal/interfaces/telegram/telegram_interface"
+
 module Kanal
   module Interfaces
     module Telegram

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanal-interfaces-telegram
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - idchlife
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-29 00:00:00.000000000 Z
+date: 2023-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: telegram-bot-ruby
@@ -42,8 +42,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- kanal-interfaces-telegram.gemspec
+- examples/telegram_bot.rb
 - lib/kanal/interfaces/telegram.rb
+- lib/kanal/interfaces/telegram/helpers/telegram_link_parser.rb
 - lib/kanal/interfaces/telegram/plugins/telegram_integration_plugin.rb
 - lib/kanal/interfaces/telegram/telegram_interface.rb
 - lib/kanal/interfaces/telegram/version.rb
@@ -56,7 +57,7 @@ metadata:
   homepage_uri: https://github.com/idchlife/kanal-interfaces-telegram
   source_code_uri: https://github.com/idchlife/kanal-interfaces-telegram
   changelog_uri: https://github.com/idchlife/kanal-interfaces-telegram
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -72,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: This library provides a Telegram interface for Kanal
 test_files: []

data/kanal-interfaces-telegram.gemspec

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/kanal/interfaces/telegram/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "kanal-interfaces-telegram"
-  spec.version = Kanal::Interfaces::Telegram::VERSION
-  spec.authors = ["idchlife"]
-  spec.email = ["idchlife@gmail.com"]
-
-  spec.summary = "This library provides a Telegram interface for Kanal"
-  spec.description = "Library provides Telegram interface for Kanal. With this you can connect to telegram bot and control it"
-  spec.homepage = "https://github.com/idchlife/kanal-interfaces-telegram"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.6"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/idchlife/kanal-interfaces-telegram"
-  spec.metadata["changelog_uri"] = "https://github.com/idchlife/kanal-interfaces-telegram"
-
-  # spec.add_dependency "kanal", git: "git@github.com:idchlife/kanal.git"
-  spec.add_dependency "telegram-bot-ruby"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end