dripdrop 0.6.0 → 0.7.1

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.1

data/dripdrop.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dripdrop}
-  s.version = "0.6.0"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Cholakian"]
-  s.date = %q{2010-12-17}
+  s.date = %q{2011-01-30}
   s.description = %q{Evented framework for ZeroMQ and EventMachine Apps. }
   s.email = %q{andrew@andrewvc.com}
   s.extra_rdoc_files = [
@@ -27,21 +27,14 @@ Gem::Specification.new do |s|
      "dripdrop.gemspec",
      "example/agent_test.rb",
      "example/combined.rb",
+     "example/complex/README",
+     "example/complex/client.rb",
+     "example/complex/server.rb",
+     "example/complex/service.rb",
+     "example/complex/websocket.rb",
      "example/http.rb",
      "example/pubsub.rb",
      "example/pushpull.rb",
-     "example/stats_app/core.rb",
-     "example/stats_app/public/.sass-cache/b48b4299d80c05f528daf63fe51d85e5e3c10d98/stats.scssc",
-     "example/stats_app/public/backbone.js",
-     "example/stats_app/public/build_templates.rb",
-     "example/stats_app/public/json2.js",
-     "example/stats_app/public/protovis-r3.2.js",
-     "example/stats_app/public/stats.css",
-     "example/stats_app/public/stats.haml",
-     "example/stats_app/public/stats.html",
-     "example/stats_app/public/stats.js",
-     "example/stats_app/public/stats.scss",
-     "example/stats_app/public/underscore.js",
      "example/subclass.rb",
      "example/xreq_xrep.rb",
      "js/dripdrop.html",
@@ -74,16 +67,16 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Evented framework for ZeroMQ and EventMachine Apps.}
   s.test_files = [
-    "spec/gimite-websocket.rb",
-     "spec/message_spec.rb",
-     "spec/node_spec.rb",
+    "spec/node_spec.rb",
      "spec/spec_helper.rb",
-     "spec/node/http_spec.rb",
+     "spec/gimite-websocket.rb",
+     "spec/message_spec.rb",
      "spec/node/nodelet_spec.rb",
+     "spec/node/zmq_pushpull_spec.rb",
+     "spec/node/zmq_xrepxreq_spec.rb",
      "spec/node/routing_spec.rb",
      "spec/node/websocket_spec.rb",
-     "spec/node/zmq_pushpull_spec.rb",
-     "spec/node/zmq_xrepxreq_spec.rb"
+     "spec/node/http_spec.rb"
   ]
 
   if s.respond_to? :specification_version then

data/example/complex/README

@@ -0,0 +1,22 @@
+This example creates an async, evented app that can do the following.
+
+* Broadcast messages to all connected websockets originating from a
+master control server.
+* Proxy requests sent via websocket to HTTP through a master
+control server
+
+It's broken into three parts
+* service.rb: The async core, written in dripdrop/eventmachine/zeromq
+* client.rb:  A Test websocket client
+* service.rb: A test HTTP web-service that could beb used to control messages
+
+To run.
+
+In one terminal (in dripdrop root)
+ruby -I lib/ example/complex/server.rb
+
+In another terminal (Websocket client)
+cd example/complex && ruby client.rb
+
+In a third terminal (Minimal webapp in sinatra)
+cd example/complex && ruby service.rb

data/example/complex/client.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'websocket'
+require 'dripdrop/message'
+
+Thread.abort_on_exception = true
+
+client = WebSocket.new('ws://127.0.0.1:8080')
+
+Thread.new do
+  while data = client.receive
+    puts data
+  end
+end
+
+i = 0
+while sleep 1
+  i += 1
+  puts '.'
+  client.send(DripDrop::Message.new('Client Broadcast', :body => i).json_encoded)
+end

data/example/complex/server.rb

@@ -0,0 +1,115 @@
+require 'dripdrop'
+Thread.abort_on_exception = true
+
+class ComplexExample < DripDrop::Node
+  def initialize(mode=:all)
+    super()
+    @mode = mode
+  end
+  
+  def action
+    if [:all, :websockets].include?(@mode)
+      route :ws_listener,  :websocket, 'ws://127.0.0.1:8080'
+      route :broadcast_in, :zmq_subscribe, 'tcp://127.0.0.1:2200', :connect
+      route :reqs_out,     :zmq_xreq,      'tcp://127.0.0.1:2201', :connect
+      
+      WSListener.new(:ws => ws_listener, :broadcast_in => broadcast_in, :reqs_out => reqs_out).run
+    end
+    
+    if [:all, :coordinator].include?(@mode)
+      route :broadcast_out, :zmq_publish, 'tcp://127.0.0.1:2200', :bind
+      route :reqs_in,       :zmq_xrep,    'tcp://127.0.0.1:2201', :bind
+      route :reqs_htout,    :http_client, 'tcp://127.0.0.1:3000/endpoint'
+      
+      Coordinator.new(:broadcast_out => broadcast_out, :reqs_in => reqs_in, :reqs_htout => reqs_htout).run
+    end
+  end
+end
+
+class Coordinator
+  def initialize(opts={})
+    @bc_out  = opts[:broadcast_out]
+    @reqs_in = opts[:reqs_in]
+    @reqs_htout = opts[:reqs_htout]
+  end
+  
+  def run
+    proxy_reqs
+    heartbeat
+  end
+
+  def proxy_reqs
+    @reqs_in.on_recv do |message, response|
+      puts "Proxying #{message.inspect} to htout"
+      @reqs_htout.send_message(message) do |http_response|
+        puts "Received http response #{http_response.inspect} sending back"
+        response.send_message(http_response)
+      end
+    end
+  end
+  
+  def heartbeat
+    EM::PeriodicTimer.new(1) do
+      @bc_out.send_message :name => 'tick', :body => Time.now.to_s
+    end
+  end
+end
+
+class WSListener
+  def initialize(opts={})
+    @ws       = opts[:ws]
+    @bc_in    = opts[:broadcast_in]
+    @reqs_out = opts[:reqs_out]
+    @client_channel = EM::Channel.new
+  end
+  def run
+    proxy_websockets
+    broadcast_to_websockets
+  end
+
+  def broadcast_to_websockets
+    # Receives messages from Broadcast Out
+    @bc_in.on_recv do |message|
+      puts "Broadcast In recv: #{message.inspect}"
+      @client_channel.push(message)
+    end
+  end
+
+  def proxy_websockets
+    ws = @ws
+    
+    sigs_sids = {} #Map connection signatures to subscriber IDs
+     
+    ws.on_open do |conn|
+      puts "WS Connected"
+      conn.send_message(DripDrop::Message.new('test'))
+      
+      sid = @client_channel.subscribe do |message|
+        puts message.inspect
+        conn.send_message(message)
+      end
+       
+      sigs_sids[conn.signature] = sid
+    end
+    ws.on_close do |conn|
+      puts "Closed #{conn.signature}"
+      @client_channel.unsubscribe sigs_sids[conn.signature]
+    end
+    ws.on_error do |reason,conn|
+      puts "Errored #{reason.inspect}, #{conn.signature}"
+      @client_channel.unsubscribe sigs_sids[conn.signature]
+    end
+
+    ws.on_recv do |message,conn|
+      puts "WS Recv #{message.name}"
+      @reqs_out.send_message(message) do |resp_message|
+        puts "Recvd resp_message #{resp_message.inspect}, sending back to client"
+        conn.send_message(resp_message)
+      end
+    end
+  end
+end   
+    
+
+puts "Starting..."
+ComplexExample.new.start!

data/example/complex/service.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'sinatra'
+require 'dripdrop/message'
+
+post '/endpoint' do
+  puts DripDrop::Message.decode_json(request.body.read).inspect
+  DripDrop::Message.new('ack').json_encoded
+end

data/example/complex/websocket.rb

@@ -0,0 +1,442 @@
+# Copyright: Hiroshi Ichikawa <http://gimite.net/en/>
+# Lincense: New BSD Lincense
+# Reference: http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol
+
+require "socket"
+require "uri"
+require "digest/md5"
+require "openssl"
+
+
+class WebSocket
+
+    class << self
+
+        attr_accessor(:debug)
+
+    end
+
+    class Error < RuntimeError
+
+    end
+
+    def initialize(arg, params = {})
+      if params[:server] # server
+
+        @server = params[:server]
+        @socket = arg
+        line = gets().chomp()
+        if !(line =~ /\AGET (\S+) HTTP\/1.1\z/n)
+          raise(WebSocket::Error, "invalid request: #{line}")
+        end
+        @path = $1
+        read_header()
+        if @header["sec-websocket-key1"] && @header["sec-websocket-key2"]
+          @key3 = read(8)
+        else
+          # Old Draft 75 protocol
+          @key3 = nil
+        end
+        if !@server.accepted_origin?(self.origin)
+          raise(WebSocket::Error,
+            ("Unaccepted origin: %s (server.accepted_domains = %p)\n\n" +
+              "To accept this origin, write e.g. \n" +
+              "  WebSocketServer.new(..., :accepted_domains => [%p]), or\n" +
+              "  WebSocketServer.new(..., :accepted_domains => [\"*\"])\n") %
+            [self.origin, @server.accepted_domains, @server.origin_to_domain(self.origin)])
+        end
+        @handshaked = false
+
+      else # client
+
+        uri = arg.is_a?(String) ? URI.parse(arg) : arg
+
+        if uri.scheme == "ws"
+          default_port = 80
+        elsif uri.scheme = "wss"
+          default_port = 443
+        else
+          raise(WebSocket::Error, "unsupported scheme: #{uri.scheme}")
+        end
+
+        @path = (uri.path.empty? ? "/" : uri.path) + (uri.query ? "?" + uri.query : "")
+        host = uri.host + (uri.port == default_port ? "" : ":#{uri.port}")
+        origin = params[:origin] || "http://#{uri.host}"
+        key1 = generate_key()
+        key2 = generate_key()
+        key3 = generate_key3()
+
+        socket = TCPSocket.new(uri.host, uri.port || default_port)
+
+        if uri.scheme == "ws"
+          @socket = socket
+        else
+          @socket = ssl_handshake(socket)
+        end
+
+        write(
+          "GET #{@path} HTTP/1.1\r\n" +
+          "Upgrade: WebSocket\r\n" +
+          "Connection: Upgrade\r\n" +
+          "Host: #{host}\r\n" +
+          "Origin: #{origin}\r\n" +
+          "Sec-WebSocket-Key1: #{key1}\r\n" +
+          "Sec-WebSocket-Key2: #{key2}\r\n" +
+          "\r\n" +
+          "#{key3}")
+        flush()
+
+        line = gets().chomp()
+        raise(WebSocket::Error, "bad response: #{line}") if !(line =~ /\AHTTP\/1.1 101 /n)
+        read_header()
+        if (@header["sec-websocket-origin"] || "").downcase() != origin.downcase()
+          raise(WebSocket::Error,
+            "origin doesn't match: '#{@header["sec-websocket-origin"]}' != '#{origin}'")
+        end
+        reply_digest = read(16)
+        expected_digest = security_digest(key1, key2, key3)
+        if reply_digest != expected_digest
+          raise(WebSocket::Error,
+            "security digest doesn't match: %p != %p" % [reply_digest, expected_digest])
+        end
+        @handshaked = true
+
+      end
+      @received = []
+      @buffer = ""
+      @closing_started = false
+    end
+
+    attr_reader(:server, :header, :path)
+
+    def handshake(status = nil, header = {})
+      if @handshaked
+        raise(WebSocket::Error, "handshake has already been done")
+      end
+      status ||= "101 Web Socket Protocol Handshake"
+      sec_prefix = @key3 ? "Sec-" : ""
+      def_header = {
+        "#{sec_prefix}WebSocket-Origin" => self.origin,
+        "#{sec_prefix}WebSocket-Location" => self.location,
+      }
+      header = def_header.merge(header)
+      header_str = header.map(){ |k, v| "#{k}: #{v}\r\n" }.join("")
+      if @key3
+        digest = security_digest(
+          @header["Sec-WebSocket-Key1"], @header["Sec-WebSocket-Key2"], @key3)
+      else
+        digest = ""
+      end
+      # Note that Upgrade and Connection must appear in this order.
+      write(
+        "HTTP/1.1 #{status}\r\n" +
+        "Upgrade: WebSocket\r\n" +
+        "Connection: Upgrade\r\n" +
+        "#{header_str}\r\n#{digest}")
+      flush()
+      @handshaked = true
+    end
+
+    def send(data)
+      if !@handshaked
+        raise(WebSocket::Error, "call WebSocket\#handshake first")
+      end
+      data = force_encoding(data.dup(), "ASCII-8BIT")
+      write("\x00#{data}\xff")
+      flush()
+    end
+
+    def receive()
+      if !@handshaked
+        raise(WebSocket::Error, "call WebSocket\#handshake first")
+      end
+      packet = gets("\xff")
+      return nil if !packet
+      if packet =~ /\A\x00(.*)\xff\z/nm
+        return force_encoding($1, "UTF-8")
+      elsif packet == "\xff" && read(1) == "\x00" # closing
+        if @server
+          @socket.close()
+        else
+          close()
+        end
+        return nil
+      else
+        raise(WebSocket::Error, "input must be either '\\x00...\\xff' or '\\xff\\x00'")
+      end
+    end
+
+    def tcp_socket
+      return @socket
+    end
+
+    def host
+      return @header["host"]
+    end
+
+    def origin
+      return @header["origin"]
+    end
+
+    def location
+      return "ws://#{self.host}#{@path}"
+    end
+    
+    # Does closing handshake.
+    def close()
+      return if @closing_started
+      write("\xff\x00")
+      @socket.close() if !@server
+      @closing_started = true
+    end
+    
+    def close_socket()
+      @socket.close()
+    end
+
+  private
+
+    NOISE_CHARS = ("\x21".."\x2f").to_a() + ("\x3a".."\x7e").to_a()
+
+    def read_header()
+      @header = {}
+      while line = gets()
+        line = line.chomp()
+        break if line.empty?
+        if !(line =~ /\A(\S+): (.*)\z/n)
+          raise(WebSocket::Error, "invalid request: #{line}")
+        end
+        @header[$1] = $2
+        @header[$1.downcase()] = $2
+      end
+      if !(@header["upgrade"] =~ /\AWebSocket\z/i)
+        raise(WebSocket::Error, "invalid Upgrade: " + @header["upgrade"])
+      end
+      if !(@header["connection"] =~ /\AUpgrade\z/i)
+        raise(WebSocket::Error, "invalid Connection: " + @header["connection"])
+      end
+    end
+
+    def gets(rs = $/)
+      line = @socket.gets(rs)
+      $stderr.printf("recv> %p\n", line) if WebSocket.debug
+      return line
+    end
+
+    def read(num_bytes)
+      str = @socket.read(num_bytes)
+      $stderr.printf("recv> %p\n", str) if WebSocket.debug
+      return str
+    end
+
+    def write(data)
+      if WebSocket.debug
+        data.scan(/\G(.*?(\n|\z))/n) do
+          $stderr.printf("send> %p\n", $&) if !$&.empty?
+        end
+      end
+      @socket.write(data)
+    end
+
+    def flush()
+      @socket.flush()
+    end
+
+    def security_digest(key1, key2, key3)
+      bytes1 = websocket_key_to_bytes(key1)
+      bytes2 = websocket_key_to_bytes(key2)
+      return Digest::MD5.digest(bytes1 + bytes2 + key3)
+    end
+
+    def generate_key()
+      spaces = 1 + rand(12)
+      max = 0xffffffff / spaces
+      number = rand(max + 1)
+      key = (number * spaces).to_s()
+      (1 + rand(12)).times() do
+        char = NOISE_CHARS[rand(NOISE_CHARS.size)]
+        pos = rand(key.size + 1)
+        key[pos...pos] = char
+      end
+      spaces.times() do
+        pos = 1 + rand(key.size - 1)
+        key[pos...pos] = " "
+      end
+      return key
+    end
+
+    def generate_key3()
+      return [rand(0x100000000)].pack("N") + [rand(0x100000000)].pack("N")
+    end
+
+    def websocket_key_to_bytes(key)
+      num = key.gsub(/[^\d]/n, "").to_i() / key.scan(/ /).size
+      return [num].pack("N")
+    end
+
+    def force_encoding(str, encoding)
+      if str.respond_to?(:force_encoding)
+        return str.force_encoding(encoding)
+      else
+        return str
+      end
+    end
+
+    def ssl_handshake(socket)
+      ssl_context = OpenSSL::SSL::SSLContext.new()
+      ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
+      ssl_socket.sync_close = true
+      ssl_socket.connect()
+      return ssl_socket
+    end
+
+end
+
+
+class WebSocketServer
+
+    def initialize(params_or_uri, params = nil)
+      if params
+        uri = params_or_uri.is_a?(String) ? URI.parse(params_or_uri) : params_or_uri
+        params[:port] ||= uri.port
+        params[:accepted_domains] ||= [uri.host]
+      else
+        params = params_or_uri
+      end
+      @port = params[:port] || 80
+      @accepted_domains = params[:accepted_domains]
+      if !@accepted_domains
+        raise(ArgumentError, "params[:accepted_domains] is required")
+      end
+      if params[:host]
+        @tcp_server = TCPServer.open(params[:host], @port)
+      else
+        @tcp_server = TCPServer.open(@port)
+      end
+    end
+
+    attr_reader(:tcp_server, :port, :accepted_domains)
+
+    def run(&block)
+      while true
+        Thread.start(accept()) do |s|
+          begin
+            ws = create_web_socket(s)
+            yield(ws) if ws
+          rescue => ex
+            print_backtrace(ex)
+          ensure
+            begin
+              ws.close_socket() if ws
+            rescue
+            end
+          end
+        end
+      end
+    end
+
+    def accept()
+      return @tcp_server.accept()
+    end
+
+    def accepted_origin?(origin)
+      domain = origin_to_domain(origin)
+      return @accepted_domains.any?(){ |d| File.fnmatch(d, domain) }
+    end
+
+    def origin_to_domain(origin)
+      if origin == "null" || origin == "file://"  # local file
+        return "null"
+      else
+        return URI.parse(origin).host
+      end
+    end
+
+    def create_web_socket(socket)
+      ch = socket.getc()
+      if ch == ?<
+        # This is Flash socket policy file request, not an actual Web Socket connection.
+        send_flash_socket_policy_file(socket)
+        return nil
+      else
+        socket.ungetc(ch)
+        return WebSocket.new(socket, :server => self)
+      end
+    end
+
+  private
+
+    def print_backtrace(ex)
+      $stderr.printf("%s: %s (%p)\n", ex.backtrace[0], ex.message, ex.class)
+      for s in ex.backtrace[1..-1]
+        $stderr.printf("        %s\n", s)
+      end
+    end
+
+    # Handles Flash socket policy file request sent when web-socket-js is used:
+    # http://github.com/gimite/web-socket-js/tree/master
+    def send_flash_socket_policy_file(socket)
+      socket.puts('<?xml version="1.0"?>')
+      socket.puts('<!DOCTYPE cross-domain-policy SYSTEM ' +
+        '"http://www.macromedia.com/xml/dtds/cross-domain-policy.dtd">')
+      socket.puts('<cross-domain-policy>')
+      for domain in @accepted_domains
+        next if domain == "file://"
+        socket.puts("<allow-access-from domain=\"#{domain}\" to-ports=\"#{@port}\"/>")
+      end
+      socket.puts('</cross-domain-policy>')
+      socket.close()
+    end
+
+end
+
+
+if __FILE__ == $0
+  Thread.abort_on_exception = true
+
+  if ARGV[0] == "server" && ARGV.size == 3
+
+    server = WebSocketServer.new(
+      :accepted_domains => [ARGV[1]],
+      :port => ARGV[2].to_i())
+    puts("Server is running at port %d" % server.port)
+    server.run() do |ws|
+      puts("Connection accepted")
+      puts("Path: #{ws.path}, Origin: #{ws.origin}")
+      if ws.path == "/"
+        ws.handshake()
+        while data = ws.receive()
+          printf("Received: %p\n", data)
+          ws.send(data)
+          printf("Sent: %p\n", data)
+        end
+      else
+        ws.handshake("404 Not Found")
+      end
+      puts("Connection closed")
+    end
+
+  elsif ARGV[0] == "client" && ARGV.size == 2
+
+    client = WebSocket.new(ARGV[1])
+    puts("Connected")
+    Thread.new() do
+      while data = client.receive()
+        printf("Received: %p\n", data)
+      end
+    end
+    $stdin.each_line() do |line|
+      data = line.chomp()
+      client.send(data)
+      printf("Sent: %p\n", data)
+    end
+
+  else
+
+    $stderr.puts("Usage:")
+    $stderr.puts("  ruby web_socket.rb server ACCEPTED_DOMAIN PORT")
+    $stderr.puts("  ruby web_socket.rb client ws://HOST:PORT/")
+    exit(1)
+
+  end
+end