zmqjsonrpc 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 275b2e7bd02313197bd72c9791bfb20774a8f0c7
-  data.tar.gz: 32c9c8d5bba102217c2f19472575e8d893821de2
+  metadata.gz: 2948d618a2efcf6543835ede91e97a605278dc60
+  data.tar.gz: 63ddf0cd675fda196303132b7ec8d18ccb550917
 SHA512:
-  metadata.gz: 3d636755631636c90c151348753be54440f0b2ff212a1a712f111514bcf2a1a615c48e81a366ad7d08a9a5c4c3ffc496e038bda0a7903cbd03215c81650af5bf
-  data.tar.gz: b6c77e276528cf85b0040aa7e71ef0fceb3105bd5caadf8511b573aad9e90923c4905df61cc56d1b72858d411f84a6f37649756e71676d0f17904405215b3c3d
+  metadata.gz: 6753183268ac0cc54651d43d8892391fae2ba51f53cb9d160df1bdd24ec2551bffdd0a726d54379a5e3bef61c7c72d3d29b438940132654040eddb71e6790a30
+  data.tar.gz: 80d7c16ac87b2f5f652e5d6662f4cbc92b008b8b9911a8efaf6405a93ab6896491bae86ecc59909df891194dfae145dea432117c0d0c0f724dadddf3322b194b

data/README.md

@@ -1,7 +1,7 @@
-# zmqjsonrpc
+# zmqjsonrpc [![Gem Version](https://img.shields.io/gem/v/zmqjsonrpc.svg)](https://rubygems.org/gems/zmqjsonrpc)
 
 This gem implements a very simple [JSON RPC 2.0](http://www.jsonrpc.org/specification) client and server which uses zeroMQ for transport.
-Let's not talk to much, let's see some code:
+Let's not talk too much, let's see some code:
 
 ```ruby
   require 'rubygems'
@@ -10,6 +10,16 @@ Let's not talk to much, let's see some code:
   # client request to a running server
   client = ZmqJsonRpc::Client.new("tcp://127.0.0.1:49200")
   client.some_method(1, "b", [1,{a:1}])
+
+  # -or- a client with logger and error handling
+  require 'logger'
+  logger = Logger.new(STDOUT)
+  client = ZmqJsonRpc::Client.new("tcp://127.0.0.1:49200", 10000, loggger)
+  begin
+    client.faulty_method()
+  rescue ZmqJsonRpc::ClientError => e
+    puts "bad things can happen..."
+  end
 ```
 
 ```ruby
@@ -27,6 +37,13 @@ Let's not talk to much, let's see some code:
   proxy = Proxy.new()
   server = ZmqJsonRpc::Server.new(proxy, "tcp://*:49200")
   server.server_loop
+
+  # -or- a server with your own logger
+  require 'logger'
+  logger = Logger.new(STDOUT)
+  # ...
+  server = ZmqJsonRpc::Server.new(proxy, "tcp://*:49200", logger)
+
   
   # -or- dispatch a thread
   server = ZmqJsonRpc::Server.new(proxy, "tcp://*:49200")
@@ -39,6 +56,7 @@ Let's not talk to much, let's see some code:
 
 ## Resources
 
+* [API reference documentation](http://www.rubydoc.info/github/bisdn/zmqjsonrpc/)
 * The [JSON RPC 2.0 Spec](http://www.jsonrpc.org/specification)
 * The used [ZeroMQ gem](https://github.com/chuckremes/ffi-rzmq) and [good examples](http://github.com/andrewvc/learn-ruby-zeromq)
 * [Gem making](http://guides.rubygems.org/make-your-own-gem/)
@@ -51,11 +69,11 @@ Let's not talk to much, let's see some code:
 * Keep the client connection alive instead of re-establishing every time.
 * Add more tests.
 
-## Licence
+## License
 
 This code is released under the terms of MIT License.
 
 ## Contribute
 
-Please do so! Just send a messahe or send a pull request.
-Especially, adding webrick for transport would be nice.
+Please do so! Just send a message or send a pull request.
+Especially, adding webrick for transport would be nice.

data/lib/simple_json_rpc/client.rb

@@ -14,9 +14,10 @@ module ZmqJsonRpc
   # The client does not keep the connection alive. For each request, a new connection is esablished and torn down after the response.
   # This could become a performance issue.
   class Client
-    def initialize(connect="tcp://127.0.0.1:49200", timeout=10000)
+    def initialize(connect="tcp://127.0.0.1:49200", timeout=10000, logger=nil)
       @connect = connect
       @timeout = timeout
+      @logger = logger
     end
 
     def send_rpc(method, params=[])
@@ -36,12 +37,14 @@ module ZmqJsonRpc
           method: method.to_s,
           params: params
         }        
+        @logger.debug "zmqjsonrpc client sends request: #{request.inspect})" unless @logger.nil?
         rc = @socket.send_string(request.to_json) # this will always succeed, even if the server is not reachable.
 
         # interpret response
         response = ''
         rc = @socket.recv_string(response)
         raise "Could talk to the server (server unreachable? time out?)" if rc < 0
+        @logger.debug "zmqjsonrpc client got response: #{response})" unless @logger.nil?
         resjson = JSON.parse(response)
         # check response
         raise "Response's id did not match the sent id" if resjson["id"] != req_id

data/lib/simple_json_rpc/server.rb

@@ -36,6 +36,7 @@ module ZmqJsonRpc
   
     def handle_request(request)
       begin
+        @logger.debug "zmqjsonrpc server received request: #{request}" unless @logger.nil?
         req_id = nil
         rpc = JSON.parse(request)
         raise "Received unsupprted jsonrpc version (#{rpc['jsonrpc']})" if rpc["jsonrpc"].strip != "2.0"
@@ -43,17 +44,18 @@ module ZmqJsonRpc
         method = rpc["method"]
         params = rpc["params"]
 
-        @logger.info "Received JSON RPC request: #{method}(#{params.collect {|p| p.inspect}.join(", ")})" unless @logger.nil?
+        @logger.debug "zmqjsonrpc server calls proxy method: #{method}(#{params.collect {|p| p.inspect}.join(", ")})" unless @logger.nil?
         result = @proxy.send(method.to_sym, *params)
         response = {
           id: rid,
           jsonrpc: "2.0",
           result: result
         }
+        @logger.debug "zmqjsonrpc server sends response: #{response.inspect})" unless @logger.nil?
         return response.to_json
       rescue => e
         # If there is more time to spare, we could implement the actual error codes here.
-        @logger.warn "Returning error for RPC request: #{e.message})" unless @logger.nil?
+        @logger.warn "zmqjsonrpc server caugth error during request handling: #{e.message.strip})" unless @logger.nil?
         response = {
           id: rid,
           jsonrpc: "2.0",
@@ -63,6 +65,7 @@ module ZmqJsonRpc
             data: e.backtrace.inspect
           }
         }
+        @logger.debug "zmqjsonrpc server sends response: #{response.inspect})" unless @logger.nil?
         return response.to_json
       end
     end
@@ -71,6 +74,7 @@ module ZmqJsonRpc
       @context = ZMQ::Context.new(1)
       @socket = @context.socket(ZMQ::REP)
       @socket.bind(@connect)
+      @logger.info "zmqjsonrpc server listens to #{@connect}" unless @logger.nil?
       begin
         loop do
           request = ''
@@ -79,6 +83,7 @@ module ZmqJsonRpc
           @socket.send_string(response)
         end
       ensure
+        @logger.info "zmqjsonrpc server shuts down" unless @logger.nil?
         @socket.close
         # @context.terminate
       end

data/zmqjsonrpc.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "zmqjsonrpc"
-  spec.version       = "0.1"
+  spec.version       = "0.1.1"
   spec.authors       = ["Tom Rothe"]
   spec.email         = ["tom@bisdn.de"]
   spec.description   = 'Simple JSON RPC 2.0 client and server via zmq.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zmqjsonrpc
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Tom Rothe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq