RPC level 1 implementation

.gitignore

@@ -4,3 +4,7 @@ Gemfile.lock
 tmp
 .env
 pkg
+*.o
+*.so
+*.gem
+Makefile

README.md

@@ -13,16 +13,148 @@ This here is a [Ruby][ruby] wrapper for the official C++ implementation of [Cap'
 First [install libcapnp][libcapnp-install], then install the gem:
 
 ```bash
-gem install capn_proto --pre
+gem install capn_proto-rpc --pre
 ```
 
-The native extension for this gem requires a C++ compiler with C++11 features, so use the same C++ compiler and flags that you used to compile libcapnp (e.g. `CXX` and `CXXFLAGS`). As an OSX user, having followed the [instructions for installing libcapnp on OSX][libcapnp-install], the correct incantation is as follows:
+or add this to your Gemfile
+
 
 ```bash
-CXX=$HOME/clang-3.2/bin/clang++ gem install capn_proto --pre
+gem capn_proto-rpc
+```
+
+The native extension for this gem requires a C++ compiler with C++11 features.
+I've hardcoded compiler flags directly on the makefile in order to make the install easier.
+
+# RPC Client Example    
+note: the schema file, client example and the server example can be found in lib/tests as a minitest.   
+
+The following examples uses this schema:
+
+```CapnProto
+# file hidraCordatus.capnp
+
+struct Task {
+  dataint @0 :Int32;
+  madeBy @1 :Text;
+}
+
+interface Employer {
+  getWorker @0 () -> ( worker :Worker );
+}
+
+interface Worker {
+  put23 @0 (taskToProcess :Task) -> (taskProcessed :Task);
+}
+
+```
+Load all the schemas and methods that will be used then create an EzRpcClient and from it get our client.
+```ruby
+require 'capn_proto'
+
+module Hydra extend CapnProto::SchemaLoader
+  load_schema('./tests/hidraCordatus.capnp')
+end
+
+employer_schema =   Hydra::Employer.schema
+get_worker_method = Hydra::Employer.method! 'getWorker'
+put23method =       Hydra::Worker.method!   'put23'
+
+ezclient = CapnProto::EzRpcClient.new("127.0.0.1:1337",employer_schema)
+client = ezclient.client
+
+```
+Create a request of the method "getWorker" who is in the variable get_worker_method above.
+Then, send it storing the pipelined request.
+```ruby
+request = client.request(get_worker_method)
+pipelinedRequest = request.send
+```
+get the returned "worker" set the method that we want to request on it and then set
+the parameters to be requested, in this case we set dataint to 0.
+
+```ruby
+pipelinedRequest.get('worker').method = put23method
+pipelinedRequest.taskToProcess.dataint(0)
+```
+now we wait for the results (note that this is the only line that blocks). while we are waiting
+the Global interpreter lock is released so we can run ruby code on other threads.
+Also note that we use ezclient as a waitscope.
+```ruby
+results = pipelinedRequest.send.wait(ezclient)
+puts results.taskProcessed.dataint
+puts results.taskProcessed.madeBy
+```
+
+# RPC server Example
+```ruby
+require 'capn_proto'
+
+module Hydra extend CapnProto::SchemaLoader
+  load_schema('./tests/hidraCordatus.capnp')
+end
+
+class WorkerServer < CapnProto::CapabilityServer
+  def initialize(i)
+    @madeBy = "made by worker ##{i}"
+    super(Hydra::Worker.schema)
+  end
+
+  def put23(context)
+    n = context.getParams.taskToProcess.dataint
+    context.getResults.taskProcessed.dataint = n + 23
+    context.getResults.taskProcessed.madeBy = @madeBy
+  end
+end
+
+class EmployerServer < CapnProto::CapabilityServer
+  def initialize(wp)
+    @worker_pool = wp
+    @currentWorker = 0
+    super(Hydra::Employer.schema)
+  end
+
+  def get_a_Worker
+    @currentWorker += 1
+    @worker_pool[@currentWorker % @worker_pool.size]
+  end
+
+  def getWorker(context)
+    context.getResults.worker = get_a_Worker
+  end
+end
+
 ```
+note that the name of the methods is exactly the same as the name of the function that is defined on the schema and recieves only one argument. This argument is a callContext, you can use the method **getParams** to get the parameters passed  to the called method or
+use **getResults** to set the results of the request.   
+regarding to the example, EmployerServer will serve WorkerServers to the clients.
 
-# Example
+```ruby
+workers = []
+10.times do |i|
+  workers << WorkerServer.new(i)
+end
+
+
+e = CapnProto::EzRpcServer.new(EmployerServer.new(workers), "*:1337")
+puts "serving EmployerServer on 1337..."
+e.run
+
+```
+create ten workers, then a EzRpcServer wich binds to port 1337. Then run it.
+```
+the results of running the server/client pair is :
+
+23
+"made by worker #1"
+23
+"made by worker #2"
+23
+"made by worker #3"
+23
+...
+```
+# Structs Example
 
 ```ruby
 require 'capn_proto'
@@ -99,13 +231,18 @@ What's implemented:
 - Message writing
   - To byte string
   - To file descriptor
+- RPC
+  - loading InterfaceSchema and their methods
+  - RPC client
+  - RPC server
 
 What's to come:
 - More reading/writing mechanisms:
   - Packing/unpacking
 - Extensive test coverage
 - Proper support for [JRuby][jruby]
-- Support for RPC
+- There is a known bug where the servers don't exits when pressing control-c. It only exits after
+pressing control-c and then a request is made from a client.
 
 [logo]: https://raw.github.com/cstrahan/capnp-ruby/master/media/captain_proto_small.png "Cap'n Proto"
 [ruby]: http://www.ruby-lang.org/ "Ruby"

capn_proto.gemspec

@@ -1,10 +1,11 @@
 require File.expand_path('../lib/capn_proto/version', __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = 'capn_proto'
+  s.name = 'capn_proto-rpc'
   s.license = 'MIT'
 
   s.version = CapnProto::VERSION
+  s.required_ruby_version = '>= 2.0'
 
   s.summary = "Cap'n Proto (libcapnp) bindings for Ruby."
 
@@ -14,19 +15,20 @@ Gem::Specification.new do |s|
     "From the Cap'n Proto documentation: " \
     "\"Cap'n Proto is an insanely fast data interchange format and " \
     "capability-based RPC system. Think JSON, except binary. " \
-    "Or think Protocol Buffers, except faster.\""
+    "Or think Protocol Buffers, except faster.\" " \
+    "This is a extended version of the original gem Capnproto which adds RPC support visit the homepage to view usage"
 
-  s.homepage = 'https://github.com/cstrahan/capnp-ruby'
+  s.homepage = 'https://github.com/nemoNoboru/capnp-ruby'
 
-  s.authors = ['Charles Strahan']
-  s.email = ['charles.c.strahan@gmail.com']
+  s.authors = ['Charles Strahan','Felipe Vieira']
+  s.email = ['charles.c.strahan@gmail.com','felipetavres@gmail.com']
 
   s.add_development_dependency 'rspec', '2.14.1'
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rake' , '~> 0'
   s.add_development_dependency 'rake-compiler', '0.7.6'
 
-  s.add_development_dependency 'awesome_print'
-  s.add_development_dependency 'interactive_editor'
+  s.add_development_dependency 'awesome_print', '~> 0'
+  s.add_development_dependency 'interactive_editor', '~> 0'
 
   s.extensions = ['ext/capn_proto/extconf.rb']
   s.require_paths = ['lib']

ext/capn_proto/EzRpc_client.cc

@@ -0,0 +1,52 @@
+#include "ruby_capn_proto.h"
+#include "EzRpc_client.h"
+#include "capability_client.h"
+#include "dynamic_capability_client.h"
+#include "class_builder.h"
+#include "exception.h"
+#include "util.h"
+
+namespace ruby_capn_proto {
+  using WrappedType = capnp::EzRpcClient;
+  VALUE EzRpcCapabilityClient::Class;
+
+  void EzRpcCapabilityClient::Init() {
+    ClassBuilder("EzRpcClient", rb_cObject).
+      defineAlloc(&alloc).
+      defineMethod("client", &make_dynamic).
+      defineMethod("initialize" , &create).
+      store(&Class);
+  }
+
+  void EzRpcCapabilityClient::free(WrappedType* p) {
+    ruby_xfree(p);
+  }
+
+  VALUE EzRpcCapabilityClient::alloc(VALUE klass) {
+    return Data_Wrap_Struct(klass, NULL, free, ruby_xmalloc(sizeof(WrappedType)));
+  }
+
+  WrappedType* EzRpcCapabilityClient::unwrap(VALUE self) {
+    WrappedType* p;
+    Data_Get_Struct(self, WrappedType, p);
+    return p;
+  }
+
+  VALUE EzRpcCapabilityClient::create(VALUE self, VALUE dir, VALUE interschema) {
+
+    WrappedType* rb_self = unwrap(self);
+    new (rb_self) capnp::EzRpcClient(Util::toString(dir));
+
+    //store the InterfaceSchema
+    rb_iv_set(self,"schema",interschema);
+
+    return self;
+  }
+
+  VALUE EzRpcCapabilityClient::make_dynamic(VALUE self){
+    VALUE rb_schema = rb_iv_get(self,"schema");
+    VALUE rb_cap = CapabilityClient::create(unwrap(self)->getMain());
+    return DynamicCapabilityClient::create(rb_cap,rb_schema);
+  }
+
+}

ext/capn_proto/EzRpc_client.h

@@ -0,0 +1,21 @@
+#ifndef EZRPC_CAPABILITY_CLIENT_H
+#define EXRPC_CAPABILITY_CLIENT_H
+
+#include "ruby_capn_proto.h"
+
+namespace ruby_capn_proto {
+  class EzRpcCapabilityClient {
+  public:
+    using WrappedType = capnp::EzRpcClient;
+    static void Init();
+    static VALUE alloc(VALUE klass);
+    static VALUE create(VALUE self, VALUE dir, VALUE schema);
+    static void free(WrappedType* p);
+    static WrappedType* unwrap(VALUE self);
+    static VALUE make_dynamic(VALUE self);
+    static VALUE Class;
+  };
+}
+
+
+#endif /* EZRPC_CAPABILITY_CLIENT_H */

ext/capn_proto/EzRpc_server.cc

@@ -0,0 +1,79 @@
+#include "ruby_capn_proto.h"
+#include "EzRpc_server.h"
+#include "ruby_capability_server.h"
+#include "interface_schema.h"
+#include "exception.h"
+#include "class_builder.h"
+#include <ruby/thread.h>
+#include "util.h"
+
+namespace ruby_capn_proto {
+  using WrappedType = capnp::EzRpcServer;
+  VALUE EzRpcCapabilityServer::Class;
+
+  void EzRpcCapabilityServer::Init() {
+    ClassBuilder("EzRpcServer", rb_cObject).
+      defineAlloc(&alloc).
+      defineMethod("run" , &process).
+      defineMethod("initialize" , &create).
+      store(&Class);
+  }
+
+  void EzRpcCapabilityServer::free(WrappedType* p) {
+    ruby_xfree(p);
+  }
+
+  VALUE EzRpcCapabilityServer::alloc(VALUE klass) {
+    return Data_Wrap_Struct(klass, NULL, free, ruby_xmalloc(sizeof(WrappedType)));
+  }
+
+  WrappedType* EzRpcCapabilityServer::unwrap(VALUE self) {
+    WrappedType* p;
+    Data_Get_Struct(self, WrappedType, p);
+    return p;
+  }
+
+  VALUE EzRpcCapabilityServer::create(VALUE self, VALUE rb_capServer, VALUE dir) {
+
+    VALUE interschema = rb_iv_get(rb_capServer,"@schema");
+    auto schema = InterfaceSchema::unwrap(interschema);
+
+    WrappedType* rb_self = unwrap(self);
+    new (rb_self) capnp::EzRpcServer( kj::heap<capnp::RubyCapabilityServer>(*schema, rb_capServer) , Util::toString(dir) );
+
+    return self;
+  }
+
+  VALUE EzRpcCapabilityServer::process(VALUE self){
+    try{
+      loopCall l;
+      auto server = unwrap(self);
+      auto to_fulfill = kj::heap<kj::PromiseFulfillerPair<void>>(kj::newPromiseAndFulfiller<void>());
+      l.waitscope = &server->getWaitScope();
+      l.promisepair = to_fulfill.get();
+      rb_thread_call_without_gvl(loopServer, &l, stopLoopServer , l.promisepair);
+    }catch ( kj::Exception t ){
+      Exception::raise(t);
+    }
+    return Qtrue;
+  }
+
+  void * EzRpcCapabilityServer::loopServer(void * p){
+    try {
+      auto* loopcall = (loopCall*) p;
+      loopcall->promisepair->promise.wait(*(loopcall->waitscope));
+    }catch( kj::Exception t ){
+      //adquire the lock to raise a ruby exception
+      rb_thread_call_with_gvl(&Exception::raise,&t);
+    }
+  }
+
+  void EzRpcCapabilityServer::stopLoopServer(void *p){
+    try {
+      auto* promisefulfiller = (kj::PromiseFulfillerPair<void>*) p;
+      promisefulfiller->fulfiller->fulfill();
+    }catch( kj::Exception t ){
+      Exception::raise(t);
+    }
+  }
+}