cramp 0.12 → 0.13

data/lib/cramp.rb

@@ -2,6 +2,7 @@ require 'eventmachine'
 EM.epoll
 
 require 'active_support'
+require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/class/inheritable_attributes'
 require 'active_support/core_ext/class/attribute_accessors'
 require 'active_support/core_ext/module/aliasing'
@@ -13,17 +14,25 @@ require 'active_support/buffered_logger'
 
 require 'rack'
 
+if RUBY_VERSION >= '1.9.1'
+  require File.join(File.dirname(__FILE__), 'vendor/fiber_pool')
+end
+  
 module Cramp
-  VERSION = '0.12'
+  VERSION = '0.13'
 
   mattr_accessor :logger
 
   autoload :Action, "cramp/action"
   autoload :Websocket, "cramp/websocket"
+  autoload :WebsocketExtension, "cramp/websocket/extension"
+  autoload :SSE, "cramp/sse"
+  autoload :LongPolling, "cramp/long_polling"
   autoload :Body, "cramp/body"
   autoload :PeriodicTimer, "cramp/periodic_timer"
   autoload :KeepConnectionAlive, "cramp/keep_connection_alive"
   autoload :Abstract, "cramp/abstract"
   autoload :Callbacks, "cramp/callbacks"
+  autoload :FiberPool, "cramp/fiber_pool"
   autoload :TestCase, "cramp/test_case"
 end

data/lib/cramp/abstract.rb

@@ -2,10 +2,11 @@ require 'active_support/core_ext/hash/keys'
 
 module Cramp
   class Abstract
-
     include Callbacks
+    include FiberPool
 
-    ASYNC_RESPONSE = [-1, {}, []].freeze
+    class_attribute :transport
+    self.transport = :regular
 
     class << self
       def call(env)
@@ -15,20 +16,22 @@ module Cramp
 
     def initialize(env)
       @env = env
+      @finished = false
     end
 
     def process
       EM.next_tick { before_start }
-      ASYNC_RESPONSE
+      throw :async
     end
 
+    protected
+
     def continue
       init_async_body
 
       status, headers = respond_with
       send_initial_response(status, headers, @body)
 
-      EM.next_tick { start } if respond_to?(:start)
       EM.next_tick { on_start }
     end
 
@@ -45,16 +48,25 @@ module Cramp
       end
     end
 
+    def finished?
+      !!@finished
+    end
+
     def finish
+      @finished = true
       @body.succeed
     end
 
     def send_initial_response(response_status, response_headers, response_body)
-      EM.next_tick { @env['async.callback'].call [response_status, response_headers, response_body] }
+      send_response(response_status, response_headers, response_body)
     end
 
     def halt(status, headers = {}, halt_body = '')
-      send_initial_response(status, headers, halt_body)
+      send_response(status, headers, halt_body)
+    end
+
+    def send_response(response_status, response_headers, response_body)
+      @env['async.callback'].call [response_status, response_headers, response_body]
     end
 
     def request
@@ -66,7 +78,7 @@ module Cramp
     end
 
     def route_params
-      @env['router.params']||@env['usher.params']
+      @env['router.params'] || @env['usher.params']
     end
   end
 end

data/lib/cramp/action.rb

@@ -1,12 +1,60 @@
 module Cramp
   class Action < Abstract
-
     include PeriodicTimer
     include KeepConnectionAlive
 
-    def render(body)
+    protected
+
+    def render(body, *args)
+      send(:"render_#{transport}", body, *args)
+    end
+
+    def send_initial_response(*)
+      case transport
+      when :long_polling
+        # Dont send no initial response
+      else
+        super
+      end
+    end
+
+    def respond_with
+      case transport
+      when :sse
+        [200, {'Content-Type' => 'text/event-stream', 'Cache-Control' => 'no-cache', 'Connection' => 'keep-alive'}]
+      else
+        super
+      end
+    end
+
+    def render_regular(body, *)
       @body.call(body)
     end
 
+    def render_long_polling(data, *)
+      status, headers = respond_with
+      headers['Content-Length'] = data.size.to_s
+
+      send_response(status, headers, @body)
+      @body.call(data)
+
+      finish
+    end
+
+    def render_sse(data, options = {})
+      result = "id: #{sse_event_id}\n"
+      result << "retry: #{options[:retry]}\n" if options[:retry]
+
+      data.split(/\n/).each {|d| result << "data: #{d}\n" }
+      result << "\n"
+
+      @body.call(result)
+    end
+
+    # Used by SSE
+    def sse_event_id
+      @sse_event_id ||= Time.now.to_i
+    end
+
   end
 end

data/lib/cramp/callbacks.rb

@@ -26,23 +26,29 @@ module Cramp
 
     def before_start(n = 0)
       if callback = self.class.before_start_callbacks[n]
-        EM.next_tick { send(callback) { before_start(n+1) } }
+        callback_wrapper { send(callback) { before_start(n+1) } }
       else
         continue
       end
     end
 
     def on_start
+      callback_wrapper { start } if respond_to?(:start)
+
       self.class.on_start_callback.each do |callback|
-        EM.next_tick { send(callback) }
+        callback_wrapper { send(callback) unless @finished }
       end
     end
 
     def on_finish
       self.class.on_finish_callbacks.each do |callback|
-        EM.next_tick { send(callback) }
+        callback_wrapper { send(callback) }
       end
     end
 
+    def callback_wrapper
+      EM.next_tick { yield }
+    end
+
   end
 end

data/lib/cramp/fiber_pool.rb

@@ -0,0 +1,34 @@
+module Cramp
+  module FiberPool
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :fiber_pool
+    end
+
+    module ClassMethods
+      def use_fiber_pool(options = {})
+        if RUBY_VERSION < '1.9.1'
+          raise "Fibers are supported only for Rubies >= 1.9.1"
+        end
+
+        self.fiber_pool = ::FiberPool.new(options[:size] || 100)
+        yield self.fiber_pool if block_given?
+        include UsesFiberPool
+      end
+    end
+
+    module UsesFiberPool
+      # Overrides wrapper methods to run callbacks in a fiber
+
+      def callback_wrapper
+        self.fiber_pool.spawn { yield }
+      end
+
+      def timer_method_wrapper(method)
+        self.fiber_pool.spawn { send(method) }
+      end
+    end
+
+  end
+end

data/lib/cramp/keep_connection_alive.rb

@@ -12,7 +12,7 @@ module Cramp
     end
 
     def keep_connection_alive
-      render " "
+      @body.call " "
     end
 
   end

data/lib/cramp/long_polling.rb

@@ -0,0 +1,6 @@
+module Cramp
+  # All the usual Cramp::Action stuff. But the request is terminated as soon as render() is called.
+  class LongPolling < Action
+    self.transport = :long_polling
+  end
+end

data/lib/cramp/periodic_timer.rb

@@ -19,9 +19,11 @@ module Cramp
       @timers = []
     end
 
+    protected
+
     def continue
       super
-      EM.next_tick { start_periodic_timers }
+      start_periodic_timers
     end
 
     def init_async_body
@@ -33,11 +35,9 @@ module Cramp
       end
     end
 
-    private
-
     def start_periodic_timers
       self.class.periodic_timers.each do |method, options|
-        @timers << EventMachine::PeriodicTimer.new(options[:every] || 1) { send(method) }
+        @timers << EventMachine::PeriodicTimer.new(options[:every] || 1) { timer_method_wrapper(method) unless @finished }
       end
     end
 
@@ -45,5 +45,9 @@ module Cramp
       @timers.each {|t| t.cancel }
     end
 
+    def timer_method_wrapper(method)
+      send(method)
+    end
+
   end
 end

data/lib/cramp/sse.rb

@@ -0,0 +1,5 @@
+module Cramp
+  class SSE < Action
+    self.transport = :sse
+  end
+end

data/lib/cramp/test_case.rb

@@ -14,7 +14,9 @@ module Cramp
       callback = options.delete(:callback) || block
       headers = headers.merge('async.callback' => callback)
 
-      EM.run { @request.get(path, headers) }
+      EM.run do
+        catch(:async) { @request.get(path, headers) }
+      end
     end
 
     def get_body(path, options = {}, headers = {}, &block)
@@ -22,7 +24,9 @@ module Cramp
       response_callback = proc {|response| response[-1].each {|chunk| callback.call(chunk) } }
       headers = headers.merge('async.callback' => response_callback)
 
-      EM.run { @request.get(path, headers) }
+      EM.run do
+        catch(:async) { @request.get(path, headers) }
+      end
     end
 
     def get_body_chunks(path, options = {}, headers = {}, &block)

data/lib/cramp/websocket.rb

@@ -1,47 +1,4 @@
 module Cramp
-  module WebsocketExtension
-    WEBSOCKET_RECEIVE_CALLBACK = 'websocket.receive_callback'.freeze
-
-    def websocket?
-      @env['HTTP_CONNECTION'] == 'Upgrade' && @env['HTTP_UPGRADE'] == 'WebSocket'
-    end
-
-    def websocket_upgrade_data
-      location  = "ws://#{@env['HTTP_HOST']}#{@env['REQUEST_PATH']}"
-      challenge = solve_challange(
-        @env['HTTP_SEC_WEBSOCKET_KEY1'],
-        @env['HTTP_SEC_WEBSOCKET_KEY2'],
-        @env['rack.input'].read
-      )
-
-      upgrade =  "HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
-      upgrade << "Upgrade: WebSocket\r\n"
-      upgrade << "Connection: Upgrade\r\n"
-      upgrade << "Sec-WebSocket-Origin: #{@env['HTTP_ORIGIN']}\r\n"
-      upgrade << "Sec-WebSocket-Location: #{location}\r\n\r\n"
-      upgrade << challenge
-
-      upgrade
-    end
-
-    def solve_challange(first, second, third)
-      # Refer to 5.2 4-9 of the draft 76
-      sum = 
-        [extract_nums(first) / count_spaces(first)].pack("N*") +
-        [extract_nums(second) / count_spaces(second)].pack("N*") +
-        third
-      Digest::MD5.digest(sum)
-    end
-
-    def extract_nums(string)
-      string.scan(/[0-9]/).join.to_i
-    end
-
-    def count_spaces(string)
-      string.scan(/ /).size 
-    end
-  end
-
   class Websocket < Abstract
     include PeriodicTimer
 
@@ -68,7 +25,8 @@ module Cramp
     end
 
     def render(body)
-      @body.call("\x00#{body}\xff")
+      data = ["\x00", body, "\xFF"].map(&method(:encode)) * ''
+      @body.call(data)
     end
 
     def _on_data_receive(data)
@@ -79,6 +37,12 @@ module Cramp
         end
       end
     end
-    
+
+    protected
+
+    def encode(string, encoding = 'UTF-8')
+      string.respond_to?(:force_encoding) ? string.force_encoding(encoding) : string
+    end
+
   end
 end

data/lib/cramp/websocket/extension.rb

@@ -0,0 +1,82 @@
+module Cramp
+  module WebsocketExtension
+    WEBSOCKET_RECEIVE_CALLBACK = 'websocket.receive_callback'.freeze
+
+    def websocket?
+      @env['HTTP_CONNECTION'] == 'Upgrade' && @env['HTTP_UPGRADE'] == 'WebSocket'
+    end
+
+    def secure_websocket?
+      if @env.has_key?('HTTP_X_FORWARDED_PROTO')
+        @env['HTTP_X_FORWARDED_PROTO'] == 'https' 
+      else
+        @env['HTTP_ORIGIN'] =~ /^https:/i
+      end
+    end
+
+    def websocket_url
+      scheme = secure_websocket? ? 'wss:' : 'ws:'
+      @env['websocket.url'] = "#{ scheme }//#{ @env['HTTP_HOST'] }#{ @env['REQUEST_URI'] }"
+    end
+
+    class WebSocketHandler
+      def initialize(env, websocket_url, body)
+        @env = env
+        @websocket_url = websocket_url
+        @body = body
+      end
+    end
+
+    class Protocol75 < WebSocketHandler
+      def handshake
+        upgrade =  "HTTP/1.1 101 Web Socket Protocol Handshake\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
+      end
+    end
+
+    class Protocol76 < WebSocketHandler
+      def handshake
+        key1   = @env['HTTP_SEC_WEBSOCKET_KEY1']
+        value1 = number_from_key(key1) / spaces_in_key(key1)
+
+        key2   = @env['HTTP_SEC_WEBSOCKET_KEY2']
+        value2 = number_from_key(key2) / spaces_in_key(key2)
+
+        hash = Digest::MD5.digest(big_endian(value1) +
+                                  big_endian(value2) +
+                                  @body)
+
+        upgrade =  "HTTP/1.1 101 Web Socket Protocol Handshake\r\n"
+        upgrade << "Upgrade: WebSocket\r\n"
+        upgrade << "Connection: Upgrade\r\n"
+        upgrade << "Sec-WebSocket-Origin: #{@env['HTTP_ORIGIN']}\r\n"
+        upgrade << "Sec-WebSocket-Location: #{@websocket_url}\r\n\r\n"
+        upgrade << hash
+        upgrade
+      end
+
+      private
+
+      def number_from_key(key)
+        key.scan(/[0-9]/).join('').to_i(10)
+      end
+
+      def spaces_in_key(key)
+        key.scan(/ /).size
+      end
+
+      def big_endian(number)
+        string = ''
+        [24,16,8,0].each do |offset|
+          string << (number >> offset & 0xFF).chr
+        end
+        string
+      end
+    end
+
+  end
+end

data/lib/cramp/websocket/thin_backend.rb

@@ -31,6 +31,17 @@ end
 
 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
+  end
+
 end
 
 class Thin::Response

data/lib/vendor/fiber_pool.rb

@@ -0,0 +1,85 @@
+# Author::    Mohammad A. Ali  (mailto:oldmoe@gmail.com)
+# Copyright:: Copyright (c) 2008 eSpace, Inc.
+# License::   Distributes under the same terms as Ruby
+
+require 'fiber'
+
+class Fiber
+  
+  #Attribute Reference--Returns the value of a fiber-local variable, using
+  #either a symbol or a string name. If the specified variable does not exist,
+  #returns nil.
+  def [](key)
+    local_fiber_variables[key]
+  end
+  
+  #Attribute Assignment--Sets or creates the value of a fiber-local variable,
+  #using either a symbol or a string. See also Fiber#[].
+  def []=(key,value)
+    local_fiber_variables[key] = value
+  end
+  
+  private
+  
+  def local_fiber_variables
+    @local_fiber_variables ||= {}
+  end
+end
+
+class FiberPool
+
+  # gives access to the currently free fibers
+  attr_reader :fibers
+  attr_reader :busy_fibers
+
+  # Code can register a proc with this FiberPool to be called
+  # every time a Fiber is finished.  Good for releasing resources
+  # like ActiveRecord database connections.
+  attr_accessor :generic_callbacks
+
+  # Prepare a list of fibers that are able to run different blocks of code
+  # every time. Once a fiber is done with its block, it attempts to fetch
+  # another one from the queue
+  def initialize(count = 100)
+    @fibers,@busy_fibers,@queue,@generic_callbacks = [],{},[],[]
+    count.times do |i|
+      fiber = Fiber.new do |block|
+        loop do
+          block.call
+
+          # callbacks are called in a reverse order, much like c++ destructor
+          Fiber.current[:callbacks].pop.call while Fiber.current[:callbacks].length > 0
+          generic_callbacks.each do |cb|
+            cb.call
+          end
+
+          if @queue.any?
+            block = @queue.shift
+          else
+            @busy_fibers.delete(Fiber.current.object_id)
+            @fibers.unshift Fiber.current
+            block = Fiber.yield
+          end
+
+        end
+      end
+      fiber[:callbacks] = []
+      fiber[:em_keys] = []
+      @fibers << fiber
+    end
+  end
+
+  # If there is an available fiber use it, otherwise, leave it to linger
+  # in a queue
+  def spawn(&block)
+    if fiber = @fibers.shift
+      fiber[:callbacks] = []
+      @busy_fibers[fiber.object_id] = fiber
+      fiber.resume(block)
+    else
+      @queue << block
+    end
+    self # we are keen on hiding our queue
+  end
+
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: cramp
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
-  - 12
-  version: "0.12"
+  - 13
+  version: "0.13"
 platform: ruby
 authors: 
 - Pratik Naik
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-13 00:00:00 +00:00
+date: 2011-07-31 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,12 +25,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 21
         segments: 
         - 3
         - 0
-        - 4
-        version: 3.0.4
+        - 9
+        version: 3.0.9
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -79,14 +79,19 @@ files:
 - lib/cramp/action.rb
 - lib/cramp/body.rb
 - lib/cramp/callbacks.rb
+- lib/cramp/fiber_pool.rb
 - lib/cramp/keep_connection_alive.rb
+- lib/cramp/long_polling.rb
 - lib/cramp/periodic_timer.rb
 - lib/cramp/rendering.rb
+- lib/cramp/sse.rb
 - lib/cramp/test_case.rb
+- lib/cramp/websocket/extension.rb
 - lib/cramp/websocket/rainbows_backend.rb
 - lib/cramp/websocket/thin_backend.rb
 - lib/cramp/websocket.rb
 - lib/cramp.rb
+- lib/vendor/fiber_pool.rb
 has_rdoc: true
 homepage: http://m.onkey.org
 licenses: []
@@ -117,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Asynchronous web framework.