sinatra-sse 0.1

data/README.md

@@ -0,0 +1,44 @@
+# sinatra-sse
+
+Sinatra support for server-sent events. The sinatra-sse gem needs a web server, which
+supports async operation. It is tested with thin.
+ 
+## Installation
+
+    gem install sinatra-sse
+
+## Getting started: the timer example
+
+The timer example (in example/config.ru) sends time information over an SSE stream, like this:
+
+    require "sinatra/base"
+    require "sinatra/see"
+
+    class TimeServer < Sinatra::Base
+      include Sinatra::SSE
+  
+      get '/' do
+        sse_stream do |out|
+          EM.add_periodic_timer(1) do 
+            out.push :event => "timer", :data => Time.now.to_s
+          end
+        end
+      end
+    end
+
+## Run the example
+
+The SSE specs define the "text/event-stream" content type. Conforming clients 
+send these in the "Accept:" header, and conforming servers set the "Content-Type:"
+header accordingly.
+
+    1.9.2 ~/sinatra-sse/lib[master] > curl -s -H "Accept: text/event-stream" http://0.0.0.0:9292
+    event: timer
+    data: 2012-10-21 11:21:48 +0200
+
+    event: timer
+    data: 2012-10-21 11:21:49 +0200
+
+## License
+
+The sinatra-sse gem is (c) radiospiel, 2012; it is distributed under the terms of the Modified BSD License, see LICENSE.BSD for details.

data/lib/sinatra/sse.rb

@@ -0,0 +1,83 @@
+# This file is part of the sinatra-sse ruby gem.
+#
+# Copyright (c) 2011, 2012 @radiospiel
+# Distributed under the terms of the modified BSD license, see LICENSE.BSD
+
+module Sinatra::SSE
+end
+
+require_relative "sse/version"
+require_relative "sse/marshal"
+
+# Support for SSE streams.
+#
+# The Sinatra::SSE module adds support for streaming server sent events.
+#
+# It wraps a sinatra stream (via <tt>stream :keep_open</tt>) in a structure
+# which
+#
+# - formats events according to the SSE specs, and
+# - keeps the connection alive by sending some data every 28 seconds.
+#
+module Sinatra::SSE
+  extend Marshal
+  
+  # The keepalive period.
+  KEEP_ALIVE = 28
+
+  # The SSEStream class wraps a connection as created via the Sinatra
+  # stream helper.
+  class Stream #:nodoc:
+    def initialize(out)
+      @out = out
+
+      @out.callback do
+        cancel_keepalive_timer
+        @callback.call if @callback
+      end
+
+      reset_keepalive_timer
+    end
+    
+    def close
+      @out.close
+    end
+    
+    # set a callback block.
+    def callback(&block)
+      @callback = Proc.new
+    end
+    
+    # Push an event to the client.
+    def push(hash)
+      raise ArgumentError unless hash.is_a?(Hash)
+      
+      @out << Sinatra::SSE.marshal(hash)
+      reset_keepalive_timer
+    end
+    
+    private
+    
+    def cancel_keepalive_timer #:nodoc:
+      @timer.cancel if @timer
+    end
+
+    def reset_keepalive_timer #:nodoc:
+      cancel_keepalive_timer
+      @timer = EventMachine::PeriodicTimer.new(KEEP_ALIVE) { send_keepalive_traffic }
+    end
+    
+    def send_keepalive_traffic #:nodoc:
+      @out << " \n"
+    end
+  end
+
+  # Start a SSE stream.
+  def sse_stream(&block)
+    content_type "text/event-stream"
+
+    stream :keep_open do |out|
+      yield Sinatra::SSE::Stream.new(out)
+    end
+  end
+end

data/lib/sinatra/sse/marshal.rb

@@ -0,0 +1,64 @@
+# This file is part of the sinatra-sse ruby gem.
+#
+# Copyright (c) 2011, 2012 @radiospiel
+# Distributed under the terms of the modified BSD license, see LICENSE.BSD
+
+require "expectation"
+
+#
+# packing/unpacking SSE events
+module Sinatra::SSE::Marshal
+  FIXED_ORDER = {
+    :event  => 1,
+    :id     => 2,
+    :data   => 3
+  } #:nodoc:
+
+  # converts an object into an event.
+  #
+  # The object must be a hash or a String.
+  def marshal(object)
+    expect! object => [ String, Hash ]
+    
+    if object.is_a?(String)
+      object = { :data => object }
+    end
+    
+    # sort all entries in a way, that make sure that event, id, data
+    # are at the end. This makes sure that confirming clients just
+    # ignore the extra entries. If we would just send them in random
+    # order we might produce "bogus" events, when "data", "event",
+    # and "id" are separated by invalid entries. 
+    entries = object.sort_by { |key, value| FIXED_ORDER[key.to_sym] || 0 }
+
+    entries.map do |key, value|
+      escaped_value = value.gsub(/(\r\n|\r|\n)/, "\n#{key}: ")
+      "#{key}: #{escaped_value}\n"
+    end.join + "\n"
+  end
+
+  # Unmarshals a single event in data. The string SHOULD NOT contain 
+  # multipe events, or else the returned hash somehow mangles all these
+  # events into a single one.
+  def unmarshal(data)
+    event = Hash.new { |hash, key| hash[key] = [] }
+
+    data.split("\n").each do |line|
+      key, value = line.split(/: ?/, 2)
+      next if key =~ /^\s*$/
+
+      event[key.to_sym] << value
+    end
+
+    event.inject({}) do |hash, (key, value)|
+      hash.update key => value.join("\n")
+    end
+  end
+
+  # Extract all events from a data stream.
+  def unmarshal_all(data)
+    data.split(/\n\n/).
+      map { |event| unpack(event) }.
+      reject(&:empty?)
+  end
+end

data/lib/sinatra/sse/version.rb

@@ -0,0 +1,12 @@
+# This file is part of the sinatra-sse ruby gem.
+#
+# Copyright (c) 2011, 2012 @radiospiel
+# Distributed under the terms of the modified BSD license, see LICENSE.BSD
+
+module Sinatra #:nodoc:
+end
+
+module Sinatra::SSE
+  # The Sinatra::SSE version number
+  VERSION = "0.1"
+end

data/test/expect_test.rb

@@ -0,0 +1,119 @@
+# Author::    radiospiel  (mailto:eno@radiospiel.org)
+# Copyright:: Copyright (c) 2011, 2012 radiospiel
+# License::   Distributes under the terms  of the Modified BSD License, see LICENSE.BSD for details.
+require_relative 'test_helper'
+
+class ExpectationTest < Test::Unit::TestCase
+  def assert_expectation!(*expectation, &block)
+    assert_nothing_raised do
+      expect! *expectation, &block
+    end
+  end
+  
+  def assert_failed_expectation!(*expectation, &block)
+    assert_raise(ArgumentError) {  
+      expect! *expectation, &block
+    }
+  end
+
+  def assert_expectation(*expectation, &block)
+    assert_nothing_raised do
+      expect *expectation, &block
+    end
+  end
+  
+  def assert_failed_expectation(*expectation, &block)
+    assert_raise(ArgumentError) {  
+      expect *expectation, &block
+    }
+  end
+  
+  # Verify that the exception's backtrace is properly adjusted,
+  # i.e. points to this file.
+  def test_expectations_backtrace
+    backtrace = nil
+    
+    begin
+      expect! 1 => 0
+    rescue 
+      backtrace = $!.backtrace
+    end
+    assert backtrace.first.include?("/expect_test.rb:")
+  end
+  
+  def test_int_expectations
+    assert_expectation! 1 => 1
+    assert_expectation! 1 => Fixnum
+    assert_expectation! 1 => Integer
+    assert_expectation! 1 => 0..2
+    assert_expectation! 1 => 0..1
+    assert_expectation! 1 => 1..10
+    assert_expectation! 1 => [0,1,2]
+    assert_expectation! 1 => lambda { |i| i.odd? }
+    
+    assert_failed_expectation! 1 => 2
+    assert_failed_expectation! 1 => Float
+    assert_failed_expectation! 1 => 0...1
+    assert_failed_expectation! 1 => 3..5
+    assert_failed_expectation! 1 => [3,4,5]
+    assert_failed_expectation! 1 => lambda { |i| i.even? }
+  end
+  
+  def test_regexp_expectations
+    assert_expectation! " foo" => /foo/
+    assert_failed_expectation! " foo" => /^foo/
+
+    assert_expectation! "1" => /1/
+    assert_failed_expectation! "1" => /2/
+
+    assert_failed_expectation! 1 => /1/
+    assert_failed_expectation! 1 => /2/
+  end
+  
+  def test_multiple_expectations
+    assert_expectation! 1 => 1, :a => :a
+    assert_failed_expectation! 1 => 2, :a => :a
+  end
+
+  def test_array_expectations
+    assert_expectation! 1, 1, 1, /1/
+    assert_expectation! 1, 1, "1" => /1/
+    
+    assert_failed_expectation! 1, 1, "1" => /2/
+    assert_failed_expectation! 1, 1, 1 => /2/
+    assert_failed_expectation! 1, nil, "1" => /1/
+    assert_failed_expectation! 1, false, "1" => /1/
+  end
+
+  def test_block_expectations
+    assert_expectation! do true end
+    assert_failed_expectation! do false end
+    assert_failed_expectation! do nil end
+  end
+
+  def test_hash_expectations
+    assert_failed_expectation!({} => { :key => "Foo" })
+    assert_expectation!({ :key => "Foo" } => { :key => "Foo" })
+
+    assert_failed_expectation!({ :other_key => "Foo" } => { :key => "Foo" })
+    assert_failed_expectation!({ :key => "Bar" } => { :key => "Foo" })
+
+    assert_expectation!({ :key => "Foo" } => { :key => String })
+    assert_expectation!({ :key => "Foo" } => { :key => [Integer,String] })
+    assert_failed_expectation!({ :key => "Foo" } => { :key => [Integer,"Bar"] })
+    assert_expectation!({ :other_key => "Foo" } => { :key => [nil, "Foo"] })
+  end
+
+  def test_enable_and_disable
+    assert_failed_expectation! "foo" => "bar"
+    assert_failed_expectation "foo" => "bar"
+
+    Expectation.disable
+    assert_failed_expectation! "foo" => "bar"
+    assert_expectation "foo" => "bar"
+
+    Expectation.enable
+    assert_failed_expectation! "foo" => "bar"
+    assert_failed_expectation "foo" => "bar"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'simplecov'
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+
+class Test::Unit::UI::Console::TestRunner
+  def guess_color_availability; true; end
+end
+
+require 'mocha'
+
+SimpleCov.start do
+  add_filter "test/*.rb"
+end
+
+require "expectation"

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-sse
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- radiospiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: expectation
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sinatra support for server sent events
+email: eno@radiospiel.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sinatra/sse/marshal.rb
+- lib/sinatra/sse/version.rb
+- lib/sinatra/sse.rb
+- README.md
+- test/expect_test.rb
+- test/test_helper.rb
+homepage: http://github.com/radiospiel/sinatra-sse
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3390148179988891335
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3390148179988891335
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sinatra support for server sent events
+test_files: []