rack-async 0.0.1

data/README.rdoc

@@ -0,0 +1,166 @@
+= Rack::Async
+
+Rack::Async is a rack middleware that makes available a thin[https://github.com/macournoyer/thin] like async api on most rack compatible web servers.
+
+It works with mongrel, thin, and all the related mongrel-derived servers I've tried, additionally ebb works fine.
+
+Although WEBrick won't support sending asynchronous replies, using Rack::Async will successfully send everything you ask it to, just bundled up all together like a normal synchronous reply.
+
+It won't work with MacRuby's ControlTower at all.
+
+== Installation
+
+gem install rack-async
+
+== Common problems
+
+=== Rack::Lint::LintError
+Rack::Lint doesn't know anything about async responses, so can't validate them properly, you'll have to turn it off.
+
+=== The response doesn't seem asynchronous in my browser
+Most browsers won't start rendering anything until they have around 1024 bytes of data. One way to get around this is to simply send 1024 bytes of whitespace at the start of your response. If you're just looking to see your response come in chunk by chunk, `curl` doesn't suffer this problem.
+
+== Async Response with EventMachine
+
+Here's how to send an async response with EventMachine that will work across thin, mongrel, ebb, etc
+
+config.ru
+
+   require 'rubygems'
+   require 'rack/async'
+   require 'eventmachine'
+   
+   class EMAsyncApp
+     def call(env)
+       event_machine do
+         EM.add_timer(5) do
+           env['async.callback'].call([200, {}, ["Hello world!"]])
+         end
+       end
+       
+       # returning this signals to the server we are sending an async response
+       Rack::Async::RESPONSE
+     end
+     
+     private
+     # make sure EventMachine is running (if we're on thin it'll be up and
+     # running, but this isn't the case on other servers).
+     def event_machine(&block)
+       if EM.reactor_running?
+         block.call
+       else
+         Thread.new {EM.run}
+         EM.next_tick(block)
+       end
+     end
+   end
+   
+   use Rack::Async
+   run EMAsyncApp.new
+
+== Async Response with Threads
+
+Here's how to send an async response using threads that will work across thin, mongrel, ebb, etc
+
+(we'll just give you the #call method this time)
+
+  def call(env)
+    Thread.new do
+      sleep 5
+      env['async.callback'].call([200, {}, ["Hello world!"]])
+    end
+    
+    Rack::Async::RESPONSE
+  end
+
+== Async Body with EventMachine
+
+Sure sending an asynchronous response is neat, but what really cool is streaming out the body to the client, here's how to do that
+
+config.ru
+
+  require 'rubygems'
+  require 'rack/async'
+  require 'eventmachine'
+  
+  class EMAsyncBodyApp
+    def call(env)
+      body = env['async.body']
+      
+      event_machine do
+        i = 0
+        timer = EM.add_periodic_timer(1) do
+          body << "Hello world!\r\n"
+          i += 1
+          if i >= 5
+            body.finish
+            timer.cancel
+          end
+        end
+      end
+      
+      [200, {}, body]
+    end
+    
+    private
+    def event_machine(&block)
+      if EM.reactor_running?
+        block.call
+      else
+        Thread.new {EM.run}
+        EM.next_tick(block)
+      end
+    end
+  end
+  
+  use Rack::Async
+  run EMAsyncBodyApp.new
+
+== Async Everything with Threads
+
+You can combine the two like so (threaded example this time, but it works just fine with event machine too).
+
+  require 'rubygems'
+  require 'rack/async'
+  require 'thread'
+  
+  class ThreadedAsyncApp
+    def call(env)
+      Thread.new do
+        sleep 1
+        body = env['async.body']
+        env['async.callback'].call([200, {}, body])
+        5.times {sleep 1; body << "Hello world!\r\n";}
+        body.finish
+      end
+      
+      Rack::Async::RESPONSE
+    end
+  end
+  
+  use Rack::Async
+  run ThreadedAsyncApp.new
+
+== Licence
+
+(The MIT License)
+
+Copyright (c) 2011 Matthew Sadler
+
+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/lib/rack/async.rb

@@ -0,0 +1,128 @@
+require 'thread'
+
+module Rack
+  class Async
+    RESPONSE = [-1, {}, []].freeze
+    CALLBACK = "async.callback".freeze
+    BODY = "async.body".freeze
+    
+    def initialize(app)
+      @app = app
+    end
+    
+    def call(env)
+      original_callback = env[Async::CALLBACK]
+      if original_callback.respond_to?(:arity)
+        original_callback_arity = original_callback.arity
+      elsif original_callback
+        original_callback_arity = original_callback.method(:call).arity
+      end
+      
+      if original_callback # we've got a thin-like async api!
+        if original_callback_arity > 1 # wrap ebb's callback to expand the args
+          env[Async::CALLBACK] = Proc.new do |response|
+            original_callback.call(*response)
+          end
+        end
+        env[Async::BODY] = Async::CallbackBody.new
+      else # no async api, but blocking in the right places we can fake it
+        blocking_callback = Async::BlockingCallback.new
+        env[Async::CALLBACK] = blocking_callback
+        env[Async::BODY] = Async::BlockingBody.new
+      end
+      
+      response = @app.call(env)
+      
+      if response.first != Async::RESPONSE.first # non-async response
+        response
+      elsif original_callback && original_callback_arity > 1 # ebb-like
+        [0, {}, []]
+      elsif original_callback # thin-like
+        Async::RESPONSE
+      else # mongrel, etc
+        blocking_callback.wait
+      end
+    end
+    
+    class BlockingCallback < Queue
+      alias call push
+      alias wait pop
+    end
+    
+    class BlockingBody < Queue
+      def each
+        until @finished && empty?
+          data = pop
+          yield data if data
+        end
+      end
+      
+      def succeed
+        @finished = true
+        self << nil
+      end
+      alias finish succeed
+      alias fail succeed
+    end
+    
+    class CallbackBody
+      def initialize(*args)
+        super
+        @buffer = []
+        @lock = Mutex.new
+      end
+      
+      def <<(data)
+        @lock.synchronize do
+          if @each_callback
+            @each_callback.call(data)
+          else
+            @buffer << data
+          end
+        end
+        self
+      end
+      
+      def each(&block)
+        @lock.synchronize do
+          @buffer.each(&block)
+          @buffer.clear
+          @each_callback = block
+        end
+      end
+      
+      def succeed
+        @callback.call if @callback
+        @finished = true
+      end
+      alias finish succeed
+      
+      def fail
+        @errback.call if @errback
+        @finished = true
+      end
+      
+      def callback(&block)
+        if !@callback && @finished
+          block.call
+        else
+          @callback = block
+        end
+      end
+      
+      def errback(&block)
+        if !@errback && @finished
+          block.call
+        else
+          @errback = block
+        end
+      end
+      
+      def on_eof(&block)
+        callback(&block)
+        errback(&block)
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: rack-async
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matthew Sadler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-19 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: Thin's asynchronous API available to any Rack server.
+email: mat@sourcetagsandcodes.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/rack/async.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/matsadler/rack-async
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --charset
+- utf-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An asynchronous Rack API for everyone.
+test_files: []
+