simplex-chat 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f038bfb3c5cc7308a7c53d4a19e4152cfcc4e3f54088093d66b1947d2816f7c
-  data.tar.gz: 4e4fa59d7fa8c29225b64bf7856ce9dec9a5551df0038158e4c53e4a60c25b7c
+  metadata.gz: a5abf1b7b550f998760cb68e89636e031dcf96aff3449e9422903db050521bd2
+  data.tar.gz: 4602313dfbf09bfd9b650c5668f16389d885cf16202b1896fc81f4dd71dfa869
 SHA512:
-  metadata.gz: c3d3091b7fdbc2ff66ed648dc27729860fd79b2434dbb3bbe3f3ec7473042975a8a8aa981b853e302259137aa7b88b1ad5233f4459f9ec1d09aab7d8eadfd165
-  data.tar.gz: c690575e7ad589694966f0ed69f3e62b2ce7d9e562cd419b49bed1bc8bcfb07d5dfefc43fed5b2905ceca1d9520d6c5a90153a67ebc52df853a3f3886ea5fe07
+  metadata.gz: 5f77b4edf376118de56ff6dde9a99ee06fc49c12f6ef348053a8ba1ec807b885fac6c2ef4c5c6fe48c21d95a10d7b3351a6ad07a8429603f0ec1ee997ea2923e
+  data.tar.gz: f59fb84f87c57f491eda4e3ab58c30451a376c1c8b79c8e6b190df433f53d4394c4c41b459e8e18940bea91c95517ebd82643cf1e3e65c6093462be3910455c1

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.3.0"
+  VERSION = "0.5.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,36 +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
-
-  module GroupMemberRole
-    AUTHOR = 'author' # reserved and unused as of now, but added anyways
-    OWNER = 'owner'
-    ADMIN = 'admin'
-    MEMBER = 'member'
-    OBSERVER = 'observer'
-  end
-
   class ClientAgent
     attr_accessor :on_message
 
-    def initialize client_uri, connect: true, log_level: Logger::INFO, timeout_ms: 30_000, interval_ms: 100
+    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
@@ -87,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"]
@@ -96,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
@@ -121,7 +100,9 @@ module SimpleXChat
       @message_queue.pop
     end
 
-    def next_chat_message
+    def next_chat_message(
+      max_backlog_secs: 15.0 # if nil, it will process any incoming messages, including old ones
+    )
       # NOTE: There can be more than one message per
       #       client message. Because of that, we use
       #       a chat message queue to insert one or
@@ -134,11 +115,6 @@ module SimpleXChat
         break if msg == nil
         next if not ["chatItemUpdated", "newChatItems"].include?(msg["type"])
 
-        chat_info_types = {
-          "direct" => ChatType::DIRECT,
-          "group" => ChatType::GROUP
-        }
-
         # Handle one or more chat messages in a single client message
         new_chat_messages = nil
         if msg["type"] == "chatItemUpdated"
@@ -148,36 +124,13 @@ module SimpleXChat
         end
 
         new_chat_messages.each do |chat_item|
-          chat_type = chat_info_types.dig(chat_item["chatInfo"]["type"])
-          group = nil
-          sender = nil
-          contact = nil
-          contact_role = nil
-          if chat_type == ChatType::GROUP
-            # 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
-            contact = chat_item["chatInfo"]["contact"]["localDisplayName"]
-            sender = contact
-          end
+          chat_message = parse_chat_item chat_item
 
-          msg_text = chat_item["chatItem"]["meta"]["itemText"]
-          timestamp = chat_item["chatItem"]["meta"]["updatedAt"]
-
-          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)
-          }
+          time_diff = Time.now - chat_message[:msg_timestamp]
+          if max_backlog_secs != nil && time_diff > max_backlog_secs
+            @logger.debug("Skipped message (time diff: #{time_diff}, max allowed: #{max_backlog_secs}): #{chat_message}")
+            next
+          end
 
           @chat_message_queue.push chat_message
         end
@@ -212,9 +165,12 @@ 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
       iterations = timeout_ms / interval_ms
       iterations.times do
@@ -223,31 +179,31 @@ module SimpleXChat
           break
         rescue ThreadError
           sleep(interval_ms / 1000.0)
-        ensure
-          # Clean up command_waiters
-          @command_waiters.delete corr_id
         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"
+      check_response_type(resp, "versionInfo")
 
       resp["versionInfo"]["version"]
     end
 
     def api_profile
       resp = send_command '/profile'
-      resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "userProfile"
+      check_response_type(resp, "userProfile")
 
       {
         "name" => resp["user"]["profile"]["displayName"],
@@ -263,32 +219,42 @@ module SimpleXChat
       if resp_type == "chatCmdError" && resp.dig("chatError", "storeError", "type") == "userContactLinkNotFound"
         return nil
       end
-  
-      raise "Unexpected response: #{resp_type}" if resp_type != "userContactLink"
+      check_response_type(resp, "userContactLink")
 
       resp["contactLink"]["connReqContact"]
     end
 
     def api_create_user_address
       resp = send_command '/address'
-      resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "userContactLinkCreated"
+      check_response_type(resp, "userContactLinkCreated")
 
       resp["connReqContact"]
     end
 
-    def api_send_text_message(chat_type, contact, message)
-      resp = send_command "#{chat_type}#{contact} #{message}"
-      resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "newChatItems"
+    def api_send_text_message(chat_type, receiver, message)
+      resp = send_command "#{chat_type}#{receiver} #{message}"
+      check_response_type(resp, "newChatItems")
+
+      resp["chatItems"]
+    end
+
+    def api_send_image(chat_type, receiver, file_path)
+      resp = send_command "/image #{chat_type}#{receiver} #{file_path}"
+      check_response_type(resp, "newChatItems")
+
+      resp["chatItems"]
+    end
+
+    def api_send_file(chat_type, receiver, file_path)
+      resp = send_command "/file #{chat_type}#{receiver} #{file_path}"
+      check_response_type(resp, "newChatItems")
 
       resp["chatItems"]
     end
 
     def api_contacts
       resp = send_command "/contacts"
-      resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "contactsList"
+      check_response_type(resp, "contactsList")
 
       contacts = resp["contacts"]
       contacts.map{ |c| {
@@ -303,8 +269,7 @@ module SimpleXChat
 
     def api_groups
       resp = send_command "/groups"
-      resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "groupsList"
+      check_response_type(resp, "groupsList")
 
       groups = resp["groups"]
       groups.map{ |entry| 
@@ -330,16 +295,14 @@ module SimpleXChat
       onoff = is_enabled && "on" || "off"
 
       resp = send_command "/auto_accept #{onoff}"
-      resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "userContactLinkUpdated"
+      check_response_type(resp, "userContactLinkUpdated")
 
       nil
     end
 
     def api_kick_group_member(group, member)
       resp = send_command "/remove #{group} #{member}"
-      resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" unless resp_type == "userDeletedMember"
+      check_response_type(resp, "userDeletedMember")
     end
 
     # Parameters for /network:
@@ -362,17 +325,100 @@ module SimpleXChat
         command += " #{param}=#{value}"
       end
       resp = send_command command
-      resp_type = resp["type"]
-      raise "Unexpected response: #{resp_type}" if resp_type != "networkConfig"
+      check_response_type(resp, "networkConfig")
 
       resp["networkConfig"]
     end
 
+    def api_tail(chat_type: nil, conversation: nil, message_count: nil)
+      cmd = "/tail"
+      cmd += " #{chat_type}#{conversation}" if chat_type != nil && conversation != nil
+      cmd += " #{message_count}" if message_count != nil
+      resp = send_command cmd
+      check_response_type(resp, "chatItems")
+
+      resp["chatItems"].map{|chat_item| parse_chat_item chat_item}
+    end
+
+    def api_chats(
+      chat_count=20 # if nil, will return all the chats
+    )
+      param = chat_count != nil ? "#{chat_count}" : "all"
+      cmd = "/chats #{param}"
+      resp = send_command cmd
+      check_response_type(resp, "chats")
+
+      resp["chats"].map do |chat|
+        chat_type = parse_chat_info_type chat["chatInfo"]["type"]
+        next if chat_type == nil # WARN: Chat type "local" is currently ignored
+        conversation = nil
+        if chat_type == ChatType::GROUP
+          conversation = chat["chatInfo"]["groupInfo"]["localDisplayName"]
+        else
+          conversation = chat["chatInfo"]["contact"]["localDisplayName"]
+        end
+
+        {
+          :chat_type => chat_type,
+          :conversation => conversation
+        }
+      end.filter { |x| x != nil }
+    end
+
     private
 
+    def check_response_type(resp, expected_resp_type)
+      resp_type = resp["type"]
+      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+    end
+
     def next_corr_id
       # The correlation ID has to be a string
       (@corr_id.update { |x| x + 1 } - 1).to_s(10)
     end
+
+    def parse_chat_info_type(type)
+      chat_info_types = {
+        "direct" => ChatType::DIRECT,
+        "group" => ChatType::GROUP
+      }
+
+      chat_info_types.dig(type)
+    end
+
+    def parse_chat_item(chat_item)
+      chat_type = parse_chat_info_type chat_item["chatInfo"]["type"]
+      group = nil
+      sender = nil
+      contact = nil
+      contact_role = nil
+      if chat_type == ChatType::GROUP
+        # 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
+        contact = chat_item["chatInfo"]["contact"]["localDisplayName"]
+        sender = contact
+      end
+
+      msg_text = chat_item["chatItem"]["meta"]["itemText"]
+      timestamp = Time.parse(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 => timestamp,
+        :img_preview => image_preview
+      }
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: simplex-chat
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - rdbo
 bindir: exe
 cert_chain: []
-date: 2025-03-01 00:00:00.000000000 Z
+date: 2025-03-04 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