jubilee 2.1.0.beta-java → 2.1.0.rc1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 865bcd4759e0b52c639ae642a749f1885da1025c
-  data.tar.gz: 7a13f948d9e4a4a75ee039b1765b74ea9333c3b6
+  metadata.gz: a4025890d1a3b94265ecc1baf4b14c29360b2639
+  data.tar.gz: 12d2da1989239ee2b4d52ab5c64e0c0491713c26
 SHA512:
-  metadata.gz: ba572a6a03c0c8c593d6f183375c8aa42fa69c10fe5c41b9d50fd9f0d7360f7ad3a71201ee7dd695a4ee5c1ddfac98b77d5ed3727cec2e68c7e4a8d63c1d3757
-  data.tar.gz: 7e209e4e8a9d0e24599078aa550b2a74c57e1a4f7a8d1961d9fcb67faf1c403301d29436dcfb0c582402a69fc6bff6883c50a6e61482f01f6f947e23efa3a2ae
+  metadata.gz: 3d6b27947fe1717e3e5ff1def31dc325ecc6aa00b560e04789a5723d1c4960ed0c70bd90dbc8bc6f369ad290af89386f179fbc6545dfbfe3fe1f439c3c3ff457
+  data.tar.gz: 0fe735bc70b1bade1be8ff36062cb65177763944ba74a9b16213c5fb95a26e9bd61bea60030a8f7ac3c0f7931b739b44c37bbd00778ebd3b9afd01a0598a7435

data/Gemfile.lock

@@ -29,6 +29,7 @@ GEM
       tzinfo (~> 0.3.37)
     addressable (2.3.5)
     arel (4.0.1)
+    atomic (1.1.14)
     atomic (1.1.14-java)
     builder (3.1.4)
     capybara (2.2.0)
@@ -53,6 +54,7 @@ GEM
     execjs (2.0.2)
     faraday (0.8.8)
       multipart-post (~> 1.2.0)
+    ffi (1.9.3)
     ffi (1.9.3-java)
     formatador (0.2.4)
     git (1.2.6)
@@ -94,6 +96,7 @@ GEM
     jquery-rails (3.0.4)
       railties (>= 3.0, < 5.0)
       thor (>= 0.14, < 2.0)
+    json (1.8.1)
     json (1.8.1-java)
     jwt (0.1.8)
       multi_json (>= 1.5)
@@ -111,6 +114,7 @@ GEM
     multi_json (1.8.2)
     multi_xml (0.5.5)
     multipart-post (1.2.0)
+    nokogiri (1.5.10)
     nokogiri (1.5.10-java)
     oauth2 (0.9.2)
       faraday (~> 0.8)
@@ -125,6 +129,10 @@ GEM
       multi_json (~> 1.0)
       websocket-driver (>= 0.2.0)
     polyglot (0.3.3)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     pry (0.9.12.4-java)
       coderay (~> 1.0)
       method_source (~> 0.8)
@@ -148,10 +156,11 @@ GEM
       activesupport (= 4.0.2)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rake (10.1.1)
+    rake (10.3.2)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.3)
       ffi (>= 0.5.0)
+    rcov (0.9.11)
     rcov (0.9.11-java)
     rdoc (4.1.0)
       json (~> 1.4)
@@ -188,6 +197,8 @@ GEM
       therubyrhino_jar (>= 1.7.3)
     therubyrhino_jar (1.7.4)
     thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
     thread_safe (0.1.3-java)
       atomic
     tilt (1.4.1)
@@ -201,6 +212,7 @@ GEM
     uglifier (2.4.0)
       execjs (>= 0.3.0)
       json (>= 1.8.0)
+    websocket-driver (0.3.2)
     websocket-driver (0.3.2-java)
     xpath (2.0.0)
       nokogiri (~> 1.3)

data/README.md

@@ -1,74 +1,49 @@
 [![Build Status](https://travis-ci.org/isaiah/jubilee.png?branch=master)](https://travis-ci.org/isaiah/jubilee)
 
-Jubilee server
-=========
- 
-> "We need a web framework for Vertx.", you said.
-
-> "But why not use Vertx in your Rails applications, it's the most productive web framework ever created."
-
-The Answer is Jubilee, a rack server with [vertx 2.0](http://vertx.io) awesomeness builtin. Check out the
-[demo](http://192.241.201.68:8080/) [application](https://github.com/isaiah/jubilee/tree/master/examples/chatapp).
-
-Why another rack server?
-------------------------
+Jubilee / mod-rack
+==================
 
-> "Vert.x is a lightweight, high performance application platform for the JVM
-> that's designed for modern mobile, web, and enterprise applications."
->      - vertx.io site
+> A rack server for jruby.
 
-By using Vertx, jubilee inherent advantages in terms of performance, and all
-the other cool features of Vertx:
+> Also works as vertx module.
 
-* [EventBus](https://github.com/isaiah/jubilee/wiki/Event-Bus)
-* [SharedData](https://github.com/isaiah/jubilee/wiki/SharedData)
-* [Clustering](https://github.com/isaiah/jubilee/wiki/Clustering)
+Get started
+-----------
 
+Please checkout the [wiki
+page](https://github.com/isaiah/jubilee/wiki/Running-as-vertx-module)
+before you proceed.
 
+Add the following snippet to ```$VERTX\_HOME/conf/langs.properties```
+```
+rackup=isaiah~mod-rack~0.1.2:org.jruby.jubilee.JubileeVerticleFactory
+.ru=rackup
+```
 
-Installation
-------------
+Make sure JRUBY_HOME is correctly set, and ```rack``` gem is install before proceed.
 
-    $ jruby -S gem install jubilee
+Then run the rackup file as a normal verticle,
 
-Jubilee requires JRuby 1.7.5 or later, and JDK 7+
+```shell
+vertx run config.ru
+```
 
 Build from source
 -----------------
 
-Checkout the source and run the following command in the root directory of the
-project:
+First checkout the source from github.
+
+1. To run as a vertx module, run the following command in the root directory:
 
 ```shell
-bundle && bundle exec rake install
+mvn package
+vertx create-module-link org.jruby.jubilee~mod-rack~0.1.3-SNAPSHOT
 ```
 
-Get started
------------
-
-    $ cd a-rack-app
-    $ jruby -S jubilee
-
-Setup
------
-
-If you use bundler, you might want to add `jubilee` to your Gemfile
+then change your langs.properties file to point to the new module;
 
-    gem 'jubilee', '~> 2.0.0'
-
-Rails
------
-
-Under the default setup, jubilee runs 4 instances of web
-servers, each with it's own jruby runtime, if you find that jubilee
-crashes or hangs with OutOfMemeoryError, please tune your JVM OPTS
-like this:
-
-    $ export JAVA_OPTS="-Xms1024m -Xmx2048m -XX:PermSize=512m -XX:MaxPermSize=512m"
-
-If your OS memory is quite limited, please run jubilee with
-
-    $ jubilee -n 1
+2. To run as rubygem, run ```rake install``` in the root directory, maven is
+required.
 
 Event Bus
 =========
@@ -81,10 +56,18 @@ Examples
 --------
 
 Assume necessary javascript files are loaded in the page (they can be found [here](https://github.com/isaiah/jubilee/tree/master/examples/client)),
-start jubilee in a rack application with:
+run rack application with the following config:
+
+```
+$ cat config.json
+{ "host": "0.0.0.0",
+  "port": 8080,
+  "event_bus": "/eventbus"
+}
+```
 
 ```
-$ jubilee --eventbus /eventbus
+$ vertx run config.ru -conf config.json
 ```
 
 In one browser:
@@ -109,6 +92,34 @@ In the previous tab it should print the greetings you just sent.
 For more advanced examples, please checkout the
 [chatapp](https://github.com/isaiah/jubilee/tree/master/examples/chatapp).
 
+EventBus Security
+------------------
+
+The EventBus can (and probably should) be secured by passing in parameters in the config.json 
+object.
+
+The following config will allow all messages from the browser to `accounts.get_balances` and 
+only allow messages outward that match the format `accounts.get_balances.*`.
+ 
+```
+$ cat config.json
+{ 
+  "host": "0.0.0.0",
+  "port": 8080,
+  "event_bus": "/eventbus",
+  "event_bus_security": 
+    {
+      "incoming": [{address: "user_accounts.get_balances"}],
+      "outgoing": [{address_re: "user_accounts.balances.*"}]
+    }
+}
+```
+
+More details of parameters can be found in [the VertX docs](http://vertx.io/core_manual_ruby.html#securing-the-bridge)
+
+By default the bridge is left wide open.  Any browser connected to an application can observe *all* messages being 
+passed on your EventBus.
+
 Performance Tuning
 -------------------
 

data/Rakefile

@@ -34,6 +34,8 @@ Jeweler::Tasks.new do |gem|
   gem.version = Jubilee::Version::STRING
   gem.platform = "java"
   gem.files.include "lib/jubilee/jubilee.jar"
+  gem.files.include "jars/*.jar"
+  gem.files.include "lib/**/*.rb"
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
@@ -69,35 +71,35 @@ end
 
 require 'ant'
 
-DEST_PATH = "pkg/classes"
-RESOURCE_PATH = "java/resources"
-
-directory DEST_PATH
-
 desc "Clean up build artifacts"
 task :clean do
-  rm_rf "pkg/classes"
+  sh "mvn clean"
+  rm_rf "jars"
   rm_rf "lib/jubilee/*.jar"
+  rm_rf "lib/core"
+  rm_rf "lib/vertx.rb"
+  rm_rf "lib/vertx_tests.rb"
+  rm_rf "lib/container.rb"
+  rm_rf "lib/test_utils.rb"
 end
 
-BUILDTIME_LIB_DIR = File.join(File.dirname(__FILE__), "jars")
-
-desc "Compile the extension, need jdk7 because vertx relies on it"
-task :compile => [DEST_PATH, "#{DEST_PATH}/META-INF"] do |t|
-  ant.javac :srcdir => "java", :destdir => t.prerequisites.first,
-    :source => "1.7", :target => "1.7", :debug => true, :includeantruntime => false,
-    :classpath => "${java.class.path}:${sun.boot.class.path}:jars/vertx-core-2.1.1.jar:jars/netty-all-4.0.20.Final.jar:jars/jackson-core-2.2.2.jar:jars/jackson-databind-2.2.2.jar:jars/jackson-annotations-2.2.2.jar:jars/hazelcast-3.2.3.jar:jars/vertx-platform-2.1.1.jar:jars/vertx-hazelcast-2.1.1.jar"
-end
+#desc "Compile the extension, need jdk7 because vertx relies on it"
+#task :compile => [DEST_PATH, "#{DEST_PATH}/META-INF"] do |t|
+#  #ant.javac :srcdir => "java", :destdir => t.prerequisites.first,
+#  #  :source => "1.7", :target => "1.7", :debug => true, :includeantruntime => false,
+#  #  :classpath => "${java.class.path}:${sun.boot.class.path}:jars/vertx-core-2.1.2.jar:jars/netty-all-4.0.20.Final.jar:jars/jackson-core-2.2.2.jar:jars/jackson-databind-2.2.2.jar:jars/jackson-annotations-2.2.2.jar:jars/hazelcast-3.2.3.jar:jars/vertx-platform-2.1.2.jar:jars/vertx-hazelcast-2.1.2.jar"
+#end
 
-desc "Copy META-INF"
-task "#{DEST_PATH}/META-INF" => ["#{RESOURCE_PATH}/META-INF", "#{RESOURCE_PATH}/default-cluster.xml"] do |t|
-  FileUtils.cp_r t.prerequisites.first, t.name, verbose: true
-  cp t.prerequisites[1], DEST_PATH, verbose: true
-end
+#desc "Copy META-INF"
+#task "#{DEST_PATH}/META-INF" => ["#{RESOURCE_PATH}/META-INF", "#{RESOURCE_PATH}/default-cluster.xml"] do |t|
+#  FileUtils.cp_r t.prerequisites.first, t.name, verbose: true
+#  cp t.prerequisites[1], DEST_PATH, verbose: true
+#end
 
 desc "Build the jar"
-task :jar => [:clean, :compile] do
-  ant.jar :basedir => "pkg/classes", :destfile => "lib/jubilee/jubilee.jar"
+task :jar => :clean do
+  sh "mvn package"
+  sh "unzip jars/*.zip *.rb -d lib"
 end
 
 task :build => :jar

data/examples/chatapp/Gemfile

@@ -1,5 +1,4 @@
 source "https://rubygems.org"
 gem 'sinatra'
 gem 'haml'
-
-gem 'jubilee', '2.0.0.beta'
+gem 'jubilee'

data/examples/chatapp/Gemfile.lock

@@ -4,7 +4,7 @@ GEM
     ffi (1.9.3-java)
     haml (4.0.4)
       tilt
-    jubilee (2.0.0.beta-java)
+    jubilee (2.1.0.beta-java)
       rack (>= 1.4.1)
       spoon (~> 0.0.4)
     rack (1.5.2)
@@ -23,5 +23,5 @@ PLATFORMS
 
 DEPENDENCIES
   haml
-  jubilee (= 2.0.0.beta)
+  jubilee
   sinatra

data/examples/chatapp/README.md

@@ -6,12 +6,24 @@ application.
 
 Make sure you are using jruby 1.7+ (jubilee 1.1.0+ require jruby 1.7.5 or later) and your JDK version is 7+
 
-To run the application:
+Install the lastest stable version of vertx(2.1.2), and put the following snippet in your vertx
+language configuration, you can find the file under $VERTX\_HOME/conf/langs.properties
+
+```
+rackup=isaiah~mod-rack~0.1.1:org.jruby.jubilee.JubileeVerticleFactory
+.ru=rackup
+```
+
+and run
 
 ```shell
-bundle && jubilee --eventbus /eventbus
+vertx run config.ru -conf config.json
 ```
 
 Then go to http://localhost:8080 in your browser, if you have the page
 opened in multiple tabs or windows you can see the message you sent are
 broadcasted to all the other tabs.
+
+Checkout the [wiki
+page](https://github.com/isaiah/jubilee/wiki/Running-as-vertx-module) if
+you run into any trouble.

data/examples/chatapp/app.rb

@@ -1,6 +1,7 @@
 require 'bundler/setup'
 Bundler.require(:default)
 require 'vertx'
+Vertx.deploy_verticle('test.rb')
 
 def to_a(shared_set)
   ret = []

data/examples/chatapp/config.json

@@ -0,0 +1,4 @@
+{ "host": "0.0.0.0",
+  "port": 8080,
+  "event_bus": "/eventbus"
+}

data/examples/chatapp/config.ru

@@ -1,4 +1,2 @@
-require 'jubilee'
-require 'vertx'
 require './app'
 run Sinatra::Application.new

data/lib/container.rb

@@ -0,0 +1,117 @@
+# Copyright 2011 the original author or authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'core/wrapped_handler'
+
+module Vertx
+
+  # Deploy a verticle. The actual deploy happens asynchronously
+  # @param main [String] The main of the verticle to deploy
+  # @param config [Hash] JSON configuration for the verticle
+  # @param instances [FixNum] Number of instances to deploy
+  # @param block [Block] Block will be executed when deploy has completed - the first parameter passed to
+  # the block will be an exception or nil if no failure occurred, the second parameter will be the deployment id
+  def Vertx.deploy_verticle(main, config = nil, instances = 1, &block)
+    if config
+      json_str = JSON.generate(config)
+      config = org.vertx.java.core.json.JsonObject.new(json_str)
+    end
+    if block
+      block = ARWrappedHandler.new(block)
+    end
+    org.vertx.java.platform.impl.JRubyVerticleFactory.container.deployVerticle(main, config, instances, block)
+  end
+
+  # Deploy a worker verticle. The actual deploy happens asynchronously
+  # @param main [String] The main of the verticle to deploy
+  # @param config [Hash] JSON configuration for the verticle
+  # @param instances [FixNum] Number of instances to deploy
+  # @param block [Block] Block will be executed when deploy has completed - the first parameter passed to
+  # the block will be an exception or nil if no failure occurred, the second parameter will be the deployment id
+  def Vertx.deploy_worker_verticle(main, config = nil, instances = 1, multi_threaded = false, &block)
+    if config
+      json_str = JSON.generate(config)
+      config = org.vertx.java.core.json.JsonObject.new(json_str)
+    end
+    if block
+      block = ARWrappedHandler.new(block)
+    end
+    org.vertx.java.platform.impl.JRubyVerticleFactory.container.deployWorkerVerticle(main, config, instances, multi_threaded, block)
+  end
+
+  # Deploy a module. The actual deploy happens asynchronously
+  # @param module_name [String] The name of the module to deploy
+  # @param config [Hash] JSON configuration for the module
+  # @param instances [FixNum] Number of instances to deploy
+  # @param block [Block] Block will be executed when deploy has completed - the first parameter passed to
+  # the block will be an exception or nil if no failure occurred, the second parameter will be the deployment id
+  def Vertx.deploy_module(module_name, config = nil, instances = 1, &block)
+    if config
+      json_str = JSON.generate(config)
+      config = org.vertx.java.core.json.JsonObject.new(json_str)
+    end
+    if block
+      block = ARWrappedHandler.new(block)
+    end
+    org.vertx.java.platform.impl.JRubyVerticleFactory.container.deployModule(module_name, config, instances, block)
+  end
+
+  # Undeploy a verticle
+  # @param id [String] The deployment id  - the undeploy happens asynchronously
+  # @param block [Block] Block will be executed when undeploy has completed, an exception will be passed to the block
+  # as the first parameter if undeploy failed
+  def Vertx.undeploy_verticle(id, &block)
+    if block
+      block = ARWrappedHandler.new(block)
+    end
+    org.vertx.java.platform.impl.JRubyVerticleFactory.container.undeployVerticle(id, block)
+  end
+
+  # Undeploy a module
+  # @param id [String] The deployment id
+  # @param block [Block] Block will be executed when undeploy has completed, an exception will be passed to the block
+  # as the first parameter if undeploy failed
+  def Vertx.undeploy_module(id, &block)
+    if block
+      block = ARWrappedHandler.new(block)
+    end
+    org.vertx.java.platform.impl.JRubyVerticleFactory.container.undeployModule(id, block)
+  end
+
+  # Cause the container to exit
+  def Vertx.exit
+    org.vertx.java.platform.impl.JRubyVerticleFactory.container.exit
+  end
+
+  # Get config for the verticle
+  # @return [Hash] The JSON config for the verticle
+  def Vertx.config
+    if !defined? @@j_conf
+      @@j_conf = org.vertx.java.platform.impl.JRubyVerticleFactory.container.config
+      @@j_conf = JSON.parse(@@j_conf.encode) if @@j_conf
+    end
+    @@j_conf
+  end
+
+  # @return [Hash] Get the environment for the verticle
+  def Vertx.env
+    org.vertx.java.platform.impl.JRubyVerticleFactory.container.env
+  end
+
+  # @return [Logger] Get the logger for the verticle
+  def Vertx.logger
+    org.vertx.java.platform.impl.JRubyVerticleFactory.container.logger
+  end
+
+end