simplex-chat 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb15441c1b0a770fff253bb8eddbacf6bf52df1ddcddd502597ada7385a62c1c
-  data.tar.gz: 0ba06bf88529d8bbd2eb429fd781162c94a23bfe7577ea313ef9ca8db346c407
+  metadata.gz: a5abf1b7b550f998760cb68e89636e031dcf96aff3449e9422903db050521bd2
+  data.tar.gz: 4602313dfbf09bfd9b650c5668f16389d885cf16202b1896fc81f4dd71dfa869
 SHA512:
-  metadata.gz: e975110a2bfa186b9f1f9f80264fa0343bc6e148e113a4eaf0d778064abbdeb54e822725e51ca499700f4e2a855fa41a8a06aa532b5561ecc33e75795528adcc
-  data.tar.gz: b681e83e16e20ad1e55f0c16918a5fe438703bd98c29e1f6a4cca2e24af19e3a352162a9bb2dab673f927974b222715fe431cf7d521ff0848431631846fe5d66
+  metadata.gz: 5f77b4edf376118de56ff6dde9a99ee06fc49c12f6ef348053a8ba1ec807b885fac6c2ef4c5c6fe48c21d95a10d7b3351a6ad07a8429603f0ec1ee997ea2923e
+  data.tar.gz: f59fb84f87c57f491eda4e3ab58c30451a376c1c8b79c8e6b190df433f53d4394c4c41b459e8e18940bea91c95517ebd82643cf1e3e65c6093462be3910455c1

data/lib/simplex-chat/version.rb

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

data/lib/simplex-chat.rb

@@ -100,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
@@ -113,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"
@@ -127,38 +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"]
-          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),
-            :img_preview => image_preview
-          }
+          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
@@ -224,18 +196,14 @@ module SimpleXChat
 
     def api_version
       resp = send_command '/version'
-      resp_type = resp["type"]
-      expected_resp_type = "versionInfo"
-      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+      check_response_type(resp, "versionInfo")
 
       resp["versionInfo"]["version"]
     end
 
     def api_profile
       resp = send_command '/profile'
-      resp_type = resp["type"]
-      expected_resp_type = "userProfile"
-      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+      check_response_type(resp, "userProfile")
 
       {
         "name" => resp["user"]["profile"]["displayName"],
@@ -251,54 +219,42 @@ module SimpleXChat
       if resp_type == "chatCmdError" && resp.dig("chatError", "storeError", "type") == "userContactLinkNotFound"
         return nil
       end
-  
-      expected_resp_type = "userContactLink"
-      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+      check_response_type(resp, "userContactLink")
 
       resp["contactLink"]["connReqContact"]
     end
 
     def api_create_user_address
       resp = send_command '/address'
-      resp_type = resp["type"]
-      expected_resp_type = "userContactLinkCreated"
-      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+      check_response_type(resp, "userContactLinkCreated")
 
       resp["connReqContact"]
     end
 
     def api_send_text_message(chat_type, receiver, message)
       resp = send_command "#{chat_type}#{receiver} #{message}"
-      resp_type = resp["type"]
-      expected_resp_type = "newChatItems"
-      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+      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}"
-      resp_type = resp["type"]
-      expected_resp_type = "newChatItems"
-      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+      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}"
-      resp_type = resp["type"]
-      expected_resp_type = "newChatItems"
-      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+      check_response_type(resp, "newChatItems")
 
       resp["chatItems"]
     end
 
     def api_contacts
       resp = send_command "/contacts"
-      resp_type = resp["type"]
-      expected_resp_type = "contactsList"
-      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+      check_response_type(resp, "contactsList")
 
       contacts = resp["contacts"]
       contacts.map{ |c| {
@@ -313,9 +269,7 @@ module SimpleXChat
 
     def api_groups
       resp = send_command "/groups"
-      resp_type = resp["type"]
-      expected_resp_type = "groupsList"
-      raise UnexpectedResponseError.new(resp_type, expected_resp_type) unless resp_type == expected_resp_type
+      check_response_type(resp, "groupsList")
 
       groups = resp["groups"]
       groups.map{ |entry| 
@@ -341,18 +295,14 @@ module SimpleXChat
       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
+      check_response_type(resp, "userContactLinkUpdated")
 
       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
+      check_response_type(resp, "userDeletedMember")
     end
 
     # Parameters for /network:
@@ -375,18 +325,100 @@ module SimpleXChat
         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
+      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.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - rdbo
 bindir: exe
 cert_chain: []
-date: 2025-03-03 00:00:00.000000000 Z
+date: 2025-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket