roda-sse 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81bbd096f5155da3f8593b8e3d37771daedd543a9cf4816d5bab36f3192bb203
-  data.tar.gz: 88366dcfba9fb10fcf5a810c540c3ae5b77c9f52989cdea5c03ea1b0a9aa9641
+  metadata.gz: e63c433081f53c50061c380222d40ba9ea30bedd06b5d95982c3dcf9bbd15fa3
+  data.tar.gz: 5bd7d45309f2903e6a953d59b9c02e58c6e965d758859f990ba435eed1372f23
 SHA512:
-  metadata.gz: 8375dd84ecfefe94dafb591d5edfb1e22a3413aa0f574b7c7a965b1adcf7ef62cd70397fb133a8f0e2468183edae44f82208742d357f45a43a69e53d9f352e6c
-  data.tar.gz: 9bf26ed27a75bb355f1468baa668e0c3b569b9313d1468b60ac9aa6bbe7a2c142592011bacb7f931232e18a2bb90c932011b375a6b73e7d654a942ae0bb57210
+  metadata.gz: 18b52b5dd1fc76864d52c74ee81ede34cdc266f3dde68e83c7235aae3f96fdb0a9af1c6451afe6be0a63ee4bd68bc830b275ae371d7cb6ae3fb81b56bc2bf882
+  data.tar.gz: b862451ef7df47f104892033286e14de121a5716c2857f8b31ce3bda2db1d66d130cbd6bcef22ddeedfdcd166372ca6c2505704cf2750efd752362ecf371027c

data/README.md

@@ -1,6 +1,10 @@
 # roda-sse
 
-The roda-sse Roda plugin adds SSE headers and provides Rack 3 streaming for you to send your own events.
+The roda-sse Roda plugin adds SSE provides a streaming interface for
+server-sent events. Each stream is wrapped in an [Async](https://github.com/socketry/async) reactor
+and events are sent asyncronously via tasks. The roda-sse plugin sets
+appropriate SSE headers, handles disconnection errors, ensures
+streams are properly closed and provies a `last_event_id` helper.
 
 ## Installation
 
@@ -15,6 +19,8 @@ https://github.com/havenwood/roda-sse
 
 ## Usage
 
+See the [examples/](https://github.com/havenwood/roda-sse/tree/main/example) directory for an example app.
+
 roda-sse is a Roda plugin, so you need to load it into your Roda
 application similar to other plugins:
 
@@ -30,7 +36,5 @@ In your routing block, you can then use `r.sse` to stream with the correct heade
 r.sse do |stream|
   stream << "data: hello\n\n"
   stream << "data: world\n\n"
-ensure
-  stream.close
 end
 ```

data/lib/roda/plugins/sse.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'async'
+
 class Roda
   module RodaPlugins
     # Example:
@@ -11,22 +13,66 @@ class Roda
     #       # GET /
     #       r.sse do |stream|
     #         stream.write "data: hola\n\n"
-    #       ensure
-    #         stream.close
     #       end
     #     end
     #   end
     module SSE
+      class Output
+        def initialize(stream)
+          @stream = stream
+        end
+
+        def write(message)
+          data = message.to_s
+          @stream.write(data)
+          return data.bytesize
+        end
+
+        def <<(message)
+          write(message)
+          self
+        end
+
+        def close(error = nil)
+          if stream = @stream
+            @stream = nil
+            stream.close_write(error)
+          end
+        end
+      end
+
+      class Body
+        def initialize(block)
+          @block = block
+        end
+        
+        def call(stream)
+          output = Output.new(stream)
+          @block.call(output)
+        rescue => error
+        ensure
+          stream.close_write(error)
+        end
+      end
+
       module RequestMethods
-        def sse(&block)
-          response['Content-Type'] = 'text/event-stream'
-          response['Cache-Control'] = 'no-cache'
+        HEADERS = {
+          'content-type' => 'text/event-stream',
+          'cache-control' => 'no-cache',
+        }.freeze
 
-          always do
-            halt response.finish_with_body(block)
+        def sse(&block)
+          get do
+            halt [200, HEADERS.dup, Body.new(block)]
           end
         end
       end
+
+      module InstanceMethods
+        def last_event_id
+          env['HTTP_LAST_EVENT_ID']
+        end
+      end
     end
 
     register_plugin(:sse, SSE)

data/spec/roda-sse_spec.rb

@@ -12,9 +12,8 @@ class App < Roda
   route do |r|
     r.root do
       r.sse do |stream|
+        last_event_id
         stream.write "data: hola\n\n"
-      ensure
-        stream.close
       end
     end
   end
@@ -23,34 +22,42 @@ end
 def app = App.freeze.app
 
 describe 'roda-sse plugin' do
-  include Rack::Test::Methods
-
   prove_it!
 
-  it 'responds 200 OK' do
-    get '/'
+  describe 'roda app' do
+    include Rack::Test::Methods
 
-    assert last_response.ok?
-  end
+    it 'responds 200 OK' do
+      get '/'
 
-  it 'has SSE headers' do
-    get '/'
+      assert last_response.ok?
+    end
 
-    headers = {'content-type' => 'text/event-stream', 'cache-control' => 'no-cache'}
-    assert_equal headers, last_response.headers
-  end
+    it 'does not respond to PUT' do
+      post '/'
+
+      refute last_response.ok?
+    end
+
+    it 'has SSE headers' do
+      get '/'
 
-  it 'streams the body' do
-    get '/'
+      headers = {'content-type' => 'text/event-stream', 'cache-control' => 'no-cache'}
+      assert_equal headers, last_response.headers
+    end
 
-    stream = Minitest::Mock.new
-    stream.expect(:write, nil, ["data: hola\n\n"])
-    stream.expect(:close, nil)
-    response_body = last_response.instance_variable_get(:@body)
-    assert_instance_of Proc, response_body
+    it 'streams the body' do
+      get '/'
 
-    response_body.call(stream)
+      stream = Minitest::Mock.new
+      stream.expect(:write, nil, ["data: hola\n\n"])
+      stream.expect(:close_write, nil, [nil])
+      response_body = last_response.instance_variable_get(:@body)
+      assert_instance_of Roda::RodaPlugins::SSE::Body, response_body
 
-    stream.verify
+      response_body.call(stream)
+
+      stream.verify
+    end
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda-sse
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Shannon Skipper
+- Samuel Williams
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda
@@ -15,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.85'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.85'
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.18'
 description: The roda-sse gem integrates simple SSE streaming into the roda web toolkit.
 email: shannonskipper@gmail.com
 executables: []