io_request 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6ba3ef4cb967a230cfb350a7413cee8868a2817f5451134105c7ba075470427
-  data.tar.gz: 1438ae77d9f2db624bbf8596d2b4acbf793aa1826bcc9a6e0f83dfe8fde3e541
+  metadata.gz: da825a2b5c4621543a1c66625eebf871852a07a5ed51db4fa3df51a26ed23874
+  data.tar.gz: a47015fa8c95cad7baadf55d0ef43921272c9fa4898d4a78f238b6f48ca15842
 SHA512:
-  metadata.gz: e1cc15e03f5489653ec07ce7d7424992ee259b508124972f84fe8c2f10bf08465a59ebebd25dc30cba5be8012c583c2028b4c22332882e13e575903c0898e7af
-  data.tar.gz: a648b296f3b12c90205253bd40ce906b12a5638b892113bfdcf54deedaed8a41d5262c5f4937edc28509de862ce52c91429f450c40a8b97c60acdcf8afdec651
+  metadata.gz: 9a4ccf24e708cfe1bf1d428f780be958a54516dd57dbfc25b450eba57b4ea111dfcc09f88a1fdfefe12eb55bf450541665f3e0a3eb3458406c9958d843f8af3b
+  data.tar.gz: 044ff5beb060aa71aa95971f3d4ad6eb2b0dab452a3c2df16460adafc8adae690a8d13f2a9993dcf32d43020abd03cbc041ac23d7aec97674247b12aead5bed7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    io_request (1.0.0)
+    io_request (1.1.0)
       json (~> 2.0)
       logger (~> 1.4)
       timeout-extensions (~> 0.1.1)

data/README.md

@@ -20,7 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Documentation is available at https://www.rubydoc.info/gems/io_request
+
+Some examples could be find in *examples* folder.
 
 ## Development
 

data/examples/simple_example.rb

@@ -0,0 +1,52 @@
+require "io_request"
+
+r1, w1 = IO.pipe
+r2, w2 = IO.pipe
+
+client_1 = IORequest::Client.new read: r1, write: w2
+client_2 = IORequest::Client.new read: r2, write: w1
+
+# Use
+# Set up responders
+# Authorization
+client_2.respond type: "auth" do |request|
+  puts "Client 2: Authorization attempt as #{request.data[:username].inspect}"
+  sleep 2 # Some processing
+  { type: "auth_success" }
+end
+
+# Default
+client_2.respond do |request|
+  puts "Client 2: #{request.data.inspect}"
+  { type: "success" }
+end
+
+# Send requests
+auth = false
+auth_request = client_1.request(
+  data: { type: "auth", username: "mymail@example.com", password: "let's pretend password hash is here" },
+  sync: true
+) do |response|
+  unless response.data[:type] == "auth_success"
+    puts "Client 1: Authorization failed. Response: #{response.data.inspect}"
+    next
+  end
+
+  auth = true
+  # Do something
+end
+exit unless auth
+puts "Client 1: Authorized!"
+
+message = client_1.request(
+  data: { type: "message", message: "Hello!" },
+  sync: true
+) do |response|
+  puts "Client 1: Message responded"
+end
+
+# Close
+r1.close
+w1.close
+r2.close
+w2.close

data/lib/io_request/client.rb

@@ -8,9 +8,6 @@ module IORequest
     include Utility::WithProgName
     include Utility::MultiThread
 
-    # IO-like object provided at initialization.
-    attr_reader :io
-
     # Initialize new client over IO.
     #
     # @option options [:gets] read IO to read from.
@@ -31,8 +28,7 @@ module IORequest
     #
     # Optional block can be provided. It will be called when response received.
     #
-    # @param data [Hash] data to send with request.
-    #
+    # @option options [Hash] data data to send.
     # @option options [Boolean] sync whether to join request after sending.
     # @option options [Integer, Float] timeout timeout for {Request#join}.
     #
@@ -42,6 +38,7 @@ module IORequest
     def request(data: {}, sync: false, timeout: nil, &block)
       req = Request.new(data)
       @out_requests[req] = block
+      IORequest.debug("Sending request ##{req.id}", prog_name)
       send(req.to_hash)
       req.join(timeout) if sync
       req
@@ -85,12 +82,18 @@ module IORequest
       in_thread do
         responder = find_responder(req)
         data = nil
-        begin
-          data = responder.call(req) if responder
+        data = begin
+          if responder
+            responder.call(req)
+          else
+            IORequest.warn "Responder not found!"
+            nil
+          end
         rescue Exception => e
-          IORequest.warn("Provided block raised exception:\n#{e.full_message}", prog_name)
+          IORequest.warn "Provided block raised exception:\n#{e.full_message}", prog_name
+          nil
         end
-        data = {} unless data.is_a?(Hash)
+        data ||= {}
         res = Response.new(data, req)
         send(res.to_hash)
       end
@@ -121,15 +124,22 @@ module IORequest
 
     # find responder for provided request.
     def find_responder(req)
+      result = nil
       @responders.each do |subdata, block|
-        break block if req.data.contains? subdata
+        if req.data.contains? subdata
+          result = block
+          break
+        end
       end
+      
+      result
     end
 
     # Send data.
     # 
     # @param [Hash]
     def send(data)
+      IORequest.debug("Sending hash: #{data.inspect}", prog_name)
       send_raw(encode(data_to_string data))
     end
 

data/lib/io_request/version.rb

@@ -1,4 +1,4 @@
 module IORequest
   # Gem version.
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: io_request
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Fizvlad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-13 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,6 +109,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- examples/simple_example.rb
 - io_request.gemspec
 - lib/io_request.rb
 - lib/io_request/client.rb