simplex-chat 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d837e851181b5797fc07d870cbb4170030de614570d1b960ff44a16272e4d765
-  data.tar.gz: 9c031346b853a2a82a3b11314be2f56b65a381f15cdfddc0e12efd2084f899b6
+  metadata.gz: 1dde8b2fbd228f72ec1b9cb4f95269401aa2fa68774b38fdbef43d8eec2b7d63
+  data.tar.gz: 1c54b1064c53ceeb06ae4b0f68715e773e96753208ec87b7ad445e2863649969
 SHA512:
-  metadata.gz: 32b2980044aeeb7a216ae9d8fa4a9f1c0dd075635740a71b3160a83d9e481f126b180397b6d0cae74562434149e3a0f7d60595eebcaacba66ec2c80640cfef65
-  data.tar.gz: fee2870de270b270750f1e82421ba24ed1689df71a40c1113b1386f907beb11e582a2e3ddb2027c139ba273ff48e6ac4e8f66a12bcefe2d792382e3c0eb4f1c1
+  metadata.gz: 669c992a7cbab4e903581bae8def4f6a4dc6e269cc5041e8e0dd5901bc62e8d162aaf4aa95ab0f266932619e34c48d10400107dfd84d4a8cc60d64c51a40711a
+  data.tar.gz: f6c49bb438a61eb4015cd94e5f29197214b36a7eb3d18f5a8bee05ecc2d7cbcf284f10d792cb3b0aad8aa9f3c41be36a78875b5c38b13961770aa835b829823c

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.2.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
@@ -33,6 +34,7 @@ module SimpleXChat
     def initialize client_uri, connect: true, log_level: Logger::INFO
       @uri = client_uri
       @message_queue = SizedQueue.new 4096
+      @chat_message_queue = Queue.new
       @socket = nil
       @handshake = nil
 
@@ -97,7 +99,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,10 +113,72 @@ 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
+          if chat_type == ChatType::GROUP
+            contact = chat_item["chatItem"]["chatDir"]["groupMember"]["localDisplayName"]
+            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 => 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: simplex-chat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - rdbo
 bindir: exe
 cert_chain: []
-date: 2025-02-22 00:00:00.000000000 Z
+date: 2025-02-23 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