sinatra-synchrony 0.0.1

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+gem 'sinatra'
+gem 'rack-fiber_pool',   '0.9.1'
+gem 'em-http-request',   '0.3.0'
+gem 'em-synchrony',      '0.2.0'
+gem 'em-resolv-replace', '1.1.1'
+gem 'async-rack',        '0.5.1'
+gem 'wrong',             '0.5.0'
+gem 'rack-test',         '0.5.7'
+gem 'freegenie-em-spec', '0.2.3'
+gem 'ruby-debug19'

data/README.markdown

@@ -0,0 +1,111 @@
+Sinatra::Synchrony
+===
+
+Sinatra + EM-Synchrony - fast, concurrent web applications with no callbacks!
+
+Sinatra::Synchrony is a very small extension for Sinatra that dramatically improves the concurrency of your web application. Powered by [EventMachine](https://github.com/eventmachine/eventmachine) and [EM-Synchrony](https://github.com/igrigorik/em-synchrony), it increases the number of clients your application can serve per process when you have a lot of slow IO calls (like HTTP calls to external APIs). Because it uses [Fibers](http://www.ruby-doc.org/core-1.9/classes/Fiber.html) internally to handle concurrency, no callback gymnastics are required! Just develop as if you were writing a normal Sinatra web application, use non-blocking libraries (see below) and you're all set!
+
+How it works
+---
+
+* Loads [EventMachine](https://github.com/eventmachine/eventmachine) and [EM-Synchrony](https://github.com/igrigorik/em-synchrony). Requires app server with EventMachine and Ruby 1.9 support (Thin, Rainbows!, Heroku).
+* Inserts the [Rack::FiberPool](https://github.com/mperham/rack-fiber_pool) middleware, which automatically provides a Fiber for each incoming request, allowing EM-Synchrony to work.
+* Inserts [async-rack](https://github.com/rkh/async-rack/tree/master/lib/async_rack), which makes Rack's middleware more async friendly.
+* Adds [em-http-request](https://github.com/igrigorik/em-http-request), which you can use with EM::Synchrony to do concurrent HTTP calls to APIs! Or if you'd rather use a different client:
+* Patches TCPSocket via EM-Synchrony. Any software that uses this (such as an HTTP Client that uses Net::HTTP) can run without blocking IO. [RestClient](https://github.com/archiloque/rest-client) works great with this!
+* Patches Rack::Test so that it runs your tests within an EventMachine. Just test the same way you did before and it should just work.
+* Patches Resolv via [em-resolv-replace](https://github.com/mperham/em-resolv-replace), enabling non-blocking DNS lookups magically, the way David Bowie would want it.
+
+What it doesn't do (yet)
+---
+
+Provide non-blocking drivers for everything. Right now the focus was to deal with the biggest concurrency problem for most apps, which is API calls to external websites. You don't have to make _everything_ non-blocking to speed up applications with this approach, which is the important thing to understand. For example, if your database access is under ten milliseconds, it's not as bad as an API call to an external web site that takes a few seconds. There are numerous non-blocking drivers available however, check out the [Protocol Implementations](https://github.com/eventmachine/eventmachine/wiki/Protocol-Implementations) page on the [EventMachine GitHub Wiki](https://github.com/eventmachine/eventmachine/wiki) for a full list. I would personally like to see plug-and-play drivers implemented for the major three ORMs (ActiveRecord, DataMapper, Sequel), because then I could simply drop them into this gem and you'd be non-blocking without requiring any special changes. For most of the web applications I work on, this would be all I need to eliminate my blocking IO problems forever!
+
+Installation
+---
+Install the gem:
+
+    gem install sinatra-synchrony
+
+Register with Sinatra __at the top, before any other middleware or plugins are loaded__:
+
+    require 'sinatra/synchrony'
+    class App < Sinatra::Base
+      register Sinatra::Synchrony
+    end
+    
+One important thing: __do not use Sinatra's internal session code__. So no "enable :sessions". Instead, enable the sessions directly via the [Rack::Session::Cookie](http://rack.rubyforge.org/doc/classes/Rack/Session/Cookie.html) middleware (there is no consequence to doing this, Sinatra does the same thing under the hood.. it just does it in the wrong load order):
+
+    class App < Sinatra::Base
+      register Sinatra::Synchrony
+      use Rack::Session::Cookie, :secret => 'CHANGE ME TO SOMETHING!'
+    end
+
+Tests
+---
+
+Just write your tests as usual, my Rack::Test patch fixes the "outside of EventMachine" errors. You must be in the __test__ environment so that Sinatra will not load Rack::FiberPool. My patch admittedly needs some work.
+
+Benchmarks
+---
+It's pretty fast!
+
+    class App < Sinatra::Base
+      register Sinatra::Synchrony
+      get '/' do
+        'Hello World!'
+      end
+    end
+
+run with rackup -s thin:
+
+    $ ab -c 50 -n 2000 http://127.0.0.1:9292/
+    ...
+    Requests per second:    3102.30 [#/sec] (mean)
+    Time per request:       16.117 [ms] (mean)
+    Time per request:       0.322 [ms] (mean, across all concurrent requests)
+
+    Connection Times (ms)
+                  min  mean[+/-sd] median   max
+    Connect:        0    0   0.1      0       1
+    Processing:     5   16   7.7     13      38
+    Waiting:        3   13   7.0     10      35
+    Total:          6   16   7.7     13      38
+
+Let's try a simple blocking IO example to prove it works. 100 hits to google.com:
+
+    require 'rest-client'
+    
+    class App < Sinatra::Base
+      register Sinatra::Synchrony
+      get '/' do
+        # Using EventMachine::HttpRequest
+        # EM::Synchrony.sync(EventMachine::HttpRequest.new('http://google.com').get).response
+
+        # Using RestClient, which gets concurrency via patched TCPSocket, no changes required!
+        RestClient.get 'http://google.com'
+      end 
+    end
+
+    $ ab -c 100 -n 100 http://127.0.0.1:9292/
+    ...
+    Time taken for tests:   1.270 seconds
+    
+For a perspective, this operation takes __33 seconds__ without this extension. That's __26x__ faster!
+
+TODO / Thoughts
+---
+* This is fairly alpha. Please test before deploying to production.
+* Provide better method for patching Rack::Test that's less fragile to version changes. This is a big priority and I intend to improve this. Pull requests here welcome!
+* Research way to run tests with Rack::FiberPool enabled.
+
+Author
+---
+* [Kyle Drake](http://kyledrake.net)
+
+Thanks
+---
+* [Ilya Grigorik](http://www.igvita.com) and [PostRank](http://www.postrank.com) for their amazing work on em-synchrony, em-http-request, and countless articles explaining this.
+* [Mike Perham](http://www.mikeperham.com) and [Carbon Five](http://carbonfive.com). For rack-fiber_pool, em-resolv-replace, and many blog posts and presentations on this.
+* [Konstantin Haase](http://rkh.im/) for async-rack and his many contributions to Sinatra.
+* The many Sinatra developers that liberated me from framework hell, and EventMachine developers that liberated me from blocking IO hell.

data/lib/rack/test_synchrony.rb

@@ -0,0 +1,25 @@
+require 'rack/test'
+# Monkeypatch to provide EM within tests.
+# If you have a better approach, please send a pull request!
+
+module Rack
+  class MockSession
+    def request(uri, env)
+      env["HTTP_COOKIE"] ||= cookie_jar.for(uri)
+      @last_request = Rack::Request.new(env)
+      EM.synchrony do
+        status, headers, body = @app.call(@last_request.env)
+        @last_response = MockResponse.new(status, headers, body, env["rack.errors"].flush)
+        body.close if body.respond_to?(:close)
+        cookie_jar.merge(last_response.headers["Set-Cookie"], uri)
+        @after_request.each { |hook| hook.call }
+        if @last_response.respond_to?(:finish)
+          @last_response.finish
+        else
+          @last_response
+        end
+        EM.stop
+      end
+    end
+  end
+end

data/lib/sinatra/synchrony.rb

@@ -0,0 +1,22 @@
+require 'sinatra/base'
+require 'rack/fiber_pool'
+require 'async-rack'
+require 'eventmachine'
+require 'em-http-request'
+require 'em-synchrony'
+require 'em-resolv-replace'
+require 'net/http'
+
+original_verbosity = $VERBOSE
+$VERBOSE = nil
+TCPSocket = EventMachine::Synchrony::TCPSocket
+$VERBOSE = original_verbosity
+
+module Sinatra
+  module Synchrony
+    def self.registered(app)
+      app.use Rack::FiberPool unless app.test?
+    end
+  end
+  register Synchrony
+end

data/spec/synchrony_spec.rb

@@ -0,0 +1,29 @@
+ENV['RACK_ENV'] = 'test'
+require File.join(File.join(File.expand_path(File.dirname(__FILE__))), '..', 'lib', 'sinatra', 'synchrony')
+require File.join(File.join(File.expand_path(File.dirname(__FILE__))), '..', 'lib', 'rack', 'test_synchrony')
+require 'minitest/autorun'
+require 'wrong/adapters/minitest'
+Wrong.config.alias_assert :expect
+
+def mock_app(base=Sinatra::Base, &block)
+  @app = Sinatra.new(base, &block)
+  @app.set :environment, :test
+  @app.disable :show_exceptions
+  @app.register Sinatra::Synchrony
+end
+def app; @app end
+
+describe 'A mock app' do
+  include Rack::Test::Methods
+  it 'successfully completes a sleep call' do
+    mock_app {
+      get '/?' do
+        EM::Synchrony.sleep(0.0001)
+        'ok'
+      end
+    }
+    get '/'
+    expect { last_response.ok? }
+    expect { last_response.body == 'ok' }
+  end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-synchrony
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kyle Drake
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-fiber_pool
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: async-rack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 5
+        - 1
+        version: 0.5.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: em-synchrony
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: em-resolv-replace
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 1
+        - 1
+        version: 1.1.1
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 5
+        - 7
+        version: 0.5.7
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: wrong
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :development
+  version_requirements: *id008
+description: Bootstraps in code required to take advantage of EventMachine/EM-Synchrony's concurrency enhancements for slow IO. Patches TCPSocket, which makes anything based on it EM-aware (including RestClient). Includes patch for tests. Requires ruby 1.9.
+email: 
+- kyledrake@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/sinatra/synchrony.rb
+- lib/rack/test_synchrony.rb
+- spec/synchrony_spec.rb
+- Gemfile
+- README.markdown
+homepage: https://github.com/kyledrake/sinatra-synchrony
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 19
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: sinatra-synchrony
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Bootstraps Sinatra with EM-Synchrony code, make TCPSocket EM-aware, provides support for tests
+test_files: []
+