cramp 0.14.1 → 0.15

data/lib/cramp.rb

@@ -10,6 +10,7 @@ require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/kernel/reporting'
 require 'active_support/concern'
 require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/except'
 require 'active_support/buffered_logger'
 
 require 'rack'
@@ -19,13 +20,14 @@ if RUBY_VERSION >= '1.9.1'
 end
   
 module Cramp
-  VERSION = '0.14.1'
+  VERSION = '0.15'
 
   mattr_accessor :logger
 
   autoload :Action, "cramp/action"
   autoload :Websocket, "cramp/websocket"
   autoload :WebsocketExtension, "cramp/websocket/extension"
+  autoload :Protocol10FrameParser, "cramp/websocket/protocol10_frame_parser"
   autoload :SSE, "cramp/sse"
   autoload :LongPolling, "cramp/long_polling"
   autoload :Body, "cramp/body"
@@ -34,5 +36,6 @@ module Cramp
   autoload :Abstract, "cramp/abstract"
   autoload :Callbacks, "cramp/callbacks"
   autoload :FiberPool, "cramp/fiber_pool"
+  autoload :ExceptionHandler, "cramp/exception_handler"
   autoload :TestCase, "cramp/test_case"
 end

data/lib/cramp/abstract.rb

@@ -16,9 +16,9 @@ module Cramp
 
     def initialize(env)
       @env = env
-      @env['websocket.receive_callback'] = method(:_on_data_receive)
-
       @finished = false
+
+      @_state = :init
     end
 
     def process
@@ -30,15 +30,21 @@ module Cramp
 
     def continue
       init_async_body
+      send_headers
 
-      status, headers = respond_with
-      send_initial_response(status, headers, @body)
-
+      @_state = :started
       EM.next_tick { on_start }
     end
 
-    def respond_with
-      [200, {'Content-Type' => 'text/html'}]
+    def send_headers
+      status, headers = build_headers
+      send_initial_response(status, headers, @body)
+    rescue StandardError, LoadError, SyntaxError => exception
+      handle_exception(exception)
+    end
+
+    def build_headers
+      respond_to?(:respond_with, true) ? respond_with : [200, {'Content-Type' => 'text/html'}]
     end
 
     def init_async_body
@@ -55,8 +61,10 @@ module Cramp
     end
 
     def finish
+      @body.succeed if is_finishable?
+    ensure
+      @_state = :finished
       @finished = true
-      @body.succeed
     end
 
     def send_initial_response(response_status, response_headers, response_body)
@@ -82,5 +90,12 @@ module Cramp
     def route_params
       @env['router.params'] || @env['usher.params']
     end
+
+    private
+
+    def is_finishable?
+      !finished? && @body && !@body.closed?
+    end
+
   end
 end

data/lib/cramp/action.rb

@@ -3,25 +3,44 @@ module Cramp
     include PeriodicTimer
     include KeepConnectionAlive
 
+    def initialize(env)
+      super
+      @env['websocket.receive_callback'] = method(:_on_data_receive)
+    end
+
     protected
 
     def render(body, *args)
       send(:"render_#{transport}", body, *args)
     end
 
-    def send_initial_response(*)
+    def send_initial_response(status, headers, body)
       case transport
       when :long_polling
-        # Dont send no initial response
+        # Dont send no initial response. Just cache it for later.
+        @_lp_status = status
+        @_lp_headers = headers
       else
         super
       end
     end
 
-    def respond_with
+    class_attribute :default_sse_headers
+    self.default_sse_headers = {'Content-Type' => 'text/event-stream', 'Cache-Control' => 'no-cache', 'Connection' => 'keep-alive'}
+
+    class_attribute :default_chunked_headers
+    self.default_chunked_headers = {'Transfer-Encoding' => 'chunked', 'Connection' => 'keep-alive'}
+
+    def build_headers
       case transport
       when :sse
-        [200, {'Content-Type' => 'text/event-stream', 'Cache-Control' => 'no-cache', 'Connection' => 'keep-alive'}]
+        status, headers = respond_to?(:respond_with, true) ? respond_with : [200, {'Content-Type' => 'text/html'}]
+        [status, headers.merge(self.default_sse_headers)]
+      when :chunked
+        status, headers = respond_to?(:respond_with, true) ? respond_with : [200, {}]
+        headers['Content-Type'] ||= 'text/html'
+
+        [status, headers.merge(self.default_chunked_headers)]
       else
         super
       end
@@ -32,10 +51,9 @@ module Cramp
     end
 
     def render_long_polling(data, *)
-      status, headers = respond_with
-      headers['Content-Length'] = data.size.to_s
+      @_lp_headers['Content-Length'] = data.size.to_s
 
-      send_response(status, headers, @body)
+      send_response(@_lp_status, @_lp_headers, @body)
       @body.call(data)
 
       finish
@@ -52,7 +70,21 @@ module Cramp
     end
 
     def render_websocket(body, *)
-      data = ["\x00", body, "\xFF"].map(&method(:encode)) * ''
+      if websockets_protocol_10?
+        data = encode(protocol10_parser.send_text_frame(body), 'BINARY')
+      else
+        data = ["\x00", body, "\xFF"].map(&method(:encode)) * ''
+      end
+
+      @body.call(data)
+    end
+
+    CHUNKED_TERM = "\r\n"
+    CHUNKED_TAIL = "0#{CHUNKED_TERM}#{CHUNKED_TERM}"
+
+    def render_chunked(body, *)
+      data = [Rack::Utils.bytesize(body).to_s(16), CHUNKED_TERM, body, CHUNKED_TERM].join
+
       @body.call(data)
     end
 
@@ -65,5 +97,24 @@ module Cramp
       string.respond_to?(:force_encoding) ? string.force_encoding(encoding) : string
     end
 
+    protected
+
+    def finish
+      case transport
+      when :chunked
+        @body.call(CHUNKED_TAIL) if is_finishable?
+      end
+
+      super
+    end
+
+    def websockets_protocol_10?
+      [8, 9, 10].include?(@env['HTTP_SEC_WEBSOCKET_VERSION'].to_i)
+    end
+
+    def protocol10_parser
+      @protocol10_parser ||= Protocol10FrameParser.new
+    end
+
   end
 end

data/lib/cramp/callbacks.rb

@@ -53,15 +53,55 @@ module Cramp
     end
 
     def callback_wrapper
-      EM.next_tick { yield }
+      EM.next_tick do
+        begin
+          yield
+        rescue StandardError, LoadError, SyntaxError => exception
+          handle_exception(exception)
+        end
+      end
     end
 
     def _on_data_receive(data)
+      websockets_protocol_10? ? _receive_protocol10_data(data) : _receive_protocol76_data(data)
+    end
+
+    protected
+
+    def _receive_protocol10_data(data)
+      protocol10_parser.data << data
+
+      messages = @protocol10_parser.process_data
+      messages.each do |type, content|
+        _invoke_data_callbacks(content) if type == :text
+      end
+    end
+
+    def _receive_protocol76_data(data)
       data = data.split(/\000([^\377]*)\377/).select{|d| !d.empty? }.collect{|d| d.gsub(/^\x00|\xff$/, '') }
+      data.each {|message| _invoke_data_callbacks(message) }
+    end
+
+    def _invoke_data_callbacks(message)
       self.class.on_data_callbacks.each do |callback|
-        data.each do |message|
-          callback_wrapper { send(callback, message) }
-        end
+        callback_wrapper { send(callback, message) }
+      end
+    end
+
+    def handle_exception(exception)
+      handler = ExceptionHandler.new(@env, exception)
+
+      # Log the exception
+      unless ENV['RACK_ENV'] == 'test'
+        exception_body = handler.dump_exception
+        Cramp.logger ? Cramp.logger.error(exception_body) : $stderr.puts(exception_body)
+      end
+
+      case @_state
+      when :init
+        halt 500, {"Content-Type" => 'text/html'}, ENV['RACK_ENV'] == 'development' ? handler.pretty : 'Something went wrong'
+      else
+        finish
       end
     end
 

data/lib/cramp/exception_handler.rb

@@ -0,0 +1,357 @@
+# Based on Rack::ShowExceptions
+#
+# Copyright (c) 2007, 2008, 2009, 2010 Christian Neukirchen <purl.org/net/chneukirchen>
+# 
+# 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 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.
+
+require 'erb'
+require 'ostruct'
+
+module Cramp
+  class ExceptionHandler
+
+    attr_reader :env, :exception
+
+    def initialize(env, exception)
+      @env = env
+      @exception = exception
+      @template = ERB.new(TEMPLATE)
+    end
+
+    def dump_exception
+      string = "#{exception.class}: #{exception.message}\n"
+      string << exception.backtrace.map { |l| "\t#{l}" }.join("\n")
+      string
+    end
+
+    def pretty
+      req = Rack::Request.new(env)
+
+      # This double assignment is to prevent an "unused variable" warning on
+      # Ruby 1.9.3.  Yes, it is dumb, but I don't like Ruby yelling at me.
+      path = path = (req.script_name + req.path_info).squeeze("/")
+
+      # This double assignment is to prevent an "unused variable" warning on
+      # Ruby 1.9.3.  Yes, it is dumb, but I don't like Ruby yelling at me.
+      frames = frames = exception.backtrace.map { |line|
+        frame = OpenStruct.new
+        if line =~ /(.*?):(\d+)(:in `(.*)')?/
+          frame.filename = $1
+          frame.lineno = $2.to_i
+          frame.function = $4
+
+          begin
+            lineno = frame.lineno-1
+            lines = ::File.readlines(frame.filename)
+            frame.pre_context_lineno = [lineno-CONTEXT, 0].max
+            frame.pre_context = lines[frame.pre_context_lineno...lineno]
+            frame.context_line = lines[lineno].chomp
+            frame.post_context_lineno = [lineno+CONTEXT, lines.size].min
+            frame.post_context = lines[lineno+1..frame.post_context_lineno]
+          rescue
+          end
+
+          frame
+        else
+          nil
+        end
+      }.compact
+
+      [@template.result(binding)]
+    end
+
+    def h(obj)                  # :nodoc:
+      case obj
+      when String
+        Rack::Utils.escape_html(obj)
+      else
+        Rack::Utils.escape_html(obj.inspect)
+      end
+    end
+
+# adapted from Django <djangoproject.com>
+# Copyright (c) 2005, the Lawrence Journal-World
+# Used under the modified BSD license:
+# http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5
+TEMPLATE = <<'HTML'
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <meta name="robots" content="NONE,NOARCHIVE" />
+  <title><%=h exception.class %> at <%=h path %></title>
+  <style type="text/css">
+    html * { padding:0; margin:0; }
+    body * { padding:10px 20px; }
+    body * * { padding:0; }
+    body { font:small sans-serif; }
+    body>div { border-bottom:1px solid #ddd; }
+    h1 { font-weight:normal; }
+    h2 { margin-bottom:.8em; }
+    h2 span { font-size:80%; color:#666; font-weight:normal; }
+    h3 { margin:1em 0 .5em 0; }
+    h4 { margin:0 0 .5em 0; font-weight: normal; }
+    table {
+        border:1px solid #ccc; border-collapse: collapse; background:white; }
+    tbody td, tbody th { vertical-align:top; padding:2px 3px; }
+    thead th {
+        padding:1px 6px 1px 3px; background:#fefefe; text-align:left;
+        font-weight:normal; font-size:11px; border:1px solid #ddd; }
+    tbody th { text-align:right; color:#666; padding-right:.5em; }
+    table.vars { margin:5px 0 2px 40px; }
+    table.vars td, table.req td { font-family:monospace; }
+    table td.code { width:100%;}
+    table td.code div { overflow:hidden; }
+    table.source th { color:#666; }
+    table.source td {
+        font-family:monospace; white-space:pre; border-bottom:1px solid #eee; }
+    ul.traceback { list-style-type:none; }
+    ul.traceback li.frame { margin-bottom:1em; }
+    div.context { margin: 10px 0; }
+    div.context ol {
+        padding-left:30px; margin:0 10px; list-style-position: inside; }
+    div.context ol li {
+        font-family:monospace; white-space:pre; color:#666; cursor:pointer; }
+    div.context ol.context-line li { color:black; background-color:#ccc; }
+    div.context ol.context-line li span { float: right; }
+    div.commands { margin-left: 40px; }
+    div.commands a { color:black; text-decoration:none; }
+    #summary { background: #ffc; }
+    #summary h2 { font-weight: normal; color: #666; }
+    #summary ul#quicklinks { list-style-type: none; margin-bottom: 2em; }
+    #summary ul#quicklinks li { float: left; padding: 0 1em; }
+    #summary ul#quicklinks>li+li { border-left: 1px #666 solid; }
+    #explanation { background:#eee; }
+    #template, #template-not-exist { background:#f6f6f6; }
+    #template-not-exist ul { margin: 0 0 0 20px; }
+    #traceback { background:#eee; }
+    #requestinfo { background:#f6f6f6; padding-left:120px; }
+    #summary table { border:none; background:transparent; }
+    #requestinfo h2, #requestinfo h3 { position:relative; margin-left:-100px; }
+    #requestinfo h3 { margin-bottom:-1em; }
+    .error { background: #ffc; }
+    .specific { color:#cc3300; font-weight:bold; }
+  </style>
+  <script type="text/javascript">
+  //<!--
+    function getElementsByClassName(oElm, strTagName, strClassName){
+        // Written by Jonathan Snook, http://www.snook.ca/jon;
+        // Add-ons by Robert Nyman, http://www.robertnyman.com
+        var arrElements = (strTagName == "*" && document.all)? document.all :
+        oElm.getElementsByTagName(strTagName);
+        var arrReturnElements = new Array();
+        strClassName = strClassName.replace(/\-/g, "\\-");
+        var oRegExp = new RegExp("(^|\\s)" + strClassName + "(\\s|$$)");
+        var oElement;
+        for(var i=0; i<arrElements.length; i++){
+            oElement = arrElements[i];
+            if(oRegExp.test(oElement.className)){
+                arrReturnElements.push(oElement);
+            }
+        }
+        return (arrReturnElements)
+    }
+    function hideAll(elems) {
+      for (var e = 0; e < elems.length; e++) {
+        elems[e].style.display = 'none';
+      }
+    }
+    window.onload = function() {
+      hideAll(getElementsByClassName(document, 'table', 'vars'));
+      hideAll(getElementsByClassName(document, 'ol', 'pre-context'));
+      hideAll(getElementsByClassName(document, 'ol', 'post-context'));
+    }
+    function toggle() {
+      for (var i = 0; i < arguments.length; i++) {
+        var e = document.getElementById(arguments[i]);
+        if (e) {
+          e.style.display = e.style.display == 'none' ? 'block' : 'none';
+        }
+      }
+      return false;
+    }
+    function varToggle(link, id) {
+      toggle('v' + id);
+      var s = link.getElementsByTagName('span')[0];
+      var uarr = String.fromCharCode(0x25b6);
+      var darr = String.fromCharCode(0x25bc);
+      s.innerHTML = s.innerHTML == uarr ? darr : uarr;
+      return false;
+    }
+    //-->
+  </script>
+</head>
+<body>
+
+<div id="summary">
+  <h1><%=h exception.class %> at <%=h path %></h1>
+  <h2><%=h exception.message %></h2>
+  <table><tr>
+    <th>Ruby</th>
+    <td>
+<% if first = frames.first %>
+      <code><%=h first.filename %></code>: in <code><%=h first.function %></code>, line <%=h frames.first.lineno %>
+<% else %>
+      unknown location
+<% end %>
+    </td>
+  </tr><tr>
+    <th>Web</th>
+    <td><code><%=h req.request_method %> <%=h(req.host + path)%></code></td>
+  </tr></table>
+
+  <h3>Jump to:</h3>
+  <ul id="quicklinks">
+    <li><a href="#get-info">GET</a></li>
+    <li><a href="#post-info">POST</a></li>
+    <li><a href="#cookie-info">Cookies</a></li>
+    <li><a href="#env-info">ENV</a></li>
+  </ul>
+</div>
+
+<div id="traceback">
+  <h2>Traceback <span>(innermost first)</span></h2>
+  <ul class="traceback">
+<% frames.each { |frame| %>
+      <li class="frame">
+        <code><%=h frame.filename %></code>: in <code><%=h frame.function %></code>
+
+          <% if frame.context_line %>
+          <div class="context" id="c<%=h frame.object_id %>">
+              <% if frame.pre_context %>
+              <ol start="<%=h frame.pre_context_lineno+1 %>" class="pre-context" id="pre<%=h frame.object_id %>">
+                <% frame.pre_context.each { |line| %>
+                <li onclick="toggle('pre<%=h frame.object_id %>', 'post<%=h frame.object_id %>')"><%=h line %></li>
+                <% } %>
+              </ol>
+              <% end %>
+
+            <ol start="<%=h frame.lineno %>" class="context-line">
+              <li onclick="toggle('pre<%=h frame.object_id %>', 'post<%=h frame.object_id %>')"><%=h frame.context_line %><span>...</span></li></ol>
+
+              <% if frame.post_context %>
+              <ol start='<%=h frame.lineno+1 %>' class="post-context" id="post<%=h frame.object_id %>">
+                <% frame.post_context.each { |line| %>
+                <li onclick="toggle('pre<%=h frame.object_id %>', 'post<%=h frame.object_id %>')"><%=h line %></li>
+                <% } %>
+              </ol>
+              <% end %>
+          </div>
+          <% end %>
+      </li>
+<% } %>
+  </ul>
+</div>
+
+<div id="requestinfo">
+  <h2>Request information</h2>
+
+  <h3 id="get-info">GET</h3>
+  <% unless req.GET.empty? %>
+    <table class="req">
+      <thead>
+        <tr>
+          <th>Variable</th>
+          <th>Value</th>
+        </tr>
+      </thead>
+      <tbody>
+          <% req.GET.sort_by { |k, v| k.to_s }.each { |key, val| %>
+          <tr>
+            <td><%=h key %></td>
+            <td class="code"><div><%=h val.inspect %></div></td>
+          </tr>
+          <% } %>
+      </tbody>
+    </table>
+  <% else %>
+    <p>No GET data.</p>
+  <% end %>
+
+  <h3 id="post-info">POST</h3>
+  <% unless req.POST.empty? %>
+    <table class="req">
+      <thead>
+        <tr>
+          <th>Variable</th>
+          <th>Value</th>
+        </tr>
+      </thead>
+      <tbody>
+          <% req.POST.sort_by { |k, v| k.to_s }.each { |key, val| %>
+          <tr>
+            <td><%=h key %></td>
+            <td class="code"><div><%=h val.inspect %></div></td>
+          </tr>
+          <% } %>
+      </tbody>
+    </table>
+  <% else %>
+    <p>No POST data.</p>
+  <% end %>
+
+
+  <h3 id="cookie-info">COOKIES</h3>
+  <% unless req.cookies.empty? %>
+    <table class="req">
+      <thead>
+        <tr>
+          <th>Variable</th>
+          <th>Value</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% req.cookies.each { |key, val| %>
+          <tr>
+            <td><%=h key %></td>
+            <td class="code"><div><%=h val.inspect %></div></td>
+          </tr>
+        <% } %>
+      </tbody>
+    </table>
+  <% else %>
+    <p>No cookie data.</p>
+  <% end %>
+
+  <h3 id="env-info">Rack ENV</h3>
+    <table class="req">
+      <thead>
+        <tr>
+          <th>Variable</th>
+          <th>Value</th>
+        </tr>
+      </thead>
+      <tbody>
+          <% env.sort_by { |k, v| k.to_s }.each { |key, val| %>
+          <tr>
+            <td><%=h key %></td>
+            <td class="code"><div><%=h val %></div></td>
+          </tr>
+          <% } %>
+      </tbody>
+    </table>
+
+</div>
+
+</body>
+</html>
+HTML
+
+
+  end
+end

data/lib/cramp/fiber_pool.rb

@@ -22,12 +22,25 @@ module Cramp
       # Overrides wrapper methods to run callbacks in a fiber
 
       def callback_wrapper
-        self.fiber_pool.spawn { yield }
+        self.fiber_pool.spawn do
+          begin
+            yield
+          rescue StandardError, LoadError, SyntaxError => exception
+            handle_exception(exception)
+          end
+        end
       end
 
       def timer_method_wrapper(method)
-        self.fiber_pool.spawn { send(method) }
+        self.fiber_pool.spawn do
+          begin
+            send(method)
+          rescue StandardError, LoadError, SyntaxError => exception
+            handle_exception(exception)
+          end
+        end
       end
+
     end
 
   end

data/lib/cramp/periodic_timer.rb

@@ -47,6 +47,8 @@ module Cramp
 
     def timer_method_wrapper(method)
       send(method)
+    rescue StandardError, LoadError, SyntaxError => exception
+      handle_exception(exception)
     end
 
   end

data/lib/cramp/websocket/extension.rb

@@ -1,9 +1,16 @@
+require 'base64'
+require 'digest/sha1'
+
 module Cramp
   module WebsocketExtension
     WEBSOCKET_RECEIVE_CALLBACK = 'websocket.receive_callback'.freeze
 
+    def protocol_class
+      @env['HTTP_SEC_WEBSOCKET_VERSION'] ? Protocol10 : Protocol76
+    end
+
     def websocket?
-      @env['HTTP_CONNECTION'] == 'Upgrade' && @env['HTTP_UPGRADE'] == 'WebSocket'
+      @env['HTTP_CONNECTION'] == 'Upgrade' && ['WebSocket', 'websocket'].include?(@env['HTTP_UPGRADE'])
     end
 
     def secure_websocket?
@@ -20,20 +27,23 @@ module Cramp
     end
 
     class WebSocketHandler
-      def initialize(env, websocket_url, body)
+      def initialize(env, websocket_url, body = nil)
         @env = env
         @websocket_url = websocket_url
         @body = body
       end
     end
 
-    class Protocol75 < WebSocketHandler
+    class Protocol10 < WebSocketHandler
+      MAGIC_GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11".freeze
+
       def handshake
-        upgrade =  "HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
-        upgrade << "Upgrade: WebSocket\r\n"
+        digest = Base64.encode64(Digest::SHA1.digest("#{@env['HTTP_SEC_WEBSOCKET_KEY']}#{MAGIC_GUID}")).chomp
+        
+        upgrade =  "HTTP/1.1 101 Switching Protocols\r\n"
+        upgrade << "Upgrade: websocket\r\n"
         upgrade << "Connection: Upgrade\r\n"
-        upgrade << "WebSocket-Origin: #{@env['HTTP_ORIGIN']}\r\n"
-        upgrade << "WebSocket-Location: #{@websocket_url}\r\n\r\n"
+        upgrade << "Sec-WebSocket-Accept: #{digest}\r\n\r\n"
         upgrade
       end
     end

data/lib/cramp/websocket/protocol10_frame_parser.rb

@@ -0,0 +1,241 @@
+# encoding: BINARY
+
+# The MIT License - Copyright (c) 2009 Ilya Grigorik
+# Thank you https://github.com/igrigorik/em-websocket
+#
+# Copyright (c) 2009 Ilya Grigorik
+# 
+# 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.
+
+module Cramp
+  class Protocol10FrameParser
+    class WebSocketError < RuntimeError; end
+
+    class MaskedString < String
+      # Read a 4 bit XOR mask - further requested bytes will be unmasked
+      def read_mask
+        if respond_to?(:encoding) && encoding.name != "ASCII-8BIT"
+          raise "MaskedString only operates on BINARY strings"
+        end
+        raise "Too short" if bytesize < 4 # TODO - change
+        @masking_key = String.new(self[0..3])
+      end
+
+      # Removes the mask, behaves like a normal string again
+      def unset_mask
+        @masking_key = nil
+      end
+
+      def slice_mask
+        slice!(0, 4)
+      end
+
+      def getbyte(index)
+        if @masking_key
+          masked_char = super
+          masked_char ? masked_char ^ @masking_key.getbyte(index % 4) : nil
+        else
+          super
+        end
+      end
+
+      def getbytes(start_index, count)
+        data = ''
+        count.times do |i|
+          data << getbyte(start_index + i)
+        end
+        data
+      end
+    end
+
+    attr_accessor :data
+
+    def initialize
+      @data = MaskedString.new
+      @application_data_buffer = '' # Used for MORE frames
+    end
+    
+    def process_data
+      messages = []
+      error = false
+
+      while !error && @data.size >= 2
+        pointer = 0
+
+        fin = (@data.getbyte(pointer) & 0b10000000) == 0b10000000
+        # Ignoring rsv1-3 for now
+        opcode = @data.getbyte(pointer) & 0b00001111
+        pointer += 1
+
+        mask = (@data.getbyte(pointer) & 0b10000000) == 0b10000000
+        length = @data.getbyte(pointer) & 0b01111111
+        pointer += 1
+
+        raise WebSocketError, 'Data from client must be masked' unless mask
+
+        payload_length = case length
+        when 127 # Length defined by 8 bytes
+          # Check buffer size
+          if @data.getbyte(pointer+8-1) == nil
+            debug [:buffer_incomplete, @data]
+            error = true
+            next
+          end
+          
+          # Only using the last 4 bytes for now, till I work out how to
+          # unpack 8 bytes. I'm sure 4GB frames will do for now :)
+          l = @data.getbytes(pointer+4, 4).unpack('N').first
+          pointer += 8
+          l
+        when 126 # Length defined by 2 bytes
+          # Check buffer size
+          if @data.getbyte(pointer+2-1) == nil
+            debug [:buffer_incomplete, @data]
+            error = true
+            next
+          end
+          
+          l = @data.getbytes(pointer, 2).unpack('n').first
+          pointer += 2
+          l
+        else
+          length
+        end
+
+        # Compute the expected frame length
+        frame_length = pointer + payload_length
+        frame_length += 4 if mask
+
+        # Check buffer size
+        if @data.getbyte(frame_length - 1) == nil
+          debug [:buffer_incomplete, @data]
+          error = true
+          next
+        end
+
+        # Remove frame header
+        @data.slice!(0...pointer)
+        pointer = 0
+
+        # Read application data (unmasked if required)
+        @data.read_mask if mask
+        pointer += 4 if mask
+        application_data = @data.getbytes(pointer, payload_length)
+        pointer += payload_length
+        @data.unset_mask if mask
+        
+        # Throw away data up to pointer
+        @data.slice!(0...pointer)
+
+        frame_type = opcode_to_type(opcode)
+
+        if frame_type == :continuation && !@frame_type
+          raise WebSocketError, 'Continuation frame not expected'
+        end
+
+        if !fin
+          debug [:moreframe, frame_type, application_data]
+          @application_data_buffer << application_data
+          @frame_type = frame_type
+        else
+          # Message is complete
+          if frame_type == :continuation
+            @application_data_buffer << application_data
+            messages << [@frame_type, @application_data_buffer]
+            @application_data_buffer = ''
+            @frame_type = nil
+          else
+            messages << [frame_type, application_data]
+          end
+        end
+      end # end while
+
+      messages
+    end
+    
+    def send_frame(frame_type, application_data)
+      debug [:sending_frame, frame_type, application_data]
+
+      # Protocol10FrameParser doesn't have any knowledge of :closing in Cramp
+      # if @state == :closing && data_frame?(frame_type)
+      #   raise WebSocketError, "Cannot send data frame since connection is closing"
+      # end
+
+      frame = ''
+
+      opcode = type_to_opcode(frame_type)
+      byte1 = opcode | 0b10000000 # fin bit set, rsv1-3 are 0
+      frame << byte1
+
+      length = application_data.size
+      if length <= 125
+        byte2 = length # since rsv4 is 0
+        frame << byte2
+      elsif length < 65536 # write 2 byte length
+        frame << 126
+        frame << [length].pack('n')
+      else # write 8 byte length
+        frame << 127
+        frame << [length >> 32, length & 0xFFFFFFFF].pack("NN")
+      end
+
+      frame << application_data
+    end
+
+    def send_text_frame(data)
+      send_frame(:text, data)
+    end
+
+    private
+
+    FRAME_TYPES = {
+      :continuation => 0,
+      :text => 1,
+      :binary => 2,
+      :close => 8,
+      :ping => 9,
+      :pong => 10,
+    }
+    FRAME_TYPES_INVERSE = FRAME_TYPES.invert
+    # Frames are either data frames or control frames
+    DATA_FRAMES = [:text, :binary, :continuation]
+
+    def type_to_opcode(frame_type)
+      FRAME_TYPES[frame_type] || raise("Unknown frame type")
+    end
+
+    def opcode_to_type(opcode)
+      FRAME_TYPES_INVERSE[opcode] || raise(DataError, "Unknown opcode")
+    end
+
+    def data_frame?(type)
+      DATA_FRAMES.include?(type)
+    end
+
+    def debug(*data)
+      if @debug
+        require 'pp'
+        pp data
+        puts
+      end
+    end
+
+  end
+end

data/lib/cramp/websocket/rainbows.rb

@@ -24,9 +24,7 @@ class Cramp::Websocket::Rainbows < Rainbows::EventMachine::Client
       @state = :websocket
       @input.rewind
 
-      handler = @env['HTTP_SEC_WEBSOCKET_KEY1'] &&
-                @env['HTTP_SEC_WEBSOCKET_KEY2'] ? Protocol76 : Protocol75
-      write(handler.new(@env, websocket_url, @buf).handshake)
+      write(protocol_class.new(@env, websocket_url, @buf).handshake)
       app_call NULL_IO
     else
       super

data/lib/cramp/websocket/thin_backend.rb

@@ -33,13 +33,7 @@ class Thin::Request
   include Cramp::WebsocketExtension
 
   def websocket_upgrade_data
-    handler = if @env['HTTP_SEC_WEBSOCKET_KEY1'] and @env['HTTP_SEC_WEBSOCKET_KEY2']
-      Protocol76
-    else
-      Protocol75
-    end
-
-    handler.new(@env, websocket_url, body.read).handshake
+    protocol_class.new(@env, websocket_url, body.read).handshake
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cramp
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: '0.15'
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-10 00:00:00.000000000 +01:00
+date: 2011-08-13 00:00:00.000000000 +01:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2160171700 !ruby/object:Gem::Requirement
+  requirement: &2156847620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.9
   type: :runtime
   prerelease: false
-  version_requirements: *2160171700
+  version_requirements: *2156847620
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2160171100 !ruby/object:Gem::Requirement
+  requirement: &2156847100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 1.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *2160171100
+  version_requirements: *2156847100
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &2160170520 !ruby/object:Gem::Requirement
+  requirement: &2156846640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.0.0.beta.3
   type: :runtime
   prerelease: false
-  version_requirements: *2160170520
+  version_requirements: *2156846640
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &2160169960 !ruby/object:Gem::Requirement
+  requirement: &2156846160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,7 +55,7 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *2160169960
+  version_requirements: *2156846160
 description: Cramp is a framework for developing asynchronous web applications.
 email: pratiknaik@gmail.com
 executables:
@@ -68,6 +68,7 @@ files:
 - lib/cramp/action.rb
 - lib/cramp/body.rb
 - lib/cramp/callbacks.rb
+- lib/cramp/exception_handler.rb
 - lib/cramp/fiber_pool.rb
 - lib/cramp/generators/application.rb
 - lib/cramp/generators/templates/application/app/actions/home_action.rb
@@ -83,6 +84,7 @@ files:
 - lib/cramp/sse.rb
 - lib/cramp/test_case.rb
 - lib/cramp/websocket/extension.rb
+- lib/cramp/websocket/protocol10_frame_parser.rb
 - lib/cramp/websocket/rainbows.rb
 - lib/cramp/websocket/rainbows_backend.rb
 - lib/cramp/websocket/thin_backend.rb
@@ -91,7 +93,7 @@ files:
 - lib/vendor/fiber_pool.rb
 - bin/cramp
 has_rdoc: false
-homepage: http://m.onkey.org
+homepage: http://cramp.in
 licenses: []
 post_install_message: 
 rdoc_options: []