rubydium 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2e2772c99fcea22c7e44bf38e1f627f15e82c7e40f7d7098a0274899e1f6f96
-  data.tar.gz: acfaf6eab26a496487dc3ad068d94ee32fea757013e7b7f417488df5e1bc77f5
+  metadata.gz: ebfa6d1d46ec5b5d046aae44b857f59b405e5ae79af529d695a552090dc07fc0
+  data.tar.gz: 00cd4177e06fb2920a5ff6a1b8c3be332bc57cbf473624020704855df07dec07
 SHA512:
-  metadata.gz: e5433732515339715ffce7a6a0a42c4fc16f305482605b2f7fe5021e76be5d95a32ecc70858d0f9685c874fa18e342b7eaa681e3ba658ae7d580041999e654da
-  data.tar.gz: 824cbea37e25519b5c3d1a1d1f845d1c4bd6c5eb52a29c9ecea6387302e4506055f6780492def00b594caf84ba81a1a1ed2ed6ef7c272fcd14c0fcd276cc12fe
+  metadata.gz: f09704c30374104c0c0cf608ffae1ffad372e2b41317f9a324a6ae1200867393d461fe186ec2f62c5516c38c293ba812ef1016ccf8cab3342a655ca702390358
+  data.tar.gz: 478056c327c16135dd0a546fc88c53dd345ca5db7b30047b673c6765c0f22d07a54f8b877eae86a18dceef5b4de5c55db6ecb9a7a10fa65df05f4956e18c1c4e

data/Gemfile

@@ -8,5 +8,5 @@ gem "pry"
 gem "rspec"
 gem "rubocop"
 gem "rubocop-rspec"
-gem "telegram-bot-ruby"
+gem "telegram-bot-ruby", "~> 1.0.0"
 gem "async"

data/Gemfile.lock

@@ -6,20 +6,33 @@ GEM
       console (~> 1.10)
       io-event (~> 1.1)
       timers (~> 4.1)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
+    base64 (0.1.1)
     coderay (1.1.3)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.2.2)
     console (1.16.2)
       fiber-local
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.5.0)
+    dry-core (1.0.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
     dry-inflector (1.0.0)
-    faraday (2.7.2)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-struct (1.6.0)
+      dry-core (~> 1.0, < 2)
+      dry-types (>= 1.7, < 2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    faraday (2.7.11)
+      base64
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-multipart (1.0.4)
@@ -30,7 +43,7 @@ GEM
     io-event (1.1.5)
     json (2.6.3)
     method_source (1.0.0)
-    multipart-post (2.2.3)
+    multipart-post (2.3.0)
     parallel (1.22.1)
     parser (3.1.3.0)
       ast (~> 2.4.1)
@@ -69,18 +82,14 @@ GEM
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    telegram-bot-ruby (0.23.0)
-      dry-inflector
+    telegram-bot-ruby (1.0.0)
+      dry-struct (~> 1.6)
       faraday (~> 2.0)
       faraday-multipart (~> 1.0)
-      virtus (~> 2.0)
-    thread_safe (0.3.6)
+      zeitwerk (~> 2.6)
     timers (4.3.5)
     unicode-display_width (2.3.0)
-    virtus (2.0.0)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   x86_64-linux
@@ -91,7 +100,7 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-rspec
-  telegram-bot-ruby
+  telegram-bot-ruby (~> 1.0.0)
 
 BUNDLED WITH
    2.3.26

data/example/example_bot.rb

@@ -1,17 +1,22 @@
 # frozen_string_literal: true
 
-require "rubydium"
+# require "rubydium"
+require_relative "../lib/rubydium"
+require "pry"
 
 # Your actual logic of handling the updates goes here.
 class ExampleBot < Rubydium::Bot
   on_every_message :log_message
 
   on_command "/help", description: "Show help message" do
-    text = help_message
+    text = self.class.help_message
     send_message(text)
   end
 
   on_command "/start", :greet_user, description: "Say hello"
+  on_command "/pry" do
+    binding.pry
+  end
 
   def log_message
     puts "Got message from #{@user.first_name}, text: \n#{@text}"
@@ -24,12 +29,13 @@ class ExampleBot < Rubydium::Bot
 end
 
 ExampleBot.configure do |config|
-  config.token = "1234567890:long_alphanumeric_string_goes_here"
-  config.bot_username = "ends_with_bot"
-  config.owner_username = "thats_you"
-  config.privileged_usernames = %w[
-    your_friend your_chat_moderator
-  ]
+  config.token = "1043894792:AAGC_oA2Ztvo5bBZBPxX5_oUxFX-L_obZJI"#"1234567890:long_alphanumeric_string_goes_here"
+  config.bot_username = "bulgakkebot"#"ends_with_bot"
+  config.owner_username = "bulgakke"#"thats_you"
+  config.privileged_usernames = []
+  # %w[
+  #   your_friend your_chat_moderator
+  # ]
 end
 
 ExampleBot.run

data/example/open_ai_bot/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "down", "~> 5.4"
+gem "http", "~> 5.1"
+gem "pry", "~> 0.14.2"
+gem "rubydium", ">= 0.2.3"
+gem "ruby-openai", "~> 5.1"

data/example/open_ai_bot/chat_gpt.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require_relative "chat_thread"
+
+module ChatGPT
+  module ClassMethods
+    def threads
+      @threads ||= {}
+    end
+
+    def new_thread(chat_id)
+      new_thread = ChatThread.new(chat_id)
+      threads[chat_id] = new_thread
+      new_thread
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def init_session
+    self.class.new_thread(@chat.id)
+    reply("Bot's context reset.")
+  end
+
+  def allowed_chat?
+    return true if @user.username == config.owner_username
+    return true if config.chat_gpt_allow_all_private_chats && @chat.id.positive?
+    return true if config.chat_gpt_allow_all_group_chats && @chat.id.negative?
+    return true if config.chat_gpt_whitelist.include?(@chat.id)
+
+    false
+  end
+
+  def handle_gpt_command
+    return if self.class.registered_commands.keys.any? { @text.match? Regexp.new(_1) }
+    return unless bot_mentioned? || bot_replied_to? || private_chat?
+
+    if !allowed_chat?
+      msg = "This chat (`#{@chat.id}`) is not whitelisted for ChatGPT usage. Ask @#{config.owner_username}."
+      return reply(msg, parse_mode: "Markdown")
+    end
+
+    text = @text_without_bot_mentions
+    text = nil if text.gsub(/\s/, "").empty?
+
+    target_text = @replies_to&.text || @replies_to&.caption
+    target_text = nil if @target&.username == config.bot_username
+
+    thread = self.class.threads[@chat.id] || self.class.new_thread(@chat.id)
+
+    name = "@#{@user.username}"
+
+    if target_text && bot_mentioned?
+      target_name = "@#{@replies_to.from.username}"
+      text = [add_name(target_name, target_text), add_name(name, text)].join("\n\n")
+      ask_gpt(name, text, thread)
+    elsif text
+      text = add_name(name, text)
+      ask_gpt(name, text, thread)
+    end
+  end
+
+  def ask_gpt(_name, prompt, thread)
+    thread.add!(:user, prompt)
+
+    send_request(thread)
+  end
+
+  def send_request(thread)
+    Async do |task|
+      request = Async do
+        attempt(3) do
+          response = open_ai.chat(
+            parameters: {
+              model: "gpt-3.5-turbo",
+              messages: thread.history
+            }
+          )
+
+          if response["error"]
+            error_text = response["error"]["message"]
+            error_text += "\n\nHint: press /start to reset the context." if error_text.match? "tokens"
+            raise Net::ReadTimeout, response["error"]["message"]
+          else
+            text = response.dig("choices", 0, "message", "content")
+            puts "#{Time.now.to_i} | Chat ID: #{@chat.id}, tokens used: #{response.dig("usage", "total_tokens")}"
+
+            reply(text)
+            thread.add!(:assistant, text)
+          end
+        end
+      end
+
+      status = task.async do
+        loop do
+          send_chat_action(:typing)
+          sleep 4.5
+        end
+      end
+      request.wait
+
+      status.stop
+    end
+  end
+
+  def add_name(name, text)
+    "<#{name}>:\n#{text}"
+  end
+end

data/example/open_ai_bot/chat_thread.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class ChatThread
+  def initialize(_chat)
+    @history = [
+      {
+        role: :system,
+        content: default_instruction
+      },
+      {
+        role: :user,
+        content: first_user_message
+      },
+      {
+        role: :assistant,
+        content: first_bot_message
+      }
+    ]
+  end
+
+  attr_reader :history
+
+  def add!(role, content)
+    return if [role, content].any? { [nil, ""].include?(_1) }
+
+    @history.push({
+                    role: role, content: content.gsub(/\\xD\d/, "")
+                  })
+  end
+
+  def default_instruction
+    <<~MSG
+      Ты находишься в групповом чате. Здесь могут использоваться разные языки, так что отвечай на вопросы на том языке, на котором они заданы.
+
+      Помимо текста сообщений, первой строчкой ты будешь получать имя пользователя, который отправил это сообщение.
+      Пользователи могут просить обращаться к ним иначе, чем подписано сообщение.
+
+      Тебе не нужно подписывать свои сообщения и без необходимости вставлять имена других пользователей.
+
+      Если не до конца понимаешь, о чём вопрос - задавай уточняющий вопрос в ответ. Также изредка задавай общие вопросы для продвижения диалога.
+    MSG
+  end
+
+  def first_user_message
+    <<~MSG
+      <@tyradee>:
+
+      I drank some tea today.
+    MSG
+  end
+
+  def first_bot_message
+    <<~MSG
+      Good for you!
+    MSG
+  end
+end

data/example/open_ai_bot/dalle.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dalle
+  def dalle
+    attempt(3) do
+      prompt = @replies_to&.text || @text_without_command
+      send_chat_action(:upload_photo)
+
+      response = open_ai.images.generate(parameters: { prompt: prompt })
+
+      send_chat_action(:upload_photo)
+
+      url = response.dig("data", 0, "url")
+
+      if response["error"]
+        reply_code(response)
+      else
+        send_photo(url, reply_to_message_id: @msg.message_id)
+      end
+    end
+  end
+end

data/example/open_ai_bot/open_ai_bot.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "rubydium"
+require "openai"
+require "down"
+require "pry"
+require_relative "chat_gpt"
+require_relative "dalle"
+require_relative "utils"
+require_relative "whisper"
+
+# I wrote the code "until it works" as I went without much refactoring,
+# so yes, it's not great, especially the ChatGPT functionality.
+class ChatGPTBot < Rubydium::Bot
+  include ChatGPT
+  include Dalle
+  include Utils
+  include Whisper
+
+  # Whenever mentioned or replied to, finds or creates a conversation thread
+  # for this chat, add your message to it and returns ChatGPT's response.
+  on_every_message :handle_gpt_command
+  # Whenever a voice message appears in the chat, uses Whisper to transcribe
+  # it and sends the result.
+  # Set `ignore_forwarded` to false to automatically react to forwarded voice messages
+  on_every_message :transcribe, ignore_forwarded: true
+
+  on_command "/start", :init_session, description: "Resets ChatGPT session"
+  on_command "/dalle", :dalle, description: "Sends the prompt to DALL-E"
+  on_command "/transcribe", :transcribe, description: "Reply to a voice message to transcribe it"
+  on_command "/pry", :pry, description: "Open a debug session in the terminal with the context of this message"
+
+  def pry
+    binding.pry
+  end
+
+  private
+
+  def private_chat?
+    @chat.type == "private"
+  end
+
+  def bot_replied_to?
+    @target&.username == config.bot_username
+  end
+
+  def bot_mentioned?
+    @text.split(/\s/).first == "@#{config.bot_username}"
+  end
+
+  def open_ai
+    config.open_ai_client
+  end
+end
+
+ChatGPTBot.configure do |config|
+  config.token = "1234567890:long_alphanumeric_string_goes_here"
+  config.bot_username = "ends_with_bot"
+  config.owner_username = "thats_you"
+  config.chat_gpt_allow_all_group_chats = true
+  config.chat_gpt_allow_all_private_chats = true
+  config.open_ai_token = "sk-WWEt2TQQwRwT5Q6R11erE3TerrY65E2w4q5y1t4T2TwqYYyQ"
+  config.open_ai_client = OpenAI::Client.new(
+    access_token: config.open_ai_token
+  )
+end
+
+ChatGPTBot.run

data/example/open_ai_bot/utils.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Utils
+  def attempt(times, exception=Net::ReadTimeout)
+    retries ||= 0
+    yield
+  rescue exception => e
+    retries += 1
+    if retries < times
+      retry
+    else
+      reply_code(e.message)
+    end
+  end
+
+  def download_file(voice)
+    file_path = @api.get_file(file_id: voice.file_id)["result"]["file_path"]
+
+    url = "https://api.telegram.org/file/bot#{config.token}/#{file_path}"
+
+    file = Down.download(url)
+    FileUtils.mv(file.path, "./#{file.original_filename}")
+    file
+  end
+end

data/example/open_ai_bot/whisper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Whisper
+  def transcribe
+    attempt(3) do
+      voice =
+        if @command == "/transcribe"
+          @replies_to&.voice
+        else
+          @msg.voice
+        end
+
+      return unless voice
+
+      send_chat_action(:typing)
+
+      file = ogg_to_mp3(download_file(voice))
+      response = send_whisper_request(file[:file])
+
+      if response["error"]
+        reply_code(response)
+      else
+        reply(response["text"])
+      end
+    ensure
+      FileUtils.rm_rf(file[:names]) if file
+    end
+  end
+
+  def ogg_to_mp3(file)
+    ogg = file.original_filename
+    mp3 = ogg.sub(/og.\z/, "mp3")
+    `ffmpeg -i ./#{ogg} -acodec libmp3lame ./#{mp3} -y`
+    { file: File.open("./#{mp3}", "rb"), names: [ogg, mp3] }
+  end
+
+  def send_whisper_request(file)
+    open_ai.audio.transcribe(
+      parameters: {
+        model: "whisper-1",
+        file: file
+      }
+    )
+  end
+end

data/lib/rubydium/bot.rb

@@ -52,12 +52,6 @@ module Rubydium
 
     private
 
-    def help_message
-      self.class.registered_commands.map { |command, info|
-        "#{command} - #{info[:description]}"
-      }.join("\n")
-    end
-
     # For example:
     # "/start asdf", "/start@yourbot", "/start /another", "asdf /start" will all return "/start".
     def get_command(text)

data/lib/rubydium/mixins/command_macros.rb

@@ -38,6 +38,12 @@ module Rubydium
           end
         end
 
+        def help_message
+          registered_commands.map { |command, info|
+            "#{command} - #{info[:description]}"
+          }.join("\n")
+        end
+
         def on_mention(method_name=nil, ignore_forwarded: true, &block)
           @registered_on_mention ||= []
           action = (method_name || block)

data/lib/rubydium/mixins/message_sending.rb

@@ -7,6 +7,7 @@ module Rubydium
       def send_message(text)
         @api.send_message(
           chat_id: @chat.id,
+          message_thread_id: @msg.message_thread_id,
           text: text
         )
       end
@@ -16,6 +17,7 @@ module Rubydium
 
         @api.send_sticker(
           chat_id: @chat.id,
+          message_thread_id: @msg.message_thread_id,
           sticker: sticker,
           **kwargs
         )
@@ -32,6 +34,7 @@ module Rubydium
         @api.send_chat_action(
           chat_id: @chat.id,
           action: action,
+          message_thread_id: @msg.message_thread_id,
           **kwargs
         )
       end
@@ -41,6 +44,7 @@ module Rubydium
 
         @api.send_video(
           chat_id: @chat.id,
+          message_thread_id: @msg.message_thread_id,
           video: video,
           **kwargs
         )
@@ -51,6 +55,7 @@ module Rubydium
 
         @api.send_photo(
           chat_id: @chat.id,
+          message_thread_id: @msg.message_thread_id,
           photo: photo,
           **kwargs
         )
@@ -59,6 +64,7 @@ module Rubydium
       def reply(text, **args)
         @api.send_message(
           chat_id: @chat.id,
+          message_thread_id: @msg.message_thread_id,
           reply_to_message_id: @message_id,
           text: text,
           **args
@@ -72,6 +78,7 @@ module Rubydium
       def reply_to_target(text)
         @api.send_message(
           chat_id: @chat.id,
+          message_thread_id: @msg.message_thread_id,
           reply_to_message_id: @replies_to.message_id,
           text: text
         )

data/lib/rubydium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubydium
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

data/rubydium.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.metadata["rubygems_mfa_required"] = "true"
 
   {
-    "telegram-bot-ruby" => ['~> 0.23.0'],
+    "telegram-bot-ruby" => ['~> 1.0.0'],
     "async" => ['~> 2.3']
   }.each do |name, versions|
     spec.add_dependency(name, *versions)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubydium
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - bulgakke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2023-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: telegram-bot-ruby
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement
@@ -54,6 +54,13 @@ files:
 - LICENSE
 - README.md
 - example/example_bot.rb
+- example/open_ai_bot/Gemfile
+- example/open_ai_bot/chat_gpt.rb
+- example/open_ai_bot/chat_thread.rb
+- example/open_ai_bot/dalle.rb
+- example/open_ai_bot/open_ai_bot.rb
+- example/open_ai_bot/utils.rb
+- example/open_ai_bot/whisper.rb
 - lib/rubydium.rb
 - lib/rubydium/bot.rb
 - lib/rubydium/config.rb