sse-rails

sse-rails is a simple wrapper around ActionController::Live to hide all the complexity of streaming.

Installation

Add this line to your application's Gemfile:

gem 'sse-rails'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sse-rails

Add these lines to a controller:

require 'rails/sse'

include ActionController::Live
include Rails::SSE

And then use it in one of your actions:

def listen
  stream do |channel|
    channel.post({ username: 'jim' }, event: 'refresh')
  end
end

You can also use Rails::SSE::Channel#ping! to see if connection is still open. This is useful when you are in a loop like this:

def listen
  stream do |channel|
    loop do
      channel.post('anything') if condition

      channel.ping!
      sleep 1
    end
  end
end

Without pinging you would know that the connection was lost only when the condition becomes true.