simplex-chat 0.6.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1085de134ea131845256d9109e043629b6f83ab59adf94625c89287272c9966a
-  data.tar.gz: e2a1ac6403338b1cc07238d4dc6a2cdb15992a5e938b3df04c98d72d7cce3a93
+  metadata.gz: f6abe984f48fda66308c887485726f5ea72e703750c328effa1a5e90d2b89134
+  data.tar.gz: e88620b62cf4258c52af6eac68b94d9f5991164848a0f6aa52e1e079a500f4e1
 SHA512:
-  metadata.gz: 516773178824c494adaa70bef60b323774c8775456eeef1de33ca3bc2131073808d85db998ebade717254286374db2f25b8bec2ba4fd903502b229a70ecc2467
-  data.tar.gz: 9c4848683f657f145538979603d2d5edfa83e32aaf030b6422b5d60ca38613ff8a517abd30f800c508744e255f48d4a172fa4297e2d9ae7d2f55b6ef948db5e1
+  metadata.gz: 4fe774622151042e7774640645213ba3f709e8b42719d0344f7c2176ea12c57a803eb7c30fe5051e8c8c56e361cb362ad691247766a5fcc570a9889bc03b8a25
+  data.tar.gz: 8ecef57f4c0b4d39a0e8bf75d821f67e08c06850f97fbae1db7a51bd165bf1cd38b75ecf4b5fc5985375d0455c9ca1fd7e36b550229a12cebf5b3b5c6e263ab6

data/lib/simplex-chat/cmd-runner.rb

@@ -0,0 +1,170 @@
+module SimpleXChat
+  class BasicCommand
+    attr_reader :name, :num_args, :desc, :min_role
+
+    # TODO: Allow optional arguments
+    def initialize(name, desc="", num_args: 0, min_role: GroupMemberRole::MEMBER,
+                   per_sender_cooldown_secs: nil, per_issuer_cooldown_secs: nil)
+      @name = name
+      @num_args = num_args
+      @desc = desc
+      @min_role = min_role
+      @per_sender_cooldown_secs = per_sender_cooldown_secs
+      @per_issuer_cooldown_secs = per_issuer_cooldown_secs
+      @last_runs = {
+        :per_sender => {},
+        :per_issuer => {}
+      }
+      @last_runs_lock = Mutex.new
+    end
+
+    def validate_and_execute(client, chat_msg, args)
+      return if not validate(client, chat_msg, args)
+      begin
+        execute client, chat_msg, args
+      rescue
+        client.api_send_text_message chat_msg[:chat_type], chat_msg[:sender], "@#{chat_msg[:contact]}: Failed to execute command"
+      end
+    end
+
+    private
+
+    def validate(client, chat_msg, args)
+      msg_text = chat_msg[:msg_text]
+      chat_type = chat_msg[:chat_type]
+      issuer = chat_msg[:contact]
+      issuer_role = chat_msg[:contact_role]
+      sender = chat_msg[:sender]
+
+      # Verify that user has permissions to run the command
+      role_hierarchy = {
+        GroupMemberRole::MEMBER => 0,
+        GroupMemberRole::ADMIN => 1,
+        GroupMemberRole::OWNER => 2
+      }
+      perms = role_hierarchy[issuer_role]
+      if issuer_role != nil and perms == nil || perms < role_hierarchy[@min_role]
+        client.api_send_text_message chat_type, sender, "@#{issuer}: You do not have permission to run this command (required: #{@min_role})"
+        return false
+      end
+
+      # Verify arguments
+      if args.length != @num_args
+        client.api_send_text_message chat_type, sender, "@#{issuer}: Incorrect number of arguments (required: #{@num_args})"
+        return false
+      end
+
+      # Verify per sender cooldown
+      # NOTE: This should be the last verification, because
+      #       it will update the last-validated-runs object
+      is_on_cooldown = true
+      remaining_cooldown = 0.0
+      chat = "#{chat_type}#{sender}"
+      chat_and_issuer = "#{chat_type}#{sender}[#{issuer}]"
+      @last_runs_lock.synchronize {
+        sender_last_run = @last_runs[:per_sender][chat]
+        issuer_last_run = @last_runs[:per_issuer][chat_and_issuer]
+        now = Time.now
+        if sender_last_run != nil && @per_sender_cooldown_secs != nil
+          time_diff = now - sender_last_run
+          if time_diff < @per_sender_cooldown_secs
+            remaining_cooldown = @per_sender_cooldown_secs - time_diff
+          end
+        end
+
+        if issuer_last_run != nil && @per_issuer_cooldown_secs != nil
+          time_diff = now - issuer_last_run
+          if time_diff < @per_issuer_cooldown_secs
+            cooldown = @per_issuer_cooldown_secs - time_diff
+            remaining_cooldown = [cooldown, remaining_cooldown].max
+          end
+        end
+
+        break if remaining_cooldown > 0.0
+
+        @last_runs[:per_sender][chat] = now
+        @last_runs[:per_issuer][chat_and_issuer] = now
+        is_on_cooldown = false
+      }
+
+      if is_on_cooldown
+        client.api_send_text_message chat_type, sender, "@#{issuer}: On cooldown, try again in #{remaining_cooldown.round(1)} seconds"
+        return false
+      end
+      
+
+      return true
+    end
+
+    def execute(client, chat_msg, args)
+      raise NoMethodError.new(
+        "[!] Default BasicCommand::execute called, nothing will be done\n" \
+        "    Extend this class to implement custom execution behavior"
+      )
+    end
+  end
+
+  class BasicCommandRunner
+    def initialize(client, commands, prefix)
+      @client = client
+      @commands = commands.map { |cmd|
+        { "#{prefix}#{cmd.name}" => cmd }
+      }.reduce({}, &:merge)
+      @prefix = prefix
+      @logger = Logging.logger
+    end
+
+    def listen(max_backlog_secs: 5.0)
+      loop do
+        begin
+          break if process_next_event(max_backlog_secs) == :stop
+        rescue SimpleXChat::GenericError => e
+          @logger.error("[!] Caught error: #{e}")
+        rescue => e
+          raise e
+        end
+      end
+    end
+
+    private
+
+    def process_next_event(max_backlog_secs)
+      chat_msg = @client.next_chat_message(max_backlog_secs: max_backlog_secs)
+      if chat_msg == nil
+        @logger.warn("Message queue is closed")
+        return :stop
+      end
+      @logger.debug("Chat message: #{chat_msg}")
+
+      msg_text = chat_msg[:msg_text]
+      chat_type = chat_msg[:chat_type]
+      issuer = chat_msg[:contact]
+      issuer_role = chat_msg[:contact_role]
+      sender = chat_msg[:sender]
+
+      # Skip automated group messages
+      return if issuer == nil
+
+      # Verify if message is a command
+      message_items = msg_text.split(" ")
+      first_word = message_items[0]
+      return if not first_word.start_with?(@prefix)
+
+      # React to all messages we will process
+      @client.api_reaction chat_msg[:chat_type], chat_msg[:sender_id], chat_msg[:msg_item_id], emoji: '🚀'
+
+      # Verify if this is a registered command
+      command = @commands[first_word]
+      if command == nil
+        @client.api_send_text_message chat_msg[:chat_type], chat_msg[:sender], "@#{issuer}: Unknown command"
+        return
+      end
+
+      args = message_items[1..]
+
+      # Run command
+      @logger.debug("Validating and executing command '#{command.name}' for: #{chat_type}#{sender} [#{issuer}]: #{msg_text}")
+      command.validate_and_execute @client, chat_msg, args
+    end
+  end
+end

data/lib/simplex-chat/logger.rb

@@ -0,0 +1,18 @@
+require 'logger'
+
+module SimpleXChat
+  module Logging
+    def self.logger(dest: $stderr, log_level: Logger::INFO)
+      if @logger == nil
+        @logger = Logger.new(dest)
+        @logger.level = log_level
+        @logger.progname = 'simplex-chat'
+        @logger.formatter = -> (severity, datetime, progname, msg) {
+          "| [#{severity}] | #{datetime} | (#{progname}) :: #{msg}\n"
+        }
+      end
+
+      @logger
+    end
+  end
+end

data/lib/simplex-chat/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimpleXChat
-  VERSION = "0.6.1"
+  VERSION = "0.7.1"
 end

data/lib/simplex-chat.rb

@@ -4,6 +4,7 @@ require_relative 'simplex-chat/version'
 require_relative 'simplex-chat/errors'
 require_relative 'simplex-chat/patches'
 require_relative 'simplex-chat/types'
+require_relative 'simplex-chat/logger'
 
 module SimpleXChat
   require 'net/http'
@@ -14,9 +15,7 @@ module SimpleXChat
   require 'time'
 
   class ClientAgent
-    attr_accessor :on_message
-
-    def initialize(client_uri, connect: true, log_level: Logger::INFO, timeout_ms: 10_000, interval_ms: 100)
+    def initialize(client_uri, connect: true, timeout_ms: 10_000, interval_ms: 100)
       @uri = client_uri
       @message_queue = Queue.new
       @chat_message_queue = Queue.new
@@ -30,12 +29,7 @@ module SimpleXChat
       @timeout_ms = timeout_ms
       @interval_ms = interval_ms
 
-      @logger = Logger.new($stderr)
-      @logger.level = log_level
-      @logger.progname = 'simplex-chat'
-      @logger.formatter = -> (severity, datetime, progname, msg) {
-        "| [#{severity}] | #{datetime} | (#{progname}) :: #{msg}\n"
-      }
+      @logger = Logging.logger
 
       self.connect if connect
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: simplex-chat
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.1
 platform: ruby
 authors:
 - rdbo
 bindir: exe
 cert_chain: []
-date: 2025-03-05 00:00:00.000000000 Z
+date: 2025-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket
@@ -48,7 +48,9 @@ files:
 - README.md
 - Rakefile
 - lib/simplex-chat.rb
+- lib/simplex-chat/cmd-runner.rb
 - lib/simplex-chat/errors.rb
+- lib/simplex-chat/logger.rb
 - lib/simplex-chat/patches.rb
 - lib/simplex-chat/types.rb
 - lib/simplex-chat/version.rb