capn_proto-rpc 0.1.1.alpha.rpc

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb0376733f65b4d375a29c42f945b0ee1bcec8b0
+  data.tar.gz: b61f3ba9cf9404bfa36b62b92bc9c99b5c96e5ac
+SHA512:
+  metadata.gz: 46a976fc012163fed9d32b674094cf62d3b829696a3aecdfd14b269e6689cca3eeec395b30b4527da3e9304eaff957de6edfec1a9d76209b176913e4c384187d
+  data.tar.gz: 823596f7f4696caaed82e8c30fad403d7f189ad6c08a1ec10fb599112a0684d3c03ad989611551536009b41608664dfdd98dec07219e1aabe73ea3f6748f4727

data/.gitignore

@@ -0,0 +1,10 @@
+Gemfile.lock
+*.bundle
+*.pyc
+tmp
+.env
+pkg
+*.o
+*.so
+*.gem
+Makefile

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+
+compiler: gcc
+
+before_install:
+  - sudo apt-get install autoconf automake libtool autotools-dev
+  - sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
+  - sudo apt-get -qq update
+  - sudo apt-get -qq install g++-4.8 libstdc++-4.8-dev
+  - sudo update-alternatives --quiet --install /usr/bin/gcc  gcc  /usr/bin/gcc-4.8  60
+                                     --slave   /usr/bin/g++  g++  /usr/bin/g++-4.8
+                                     --slave   /usr/bin/gcov gcov /usr/bin/gcov-4.8
+  - sudo update-alternatives --quiet --set gcc /usr/bin/gcc-4.8
+  - git clone --depth=1 https://github.com/kentonv/capnproto.git && cd capnproto/c++ && ./setup-autotools.sh && autoreconf -i && ./configure && make -j6 check && sudo make install && sudo ldconfig && cd ../..

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Charles Strahan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,249 @@
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/cstrahan/capnp-ruby/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+
+![Cap'n Proto][logo]
+
+# Ruby Edition
+
+This here is a [Ruby][ruby] wrapper for the official C++ implementation of [Cap'n Proto][capnp].
+
+[![Build Status][travis-badge]][travis-link]
+
+# Installing
+
+First [install libcapnp][libcapnp-install], then install the gem:
+
+```bash
+gem install capn_proto --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:
+
+```bash
+CXX=$HOME/clang-3.2/bin/clang++ gem install capn_proto --pre
+```
+
+
+
+# Structs Example
+
+```ruby
+require 'capn_proto'
+
+module AddressBook extend CapnProto::SchemaLoader
+  load_schema("addressbook.capnp")
+end
+
+def write_address_book(file)
+  addresses = AddressBook::AddressBook.new_message
+  people = addresses.initPeople(2)
+
+  alice = people[0]
+  alice.id = 123
+  alice.name = 'Alice'
+  alice.email = 'alice@example.com'
+  alice_phones = alice.initPhones(1)
+  alice_phones[0].number = "555-1212"
+  alice_phones[0].type = 'mobile'
+  alice.employment.school = "MIT"
+
+  bob = people[1]
+  bob.id = 456
+  bob.name = 'Bob'
+  bob.email = 'bob@example.com'
+  bob_phones = bob.initPhones(2)
+  bob_phones[0].number = "555-4567"
+  bob_phones[0].type = 'home'
+  bob_phones[1].number = "555-7654"
+  bob_phones[1].type = 'work'
+  bob.employment.unemployed = nil
+
+  addresses.write(file)
+end
+
+def print_address_book(file)
+  addresses = AddressBook::AddressBook.read_from(file)
+
+  addresses.people.each do |person|
+    puts "#{person.name} : #{person.email}"
+
+    person.phones.each do |phone|
+      puts "#{phone.type} : #{phone.number}"
+    end
+
+    if person.employment.unemployed?
+      puts "unemployed"
+    if person.employment.employer?
+      puts "employer: #{person.employment.employer}"
+    if person.employment.school?
+      puts "student at: #{person.employment.school}"
+    if person.employment.selfEmployed?
+      puts "self employed"
+    end
+  end
+end
+
+if __FILE__ == $0
+  file = File.open("addressbook.bin", "wb")
+  write_address_book(file)
+
+  file = File.open("addressbook.bin", "rb")
+  print_address_book(file)
+end
+```
+# 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
+
+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
+
+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
+
+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.
+
+```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
+...
+```
+
+# Status
+
+What's implemented:
+- Schema parsing/loading
+- Message reading
+  - From byte string
+  - From file descriptor
+- 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]
+- 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"
+[capnp]: http://kentonv.github.io/capnproto/ "Cap'n Proto"
+[jruby]: http://jruby.org/ "JRuby"
+[libcapnp-install]: http://kentonv.github.io/capnproto/install.html "Installing Cap'n Proto"
+[mit-license]: http://opensource.org/licenses/MIT "MIT License"
+
+[travis-link]: https://travis-ci.org/cstrahan/capnp-ruby
+[travis-badge]: https://travis-ci.org/cstrahan/capnp-ruby.png?branch=master

data/Rakefile

@@ -0,0 +1,44 @@
+require 'capn_proto/version'
+GEMSPEC = eval(File.read('capn_proto.gemspec'))
+
+require 'rubygems/package_task'
+Gem::PackageTask.new(GEMSPEC) do |pkg|
+end
+
+require 'rake/extensiontask'
+Rake::ExtensionTask.new('capn_proto', GEMSPEC) do |ext|
+  ext.ext_dir = 'ext/capn_proto'
+  ext.lib_dir = 'lib/capn_proto'
+  ext.source_pattern = "*.{cc,h}"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |config|
+end
+
+task :default => [:compile, :spec]
+
+Rake::Task["clean"].clear
+desc "Clean build artifacts"
+task :clean do
+  rm_r "tmp" rescue nil
+  rm_r "pkg" rescue nil
+  rm "lib/capn_proto/capn_proto.bundle" rescue nil
+end
+
+desc "Tag commit, push to repo, then push to RubyGems"
+task :release => [:clean, :compile, :spec, :gem]  do
+  tag = "v#{CapnProto::VERSION}"
+  sh "git tag #{tag}"
+  sh "git push origin #{tag}"
+  sh "gem push pkg/capn_proto-#{CapnProto::VERSION}.gem"
+end
+
+desc "Open an irb console"
+task :console do
+  $: << File.expand_path("../lib", __FILE__)
+  require 'irb'
+  require 'capn_proto'
+  ARGV.clear
+  IRB.start
+end

data/capn_proto.gemspec

@@ -0,0 +1,37 @@
+require File.expand_path('../lib/capn_proto/version', __FILE__)
+
+Gem::Specification.new do |s|
+  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."
+
+  s.description =
+    "This gem wraps the official C++ implementation of Cap'n Proto " \
+    "(libcapnp). " \
+    "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.\" " \
+    "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/nemoNoboru/capnp-ruby'
+
+  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' , '~> 0'
+  s.add_development_dependency 'rake-compiler', '0.7.6'
+
+  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']
+
+  s.files = `git ls-files`.split("\n")
+end

data/examples/addressbook.capnp

@@ -0,0 +1,31 @@
+@0x9eb32e19f86ee174;
+
+struct Person {
+  id @0 :UInt32;
+  name @1 :Text;
+  email @2 :Text;
+  phones @3 :List(PhoneNumber);
+
+  struct PhoneNumber {
+    number @0 :Text;
+    type @1 :Type;
+
+    enum Type {
+      mobile @0;
+      home @1;
+      work @2;
+    }
+  }
+
+  employment :union {
+    unemployed @4 :Void;
+    employer @5 :Text;
+    school @6 :Text;
+    selfEmployed @7 :Void;
+    # We assume that a person is only one of these.
+  }
+}
+
+struct AddressBook {
+  people @0 :List(Person);
+}

data/examples/create_test_data.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+from __future__ import print_function
+import os
+import capnp
+
+this_dir = os.path.dirname(__file__)
+out_path = os.path.join(this_dir, 'addressbook.bin')
+addressbook = capnp.load(os.path.join(this_dir, 'addressbook.capnp'))
+
+def writeAddressBook(file):
+    addresses = addressbook.AddressBook.newMessage()
+    people = addresses.init('people', 2)
+
+    alice = people[0]
+    alice.id = 123
+    alice.name = 'Alice'
+    alice.email = 'alice@example.com'
+    alicePhones = alice.init('phones', 1)
+    alicePhones[0].number = "555-1212"
+    alicePhones[0].type = 'mobile'
+    alice.employment.school = "MIT"
+
+    bob = people[1]
+    bob.id = 456
+    bob.name = 'Bob'
+    bob.email = 'bob@example.com'
+    bobPhones = bob.init('phones', 2)
+    bobPhones[0].number = "555-4567"
+    bobPhones[0].type = 'home'
+    bobPhones[1].number = "555-7654"
+    bobPhones[1].type = 'work'
+    bob.employment.unemployed = None
+
+    addresses.writeTo(file)
+
+
+if __name__ == '__main__':
+    f = open(out_path, 'w')
+    writeAddressBook(f)