/async_sinatra

A plugin for Sinatra to provide a DSL extension for using Thin for asynchronous responses

Primary LanguageRuby

async_sinatra

github.com/raggi/async_sinatra

DESCRIPTION:

A Sinatra plugin to provide convenience whilst performing asynchronous responses inside of the Sinatra framework running under async webservers.

To properly utilise this package, some knowledge of EventMachine and/or asynchronous patterns is recommended.

Currently, supporting servers include:

  • Thin

  • Rainbows

  • Zbatery

SYNOPSIS:

A quick example:

require 'sinatra/async'

class AsyncTest < Sinatra::Base
  register Sinatra::Async

  aget '/' do
    body "hello async"
  end

  aget '/delay/:n' do |n|
    EM.add_timer(n.to_i) { body { "delayed for #{n} seconds" } }
  end

end

See Sinatra::Async for more details.

REQUIREMENTS:

  • Sinatra (>= 1.3.2)

  • An async webserver

INSTALL:

  • gem install async_sinatra

LICENSE:

(The MIT License)

Copyright © 2009 James Tucker

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.