reel 0.4.0.pre5 → 0.4.0.pre6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44aa1cfa32bf4e362a459a5f18377ac56db1f8c7
-  data.tar.gz: bbf8201bd08d1f803804bfde3857cea67b66d7fb
+  metadata.gz: 62ce6ab7ff51c2b2765a1f13a373135fe8f80f1d
+  data.tar.gz: 685cd6aaa68ba0abf31525113bcaa9dc1633e30e
 SHA512:
-  metadata.gz: 5fe52aa183298afe122e513a32782b04249af3024aedef8c30ed5ab59949bf73fd2b33341d957d2f39800c4b0b3e78f83ef9a279e9916ae58f9d7f585c64ed1a
-  data.tar.gz: 185e444d3044b97c939f94d8943039b3c5fcd6b5adb95a00c6cc044e8c003a489e9842270d4b95619b5fbd5472684134b839e12a061cb315729b8b82918dffc5
+  metadata.gz: 826bd08b859f751762f444d0ce4192c5efced88d41c1982b4f9488377fc4f051cabc79dadfe7a6859b120313c4e796713bb67b82aa06a85218e2bd7ab4490362
+  data.tar.gz: 47fe6ce99b5571deeffeb3909a42bb2b715ddf63e9bfb3b70a487efe4613f059257a1295202d1d4f04869053723712e00d8c1308358023b103ab6084e003eb76

data/CHANGES.md

@@ -1,4 +1,4 @@
-0.4.0.pre5
+0.4.0.pre6
 ----------
 * Rack adapter moved to the reel-rack project
 * Pipelining support

data/Gemfile

@@ -1,7 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'celluloid',    github: 'celluloid/celluloid',    branch: 'master'
-gem 'celluloid-io', github: 'celluloid/celluloid-io', branch: 'master'
+gem 'celluloid',    github: 'celluloid/celluloid'
+gem 'celluloid-io', github: 'celluloid/celluloid-io'
+gem 'http',         github: 'tarcieri/http'
 
 gem 'jruby-openssl' if defined? JRUBY_VERSION
 gem 'coveralls', require: false

data/README.md

@@ -59,8 +59,58 @@ Node.js (0.6.5)     11735 reqs/s  (0.1 ms/req)
 All Ruby benchmarks done on Ruby 1.9.3. Latencies given are average-per-request
 and are not amortized across all concurrent requests.
 
-API
----
+Framework Adapters
+------------------
+
+### Rack
+
+A Rack adapter for Reel is available at:
+
+https://github.com/celluloid/reel-rack
+
+### Webmachine
+
+The most notable library with native Reel support is
+[webmachine-ruby](https://github.com/seancribbs/webmachine-ruby),
+an advanced HTTP framework for Ruby with a complete state machine for proper
+processing of HTTP/1.1 requests. Together with Reel, Webmachine provides
+full streaming support for both requests and responses.
+
+To use Reel with Webmachine, add the following to your Gemfile:
+
+```ruby
+gem 'webmachine', git: 'git://github.com/seancribbs/webmachine-ruby.git'
+```
+
+Then use `config.adapter = :Reel` when configuring a Webmachine app, e.g:
+
+```ruby
+MyApp = Webmachine::Application.new do |app|
+  app.routes do
+    add ['*'], MyHome
+  end
+
+  app.configure do |config|
+    config.ip      = MYAPP_IP
+    config.port    = MYAPP_PORT
+    config.adapter = :Reel
+
+    # Optional: handler for incoming websockets
+    config.adapter_options[:websocket_handler] = proc do |websocket|
+      # socket is a Reel::WebSocket
+      socket << "hello, world"
+    end
+  end
+end
+
+MyApp.run
+```
+
+See the [Webmachine documentation](http://rubydoc.info/gems/webmachine/frames/file/README.md)
+for further information
+
+Ruby API
+--------
 
 *NOTE: these examples are for the Reel 0.4.0.pre2 API*
 
@@ -134,56 +184,6 @@ end
 MyServer.run
 ```
 
-Framework Adapters
-------------------
-
-### Rack
-
-A Rack adapter for Reel is available at:
-
-https://github.com/celluloid/reel-rack
-
-### Webmachine
-
-The most notable library with native Reel support is
-[webmachine-ruby](https://github.com/seancribbs/webmachine-ruby),
-an advanced HTTP framework for Ruby with a complete state machine for proper
-processing of HTTP/1.1 requests. Together with Reel, Webmachine provides
-full streaming support for both requests and responses.
-
-To use Reel with Webmachine, add the following to your Gemfile:
-
-```ruby
-gem 'webmachine', git: 'git://github.com/seancribbs/webmachine-ruby.git'
-```
-
-Then use `config.adapter = :Reel` when configuring a Webmachine app, e.g:
-
-```ruby
-MyApp = Webmachine::Application.new do |app|
-  app.routes do
-    add ['*'], MyHome
-  end
-
-  app.configure do |config|
-    config.ip      = MYAPP_IP
-    config.port    = MYAPP_PORT
-    config.adapter = :Reel
-
-    # Optional: handler for incoming websockets
-    config.adapter_options[:websocket_handler] = proc do |websocket|
-      # socket is a Reel::WebSocket
-      socket << "hello, world"
-    end
-  end
-end
-
-MyApp.run
-```
-
-See the [Webmachine documentation](http://rubydoc.info/gems/webmachine/frames/file/README.md)
-for further information
-
 Contributing
 ------------
 

data/examples/server_sent_events.rb

@@ -0,0 +1,115 @@
+#!/usr/bin/env ruby
+# Run with: bundle exec examples/server_sent_events.rb
+# Test with: curl -vNH 'Accept: text/event-stream' -H 'Last-Event-ID: 1' -H 'Cache-Control: no-cache' http://localhost:63310
+
+require 'bundler/setup'
+require 'time'
+require 'reel'
+
+class ServerSentEvents < Reel::Server
+  include Celluloid::Logger
+  
+  def initialize(ip = '127.0.0.1', port = 63310)
+    @connections = []
+    @history = []
+    @lastMessageId = 0
+    async.ping
+    async.ring
+    super(ip, port, &method(:on_connection))
+  end
+
+  def broadcast(event, data)
+    #only keep the last 5000 Events
+    if @history.size >= 6000
+      @history.slice!(0, @history.size - 1000)
+    end
+    @lastMessageId += 1
+    @history << {id: @lastMessageId, event: event, data: data}
+    info "Sending Event: #{event} Data: #{data} to #{@connections.count} Clients"
+    @connections.each do |socket|
+      async.send_sse(socket, data, event, @lastMessageId)
+    end
+    true
+  end
+
+  private
+  #event and id are optional
+  def send_sse(socket, data, event = nil, id = nil)
+    begin
+      socket.id id if id
+      socket.event event if event
+      socket.data data
+    rescue IOError, Errno::ECONNRESET, Errno::EPIPE
+      @connections.delete(socket)
+    end
+  end
+
+  def send_ping
+    @connections.each do |socket|
+      begin
+        #Lines that start with a Colon are Comments and will be ignored
+        socket << ":\n"
+      rescue IOError, Errno::ECONNRESET, Errno::EPIPE
+        @connections.delete(socket)
+      end
+    end
+  end
+
+  def ping
+    #apache 2.2 closes connections after five seconds when nothing is send
+    every(5) do
+      send_ping
+    end
+  end
+
+  def ring
+    every(2) do
+      broadcast(:time, Time.now.httpdate)
+    end
+  end
+
+  def handle_request(request)
+    query = {}
+    (request.query_string || '').split('&').each do |kv|
+      key, value = kv.split('=')
+      if key && value
+        key, value = CGI.unescape(key), CGI.unescape(value)
+        query[key] = value
+      end
+    end
+    body = Reel::EventStream.new do |socket|
+      @connections << socket
+      socket.retry 5000
+      #after a Connection reset resend newer Messages to the Client
+      if @history.count > 0 && id = (request.headers['Last-Event-ID'] || query['lastEventId'])
+        begin
+          id = Integer(id)
+          if history = @history.select {|h| h[:id] >= id}.map {|a| "id: %d\nevent: %s\ndata: %s" % [a[:id], a[:event], a[:data]]}.join("\n\n")
+            socket << "%s\n\n" % [history]
+          else
+            socket << "id\n\n"
+          end
+        rescue ArgumentError, IOError, Errno::ECONNRESET, Errno::EPIPE
+          @connections.delete(socket)
+          request.close
+        end
+      else
+        socket << "id\n\n"
+      end
+    end
+    #X-Accel-Buffering is nginx(?) specific. Setting this to "no" will allow unbuffered responses suitable for Comet and HTTP streaming applications
+    request.respond Reel::StreamResponse.new(:ok, {
+      'Content-Type' => 'text/event-stream; charset=utf-8',
+      'Cache-Control' => 'no-cache',
+      'X-Accel-Buffering' => 'no',
+      'Access-Control-Allow-Origin' => '*'}, body)
+  end
+
+  def on_connection(connection)
+    connection.each_request do |request|
+      handle_request(request)
+    end
+  end
+end
+
+ServerSentEvents.run

data/lib/reel/response.rb

@@ -1,13 +1,14 @@
 module Reel
   class Response
+    include HTTP::Header
 
     CONTENT_LENGTH     = 'Content-Length'.freeze
     TRANSFER_ENCODING  = 'Transfer-Encoding'.freeze
     CHUNKED            = 'chunked'.freeze
 
-    # Use status code tables from the Http gem
-    STATUS_CODES          = Http::Response::STATUS_CODES
-    SYMBOL_TO_STATUS_CODE = Http::Response::SYMBOL_TO_STATUS_CODE
+    # Use status code tables from the HTTP gem
+    STATUS_CODES          = HTTP::Response::STATUS_CODES
+    SYMBOL_TO_STATUS_CODE = HTTP::Response::SYMBOL_TO_STATUS_CODE
 
     attr_reader   :status # Status has a special setter to coerce symbol names
     attr_accessor :reason # Reason can be set explicitly if desired
@@ -62,7 +63,7 @@ module Reel
 
     def canonicalize_headers(headers)
       headers.inject({}) do |headers, (header, value)|
-        headers.merge Http.canonicalize_header(header) => value.to_s
+        headers.merge canonicalize_header(header) => value.to_s
       end.freeze
     end
     private :canonicalize_headers

data/lib/reel/version.rb

@@ -1,4 +1,4 @@
 module Reel
-  VERSION  = "0.4.0.pre5"
+  VERSION  = "0.4.0.pre6"
   CODENAME = "Garbo"
 end

data/spec/reel/response_spec.rb

@@ -15,4 +15,17 @@ describe Reel::Response do
       response[(response.length - fixture.length)..-1].should eq fixture
     end
   end
+
+  it "canonicalizes response headers" do
+    with_socket_pair do |client, connection|
+      client << ExampleRequest.new.to_s
+      request = connection.request
+
+      connection.respond Reel::Response.new(:ok, {"content-type" => "application/json"}, "['mmmkay']")
+      connection.close
+
+      response = client.read(4096)
+      expect(response["Content-Type: application/json"]).to_not be_nil
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reel
 version: !ruby/object:Gem::Version
-  version: 0.4.0.pre5
+  version: 0.4.0.pre6
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-08 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -131,6 +131,7 @@ files:
 - examples/chunked.rb
 - examples/hello_world.rb
 - examples/roundtrip.rb
+- examples/server_sent_events.rb
 - examples/ssl_hello_world.rb
 - examples/websockets.rb
 - lib/reel.rb
@@ -198,3 +199,4 @@ test_files:
 - spec/reel/ssl_server_spec.rb
 - spec/reel/websocket_spec.rb
 - spec/spec_helper.rb
+has_rdoc: