sse-rails-engine 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (50) hide show
  1. checksums.yaml +7 -0
  2. data/Rakefile +35 -0
  3. data/app/controllers/sse_rails_engine/application_controller.rb +4 -0
  4. data/app/controllers/sse_rails_engine/sse_controller.rb +13 -0
  5. data/config/initializers/sse_rails_engine.rb +2 -0
  6. data/config/routes.rb +3 -0
  7. data/lib/sse-rails-engine.rb +30 -0
  8. data/lib/sse_rails_engine/engine.rb +7 -0
  9. data/lib/sse_rails_engine/manager.rb +68 -0
  10. data/lib/sse_rails_engine/version.rb +3 -0
  11. data/lib/tasks/sse_rails_engine_tasks.rake +4 -0
  12. data/test/controllers/sse_rails_engine/sse_controller_test.rb +23 -0
  13. data/test/dummy/Rakefile +6 -0
  14. data/test/dummy/app/assets/javascripts/application.js +13 -0
  15. data/test/dummy/app/assets/stylesheets/application.css +15 -0
  16. data/test/dummy/app/controllers/application_controller.rb +5 -0
  17. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  18. data/test/dummy/bin/bundle +3 -0
  19. data/test/dummy/bin/rails +4 -0
  20. data/test/dummy/bin/rake +4 -0
  21. data/test/dummy/bin/setup +29 -0
  22. data/test/dummy/config.ru +4 -0
  23. data/test/dummy/config/application.rb +29 -0
  24. data/test/dummy/config/boot.rb +5 -0
  25. data/test/dummy/config/environment.rb +5 -0
  26. data/test/dummy/config/environments/development.rb +38 -0
  27. data/test/dummy/config/environments/production.rb +76 -0
  28. data/test/dummy/config/environments/test.rb +42 -0
  29. data/test/dummy/config/initializers/assets.rb +11 -0
  30. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  31. data/test/dummy/config/initializers/cookies_serializer.rb +3 -0
  32. data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  33. data/test/dummy/config/initializers/inflections.rb +16 -0
  34. data/test/dummy/config/initializers/mime_types.rb +4 -0
  35. data/test/dummy/config/initializers/session_store.rb +3 -0
  36. data/test/dummy/config/initializers/wrap_parameters.rb +9 -0
  37. data/test/dummy/config/locales/en.yml +23 -0
  38. data/test/dummy/config/routes.rb +3 -0
  39. data/test/dummy/config/secrets.yml +22 -0
  40. data/test/dummy/log/development.log +0 -0
  41. data/test/dummy/log/test.log +357 -0
  42. data/test/dummy/public/404.html +67 -0
  43. data/test/dummy/public/422.html +67 -0
  44. data/test/dummy/public/500.html +66 -0
  45. data/test/dummy/public/favicon.ico +0 -0
  46. data/test/integration/navigation_test.rb +9 -0
  47. data/test/lib/sse_rails_engine/manager_test.rb +40 -0
  48. data/test/lib/sse_rails_engine_test.rb +50 -0
  49. data/test/test_helper.rb +27 -0
  50. metadata +202 -0
data/test/dummy/public/404.html ADDED
@@ -0,0 +1,67 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The page you were looking for doesn't exist (404)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ body {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body>
58
+ <!-- This file lives in public/404.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>The page you were looking for doesn't exist.</h1>
62
+ <p>You may have mistyped the address or the page may have moved.</p>
63
+ </div>
64
+ <p>If you are the application owner check the logs for more information.</p>
65
+ </div>
66
+ </body>
67
+ </html>
data/test/dummy/public/422.html ADDED
@@ -0,0 +1,67 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The change you wanted was rejected (422)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ body {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body>
58
+ <!-- This file lives in public/422.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>The change you wanted was rejected.</h1>
62
+ <p>Maybe you tried to change something you didn't have access to.</p>
63
+ </div>
64
+ <p>If you are the application owner check the logs for more information.</p>
65
+ </div>
66
+ </body>
67
+ </html>
data/test/dummy/public/500.html ADDED
@@ -0,0 +1,66 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>We're sorry, but something went wrong (500)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ body {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body>
58
+ <!-- This file lives in public/500.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>We're sorry, but something went wrong.</h1>
62
+ </div>
63
+ <p>If you are the application owner check the logs for more information.</p>
64
+ </div>
65
+ </body>
66
+ </html>
data/test/dummy/public/favicon.ico ADDED
File without changes
data/test/integration/navigation_test.rb ADDED
@@ -0,0 +1,9 @@
1
+ require 'test_helper'
2
+
3
+ class NavigationTest < ActionDispatch::IntegrationTest
4
+
5
+ # test "the truth" do
6
+ # assert true
7
+ # end
8
+ end
9
+
data/test/lib/sse_rails_engine/manager_test.rb ADDED
@@ -0,0 +1,40 @@
1
+ require_relative '../../test_helper'
2
+
3
+ describe SseRailsEngine::Manager do
4
+ let(:response) { Hashie::Mash.new(stream: StringIO.new, headers: {}) }
5
+ let(:manager) { SseRailsEngine.manager }
6
+
7
+ it 'should only instantiate 1 manager' do
8
+ manager.must_equal SseRailsEngine.manager
9
+ end
10
+
11
+ it 'registers new response streams' do
12
+ manager.register(response)
13
+ manager.registered?(response).must_equal true
14
+ end
15
+
16
+ it 'does not register new response stream' do
17
+ manager.registered?(response).must_equal false
18
+ end
19
+
20
+ it 'closes connection when client disconnects' do
21
+ ActionController::Live::SSE.any_instance.stubs(:write).raises(ActionController::Live::ClientDisconnected)
22
+
23
+ manager.register(response)
24
+ manager.registered?(response).must_equal true
25
+ manager.send_event('foo', 'bar')
26
+ manager.registered?(response).must_equal false
27
+ end
28
+
29
+ it 'writes string event to stream' do
30
+ manager.register(response)
31
+ manager.send_event('foo', 'bar')
32
+ response.stream.string.must_equal "event: foo\ndata: bar\n\n"
33
+ end
34
+
35
+ it 'writes event object to stream' do
36
+ manager.register(response)
37
+ manager.send_event('foo', { a: 123, 'b' => 'abc', c: { foo: 'bar' } })
38
+ response.stream.string.must_equal "event: foo\ndata: {\"a\":123,\"b\":\"abc\",\"c\":{\"foo\":\"bar\"}}\n\n"
39
+ end
40
+ end
data/test/lib/sse_rails_engine_test.rb ADDED
@@ -0,0 +1,50 @@
1
+ require_relative '../test_helper'
2
+
3
+ describe SseRailsEngine do
4
+ before do
5
+ SseRailsEngine.disconnect_wait_time = 3.seconds
6
+ SseRailsEngine.heartbeat_interval = 5.seconds
7
+ end
8
+
9
+ it "should be a module" do
10
+ assert_kind_of Module, SseRailsEngine
11
+ end
12
+
13
+ it 'should have module singleton instance' do
14
+ SseRailsEngine.manager.must_equal SseRailsEngine.manager
15
+ end
16
+
17
+ it 'should have default config values' do
18
+ SseRailsEngine.disconnect_wait_time.must_equal 3.seconds
19
+ SseRailsEngine.heartbeat_interval.must_equal 5.seconds
20
+ end
21
+
22
+ it 'allows usage of setup block' do
23
+ SseRailsEngine.setup do |config|
24
+ config.disconnect_wait_time.must_equal 3.seconds
25
+ config.heartbeat_interval.must_equal 5.seconds
26
+ end
27
+ end
28
+
29
+ it 'allows config override' do
30
+ SseRailsEngine.setup do |config|
31
+ config.disconnect_wait_time = 99.hours
32
+ config.heartbeat_interval = 1.minute
33
+ end
34
+ SseRailsEngine.disconnect_wait_time.must_equal 99.hours
35
+ SseRailsEngine.heartbeat_interval.must_equal 1.minute
36
+ end
37
+
38
+ it 'disconnects without a registry' do
39
+ response = Hashie::Mash.new(stream: StringIO.new, headers: {})
40
+ SseRailsEngine.disconnect_wait_time = 0.1
41
+ SseRailsEngine.wait_for_disconnect(response).must_equal true
42
+ end
43
+
44
+ it 'disconnects after registry deletion' do
45
+ SseRailsEngine.manager.expects(:registered?).times(3).returns(true, true, false)
46
+ response = Hashie::Mash.new(stream: StringIO.new, headers: {})
47
+ SseRailsEngine.disconnect_wait_time = 0.1
48
+ SseRailsEngine.wait_for_disconnect(response).must_equal true
49
+ end
50
+ end
data/test/test_helper.rb ADDED
@@ -0,0 +1,27 @@
1
+ # Configure Rails Environment
2
+ ENV['RAILS_ENV'] = 'test'
3
+
4
+ require File.expand_path('../../test/dummy/config/environment.rb', __FILE__)
5
+ require 'rails/test_help'
6
+ require 'minitest/rails'
7
+ require 'mocha/mini_test'
8
+ require 'hashie'
9
+ require 'codeclimate-test-reporter'
10
+
11
+ CodeClimate::TestReporter.start if ENV['CODECLIMATE_REPO_TOKEN']
12
+
13
+ # Filter out Minitest backtrace while allowing backtrace from other libraries
14
+ # to be shown.
15
+ Minitest.backtrace_filter = Minitest::BacktraceFilter.new
16
+
17
+ # Load support files
18
+ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
19
+
20
+ # Load fixtures from the engine
21
+ if ActiveSupport::TestCase.respond_to?(:fixture_path=)
22
+ ActiveSupport::TestCase.fixture_path = File.expand_path('../fixtures', __FILE__)
23
+ ActiveSupport::TestCase.fixtures :all
24
+ end
25
+
26
+ class ActiveSupport::TestCase
27
+ end
metadata ADDED
@@ -0,0 +1,202 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: sse-rails-engine
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Shane Hender
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2015-04-17 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '4.2'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '4.2'
27
+ - !ruby/object:Gem::Dependency
28
+ name: minitest-rails
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '2.1'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '2.1'
41
+ - !ruby/object:Gem::Dependency
42
+ name: mocha
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: hashie
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: codeclimate-test-reporter
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description: Provides SSE connection tracking and broadcasting of events from anywhere
84
+ in Rails app
85
+ email:
86
+ - shender@zendesk.com
87
+ executables: []
88
+ extensions: []
89
+ extra_rdoc_files: []
90
+ files:
91
+ - Rakefile
92
+ - app/controllers/sse_rails_engine/application_controller.rb
93
+ - app/controllers/sse_rails_engine/sse_controller.rb
94
+ - config/initializers/sse_rails_engine.rb
95
+ - config/routes.rb
96
+ - lib/sse-rails-engine.rb
97
+ - lib/sse_rails_engine/engine.rb
98
+ - lib/sse_rails_engine/manager.rb
99
+ - lib/sse_rails_engine/version.rb
100
+ - lib/tasks/sse_rails_engine_tasks.rake
101
+ - test/controllers/sse_rails_engine/sse_controller_test.rb
102
+ - test/dummy/Rakefile
103
+ - test/dummy/app/assets/javascripts/application.js
104
+ - test/dummy/app/assets/stylesheets/application.css
105
+ - test/dummy/app/controllers/application_controller.rb
106
+ - test/dummy/app/views/layouts/application.html.erb
107
+ - test/dummy/bin/bundle
108
+ - test/dummy/bin/rails
109
+ - test/dummy/bin/rake
110
+ - test/dummy/bin/setup
111
+ - test/dummy/config.ru
112
+ - test/dummy/config/application.rb
113
+ - test/dummy/config/boot.rb
114
+ - test/dummy/config/environment.rb
115
+ - test/dummy/config/environments/development.rb
116
+ - test/dummy/config/environments/production.rb
117
+ - test/dummy/config/environments/test.rb
118
+ - test/dummy/config/initializers/assets.rb
119
+ - test/dummy/config/initializers/backtrace_silencers.rb
120
+ - test/dummy/config/initializers/cookies_serializer.rb
121
+ - test/dummy/config/initializers/filter_parameter_logging.rb
122
+ - test/dummy/config/initializers/inflections.rb
123
+ - test/dummy/config/initializers/mime_types.rb
124
+ - test/dummy/config/initializers/session_store.rb
125
+ - test/dummy/config/initializers/wrap_parameters.rb
126
+ - test/dummy/config/locales/en.yml
127
+ - test/dummy/config/routes.rb
128
+ - test/dummy/config/secrets.yml
129
+ - test/dummy/log/development.log
130
+ - test/dummy/log/test.log
131
+ - test/dummy/public/404.html
132
+ - test/dummy/public/422.html
133
+ - test/dummy/public/500.html
134
+ - test/dummy/public/favicon.ico
135
+ - test/integration/navigation_test.rb
136
+ - test/lib/sse_rails_engine/manager_test.rb
137
+ - test/lib/sse_rails_engine_test.rb
138
+ - test/test_helper.rb
139
+ homepage: https://github.com/henders/sse-rails-engine
140
+ licenses:
141
+ - MIT
142
+ metadata: {}
143
+ post_install_message:
144
+ rdoc_options: []
145
+ require_paths:
146
+ - lib
147
+ required_ruby_version: !ruby/object:Gem::Requirement
148
+ requirements:
149
+ - - ">="
150
+ - !ruby/object:Gem::Version
151
+ version: '0'
152
+ required_rubygems_version: !ruby/object:Gem::Requirement
153
+ requirements:
154
+ - - ">="
155
+ - !ruby/object:Gem::Version
156
+ version: '0'
157
+ requirements: []
158
+ rubyforge_project:
159
+ rubygems_version: 2.4.5
160
+ signing_key:
161
+ specification_version: 4
162
+ summary: Provides SSE connection tracking and broadcasting of events from anywhere
163
+ in Rails app
164
+ test_files:
165
+ - test/controllers/sse_rails_engine/sse_controller_test.rb
166
+ - test/dummy/app/assets/javascripts/application.js
167
+ - test/dummy/app/assets/stylesheets/application.css
168
+ - test/dummy/app/controllers/application_controller.rb
169
+ - test/dummy/app/views/layouts/application.html.erb
170
+ - test/dummy/bin/bundle
171
+ - test/dummy/bin/rails
172
+ - test/dummy/bin/rake
173
+ - test/dummy/bin/setup
174
+ - test/dummy/config/application.rb
175
+ - test/dummy/config/boot.rb
176
+ - test/dummy/config/environment.rb
177
+ - test/dummy/config/environments/development.rb
178
+ - test/dummy/config/environments/production.rb
179
+ - test/dummy/config/environments/test.rb
180
+ - test/dummy/config/initializers/assets.rb
181
+ - test/dummy/config/initializers/backtrace_silencers.rb
182
+ - test/dummy/config/initializers/cookies_serializer.rb
183
+ - test/dummy/config/initializers/filter_parameter_logging.rb
184
+ - test/dummy/config/initializers/inflections.rb
185
+ - test/dummy/config/initializers/mime_types.rb
186
+ - test/dummy/config/initializers/session_store.rb
187
+ - test/dummy/config/initializers/wrap_parameters.rb
188
+ - test/dummy/config/locales/en.yml
189
+ - test/dummy/config/routes.rb
190
+ - test/dummy/config/secrets.yml
191
+ - test/dummy/config.ru
192
+ - test/dummy/log/development.log
193
+ - test/dummy/log/test.log
194
+ - test/dummy/public/404.html
195
+ - test/dummy/public/422.html
196
+ - test/dummy/public/500.html
197
+ - test/dummy/public/favicon.ico
198
+ - test/dummy/Rakefile
199
+ - test/integration/navigation_test.rb
200
+ - test/lib/sse_rails_engine/manager_test.rb
201
+ - test/lib/sse_rails_engine_test.rb
202
+ - test/test_helper.rb