simplex-chat 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d837e851181b5797fc07d870cbb4170030de614570d1b960ff44a16272e4d765
-  data.tar.gz: 9c031346b853a2a82a3b11314be2f56b65a381f15cdfddc0e12efd2084f899b6
+  metadata.gz: 3f038bfb3c5cc7308a7c53d4a19e4152cfcc4e3f54088093d66b1947d2816f7c
+  data.tar.gz: 4e4fa59d7fa8c29225b64bf7856ce9dec9a5551df0038158e4c53e4a60c25b7c
 SHA512:
-  metadata.gz: 32b2980044aeeb7a216ae9d8fa4a9f1c0dd075635740a71b3160a83d9e481f126b180397b6d0cae74562434149e3a0f7d60595eebcaacba66ec2c80640cfef65
-  data.tar.gz: fee2870de270b270750f1e82421ba24ed1689df71a40c1113b1386f907beb11e582a2e3ddb2027c139ba273ff48e6ac4e8f66a12bcefe2d792382e3c0eb4f1c1
+  metadata.gz: c3d3091b7fdbc2ff66ed648dc27729860fd79b2434dbb3bbe3f3ec7473042975a8a8aa981b853e302259137aa7b88b1ad5233f4459f9ec1d09aab7d8eadfd165
+  data.tar.gz: c690575e7ad589694966f0ed69f3e62b2ce7d9e562cd419b49bed1bc8bcfb07d5dfefc43fed5b2905ceca1d9520d6c5a90153a67ebc52df853a3f3886ea5fe07

data/README.md

@@ -5,3 +5,52 @@ A port for the SimpleX Chat client API for Ruby
 This project is licensed under the GNU AGPL-3.0 (no later versions).
 
 Read `LICENSE` for more information.
+
+## Showcase
+
+![showcase](showcase.png)
+
+## Usage
+
+1. Install the Gem from RubyGems
+   ```shell
+   gem install simplex-chat
+   ```
+
+
+2. Start your local simplex-chat client on port 5225 (or any port you wish)
+
+   ```shell
+   simplex-chat -p 5225
+   ```
+
+3. Connect the `SimpleXChat::ClientAgent` to your local client
+
+   ```rb
+   require 'simplex-chat'
+   require 'net/http'
+
+   client = SimpleXChat::ClientAgent.new URI('ws://localhost:5225')
+   ```
+
+
+4. Now the client is connected and you can start using the APIs
+
+   ```rb
+   # Get version
+   version = client.api_version
+   puts "SimpleX Chat version: #{version}"
+
+   # Listen to incoming client messages
+   loop do
+     chat_msg = client.next_chat_message
+     break if chat_msg == nil
+
+     # Reply if user sends '/say_hello'
+     if chat_msg[:msg_text] == "/say_hello"
+       client.api_send_text_message chat_msg[:chat_type], chat_msg[:sender], "Hello! This was sent automagically"
+     end
+   end
+
+   # Much more... Read the examples for more information
+   ```

data/lib/simplex-chat/version.rb

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

data/lib/simplex-chat.rb

@@ -8,6 +8,7 @@ module SimpleXChat
   require 'json'
   require 'websocket'
   require 'concurrent'
+  require 'time'
 
   # Fixes regex match for status line in HTTPResponse
   class HTTPResponse < Net::HTTPResponse
@@ -27,12 +28,21 @@ module SimpleXChat
     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
+    def initialize client_uri, connect: true, log_level: Logger::INFO, timeout_ms: 30_000, interval_ms: 100
       @uri = client_uri
       @message_queue = SizedQueue.new 4096
+      @chat_message_queue = Queue.new
       @socket = nil
       @handshake = nil
 
@@ -40,6 +50,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
@@ -48,9 +60,7 @@ module SimpleXChat
         "| [#{severity}] | #{datetime} | (#{progname}) :: #{msg}\n"
       }
 
-      if connect
-        self.connect
-      end
+      self.connect if connect
 
       @logger.debug("Initialized ClientAgent")
     end
@@ -97,7 +107,7 @@ module SimpleXChat
           rescue => e
             # TODO: Verify if this way of stopping the execution
             #       is graceful enough after implementing reconnects
-            puts "Unhandled exception caught: #{e}"
+            @logger.error "Unhandled exception caught: #{e}"
             @message_queue.close
             raise e
           end
@@ -111,14 +121,82 @@ module SimpleXChat
       @message_queue.pop
     end
 
+    def next_chat_message
+      # NOTE: There can be more than one message per
+      #       client message. Because of that, we use
+      #       a chat message queue to insert one or
+      #       more messages at a time, but poll just
+      #       one at a time
+      return @chat_message_queue.pop if not @chat_message_queue.empty?
+  
+      loop do
+        msg = next_message
+        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"
+          new_chat_messages = [msg["chatItem"]]
+        else
+          new_chat_messages = msg["chatItems"]
+        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
+
+          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)
+          }
+
+          @chat_message_queue.push chat_message
+        end
+
+        return @chat_message_queue.pop
+      end
+
+      nil
+    end
+
     def disconnect
       @listener_thread.terminate
       @socket.close
       @message_queue.clear
+      @chat_message_queue.clear
     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,
@@ -138,12 +216,16 @@ module SimpleXChat
       @socket.write frame.to_s
 
       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)
+        ensure
+          # Clean up command_waiters
+          @command_waiters.delete corr_id
         end
       end
 
@@ -244,6 +326,48 @@ module SimpleXChat
       }
     end
 
+    def api_auto_accept is_enabled
+      onoff = is_enabled && "on" || "off"
+
+      resp = send_command "/auto_accept #{onoff}"
+      resp_type = resp["type"]
+      raise "Unexpected response: #{resp_type}" if resp_type != "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"
+    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"]
+      raise "Unexpected response: #{resp_type}" if resp_type != "networkConfig"
+
+      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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - rdbo
 bindir: exe
 cert_chain: []
-date: 2025-02-22 00:00:00.000000000 Z
+date: 2025-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket
@@ -49,6 +49,7 @@ files:
 - Rakefile
 - lib/simplex-chat.rb
 - lib/simplex-chat/version.rb
+- showcase.png
 homepage: https://github.com/rdbo/simplex-chat-ruby
 licenses:
 - AGPL-3.0-only