simplex-chat 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dde8b2fbd228f72ec1b9cb4f95269401aa2fa68774b38fdbef43d8eec2b7d63
-  data.tar.gz: 1c54b1064c53ceeb06ae4b0f68715e773e96753208ec87b7ad445e2863649969
+  metadata.gz: cb15441c1b0a770fff253bb8eddbacf6bf52df1ddcddd502597ada7385a62c1c
+  data.tar.gz: 0ba06bf88529d8bbd2eb429fd781162c94a23bfe7577ea313ef9ca8db346c407
 SHA512:
-  metadata.gz: 669c992a7cbab4e903581bae8def4f6a4dc6e269cc5041e8e0dd5901bc62e8d162aaf4aa95ab0f266932619e34c48d10400107dfd84d4a8cc60d64c51a40711a
-  data.tar.gz: f6c49bb438a61eb4015cd94e5f29197214b36a7eb3d18f5a8bee05ecc2d7cbcf284f10d792cb3b0aad8aa9f3c41be36a78875b5c38b13961770aa835b829823c
+  metadata.gz: e975110a2bfa186b9f1f9f80264fa0343bc6e148e113a4eaf0d778064abbdeb54e822725e51ca499700f4e2a855fa41a8a06aa532b5561ecc33e75795528adcc
+  data.tar.gz: b681e83e16e20ad1e55f0c16918a5fe438703bd98c29e1f6a4cca2e24af19e3a352162a9bb2dab673f927974b222715fe431cf7d521ff0848431631846fe5d66

data/lib/simplex-chat/errors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SimpleXChat
+  # All SimpleX-related errors will inherit from GenericError
+  # These errors should be recoverable
+  class GenericError < StandardError
+  end
+
+  class SendCommandError < GenericError
+    def initialize(cmd)
+      super "Failed to send command: #{cmd}"
+    end
+  end
+
+  class UnexpectedResponseError < GenericError
+    def initialize(type, expected_type)
+      super "Unexpected response type: #{type} (expected: #{expected_type})"
+    end
+  end
+end

data/lib/simplex-chat/patches.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SimpleXChat
+  require 'net/http'
+
+  # Fixes regex match for status line in HTTPResponse
+  class HTTPResponse < Net::HTTPResponse
+    class << self
+      def read_status_line(sock)
+        str = sock.readline
+        m = /\AHTTP(?:\/(\d+\.\d+))?\s+(\d\d\d)(?:\s+(.*))?\Z/in.match(str) or
+          raise Net::HTTPBadResponse, "wrong status line: #{str.dump}"
+        m.captures
+      end
+    end
+  end
+end

data/lib/simplex-chat/types.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SimpleXChat
+  module ChatType
+    DIRECT = '@'
+    GROUP = '#'
+    CONTACT_REQUEST = '<@'
+  end
+
+  module GroupMemberRole
+    AUTHOR = 'author' # reserved and unused as of now, but added anyways
+    OWNER = 'owner'
+    ADMIN = 'admin'
+    MEMBER = 'member'
+    OBSERVER = 'observer'
+  end
+end

data/lib/simplex-chat/version.rb

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

data/lib/simplex-chat.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 require_relative 'simplex-chat/version'
+require_relative 'simplex-chat/errors'
+require_relative 'simplex-chat/patches'
+require_relative 'simplex-chat/types'
 
 module SimpleXChat
   require 'net/http'
@@ -10,28 +13,10 @@ module SimpleXChat
   require 'concurrent'
   require 'time'
 
-  # Fixes regex match for status line in HTTPResponse
-  class HTTPResponse < Net::HTTPResponse
-    class << self
-      def read_status_line(sock)
-        str = sock.readline
-        m = /\AHTTP(?:\/(\d+\.\d+))?\s+(\d\d\d)(?:\s+(.*))?\Z/in.match(str) or
-          raise Net::HTTPBadResponse, "wrong status line: #{str.dump}"
-        m.captures
-      end
-    end
-  end
-
-  module ChatType
-    DIRECT = '@'
-    GROUP = '#'
-    CONTACT_REQUEST = '<@'
-  end
-
   class ClientAgent
     attr_accessor :on_message
 
-    def initialize client_uri, connect: true, log_level: Logger::INFO
+    def initialize(client_uri, connect: true, log_level: Logger::INFO, timeout_ms: 10_000, interval_ms: 100)
       @uri = client_uri
       @message_queue = SizedQueue.new 4096
       @chat_message_queue = Queue.new
@@ -42,6 +27,8 @@ module SimpleXChat
       @listener_thread = nil
       @corr_id = Concurrent::AtomicFixnum.new(1) # Correlation ID for mapping client responses to command waiters
       @command_waiters = Concurrent::Hash.new
+      @timeout_ms = timeout_ms
+      @interval_ms = interval_ms
 
       @logger = Logger.new($stderr)
       @logger.level = log_level
@@ -50,9 +37,7 @@ module SimpleXChat
         "| [#{severity}] | #{datetime} | (#{progname}) :: #{msg}\n"
       }
 
-      if connect
-        self.connect
-      end
+      self.connect if connect
 
       @logger.debug("Initialized ClientAgent")
     end
@@ -79,6 +64,7 @@ module SimpleXChat
 
             msg = JSON.parse obj.to_s
             # @logger.debug("New message: #{msg}")
+            # @logger.debug("Command waiters: #{@command_waiters}")
 
             corr_id = msg["corrId"]
             resp = msg["resp"]
@@ -88,6 +74,7 @@ module SimpleXChat
               single_use_queue.push(resp)
               @logger.debug("Message sent to waiter with corrId '#{corr_id}'")
             else
+              @logger.debug("Message put on message queue")
               @message_queue.push resp
             end
           rescue IO::WaitReadable
@@ -144,8 +131,13 @@ module SimpleXChat
           group = nil
           sender = nil
           contact = nil
+          contact_role = nil
           if chat_type == ChatType::GROUP
-            contact = chat_item["chatItem"]["chatDir"]["groupMember"]["localDisplayName"]
+            # NOTE: The group can "send messages" without a contact
+            #       For example, when a member is removed, the group
+            #       sends a message about his removal, with no contact
+            contact = chat_item.dig "chatItem", "chatDir", "groupMember", "localDisplayName"
+            contact_role = chat_item.dig "chatItem", "chatDir", "groupMember", "memberRole"
             group = chat_item["chatInfo"]["groupInfo"]["localDisplayName"]
             sender = group
           else
@@ -155,14 +147,17 @@ module SimpleXChat
 
           msg_text = chat_item["chatItem"]["meta"]["itemText"]
           timestamp = chat_item["chatItem"]["meta"]["updatedAt"]
+          image_preview = chat_item.dig "chatItem", "content", "msgContent", "image"
 
           chat_message = {
             :chat_type => chat_type,
             :sender => sender,
+            :contact_role => contact_role,
             :contact => contact,
             :group => group,
             :msg_text => msg_text,
-            :msg_timestamp => Time.parse(timestamp)
+            :msg_timestamp => Time.parse(timestamp),
+            :img_preview => image_preview
           }
 
           @chat_message_queue.push chat_message
@@ -182,7 +177,7 @@ module SimpleXChat
     end
 
     # Sends a raw command to the SimpleX Chat client
-    def send_command(cmd)
+    def send_command(cmd, timeout_ms: @timeout_ms, interval_ms: @interval_ms)
       corr_id = next_corr_id
       obj = {
         "corrId" => corr_id,
@@ -198,30 +193,40 @@ module SimpleXChat
       # command response
       single_use_queue = SizedQueue.new 1
       @command_waiters[corr_id] = single_use_queue
+      @logger.debug("Created command waiter for command ##{corr_id}")
 
+      @logger.debug("Sending command ##{corr_id}: #{json.to_s}")
       @socket.write frame.to_s
 
+      @logger.debug("Waiting response for command ##{corr_id}...")
       msg = nil
-      100.times do
+      iterations = timeout_ms / interval_ms
+      iterations.times do
         begin
           msg = single_use_queue.pop(true)
           break
         rescue ThreadError
-          sleep 0.1
+          sleep(interval_ms / 1000.0)
         end
       end
 
       if msg == nil
-        raise "Failed to send command"
+        raise SendCommandError.new(json.to_s)
       end
 
+      @logger.debug("Command ##{corr_id} finished successfully with response: #{msg}")
+
       msg
+    ensure
+      @command_waiters.delete corr_id
+      @logger.debug("Cleaned up command waiter ##{corr_id}")
     end
 
     def api_version
       resp = send_command '/version'
       resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "versionInfo"
+      expected_resp_type = "versionInfo"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
 
       resp["versionInfo"]["version"]
     end
@@ -229,7 +234,8 @@ module SimpleXChat
     def api_profile
       resp = send_command '/profile'
       resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "userProfile"
+      expected_resp_type = "userProfile"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
 
       {
         "name" => resp["user"]["profile"]["displayName"],
@@ -246,7 +252,8 @@ module SimpleXChat
         return nil
       end
   
-      raise "Unexpected response: #{resp_type}" if resp_type != "userContactLink"
+      expected_resp_type = "userContactLink"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
 
       resp["contactLink"]["connReqContact"]
     end
@@ -254,15 +261,35 @@ module SimpleXChat
     def api_create_user_address
       resp = send_command '/address'
       resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "userContactLinkCreated"
+      expected_resp_type = "userContactLinkCreated"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
 
       resp["connReqContact"]
     end
 
-    def api_send_text_message(chat_type, contact, message)
-      resp = send_command "#{chat_type}#{contact} #{message}"
+    def api_send_text_message(chat_type, receiver, message)
+      resp = send_command "#{chat_type}#{receiver} #{message}"
       resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "newChatItems"
+      expected_resp_type = "newChatItems"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+
+      resp["chatItems"]
+    end
+
+    def api_send_image(chat_type, receiver, file_path)
+      resp = send_command "/image #{chat_type}#{receiver} #{file_path}"
+      resp_type = resp["type"]
+      expected_resp_type = "newChatItems"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+
+      resp["chatItems"]
+    end
+
+    def api_send_file(chat_type, receiver, file_path)
+      resp = send_command "/file #{chat_type}#{receiver} #{file_path}"
+      resp_type = resp["type"]
+      expected_resp_type = "newChatItems"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
 
       resp["chatItems"]
     end
@@ -270,7 +297,8 @@ module SimpleXChat
     def api_contacts
       resp = send_command "/contacts"
       resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "contactsList"
+      expected_resp_type = "contactsList"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
 
       contacts = resp["contacts"]
       contacts.map{ |c| {
@@ -286,7 +314,8 @@ module SimpleXChat
     def api_groups
       resp = send_command "/groups"
       resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "groupsList"
+      expected_resp_type = "groupsList"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
 
       groups = resp["groups"]
       groups.map{ |entry| 
@@ -308,6 +337,51 @@ module SimpleXChat
       }
     end
 
+    def api_auto_accept is_enabled
+      onoff = is_enabled && "on" || "off"
+
+      resp = send_command "/auto_accept #{onoff}"
+      resp_type = resp["type"]
+      expected_resp_type = "userContactLinkUpdated"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+
+      nil
+    end
+
+    def api_kick_group_member(group, member)
+      resp = send_command "/remove #{group} #{member}"
+      resp_type = resp["type"]
+      expected_resp_type = "userDeletedMember"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+    end
+
+    # Parameters for /network:
+    #   - socks: on/off/<[ipv4]:port>
+    #   - socks-mode: always/onion
+    #   - smp-proxy: always/unknown/unprotected/never
+    #   - smp-proxy-fallback: no/protected/yes
+    #   - timeout: <seconds>
+    def api_network(socks: nil, socks_mode: nil, smp_proxy: nil, smp_proxy_fallback: nil, timeout_secs: nil)
+      args = {
+        "socks" => socks,
+        "socks-mode" => socks_mode,
+        "smp-proxy" => smp_proxy,
+        "smp-proxy-fallback" => smp_proxy_fallback,
+        "timeout" => timeout_secs
+      }
+      command = '/network'
+      args.each do |param, value|
+        next if value == nil
+        command += " #{param}=#{value}"
+      end
+      resp = send_command command
+      resp_type = resp["type"]
+      expected_resp_type = "networkConfig"
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+
+      resp["networkConfig"]
+    end
+
     private
 
     def next_corr_id

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: simplex-chat
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - rdbo
 bindir: exe
 cert_chain: []
-date: 2025-02-23 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket
@@ -48,6 +48,9 @@ files:
 - README.md
 - Rakefile
 - lib/simplex-chat.rb
+- lib/simplex-chat/errors.rb
+- lib/simplex-chat/patches.rb
+- lib/simplex-chat/types.rb
 - lib/simplex-chat/version.rb
 - showcase.png
 homepage: https://github.com/rdbo/simplex-chat-ruby