drunkmonkey 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19d6e3cc109628d8686e1994aa9e97f67c74e157
+  data.tar.gz: 105874a81de22fde196db492685c77f1a6938690
+SHA512:
+  metadata.gz: 9be7bdf707ae8baabdf59e94d85f6b324efe4c76001c42ca0548159fb1a32129dd82c8fbc55cd4b86b4be96f16ddd1cb46c39111ff5dccba4e0acac1aecd2ce9
+  data.tar.gz: 68d289778433af7a80f56ad610df5104a4bd949d4ec6be1e78b5b882dc1196e1609b30ec91b3bb8ea2cdab4c38c2457e6f8abed0dbf443eada7903bca11f7f80

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in drunkmonkey.gemspec
+gemspec
+
+gem "puma"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 minoritea
+
+MIT License
+
+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,87 @@
+# DrunkMonkey
+
+DrunkMonkey is a rack middleware providing realtime two-way http communication with API for [Portal](https://github.com/flowersinthesand/portal/ "Portal").
+
+## Supported servers
+You should use servers which supports Rack hijacking API, such as follows:
+- Puma
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'drunkmonkey'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install drunkmonkey
+
+## Usage
+
+Add DrunkMonkey::Builder to Rack application by **use** method.
+
+Plain Rack:
+```ruby
+app = Rack::Builder.new do
+  use DrunkMonkey::Middleware do
+    on :message do |socket, message|
+      socket.push "ECHO: #{message}"
+    end
+  end
+end
+
+run app
+```
+
+Sinatra:
+```ruby
+require "sinatra"
+
+use DrunkMonkey::Middleware do
+  on :message do |socket, message|
+    socket.push "ECHO: #{message}"
+  end
+end
+```
+Note: the passed block will be executed once when *use* is called at first.
+
+Then, include [Portal](https://github.com/flowersinthesand/portal/ "Portal") to HTML and initialize it as follows.
+
+```html
+<script src="/portal.js"></script>
+<script>
+/*
+ * Following option is a hack to switch protocols automatically
+ * when the connection cannot be established.
+ */
+var options = {
+    transports:["ws","longpollajax"],
+    reconnect:function(lastDelay,attempts){
+      if(options.transports.length > 1)
+        options.transports.shift();
+      return 2 * (lastDelay || 100);},
+    prepare:function(connect,disconnect,opts){
+      opts.transports = options.transports;connect();}
+};
+
+//Add above options and drunkmonkey's path; default is "/drunkmonkey".
+var socket = portal.open("/drunkmonkey",options).on("open",function(){
+  //Add you event.
+  socket.send("Hello!");
+});
+</script>
+```
+
+Note: in current version, supported transports by Drunkmonkey are websocket and long-poll ajax only.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/drunkmonkey.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'drunkmonkey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "drunkmonkey"
+  spec.version       = DrunkMonkey::VERSION
+  spec.authors       = ["Minori Tokuda"]
+  spec.email         = ["minorityland@gmail.jp"]
+  spec.description   = <<-EOS
+    DrunkMonkey is a rack middleware providing realtime two-way http communication with API for Portal, a javascript messaging library.
+    It provides just two protocols currently; websocket and longpoll comet.
+    You can write code once for each protocols.
+  EOS
+  spec.summary       = %q{DrunkMonkey is a rack middleware providing realtime two-way http communication with API for Portal.}
+  spec.homepage      = "https://github.com/minoritea/drunkmonkey"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "celluloid", ">= 0.15"
+  spec.add_dependency "rack", ">= 1.5"
+  spec.add_dependency "websocket", ">= 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/drunkmonkey/transport.rb

@@ -0,0 +1,157 @@
+require "websocket"
+
+module DrunkMonkey
+  module Transport
+    # Taken from https://github.com/simulacre/sinatra-websocket/
+    # Originally taken from skinny https://github.com/sj26/skinny and updated to support Firefox
+    def self.websocket? env
+      env['HTTP_CONNECTION'] && env['HTTP_UPGRADE'] &&
+        env['HTTP_CONNECTION'].split(',').map(&:strip).map(&:downcase).include?('upgrade') &&
+        env['HTTP_UPGRADE'].downcase == 'websocket'
+    end
+    
+    def self.connection_from env, options
+      request = Rack::Request.new(env)
+      if websocket? env
+        WebSocket.resume request, **options
+        [500,{},[]]
+      else
+        body = Comet.resume request, **options
+        [200,{},[body]]
+      end
+    end
+    
+    class Base
+      class << self
+        def resume request, **options
+          @sessions ||= {}
+        
+          params = parse_params request
+          id = request.post? ? params["socket"] : params["id"]
+        
+          session = @sessions[id]
+        
+          return session if session
+          @sessions[id] = new **options
+        end
+      
+        def parse_params request
+          if request.post?
+            input = request.env["rack.input"]
+            input.rewind
+            parameters = input.read.sub(/\Adata=/,"")
+            input.rewind
+            params = JSON.parse(parameters)
+          else
+            params = request.params
+          end
+        end
+      end
+    
+      def initialize **options
+        @controller = Celluloid::Actor[options[:controller_name]]
+        @messages = []
+      end
+    
+      def portal message
+        @i ||= 0
+        {type:"message", data:message, id:(@i+=1),reply:false}.to_json
+      end
+    end
+  
+    class HijackAPINotFoundError < StandardError;end
+    
+    class WebSocket < Base
+      include Celluloid
+    
+      def self.resume request, **options
+        websocket = super
+        websocket.handle_connection request
+      end
+    
+      def handle_connection request
+        handshake request
+        @controller.async.fire :open, Actor.current
+        loop do
+          Celluloid.sleep 0.001
+          upstream
+          downstream
+          return if @socket.closed?
+        end
+      end
+    
+      def push message
+        @messages << message
+      end
+    
+      private
+      def handshake request
+        env = request.env
+        raise HijackAPINotFoundError unless hijack = env["rack.hijack"]
+        hijack.call
+        @socket = env["rack.hijack_io"]
+        @handshake = ::WebSocket::Handshake::Server.new
+        @handshake.from_rack env
+        @socket.write @handshake.to_s
+      end
+    
+      def upstream
+        buffer = ::WebSocket::Frame::Incoming::Server.new(version: @handshake.version)
+        buffer << @socket.read_nonblock(1024) rescue nil
+        while frame = buffer.next
+          case frame.type
+          when :text, :binary
+            data = JSON.parse(frame.data)
+            @controller.async.fire :message, Actor.current, data["data"]
+          end
+        end
+      end
+    
+      def downstream
+        if message = @messages.shift
+          @socket.write(
+            ::WebSocket::Frame::Outgoing::Server.new(
+              data: portal(message), type: :text, version: @handshake.version))
+        end
+      rescue Errno::EPIPE => e  
+      end
+    end
+    
+    class Comet < Base
+      include Celluloid
+
+      def self.resume request, **options
+        comet = super
+        comet.handle_connection(request)
+      end
+
+      def handle_connection request
+        params = self.class.parse_params(request)
+        request.post? ? upstream(params) : downstream(params)
+      end
+
+      def push message
+        @messages << message
+        signal :pushed
+      end
+
+      private
+      def upstream params
+        @controller.async.fire :message, Actor.current, params["data"]
+        ""
+      end
+
+      def downstream params
+        if params["when"] == "open"
+          @controller.async.fire :open, Actor.current
+          ""
+        else
+          wait :pushed if @messages.empty?
+          message = @messages.shift
+          message ? portal(message) : ""
+        end
+      end
+    end
+  
+  end
+end

data/lib/drunkmonkey/version.rb

@@ -0,0 +1,3 @@
+module DrunkMonkey
+  VERSION = "0.0.1"
+end

data/lib/drunkmonkey.rb

@@ -0,0 +1,86 @@
+require "drunkmonkey/version"
+require "celluloid"
+require "rack"
+require "celluloid/autostart"
+require "forwardable"
+require "json"
+require "drunkmonkey/transport"
+
+module DrunkMonkey  
+  class Controller
+    include Celluloid
+    def initialize name = :default_controller
+      @handlers = Hash.new
+      Actor[name] = Actor.current
+    end
+
+    def on event, &block
+      @handlers[event] ||= block
+    end
+    
+    execute_block_on_receiver :on
+
+    def fire event, transport, message = nil
+      handler = @handlers[event]
+      handler.call transport, message if handler
+    end
+  end
+  
+  class Builder < ::Rack::Builder
+    extend Forwardable
+    
+    DEFAULT_OPTIONS = {
+      path: "/drunkmonkey",
+      controller_name: :default_controller
+    }.freeze
+    
+    def_delegator :controller, :on
+    
+    def controller
+      self.class.controller
+    end
+    
+    def controller= instance
+      self.class.controller=instance
+    end
+    
+    class << self
+      attr_accessor :controller
+    end
+    
+    def initialize default_app = nil, **options , &block
+      options = DEFAULT_OPTIONS.merge(options)
+      self.controller ||= Controller.new(options[:controller_name])
+      
+      super(default_app, &block)
+      
+      map options[:path] do
+        run -> env do
+          Transport.connection_from env, options
+        end
+      end  
+    end
+  end
+  
+  def self.middleware
+    Class.new do
+      class << self
+        attr_accessor :builder
+      end
+
+      def initialize app, **options, &block
+        if self.class.builder
+          self.class.builder.run app
+        else
+          self.class.builder = Builder.new app, **options, &block
+        end
+      end
+      
+      def call env
+        self.class.builder.call env
+      end
+    end
+  end
+  
+  Middleware = self.middleware
+end

data/sample/app.rb

@@ -0,0 +1,26 @@
+require "puma"
+require "rack/handler/puma"
+require "drunkmonkey"
+
+sockets = {}
+Rack::Handler::Puma.run(Rack::Builder.new{
+  root = File.dirname(__FILE__)
+  use DrunkMonkey::Middleware do
+    on :open do |socket|
+      sockets[socket] = ""
+    end
+    
+    on :message do |socket,msg|
+      if sockets[socket].empty?
+        sockets[socket] = msg
+        socket.push "Welcome, #{msg}!"
+      else
+        name = sockets[socket]
+        sockets.each{|s,_|s.push "#{name}: #{msg}"}
+      end
+    end
+  end
+  
+  use Rack::Static, urls:[""], index:"index.html", root:"#{root}/public"
+  run -> env { [404, {'Content-Type' => 'text/html'}, ['Not Found']] }
+})

data/sample/public/index.html

@@ -0,0 +1,54 @@
+<html><head></head><body>
+  <div id="messages"></div>
+  <div>
+    <span id="on_login">My name is:</span>
+    <input id="message_box" type="text">
+    <button id="button">SEND</button>
+  </div>
+  <script src="/portal.js"></script>
+  <script>
+    window.onload = function(){
+      var options = {
+          transports:["ws","longpollajax"],
+          reconnect:function(lastDelay,attempts){
+            if(options.transports.length > 1)
+              options.transports.shift();
+            return 2 * (lastDelay || 100);},
+          prepare:function(connect,disconnect,opts){
+            opts.transports = options.transports;connect();}
+        };
+      
+      var socket;
+      function openPortal(){
+       var socket = portal.open("/drunkmonkey",options)
+        .on("message",function(msg){
+          document.getElementById("messages").innerHTML += "<p>" + msg + "</p>";
+        });
+        return socket;
+      };
+    
+      var socket;
+      
+      function _send_message(){
+        var message_box = document.getElementById("message_box");
+        var message = message_box.value;
+        if (message.length > 0) {
+          message_box.value = "";
+          socket.send("message",message);
+        }
+      }
+      
+      function send_message(){
+        if (socket == null) {
+          document.getElementById("on_login").innerHTML = "";
+          socket = openPortal();
+          _send_message();
+        } else {
+          _send_message();
+        }
+      };
+      
+      document.getElementById("button").onclick = send_message;
+    };
+  </script>
+</body><html>