roda-sse 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81bbd096f5155da3f8593b8e3d37771daedd543a9cf4816d5bab36f3192bb203
+  data.tar.gz: 88366dcfba9fb10fcf5a810c540c3ae5b77c9f52989cdea5c03ea1b0a9aa9641
+SHA512:
+  metadata.gz: 8375dd84ecfefe94dafb591d5edfb1e22a3413aa0f574b7c7a965b1adcf7ef62cd70397fb133a8f0e2468183edae44f82208742d357f45a43a69e53d9f352e6c
+  data.tar.gz: 9bf26ed27a75bb355f1468baa668e0c3b569b9313d1468b60ac9aa6bbe7a2c142592011bacb7f931232e18a2bb90c932011b375a6b73e7d654a942ae0bb57210

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest', '~> 5.2'
+gem 'minitest-proveit', '~> 1.0'
+gem 'rack-test', '~> 2.1'

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) Shannon Skipper
+
+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 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.

data/README.md

@@ -0,0 +1,36 @@
+# roda-sse
+
+The roda-sse Roda plugin adds SSE headers and provides Rack 3 streaming for you to send your own events.
+
+## Installation
+
+```sh
+gem install roda-sse
+```
+
+## Source Code
+
+Source code is available on GitHub at
+https://github.com/havenwood/roda-sse
+
+## Usage
+
+roda-sse is a Roda plugin, so you need to load it into your Roda
+application similar to other plugins:
+
+```ruby
+class App < Roda
+  plugin :sse
+end
+```
+
+In your routing block, you can then use `r.sse` to stream with the correct headers.
+
+```ruby
+r.sse do |stream|
+  stream << "data: hello\n\n"
+  stream << "data: world\n\n"
+ensure
+  stream.close
+end
+```

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/clean'
+require 'rake/testtask'
+
+CLEAN.include %w[pkg/roda-sse-*.gem].freeze
+
+task default: :test
+
+Rake::TestTask.new do |test|
+  test.pattern = 'spec/**/*_spec.rb'
+  test.warning = false
+end

data/lib/roda/plugins/sse.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Roda
+  module RodaPlugins
+    # Example:
+    #
+    #   plugin :sse
+    #
+    #   route do |r|
+    #     r.root do
+    #       # GET /
+    #       r.sse do |stream|
+    #         stream.write "data: hola\n\n"
+    #       ensure
+    #         stream.close
+    #       end
+    #     end
+    #   end
+    module SSE
+      module RequestMethods
+        def sse(&block)
+          response['Content-Type'] = 'text/event-stream'
+          response['Cache-Control'] = 'no-cache'
+
+          always do
+            halt response.finish_with_body(block)
+          end
+        end
+      end
+    end
+
+    register_plugin(:sse, SSE)
+  end
+end

data/spec/roda-sse_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'rack/test'
+require 'roda'
+
+class App < Roda
+  plugin :sse
+
+  route do |r|
+    r.root do
+      r.sse do |stream|
+        stream.write "data: hola\n\n"
+      ensure
+        stream.close
+      end
+    end
+  end
+end
+
+def app = App.freeze.app
+
+describe 'roda-sse plugin' do
+  include Rack::Test::Methods
+
+  prove_it!
+
+  it 'responds 200 OK' do
+    get '/'
+
+    assert last_response.ok?
+  end
+
+  it 'has SSE headers' do
+    get '/'
+
+    headers = {'content-type' => 'text/event-stream', 'cache-control' => 'no-cache'}
+    assert_equal headers, last_response.headers
+  end
+
+  it 'streams the body' do
+    get '/'
+
+    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
+
+    response_body.call(stream)
+
+    stream.verify
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: roda-sse
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shannon Skipper
+bindir: bin
+cert_chain: []
+date: 2024-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The roda-sse gem integrates simple SSE streaming into the roda web toolkit.
+email: shannonskipper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/roda/plugins/sse.rb
+- spec/roda-sse_spec.rb
+homepage: https://github.com/havenwood/roda-sse
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+specification_version: 4
+summary: SSE integration for Roda
+test_files: []