pipe_rpc 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99ed1d2bae8edbc79139ae6999900d97fd1cf0c1
-  data.tar.gz: 90e419e139506cd3d5483f35ba23af86bb8ec02e
+  metadata.gz: eb0f50e52b37b279be08b1044701ff5dc9fdb53f
+  data.tar.gz: 9aa8ac09ca6ad298acba5869c649a707c2d5bf4c
 SHA512:
-  metadata.gz: d023b1e46d06a7148cc20e5343c54ccb36536926d41d3bf4631a3a61b05ec0b41a7356b0458ab4d486feb04b081425628e80c918dd23d2343bf1318099765c60
-  data.tar.gz: 45e7592fd3653564fc44ee02d2d2256e437d0b5047cd49ef03bd0be151f432389f03fa366b1068ad782cb5b83fd6b977c906bee2f9de9c83ea70d86a296f3827
+  metadata.gz: 57dd76c93512192edbe0878d59887a09d9177d0db745243bc4549c226e0e9f908fcd72eb1a195dfa0bdc9009e26bd471745abdedceae9d49a84f04a776a8f640
+  data.tar.gz: cc9327c2967955c7c82790f919acc1e7ed33f93eb596a91b88e7bc92b149d9f430e646dd15b674fe562b23454818b5c38ed244d4f83082179f777b3f57c2998d

data/README.md

@@ -1,6 +1,8 @@
 # PipeRpc
 
-PipeRpc was designed so parent und child processes can call each other's methods. It uses a json protocol similar to JSON-RPC.
+PipeRpc was designed so parent und child processes can call each other's
+methods. It uses a protocol similar to JSON-RPC but serializes the payloads
+with [msgpack](http://msgpack.org/).
 
 ## Installation
 

data/lib/msgpack_config.rb

@@ -0,0 +1,27 @@
+require 'msgpack'
+
+# Serialize objects to strings by default
+class Object
+  def to_msgpack(packer)
+    packer.pack(to_s)
+  end
+
+  def self.from_msgpack(packed)
+    packed.unpack('A*').first
+  end
+end
+
+# Support serialization of symbols
+MessagePack::DefaultFactory.register_type(0x01, Symbol)
+
+# For compatibility with the msgpack implementation in mruby
+MessagePack::Error = MessagePack::UnpackError
+
+# The msgpack implementation in mruby supports an ext type for classes
+class Class
+  alias_method :to_msgpack_ext, :to_msgpack
+end
+class << Class
+  alias_method :from_msgpack_ext, :from_msgpack
+end
+MessagePack::DefaultFactory.register_type(0x02, Class)

data/lib/pipe_rpc/client.rb

@@ -1,5 +1,8 @@
 module PipeRpc
   class Client < BasicObject
+    undef_method :instance_eval unless ::Object.const_defined?(:MRUBY_VERSION)
+    undef_method :instance_exec unless ::Object.const_defined?(:MRUBY_VERSION)
+
     def initialize(server = :default, hub)
       @server = server.to_sym
       @hub = hub
@@ -9,6 +12,9 @@ module PipeRpc
       request = Client::Request.new(server: @server, method: method, arguments: args)
       @hub.requests.evaluate(request)
     end
+    alias __send__ method_missing
+    alias send method_missing
+    alias public_send method_missing
 
     def to_s
       "<Client:#{@server.to_s}>"

data/lib/pipe_rpc/hub_message.rb

@@ -1,4 +1,5 @@
 module PipeRpc
+  PipeRpcErrorResponse = ErrorResponse
   class Hub
     class Message
       def initialize(hub, body)
@@ -47,7 +48,7 @@ module PipeRpc
       def guarded
         yield
       rescue => e
-        @hub.socket.write PipeRpc::ErrorResponse.new(id: @body[:id], error: { code: -32600,
+        @hub.socket.write PipeRpcErrorResponse.new(id: @body[:id], error: { code: -32600,
               data: { message: e.message } })
         nil
       end

data/lib/pipe_rpc/hub_request_result.rb

@@ -1,7 +1,7 @@
 module PipeRpc
   class Hub::Request::Result
     def initialize(request, result)
-      @request, @result, @async_responder = request, result
+      @request, @result = request, result
     end
 
     def value

data/lib/pipe_rpc/hub_socket.rb

@@ -10,18 +10,26 @@ module PipeRpc
 
     def read
       raise ClosedError if @input.closed?
-      incoming = Incoming.new(@input.gets) # blocks
-      incoming.trigger(@on_received)
-      incoming.to_h
-    rescue JSON::JSONError => e
-      write ErrorResponse.new(id: nil, error: { code: -32700, data: { message: e.message } })
+
+      # infinite #readpartial that also works with mruby-restricted_io
+      packed = ''
+      loop do
+        packed << @input.sysread(2*16)
+        break unless @input.class.select([@input], nil, nil, 0)
+      end
+
+      unpack(packed).tap do |unpacked|
+        @on_received.each{ |cb| cb.call(unpacked) }
+      end
+    rescue MessagePack::Error => e
+      write ErrorResponse.new(id: nil, error: { code: -32700, data: { message: "MessagePack: #{e.message}" } })
     end
 
     def write(obj)
       raise ClosedError if @output.closed?
-      outgoing = Outgoing.new(obj)
-      outgoing.trigger(@on_sent)
-      @output.puts outgoing.to_payload
+      payload = obj.to_h
+      @on_sent.each{ |callback| callback.call(payload) }
+      @output.syswrite payload.to_msgpack
     end
 
     def on_sent(&on_sent)
@@ -36,5 +44,13 @@ module PipeRpc
       @input.close
       @output.close
     end
+
+    def unpack(packed)
+      if ::Object.const_defined?(:MRUBY_VERSION)
+        MessagePack.unpack(packed, true) # to create unknown symbols in mruby
+      else
+        MessagePack.unpack(packed)
+      end
+    end
   end
 end

data/lib/pipe_rpc/result_response.rb

@@ -1,7 +1,7 @@
 module PipeRpc
   class ResultResponse
     def initialize(args = {})
-      @result = sanitize(args.fetch(:result))
+      @result = args.fetch(:result)
       @id = args.fetch(:id)
     end
 
@@ -10,19 +10,5 @@ module PipeRpc
     def to_h
       { id: id, result: result }
     end
-
-    private
-
-    def sanitize(result)
-      if true == result or false == result or nil == result or result.is_a?(String) or result.is_a?(Numeric)
-        result
-      elsif result.is_a?(Array)
-        result.map{ |v| sanitize(v) }
-      elsif result.is_a?(Hash)
-        Hash[result.map{ |k,v| [sanitize(k), sanitize(v)] }]
-      else
-        result.to_s
-      end
-    end
   end
 end

data/lib/pipe_rpc/version.rb

@@ -1,3 +1,3 @@
 module PipeRpc
-  VERSION = "1.1.2"
+  VERSION = "2.0.0"
 end

data/lib/pipe_rpc.rb

@@ -1,8 +1,4 @@
-module PipeRpc
-end
-
-require 'json'
-require_relative 'hash'
+require 'msgpack_config'
 
 lib = File.dirname(__FILE__)
 Dir["#{lib}/pipe_rpc/**/*.rb"].sort.each { |f| require f }

data/pipe_rpc.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{RPC between parent and child process over pipes}
   spec.description   = %q{PipeRpc was designed so parent und child processes can call each other's
-                          methods. It uses a json protocol similar to JSON-RPC.}
+                          methods. It uses a protocol similar to JSON-RPC but serializing with msgpack.}
   spec.homepage      = "https://github.com/christopheraue/ruby-pipe_rpc"
   spec.license       = "MIT"
 
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "msgpack", "~> 1.0"
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "rspec-its"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pipe_rpc
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Christopher Aue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ dependencies:
         version: '0.2'
 description: |-
   PipeRpc was designed so parent und child processes can call each other's
-                            methods. It uses a json protocol similar to JSON-RPC.
+                            methods. It uses a protocol similar to JSON-RPC but serializing with msgpack.
 email:
 - mail@christopheraue.net
 executables: []
@@ -96,7 +96,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- lib/hash.rb
+- lib/msgpack_config.rb
 - lib/pipe_rpc.rb
 - lib/pipe_rpc/client.rb
 - lib/pipe_rpc/client_request.rb
@@ -118,8 +118,6 @@ files:
 - lib/pipe_rpc/hub_requests.rb
 - lib/pipe_rpc/hub_servers.rb
 - lib/pipe_rpc/hub_socket.rb
-- lib/pipe_rpc/hub_socket_incoming.rb
-- lib/pipe_rpc/hub_socket_outgoing.rb
 - lib/pipe_rpc/request.rb
 - lib/pipe_rpc/result_response.rb
 - lib/pipe_rpc/version.rb

data/lib/hash.rb

@@ -1,5 +0,0 @@
-class Hash
-  def symbolize_keys
-    Hash[self.map{ |k,v| [(k.to_sym rescue k), v] }]
-  end
-end

data/lib/pipe_rpc/hub_socket_incoming.rb

@@ -1,20 +0,0 @@
-module PipeRpc
-  class Hub::Socket
-    class Incoming
-      def initialize(payload)
-        @payload = payload
-      end
-
-      def to_h
-        @hash ||= JSON.load(@payload).symbolize_keys.tap do |hash|
-          hash[:error] = hash[:error].symbolize_keys if hash[:error]
-          hash[:error][:data] = hash[:error][:data].symbolize_keys if hash[:error] and hash[:error][:data]
-        end
-      end
-
-      def trigger(callbacks)
-        callbacks.each{ |callback| callback.call(to_h) }
-      end
-    end
-  end
-end

data/lib/pipe_rpc/hub_socket_outgoing.rb

@@ -1,21 +0,0 @@
-module PipeRpc
-  class Hub::Socket
-    class Outgoing
-      def initialize(object)
-        @object = object
-      end
-
-      def to_h
-        @hash ||= @object.to_h
-      end
-
-      def to_payload
-        @payload ||= JSON.dump(to_h)
-      end
-
-      def trigger(callbacks)
-        callbacks.each{ |callback| callback.call(to_h) }
-      end
-    end
-  end
-end