chatgpt_assistant 0.1.5 → 0.1.7

data/README.md

@@ -6,15 +6,18 @@
 
 This Ruby gem provides an easy way to initialize a client for Telegram and Discord bots using the ChatGPT API, audio transcription, IBM Cloud Text to Speech, and AWS Polly, creating an assistant that can answer questions in text and voice and have a conversation with the user.
 
-#### Languages supported currently: en, pt - contributions are welcome!
-You can contribute by adding your language to the DefaultMessages class in lib/chatgpt_assistant/default_messages.rb. You can also add your language to the list of languages in the README.md file.
-Pull request from language/YOUR_LANGUAGE to main, remember to name your pull request as "Add YOUR_LANGUAGE support".
+#### Discord Voice Bot temporary disabled due connection issues
+#### Telegram voice messages are working fine
+#### Languages supported currently: en, pt
+
+#### Registration and Account Confirmation are avaiable on telegram only, sign in with the same credentials on discord after registering on telegram.
 
 Other contributions are welcome too!
 Remember to give a star to this repo if you like it!
 ## Requirements
 
-- Ruby > 2.6.0
+- Ruby > 2.6.0 - for the gem who can create bots projects in your machine
+- Ruby 3.2.2 - inside the docker container or run the bots in your machine
 - Docker
 - Docker Compose
 - PostgreSQL
@@ -63,6 +66,11 @@ Remember to edit docker-compose.prod.yml when deploying to production.
 rake compose:up && sudo docker compose run --rm telegram exe/chatgpt_bot migrate
 ```
 
+## Install [Awesome Chatgpt Actors](https://github.com/JesusGautamah/awesome-chatgpt-actors)
+```bash
+rake chatgpt_actors:install
+```
+
 ## Usage
 
 You can start the Docker Compose services required for the gem using the rake tasks provided by the Lucy Dockerunner gem. These tasks include compose:up, compose:down, compose:status, compose:shell, compose:restart, and others listed previously.
@@ -87,39 +95,29 @@ After starting the Docker Compose services, you can use the features of the gem
 ## Discord Bot Commands
 
 The discord commands prefix can be changed in the .env file.
-The default prefix is dgpt!
-
-- dgpt!start - shows the welcome message
-- dgpt!help - shows the help message
-- dgpt!login email:password - logs in the user
-- dgpt!register email:password - registers a new user
-- dgpt!list - lists the user created chatbots
-- dgpt!sl_chat CHAT TITLE - starts a chat with the chatbot with the given title
-- dgpt!new_chat CHAT TITLE - creates a new chatbot with the given title
-- dgpt!ask TEXT - sends a text to the chatbot
-- dgpt!connect - connects the chat bot to the current channel
-- dgpt!disconnect - disconnects the chat bot from the current channel
-- dgpt!speak TEXT - sends a text to the chatbot and gets the response in voice
+The default prefix is !!
+
+- !!start - shows the welcome message
+- !!help - shows the help message
+- !!login email:password - logs in the user. Remember to use private messages to register or login and share a server with right permissions with the bot to message it.
+- !!list - lists the user created chatbots
+- !!sl_chat CHAT TITLE - starts a chat with the chatbot with the given title
+- !!new_chat CHAT TITLE - creates a new chatbot with the given title
+- !!ask TEXT - sends a text to the chatbot
 
 ## Telegram Bot Commands
 
 - /start - shows the welcome message
 - /help - shows the help message
-- login/email:password - logs in the user
-- register/email:password - registers a new user
+- login/email:password - logs in the user. Remember to use private messages to register or login.
+- register/email:password - registers a new user, email is not verfied yet, so you can use any email, the password is encrypted with bcrypt and stored in the database with salt. Remember to use private messages to register or login.
+- confirm/* name:token - confirms the user account. Remember to use private messages to register or login
 - list - lists the user created chatbots
 - sl_chat/CHAT TITLE - starts a chat with the chatbot with the given title
 - new_chat/CHAT TITLE - creates a new chatbot with the given title
 - TEXT - sends a text to the chatbot
 - VOICE_MESSAGE or AUDIO FILE - sends a voice message to the chatbot and returns the response in voice
 
-## Recommended Actions runner
-
-You can run Github Actions workflows locally using [act](https://github.com/nektos/act)
-
-We recommend Act installation to run Github Actions workflows locally
-as we use it to deploy the bot in a server via ssh.
-
 ## Contributing
 
 A good way to contribute is add your language to DefaultMessages class in lib/chatgpt_assistant/default_messages.rb. You can also add your language to the list of languages in the README.md file.
@@ -138,7 +136,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/JesusG
 [![Activity map](https://images.repography.com/33522702/JesusGautamah/chatgpt_assistant/recent-activity/y6ZDduNWHwPzbnUFsmdGrJ99Q1vyEKGOBWFOBvzGjnM/1rZM2QrF0__3eUfUXFe6jDraYjHvypniTqDWhCequ-U_map.svg)](https://github.com/JesusGautamah/chatgpt_assistant/commits)
 
 ## Contributors
-  - [Jesus Gautamah](https://github.com/JesusGautamah) 
+  - [Jesus Gautamah](https://github.com/JesusGautamah)
 
 ## License
 

data/Rakefile

@@ -4,6 +4,7 @@
 require "rspec/core/rake_task"
 require "lucy_dockerunner"
 require "awesome_chatgpt_actors"
+require "dotenv/load"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/docker-compose.yml

@@ -1,5 +1,11 @@
 version: "3.3"
 services:
+  redis:
+    image: redis:6-alpine
+    ports:
+      - "6379:6379"
+    volumes:
+      - ./redis_data:/data
   db:
     image: postgres:12.2
     ports:
@@ -12,23 +18,39 @@ services:
     build: .
     command: bash -c "exe/chatgpt_bot telegram"
     volumes:
-      - .:/chatgpt_assistant
+      - .:/assistant
     environment:
       POSTGRES_HOST: db
     env_file:
       - .env
     depends_on:
       - db
+      - redis
+      - sidekiq
   discord:
     build: .
     command: bash -c "exe/chatgpt_bot discord"
     volumes:
-      - .:/chatgpt_assistant
+      - .:/assistant
+    environment:
+      POSTGRES_HOST: db
+    env_file:
+      - .env
+    depends_on:
+      - db
+      - redis
+      - sidekiq
+  sidekiq:
+    build: .
+    command: bash -c "exe/chatgpt_bot sidekiq"
+    volumes:
+      - .:/assistant
     environment:
       POSTGRES_HOST: db
     env_file:
       - .env
     depends_on:
       - db
+      - redis
 volumes:
-  postgres:
+  postgres:

data/exe/chatgpt_assistant

@@ -26,7 +26,7 @@ gem_dir = Gem::Specification.find_by_name("chatgpt_assistant").gem_dir
   `cp #{gem_dir}/#{file} #{path}`
 end
 
-%w[docker-compose.yml docker-compose.prod.yml Dockerfile LICENSE LICENSE.txt].each do |file|
+%w[docker-compose.yml Dockerfile LICENSE LICENSE.txt].each do |file|
   `cp #{gem_dir}/#{file} #{path}`
 end
 

data/exe/chatgpt_bot

@@ -11,6 +11,9 @@ when "telegram"
   ChatgptAssistant::Main.new("telegram").start
 when "discord"
   ChatgptAssistant::Main.new("discord").start
+when "sidekiq"
+  # start sidekiq with the lib/chatgpt_assistant/sidekiq.rb
+  system "bundle exec sidekiq -r ./lib/chatgpt_assistant/sidekiq.rb -C ./lib/chatgpt_assistant/sidekiq.yml"
 when "migrate"
   ChatgptAssistant::Config.new.migrate
 end

data/lib/{bots → chatgpt_assistant/bots}/application_bot.rb

@@ -1,23 +1,27 @@
 # frozen_string_literal: true
 
+# helpers
 require_relative "helpers/messenger_helper"
-require_relative "helpers/authentication_helper"
-require_relative "helpers/visit_helper"
 require_relative "helpers/audio_helper"
-require_relative "helpers/logger_action_helper"
 require_relative "helpers/search_helper"
-require_relative "helpers/validation_helper"
 require_relative "helpers/file_helper"
+
+# jobs
+require_relative "jobs/register_job"
+require_relative "jobs/new_chat_job"
+require_relative "jobs/voice_connect_job"
+
+# services
+require_relative "services/register_service"
+require_relative "services/new_chat_service"
+require_relative "services/voice_connect_service"
+
 module ChatgptAssistant
-  # This class is responsible to contain the shared variables between the bot classes
+  # This class is responsible to contain the shared attributes and methods
   class ApplicationBot
     include MessengerHelper
-    include AuthenticationHelper
-    include VisitHelper
     include AudioHelper
-    include LoggerActionHelper
     include SearchHelper
-    include ValidationHelper
     include FileHelper
 
     def initialize(config)
@@ -30,7 +34,7 @@ module ChatgptAssistant
       @discord_prefix = @config.discord_prefix
       @database = @config.db_connection
       @mode = @config.mode
-      @commom_messages = default_msg.commom_messages
+      @common_messages = default_msg.common_messages
       @error_messages = default_msg.error_messages
       @success_messages = default_msg.success_messages
       @help_messages = default_msg.help_messages
@@ -38,7 +42,7 @@ module ChatgptAssistant
 
     attr_reader :openai_api_key, :telegram_token, :database, :default_msg,
                 :mode, :config, :discord_token, :discord_client_id,
-                :discord_prefix, :commom_messages, :error_messages, :success_messages,
+                :discord_prefix, :common_messages, :error_messages, :success_messages,
                 :help_messages
     attr_accessor :msg, :evnt, :bot, :audio_url, :visitor, :user, :chat, :chat_id
 

data/lib/chatgpt_assistant/bots/discord/actions.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module ChatgptAssistant
+  module Bots
+    module Discord
+      module Actions
+        def login_action
+          user_email, user_password = message.split(":")
+          case discord_user_auth(user_email, user_password, evnt.user.id)
+          when "user not found"
+            send_message error_messages[:user_not_found]
+          when "wrong password"
+            puts "wrong password"
+            send_message error_messages[:wrong_password]
+          when find_user(email: user_email).email
+            send_message success_messages[:user_logged_in]
+          end
+        end
+
+        def start_action
+          fields = %w[login start help new_chat sl_chat ask list hist connect disconnect speak]
+
+          values_hash = {
+            login: "Account login, use: #{discord_prefix}login email:password",
+            start: "Start the bot, use: #{discord_prefix}start",
+            help: "Show this message, use: #{discord_prefix}help",
+            new_chat: "Create a new chat, use: #{discord_prefix}new_chat chat_name",
+            sl_chat: "Select a chat, use: #{discord_prefix}sl_chat chat_name",
+            ask: "Ask a question, use: #{discord_prefix}ask question",
+            list: "List all chats, use: #{discord_prefix}list",
+            hist: "Show chat history, use: #{discord_prefix}hist",
+            connect: "Connect to voice channel, use: #{discord_prefix}connect",
+            disconnect: "Disconnect from voice channel, use: #{discord_prefix}disconnect",
+            speak: "Speak in voice channel, use: #{discord_prefix}speak question"
+          }
+
+          embed = Discordrb::Webhooks::Embed.new(
+            title: "Hello, #{evnt.user.name}!",
+            description: "I'm ChatGPT Assistant, see my commands below:",
+            color: "00FF00",
+            fields: fields.map { |field| { name: field, value: values_hash[field.to_sym] } }
+          )
+          evnt.respond nil, false, embed
+        end
+
+        def help_action
+          start_action
+        end
+
+        def list_action
+          chats = user.chats
+
+          embed = Discordrb::Webhooks::Embed.new(
+            title: "Hello, #{evnt.user.name}!",
+            description: "Your chats:",
+            color: "00FF00",
+            fields: chats.map { |field| { name: field.title, value: field.actor || "No prompt" } }
+          )
+
+          evnt.respond nil, false, embed
+        end
+
+        def hist_action
+          messages = Message.where(chat_id: chat.id).order(:created_at)
+          messages.each { |m| send_message "#{m.role} - #{m.content}\n#{m.created_at.strftime("%d/%m/%Y %H:%M")}" }
+          "This is the end of the chat history"
+        end
+
+        def sl_chat_action(chat_to_select)
+          @chat = user.chat_by_title(chat_to_select)
+          send_message error_messages[:chat_not_found] if chat.nil?
+          user.update(current_chat_id: chat.id) if chat
+          send_message success_messages[:chat_selected] if chat
+        end
+
+        def create_chat_action
+          title = evnt.message.content.split[1..].join(" ")
+          mode = nil
+          if title.include? ":"
+            mode = title.split(":").last.to_i
+            title = title.split(":").first
+          end
+          actors = AwesomeChatgptActors::CastControl.actors
+          return send_message "invalid mode" unless (mode.to_i >= 1 && mode.to_i <= actors.size + 1) || mode.nil?
+          return send_message "invalid chat title" if title.nil? || title.empty?
+          return send_message "chat title already exists" if user.chat_by_title(title)
+
+          actor_name = actors[mode.to_i - 1] if mode
+          actor = AwesomeChatgptActors::Actor.new(role: actor_name, language: config.language) if actor_name
+          chat = Chat.new(user_id: user.id, status: 0, title: title, actor: actor_name, prompt: actor.prompt) if actor
+          chat = Chat.new(user_id: user.id, status: 0, title: title) unless actor
+          return send_message "Something went wrong", msg.chat.id unless chat
+
+          chat.save ? chat_created_message(chat) : send_message(error_messages[:chat_creation])
+        end
+
+        def discord_created(chat)
+          evnt.respond "Intructions sended to actor:\n#{chat.prompt}" unless chat.actor.nil?
+          evnt.respond success_messages[:chat_created] if evnt.present?
+        end
+      end
+    end
+  end
+end

data/lib/chatgpt_assistant/bots/discord/auth.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ChatgptAssistant
+  module Bots
+    module Discord
+      module Auth
+        def discord_visited?(user_id)
+          return unless evnt
+
+          visitor = Visitor.find_by(discord_id: user_id, name: evnt.user.name)
+          if visitor.nil?
+            Visitor.create(discord_id: user_id, name: evnt.user.name)
+          else
+            visitor
+          end
+        end
+
+        def discord_user_auth(email, password, discord_id)
+          user = find_user(email: email)
+          return "user not found" unless user
+          return "wrong passwords" if password.nil?
+
+          user.valid_password?(password) ? discord_user_access(discord_id, user.email) : "wrong password"
+        end
+
+        def discord_user_access(discord_id, user_email)
+          other_access = where_user(discord_id: discord_id)
+          other_access&.each { |access| access.update(discord_id: nil) }
+          user = find_user(email: user_email)
+          user.update(discord_id: discord_id)
+          user.email
+        end
+      end
+    end
+  end
+end

data/lib/chatgpt_assistant/bots/discord/bot.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ChatgptAssistant
+  module Bots
+    module Discord
+      module Bot
+        def bot
+          @bot ||= Discordrb::Commands::CommandBot.new(
+            token: discord_token,
+            client_id: discord_client_id,
+            prefix: discord_prefix
+          )
+        end
+
+        def user
+          @user = find_user(discord_id: evnt.user.id)
+        end
+
+        def bot_init
+          at_exit { bot.stop }
+          bot.run
+        rescue StandardError => e
+          Error.create(message: e.message, backtrace: e.backtrace)
+          retry
+        end
+      end
+    end
+  end
+end

data/lib/chatgpt_assistant/bots/discord/chat_actions.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ChatgptAssistant
+  module Bots
+    module Discord
+      module ChatActions
+        def ask_action
+          @chat = Chat.where(id: user.current_chat_id).last
+          send_message error_messages[:chat_not_found] if chat.nil?
+          @message = Message.new(chat_id: chat.id, content: message, role: "user") if chat
+          (message.save ? answer_action : send_message(error_messages[:message_not_saved])) if chat
+        end
+
+        def private_message_action
+          @chat = Chat.where(id: user.current_chat_id).last
+          send_message error_messages[:chat_not_found] if chat.nil?
+          @message = Message.new(chat_id: chat.id, content: message, role: "user") if chat
+          (message.save ? answer_action : send_message(error_messages[:message_not_saved])) if chat
+        end
+
+        def answer_action
+          response = chatter.chat(message.content, chat.id, error_messages[:something_went_wrong])
+          send_message response
+        end
+
+        def send_message(text)
+          messages = parse_message(text, 2000)
+          messages.each { |m| evnt.respond m }
+        end
+      end
+    end
+  end
+end

data/lib/chatgpt_assistant/bots/discord/events.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module ChatgptAssistant
+  module Bots
+    module Discord
+      module Events
+        def start_event
+          bot.command :start do |event|
+            @evnt = event
+            @user = event.user
+            start_action
+            "Ok"
+          end
+        end
+
+        def login_event
+          bot.command :login do |event|
+            @message = event.message.content.split[1]
+            @evnt = event
+            message.nil? ? event.respond(common_messages[:login]) : login_action
+            "OK"
+          end
+        end
+
+        def list_event
+          bot.command :list do |event|
+            @evnt = event
+            list_action if valid_for_list_action?
+            "OK"
+          end
+        end
+
+        def hist_event
+          bot.command :hist do |event|
+            @evnt = event
+            @chat = user.current_chat
+            event.respond error_messages[:chat_not_found] if chat.nil? && user
+            hist_action if user && chat
+            "OK"
+          end
+        end
+
+        def help_event
+          bot.command :help do |event|
+            @evnt = event
+            help_action
+            "OK"
+          end
+        end
+
+        def new_chat_event
+          bot.command :new_chat do |event|
+            @evnt = event
+            event.respond error_messages[:user_not_logged_in] if user.nil?
+            event.respond error_messages[:account_not_verified] if user && !user.active?
+            create_chat_action if user&.active?
+            "OK"
+          end
+        end
+
+        def sl_chat_event
+          bot.command :sl_chat do |event|
+            @evnt = event
+            chat_to_select = event.message.content.split[1..].join(" ")
+            event.respond error_messages[:user_not_logged_in] if user.nil?
+            event.respond error_messages[:account_not_verified] if user && !user.active?
+            sl_chat_action(chat_to_select) if user&.active?
+            "OK"
+          end
+        end
+
+        def ask_event
+          bot.command :ask do |event|
+            @evnt = event
+            @message = event.message.content.split[1..].join(" ")
+            event.respond error_messages[:user_not_logged_in] if user.nil?
+            event.respond error_messages[:account_not_verified] if user && !user.active?
+            ask_action if user&.active?
+            "OK"
+          end
+        end
+
+        def voice_connect_event
+          bot.command :connect do |event|
+            @evnt = event
+            if user && !user.active?
+              event.respond error_messages[:account_not_verified]
+            elsif user&.current_chat_id.nil?
+              event.respond error_messages[:no_chat_selected]
+            elsif user&.current_chat_id
+              @chat = Chat.find(user.current_chat_id)
+              voice_connect_checker_action
+              voice_connection_checker_action
+              bot.voice_connect(event.user.voice_channel)
+            else
+              event.respond error_messages[:user_not_logged_in]
+            end
+            "OK"
+          end
+        end
+
+        def voice_disconnect_event
+          bot.command :disconnect do |event|
+            @evnt = event
+            disconnect_checker_action
+            disconnect_action if user && event.user.voice_channel && event.voice
+            "OK"
+          end
+        end
+
+        def speak_event
+          bot.command :speak do |event|
+            @evnt = event
+            @message = event.message.content.split[1..].join(" ")
+            @chat = user.current_chat
+            speak_connect_checker_action
+            speak_connection_checker_action
+            ask_to_speak_action if user && event.user.voice_channel && event.voice && !chat.nil?
+            "OK"
+          end
+        end
+
+        def private_message_event
+          bot.message do |event|
+            @evnt = event
+            @visitor = discord_visited?(@evnt.user.id)
+            next if discord_next_action?
+
+            @message = event.message.content
+            @chat = user.current_chat if user
+            private_message_action if user && !chat.nil?
+            "OK"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chatgpt_assistant/bots/discord/validations.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ChatgptAssistant
+  module Bots
+    module Discord
+      module Validations
+        def discord_next_action?
+          return true if evnt.channel.type != 1 && evnt.channel.name != "ai-spaces"
+
+          %w[login register start help new_chat sl_chat ask
+             list hist connect disconnect speak].each do |action|
+            return true if evnt.message.content.include?("#{discord_prefix}#{action}")
+          end
+          false
+        end
+
+        def discord_voice_bot_disconnected?
+          user && evnt.user.voice_channel && !evnt.voice && !chat.nil?
+        end
+
+        def discord_voice_bot_connected?
+          user && evnt.user.voice_channel && evnt.voice && !chat.nil?
+        end
+
+        def visitor_user?
+          visitor&.dis_user.nil?
+        end
+
+        def valid_for_list_action?
+          evnt.respond(error_messages[:user_not_logged_in]) if user.nil?
+          evnt.respond(error_messages[:account_not_verified]) unless user.active?
+          evnt.respond(error_messages[:chat_not_found]) if user.chats.count.zero? && user.active?
+          !user.nil? && user.active? && user.chats.count.positive?
+        end
+      end
+    end
+  end
+end

data/lib/chatgpt_assistant/bots/discord/voice_actions.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module ChatgptAssistant
+  module Bots
+    module Discord
+      module VoiceActions
+        def ask_to_speak_action
+          Message.create(chat_id: chat.id, content: message, role: "user", discord_message_id: evnt.message.id)
+          response = chatter.chat(message, chat.id, error_messages[:something_went_wrong])
+          audio_path = synthesis.synthesize_text(response)
+          speak_answer_action(audio_path, response)
+        end
+
+        def speak_answer_action(audio_path, response)
+          send_message response
+          evnt.voice.play_file(audio_path)
+          delete_file audio_path
+          "OK"
+        end
+
+        def discord_voice_bot_connect
+          bot.voice_connect(evnt.user.voice_channel) if discord_voice_bot_disconnected?
+          discord_voice_bot_connected? ? "Connected to voice channel" : "Error connecting to voice channel"
+        end
+
+        def disconnect_action
+          bot.voice_destroy(evnt.user.voice_channel)
+          "Disconnected from voice channel"
+        end
+      end
+    end
+  end
+end