sse-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ed37b1a0278ed017ea493c828438d7ed27f53b6
+  data.tar.gz: 7489f61464b12e05449b6f8879c29994b2cb64cf
+SHA512:
+  metadata.gz: cccb177bee6b02003472d8a4444cf8c0e8ca97b8e876008366f4b5b171e97fcbb0216bfe868330649267727584e5685ebf8fbfcdd1e95aa285f8c88670a3bc00
+  data.tar.gz: 3537098921904f85c1f47a616b6751a56b7b07d27bc10d760cae5e290b462898355f71ea8c9ab0e4c5ea8a770682ef62507d6d06ad0e90bbb8938f636ae997c5

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+bin/
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sse-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Antonio Scandurra
+
+MIT License
+
+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 OR COPYRIGHT HOLDERS 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,69 @@
+# 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:
+
+```ruby
+gem 'sse-rails'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install sse-rails
+```
+
+## Usage
+
+Add these lines to a controller:
+
+```ruby
+require 'rails/sse'
+
+include ActionController::Live
+include Rails::SSE
+```
+
+And then use it in one of your actions:
+
+```ruby
+def listen
+  stream do |channel|
+    channel.post(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:
+
+```ruby
+def listen
+  stream do |channel|
+    loop do
+      channel.send('something') 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.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Test"
+task default: :test

data/lib/rails/sse.rb

@@ -0,0 +1,22 @@
+require "rails/sse/version"
+require "rails/sse/channel"
+
+module Rails
+  module SSE
+    def channel
+      Channel.new(response.stream)
+    end
+
+    def stream
+      response.headers['Content-Type'] = 'text/event-stream'
+
+      begin
+        yield(channel) if block_given?
+      rescue IOError
+      ensure
+        response.stream.close unless response.stream.closed?
+      end
+    end
+
+  end
+end

data/lib/rails/sse/channel.rb

@@ -0,0 +1,25 @@
+module Rails
+  module SSE
+    class Channel
+      attr_reader :stream
+
+      def initialize(stream)
+        @stream = stream
+      end
+
+      def post(data, options = {})
+        raise ArgumentError unless data
+
+        options.each do |key, value|
+          @stream.write("#{key}: #{value}\n")
+        end
+
+        @stream.write("data: #{JSON.dump(data)}\n\n")
+      end
+
+      def ping!
+        post(:ping)
+      end
+    end
+  end
+end

data/lib/rails/sse/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module SSE
+    VERSION = "0.0.1"
+  end
+end

data/spec/rails/channel_spec.rb

@@ -0,0 +1,44 @@
+require 'minitest/autorun'
+require 'rails/sse/channel'
+require 'json'
+
+describe Rails::SSE::Channel do
+  before(:each) do
+    @input, @output = IO.pipe
+    @channel = Rails::SSE::Channel.new(@output)
+  end
+
+  it 'encodes data in json' do
+    data = { 'test' => 1 }
+
+    @channel.post(data)
+    response = @input.gets.match(/data: (.+)/)
+
+    JSON.parse(response[1]).must_equal(data)
+  end
+
+  it 'encodes options in kv format' do
+    options = { event: 'refresh', id: 'test' }
+    @channel.post({}, options)
+
+    @input.gets.must_match(/event: refresh/)
+    @input.gets.must_match(/id: test/)
+  end
+
+  it 'pings client for keep–alive' do
+    @channel.ping!
+
+    @input.gets.must_match(/data: (.+)/)
+  end
+
+  it 'closes the message with two LF' do
+    @channel.post({})
+
+    @input.gets.wont_be_nil
+    @input.gets.wont_be_nil
+  end
+
+  it 'raises an error when data is nil' do
+    lambda { @channel.post(nil) }.must_raise(ArgumentError)
+  end
+end

data/spec/rails/sse_spec.rb

@@ -0,0 +1,51 @@
+require 'minitest/autorun'
+require 'support/fake_controller'
+require 'rails/sse'
+
+describe Rails::SSE do
+  before(:each) do
+    @controller = FakeController.new
+    @controller.extend(Rails::SSE)
+  end
+
+  it 'sets content-type to text/event-stream' do
+    @controller.stream
+
+    content_type = @controller.response.headers['Content-Type']
+    content_type.must_equal('text/event-stream')
+  end
+
+  it 'closes event stream before ending communication' do
+    @controller.stream
+
+    @controller.response.stream.closed?.must_equal(true)
+  end
+
+  it 'closes event stream when errors are raised' do
+    @controller.stream do |channel|
+      raise IOError
+    end
+
+    @controller.response.stream.closed?.must_equal(true)
+  end
+
+  it 'streams messages to the channel' do
+    channel = MiniTest::Mock.new
+    channel.expect(:ping!, nil)
+    channel.expect(:send, nil, ['p1', 'p2'])
+
+    @controller.stub(:channel, channel) do
+      @controller.stream do |channel|
+        channel.ping!
+        channel.send('p1', 'p2')
+      end
+
+      channel.verify
+    end
+  end
+
+  it 'has a default channel' do
+    @controller.channel.must_be_instance_of(Rails::SSE::Channel)
+    @controller.channel.stream.must_equal @controller.response.stream
+  end
+end

data/spec/support/fake_controller.rb

@@ -0,0 +1,9 @@
+require_relative 'fake_response'
+
+class FakeController
+  attr_reader :response
+
+  def initialize
+    @response = FakeResponse.new
+  end
+end

data/spec/support/fake_response.rb

@@ -0,0 +1,8 @@
+class FakeResponse
+  attr_reader :headers, :stream
+
+  def initialize
+    @headers = Hash.new
+    @stream = File.open('/dev/null')
+  end
+end

data/sse-rails.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails/sse/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sse-rails"
+  spec.version       = Rails::SSE::VERSION
+  spec.authors       = ["Antonio Scandurra"]
+  spec.email         = ["as-cii@outlook.com"]
+  spec.description   = %q{SSE for rails, made easy.}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/as-cii/sse-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: sse-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Antonio Scandurra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: SSE for rails, made easy.
+email:
+- as-cii@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails/sse.rb
+- lib/rails/sse/channel.rb
+- lib/rails/sse/version.rb
+- spec/rails/channel_spec.rb
+- spec/rails/sse_spec.rb
+- spec/support/fake_controller.rb
+- spec/support/fake_response.rb
+- sse-rails.gemspec
+homepage: https://github.com/as-cii/sse-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: SSE for rails, made easy.
+test_files:
+- spec/rails/channel_spec.rb
+- spec/rails/sse_spec.rb
+- spec/support/fake_controller.rb
+- spec/support/fake_response.rb