sse-rails-engine 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ba7d9cea724ef6cd38b1ae06f4b0a037e575cee
-  data.tar.gz: 8aef607c6e1908f4a07571842e59667271d44da1
+  metadata.gz: 215385adafbeb44e44ff64603e5e4777206f100a
+  data.tar.gz: 18f56fa8185eaa46cc67ef115d0123ee895d3cd7
 SHA512:
-  metadata.gz: c433f71bb37b808669f96d6cddcb77c7547258329d5c3d40149a735375a807a3ae1a46534790a424b91d3631d4e8e72cbc5e172684f2955b24cbf18efbf84984
-  data.tar.gz: 7d7965dd774c11512ffc7d156ef52753b0c478a3759dd36486e64fcd1305cecbebe085c65443974ff6862ba8837a02f9b21b76917f957c732a87f76fe395b600
+  metadata.gz: 57a701b21132ca315e60e79c93527eb1d35d4276b45f2c79059b3209909e360f43fdd9e699f1ac94fd2cfadb252c2c335b1f837c81fbd98661705df26e12456f
+  data.tar.gz: 5651157dba6581bb886589cb7f9b48cc116982c54d05427ae46e85d85eb42b0915ac1ac8b7a854588722fcce14d38690ab379aac139c16029e55b4cc6729a7bd

data/Rakefile

@@ -14,12 +14,8 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
 load 'rails/tasks/statistics.rake'
 
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -31,5 +27,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/config/initializers/sse_rails_engine.rb

@@ -1,2 +1,2 @@
 
-Rails.configuration.middleware.delete "Rack::Lock"
+Rails.configuration.middleware.delete 'Rack::Lock'

data/lib/sse_rails_engine/manager.rb

@@ -1,14 +1,26 @@
 module SseRailsEngine
+  # This class provides the ability to track SSE connections and broadcast events
+  # to all connected clients from anywhere in your Rails app.
+  #
+  # Example Usage:
+  #
+  #   class MyController < ActionController::Base
+  #     def do_stuff
+  #       SseRailsEngine.send_event('event name', 'any ruby object or string for data')
+  #     end
+  #   end
+  #
+  # Note: SSEs are not currently supported by IE.
   class Manager
     RackHijackUnsupported = Class.new RuntimeError
 
     attr_reader :connections, :heartbeat_thread
 
     SSE_HEADER = ["HTTP/1.1 200 OK\r\n",
-      "Content-Type: text/event-stream\r\n",
-      "Cache-Control: no-cache, no-store\r\n",
-      "Connection: close\r\n",
-      "\r\n"].join.freeze
+                  "Content-Type: text/event-stream\r\n",
+                  "Cache-Control: no-cache, no-store\r\n",
+                  "Connection: close\r\n",
+                  "\r\n"].join.freeze
 
     def initialize
       @mutex = Mutex.new
@@ -23,10 +35,11 @@ module SseRailsEngine
         # Perform full hijack of socket (http://old.blog.phusion.nl/2013/01/23/the-new-rack-socket-hijacking-api/)
         SseRailsEngine.manager.open_connection(socket)
       else
-        raise RackHijackUnsupported, 'This Rack server does not support hijacking, ensure you are using >= v1.5 of Rack'
+        fail RackHijackUnsupported, 'This Rack server does not support hijacking, ensure you are using >= v1.5 of Rack'
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def send_event(name, data)
       @mutex.synchronize do
         @connections.dup.each do |stream, sse|
@@ -43,6 +56,7 @@ module SseRailsEngine
         end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def open_connection(io)
       Rails.logger.debug "New SSE Client connected: #{io}"
@@ -54,7 +68,7 @@ module SseRailsEngine
 
     def call(env)
       SseRailsEngine.manager.register(env)
-      [ -1, {}, []]
+      [-1, {}, []]
     end
 
     private

data/lib/sse_rails_engine/version.rb

@@ -1,3 +1,3 @@
 module SseRailsEngine
-  VERSION = "1.2.1"
+  VERSION = '1.2.2'
 end

data/test/dummy/log/test.log

@@ -71,3 +71,77 @@ Starting SSE heartbeat thread!
 New SSE Client connected: #<StringIO:0x007ff339278948>
 Starting SSE heartbeat thread!
 Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcdfb259ec0>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcdfb230ef8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcdfb21bc88>
+Failed to send event to SSE: #<StringIO:0x007fcdfb21bc88> (foo, bar - RuntimeError (RuntimeError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcdfb2035c0>
+SSE Client disconnected: #<StringIO:0x007fcdfb2035c0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcdfb200938>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fcdfb1fa290>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fa81cd396b0>
+Failed to send event to SSE: #<StringIO:0x007fa81cd396b0> (foo, bar - RuntimeError (RuntimeError
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fa81cd33288>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fa81cd23b58>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fa81cd21038>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fa81cd13c80>
+SSE Client disconnected: #<StringIO:0x007fa81cd13c80>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fa81cd10cd8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fd37d510920>
+Failed to send event to SSE: #<StringIO:0x007fd37d510920> (foo, bar - RuntimeError (RuntimeError
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fd37d4f9a40>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fd37d4d8368>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fd37d4c2a68>
+SSE Client disconnected: #<StringIO:0x007fd37d4c2a68>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fd37d4bb9c0>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007fd37d4b95f8>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff76cdeae70>
+SSE Client disconnected: #<StringIO:0x007ff76cdeae70>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff76cde3f30>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff76cdcb728>
+Starting SSE heartbeat thread!
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff76cdb2fe8>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff76cdb0838>
+Starting SSE heartbeat thread!
+New SSE Client connected: #<StringIO:0x007ff76cda0118>
+Failed to send event to SSE: #<StringIO:0x007ff76cda0118> (foo, bar - RuntimeError (RuntimeError

data/test/lib/{sse_rails_engine_test.rb → sse-rails-engine_test.rb}

@@ -29,4 +29,9 @@ describe SseRailsEngine do
     end
     SseRailsEngine.heartbeat_interval.must_equal 1.minute
   end
+
+  it 'calls shortcut module function' do
+    SseRailsEngine.manager.expects(:send_event).once
+    SseRailsEngine.send_event('name', 'foo')
+  end
 end

data/test/lib/sse_rails_engine/manager_test.rb

@@ -1,12 +1,12 @@
 require_relative '../../test_helper'
 
 describe SseRailsEngine::Manager do
-  let(:manager) { SseRailsEngine::manager }
-  let(:env) {
+  let(:manager) { SseRailsEngine.manager }
+  let(:env) do
     Hashie::Mash.new('rack.hijack?' => true,
-                     'rack.hijack' => ->() { },
+                     'rack.hijack' => ->() {},
                      'rack.hijack_io' => StringIO.new)
-  }
+  end
 
   before do
     SseRailsEngine.instance_variable_set(:@manager, nil)
@@ -54,19 +54,20 @@ describe SseRailsEngine::Manager do
 
   it 'writes event object to stream' do
     manager.register(env)
-    manager.send_event('foo', { a: 123, 'b' => 'abc', c: { foo: 'bar' } })
-    env['rack.hijack_io'].string.must_equal(SseRailsEngine::Manager::SSE_HEADER + "event: foo\ndata: {\"a\":123,\"b\":\"abc\",\"c\":{\"foo\":\"bar\"}}\n\n")
+    manager.send_event('foo', a: 123, 'b' => 'abc', c: { foo: 'bar' })
+    env['rack.hijack_io'].string.must_equal(
+      SseRailsEngine::Manager::SSE_HEADER + "event: foo\ndata: {\"a\":123,\"b\":\"abc\",\"c\":{\"foo\":\"bar\"}}\n\n")
   end
 
   it 'writes minimum headers to rack middleware' do
-    manager.call(env).must_equal [ -1, {}, []]
+    manager.call(env).must_equal [-1, {}, []]
   end
 
   it 'ensures heartbeat is sent' do
-    SseRailsEngine.stubs(:heartbeat_interval).returns(0,5)
+    SseRailsEngine.stubs(:heartbeat_interval).returns(0, 5)
     SseRailsEngine::Manager.unstub(:start_heartbeats)
     SseRailsEngine::Manager.any_instance.expects(:send_event).once
-    manager = SseRailsEngine::Manager.new
+    SseRailsEngine::Manager.new
     sleep 0.2
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sse-rails-engine
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Shane Hender
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: See the README.md at https://github.com/henders/sse-rails-engine
 email:
 - henders@gmail.com
@@ -129,8 +143,8 @@ files:
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
+- test/lib/sse-rails-engine_test.rb
 - test/lib/sse_rails_engine/manager_test.rb
-- test/lib/sse_rails_engine_test.rb
 - test/test_helper.rb
 homepage: https://github.com/henders/sse-rails-engine
 licenses:
@@ -190,6 +204,6 @@ test_files:
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
 - test/dummy/Rakefile
+- test/lib/sse-rails-engine_test.rb
 - test/lib/sse_rails_engine/manager_test.rb
-- test/lib/sse_rails_engine_test.rb
 - test/test_helper.rb