rocket_chat-realtime 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66fc24b35954885a75af20a2cd44fbb3159ae405e6e2bd41d0a47caf751055e3
-  data.tar.gz: 51380a853e80b9409fe9feb2aa490c476da53aa2f78205d16c550c73b7f7907e
+  metadata.gz: 4bb47488855acda343dbd9c40235cd4c1335a84054fe398d316a667c82882bdd
+  data.tar.gz: 8afcf13cd2d6ae9a7e0b6fb0ed4cb773b3534bd6e74fac8e873c23d72343702c
 SHA512:
-  metadata.gz: e8532f7fdd44a92966eedbe0f651af1f0c20dfe4fd07604b8286575bb90530227c02e4390e9e7786afb3b8228080189e0f35fe7bdbcd2db76e214d4efb827161
-  data.tar.gz: '0359647a097c3b7ac777f41121defb22ee4439a5abcac3bfec3f538a8b3480f0b0aa593bbc27fe46d0a050aaa151b6b8aba53847952850ec1d9fb8e54df0c1f0'
+  metadata.gz: 5a5cc9722b8aa5edce1de87ebebe1f8cf4cbfb14496460f37505aead18d9bbbdba03492d694dd8dba76021a59ff32aacfefdf193845ea7fe4e4ac19b49619cd9
+  data.tar.gz: a2b35855823bc1f0ab8c6e06023d8bab32bb18161ebf2464134981c793f1550d0ae20f6268e654477647bf602806eb8d1b3d968d0c2ccc7ff8e91cd8c332f640

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rocket_chat-realtime (0.1.0)
+    rocket_chat-realtime (0.1.1)
       concurrent-ruby (~> 1.1)
       nio4r (~> 2.5)
       websocket-driver (~> 0.7)
@@ -22,7 +22,7 @@ GEM
     docile (1.3.2)
     iniparse (1.5.0)
     method_source (1.0.0)
-    nio4r (2.5.3)
+    nio4r (2.5.4)
     overcommit (0.55.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
@@ -34,7 +34,7 @@ GEM
       method_source (~> 1.0)
     rainbow (3.0.0)
     rake (12.3.3)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.0)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -60,19 +60,20 @@ GEM
       rubocop-ast (>= 0.3.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
+    rubocop-ast (0.4.2)
       parser (>= 2.7.1.4)
-    rubocop-performance (1.7.1)
-      rubocop (>= 0.82.0)
-    rubocop-rspec (1.41.0)
-      rubocop (>= 0.68.1)
+    rubocop-performance (1.8.1)
+      rubocop (>= 0.87.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
     rubocop-thread_safety (0.4.1)
       rubocop (>= 0.51.0)
     ruby-progressbar (1.10.1)
     simplecov (0.19.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+    simplecov-html (0.12.3)
     thor (1.0.1)
     unicode-display_width (1.7.0)
     websocket-driver (0.7.3)

data/README.md

@@ -1,8 +1,6 @@
 # RocketChat::Realtime
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rocket_chat/realtime`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+The ruby implement for [RocketChat Realtime API](https://docs.rocket.chat/api/realtime-api).
 
 ## Installation
 
@@ -22,7 +20,61 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Create a client
+
+```ruby
+client = RocketChat::Realtime::Client.new(server: 'wss://chat.example.com')
+```
+
+### Connect to server
+
+```ruby
+client.connect
+```
+
+or use a shortcut via `.connect`
+
+```ruby
+client = RocketChat::Realtime.connect(server: 'wss://chat.example.com')
+```
+
+### Login to server
+
+```ruby
+client.login(username, password)
+```
+
+The Realtime API is async and depend on the Metro.js DDP, we can use `Concurrent::Promises` to capture the return message.
+
+```ruby
+client
+  .login(username, password)
+  .then { |res| puts "Token is #{res['token']}" }
+```
+
+### Subscribe room messages
+
+```ruby
+client
+  .subscribe_room_messages('ROOM_ID')
+  .then { puts 'Ready!' }
+```
+
+### Process room messages
+
+```ruby
+client.on('stream-room-messages') do |message|
+  puts "Received message: #{message['args'][0]['msg']}"
+end
+```
+
+### Send message
+
+```ruby
+client
+  .send_message('ROOM_ID', 'MESSAGE')
+  .then { |res| puts 'Success' }
+```
 
 ## Development
 
@@ -32,9 +84,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rocket_chat-realtime. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rocket_chat-realtime/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/5xRuby/rocket_chat-realtime. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/5xRuby/rocket_chat-realtime/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## Code of Conduct
 
-Everyone interacting in the RocketChat::Realtime project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rocket_chat-realtime/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RocketChat::Realtime project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/5xRuby/rocket_chat-realtime/blob/master/CODE_OF_CONDUCT.md).

data/lib/rocket_chat/realtime/adapter.rb

@@ -7,17 +7,26 @@ module RocketChat
     # @since 0.1.0
     class Adapter
       # @since 0.1.0
-      attr_reader :url
+      attr_reader :url, :monitor
 
       # @param url [String] the server to connect
       #
       # @since 0.1.0
-      def initialize(url)
+      def initialize(url, monitor)
         @url = url
+        @monitor = monitor
         @mutex = Mutex.new
         @buffer = ''
       end
 
+      def pending?
+        @buffer.empty? == false
+      end
+
+      def dispose
+        @monitor = nil
+      end
+
       # Enqueue data to send to server
       #
       # @param data [String]
@@ -25,6 +34,8 @@ module RocketChat
       # @since 0.1.0
       def write(data)
         @mutex.synchronize { @buffer = @buffer.dup.concat(data) }
+        pump_buffer
+        Reactor.selector.wakeup unless monitor.interests == :r
       end
 
       # Pump Buffer
@@ -34,17 +45,17 @@ module RocketChat
       # @return [Number] total bytes written
       #
       # @since 0.1.0
-      def pump_buffer(io)
+      def pump_buffer
         @mutex.synchronize do
           written = 0
-          begin
-            written = io.write_nonblock @buffer unless @buffer.empty?
-            @buffer = @buffer.byteslice(written..-1) if written.positive?
-          rescue IO::WaitWritable, IO::WaitReadable
-            return written
-          end
+          written = monitor.io.write_nonblock @buffer unless @buffer.empty?
+          @buffer = @buffer.byteslice(written..-1) if written.positive?
           written
         end
+      rescue IO::WaitWritable, IO::WaitReadable
+        written
+      ensure
+        monitor.interests = pending? ? :rw : :r
       end
     end
   end

data/lib/rocket_chat/realtime/client.rb

@@ -33,7 +33,7 @@ module RocketChat
       delegate %w[ping pong] => :driver
 
       # @since 0.1.0
-      attr_reader :server, :connector, :adapter, :driver
+      attr_reader :server, :connector, :adapter, :driver, :dispatcher
 
       # @param options [Hash]
       #
@@ -41,9 +41,6 @@ module RocketChat
       def initialize(options = {})
         @server = options[:server]
         @connector = Connector.new(endpoint)
-        @adapter = Adapter.new(endpoint)
-        @driver = WebSocket::Driver.client(adapter)
-        @dispatcher = Dispatcher.new(self)
       end
 
       # @return [String] the realtime api endpoint
@@ -53,19 +50,32 @@ module RocketChat
         "#{server}/websocket"
       end
 
+      # Add to reactor
+      #
+      # @since 0.1.0
+      def add_to_reactor
+        monitor = Reactor.register(self)
+        return if monitor.nil?
+
+        @adapter = Adapter.new(endpoint, monitor)
+        @driver = WebSocket::Driver.client(adapter)
+        @dispatcher = Dispatcher.new(self)
+      end
+
       # Connect to server
       #
       # @since 0.1.0
       def connect
+        add_to_reactor
         driver.start
         driver.text(INITIALIZE_COMMAND.to_json)
-        Reactor.register(self)
       end
 
       # Close connection to server
       #
       # @since 0.1.0
       def disconnect
+        @adapter.dispose
         @dispatcher.dispose
         driver.close
         Reactor.deregister(self)
@@ -86,8 +96,9 @@ module RocketChat
       #
       # @since 0.1.0
       def process(monitor)
+        monitor.interests = adapter.pending? ? :rw : :r
         driver.parse(monitor.io.read_nonblock(2**14)) if monitor.readable?
-        adapter.pump_buffer(monitor.io) if monitor.writeable?
+        adapter.pump_buffer if monitor.writeable?
       rescue IO::WaitReadable, IO::WaitWritable
         # nope
       rescue Errno::ECONNRESET, EOFError, Errno::ECONNABORTED

data/lib/rocket_chat/realtime/reactor.rb

@@ -25,6 +25,7 @@ module RocketChat
           stop
           stopped?
           reset
+          wakeup
         ] => :instance
       end
 
@@ -64,6 +65,7 @@ module RocketChat
         @clients.add(client)
         monitor = selector.register(client.connector.socket, :rw)
         monitor.value = client
+        monitor
       end
 
       # Deregister Client

data/lib/rocket_chat/realtime/version.rb

@@ -2,6 +2,6 @@
 
 module RocketChat
   module Realtime
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocket_chat-realtime
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - 5xRuby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-18 00:00:00.000000000 Z
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby