sse-rails-engine 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9588b7d4742873aa7d61489b824970e2c75242ab
+  data.tar.gz: 6e4e448cd2c510b4f05e0b0e261cc87814ea0b86
+SHA512:
+  metadata.gz: b75e9bb0140fc7a88c958cbec8337319c46add07ef6db3767b4d3d4beff26dc070d605027de9b0b0d160d23bbdfe55cdadeb39574a8f0c8dfef9f7f4933e71b9
+  data.tar.gz: fdaf7bea23120d4b7e5b0c6855c04bf78d5a06db14cb63232f6e24974c922da091a854df590172f4bf767c3e54afb658b55b8d8dfea5ad26d1d2f3fee17e5994

data/Rakefile

@@ -0,0 +1,35 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SseRailsEngine'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/sse_rails_engine/application_controller.rb

@@ -0,0 +1,4 @@
+module SseRailsEngine
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/sse_rails_engine/sse_controller.rb

@@ -0,0 +1,13 @@
+require_dependency "sse_rails_engine/application_controller"
+
+module SseRailsEngine
+  class SseController < ApplicationController
+    include ActionController::Live
+
+    def connect
+      SseRailsEngine.manager.register(response)
+      SseRailsEngine.wait_for_disconnect(response)
+      render json: {}
+    end
+  end
+end

data/config/initializers/sse_rails_engine.rb

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

data/config/routes.rb

@@ -0,0 +1,3 @@
+SseRailsEngine::Engine.routes.draw do
+  root to: 'sse#connect'
+end

data/lib/sse-rails-engine.rb

@@ -0,0 +1,30 @@
+require 'sse_rails_engine/engine'
+require 'sse_rails_engine/manager'
+
+module SseRailsEngine
+  mattr_accessor :disconnect_wait_time
+  mattr_accessor :heartbeat_interval
+
+  @@disconnect_wait_time = 3.seconds
+  @@heartbeat_interval = 5.seconds
+
+  def self.manager
+    @manager ||= Manager.new
+  end
+
+  def self.wait_for_disconnect(response)
+    loop do
+      sleep disconnect_wait_time
+      break unless manager.registered?(response)
+    end
+    true
+  end
+
+  def self.send_event(name, data)
+    manager.send_event(name, data)
+  end
+
+  def self.setup
+    yield self
+  end
+end

data/lib/sse_rails_engine/engine.rb

@@ -0,0 +1,7 @@
+module SseRailsEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace SseRailsEngine
+
+    config.sse_rails_engine = SseRailsEngine
+  end
+end

data/lib/sse_rails_engine/manager.rb

@@ -0,0 +1,68 @@
+module SseRailsEngine
+  class Manager
+    attr_reader :connections
+
+    def initialize
+      @mutex = Mutex.new
+      @connections = {}
+      start_heartbeats
+    end
+
+    def register(response)
+      ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord)
+      response.headers['Content-Type'] = 'text/event-stream'
+      response.headers['Cache-Control'] = 'no-cache'
+      @mutex.synchronize do
+        @connections[response.stream] = ActionController::Live::SSE.new(response.stream)
+      end
+    end
+
+    def registered?(response)
+      @mutex.synchronize do
+        @connections[response.stream] ? true : false
+      end
+    end
+
+    def unregister(response)
+      @mutex.synchronize do
+        close_connection(response.stream)
+      end
+    end
+
+    def send_event(name, data)
+      @mutex.synchronize do
+        @connections.dup.each do |stream, sse|
+          begin
+            sse.write(data, event: name)
+          rescue ActionController::Live::ClientDisconnected
+            close_connection(stream)
+          rescue => ex
+            Rails.logger.error "Failed to send event to SSE: #{stream} (#{name}, #{data} - #{ex.message}"
+          end
+        end
+      end
+    end
+
+    private
+
+    def close_connection(stream)
+      return if @connections[stream].nil?
+      @connections[stream].close
+      @connections.delete(stream)
+      stream.close unless stream.closed?
+    end
+
+    def heartbeat
+      send_event('heartbeat', '')
+    end
+
+    def start_heartbeats
+      Thread.new do
+        loop do
+          sleep SseRailsEngine.heartbeat_interval
+          heartbeat
+        end
+      end
+    end
+  end
+end

data/lib/sse_rails_engine/version.rb

@@ -0,0 +1,3 @@
+module SseRailsEngine
+  VERSION = "0.0.1"
+end

data/lib/tasks/sse_rails_engine_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sse_rails_engine do
+#   # Task goes here
+# end

data/test/controllers/sse_rails_engine/sse_controller_test.rb

@@ -0,0 +1,23 @@
+require_relative '../../test_helper'
+
+describe SseRailsEngine::SseController do
+  before do
+    SseRailsEngine.instance_variable_set(:@manager, nil)
+    @routes = SseRailsEngine::Engine.routes
+  end
+
+  it 'registers new connections' do
+    SseRailsEngine.expects(:wait_for_disconnect).returns(true)
+    get :connect
+    assert_response :success
+    SseRailsEngine.manager.connections.size.must_equal 1
+  end
+
+  it 'sends event to connection' do
+    SseRailsEngine.expects(:wait_for_disconnect).returns(true)
+    get :connect
+    SseRailsEngine.manager.connections.size.must_equal 1
+    ActionController::Live::SSE.any_instance.expects(:write).with('bar', event: 'foo').once
+    SseRailsEngine.send_event('foo', 'bar')
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "sse-rails-engine"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,38 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,76 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end