sse-rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ed37b1a0278ed017ea493c828438d7ed27f53b6
-  data.tar.gz: 7489f61464b12e05449b6f8879c29994b2cb64cf
+  metadata.gz: 02f8509d08fef3b64bf2d7117b2fabdd1f4e74e3
+  data.tar.gz: d34f8b852f182936ee146ef45ac32b8125e90c09
 SHA512:
-  metadata.gz: cccb177bee6b02003472d8a4444cf8c0e8ca97b8e876008366f4b5b171e97fcbb0216bfe868330649267727584e5685ebf8fbfcdd1e95aa285f8c88670a3bc00
-  data.tar.gz: 3537098921904f85c1f47a616b6751a56b7b07d27bc10d760cae5e290b462898355f71ea8c9ab0e4c5ea8a770682ef62507d6d06ad0e90bbb8938f636ae997c5
+  metadata.gz: 53b69b8dd19d9be7168fb0e6250e8f94b16aa7beacbcb97ccee12ab34f400fc176d4557c2b20d41ca177bb3e3097fa0c6458a1447ecbc487c2944b16dd362fb4
+  data.tar.gz: 88126a2486705c030064369c567dbf2f84e77d9f48b88f5cb48a98da135c39ecdba97367db6db8d2ad7580401932abb5ed17d151f21e3fa7ef3f7bff4ebc661b

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/README.md

@@ -1,4 +1,4 @@
-# sse-rails
+# sse-rails [![Build Status](https://travis-ci.org/as-cii/sse-rails.png?branch=master)](https://travis-ci.org/as-cii/sse-rails)
 
 sse-rails is a simple wrapper around ActionController::Live to hide all the complexity of streaming.
 
@@ -38,7 +38,7 @@ And then use it in one of your actions:
 ```ruby
 def listen
   stream do |channel|
-    channel.post(event: 'refresh')
+    channel.post({ username: 'jim' }, event: 'refresh')
   end
 end
 ```
@@ -49,7 +49,7 @@ You can also use `Rails::SSE::Channel#ping!` to see if connection is still open.
 def listen
   stream do |channel|
     loop do
-      channel.send('something') if condition
+      channel.post('anything') if condition
 
       channel.ping!
       sleep 1

data/lib/rails/sse/channel.rb

@@ -8,18 +8,28 @@ module Rails
       end
 
       def post(data, options = {})
-        raise ArgumentError unless data
+        raise ArgumentError if empty_arg?(data) && empty_arg?(options)
 
         options.each do |key, value|
           @stream.write("#{key}: #{value}\n")
         end
 
-        @stream.write("data: #{JSON.dump(data)}\n\n")
+        @stream.write("data: #{JSON.dump(data)}\n") unless empty_arg?(data)
+        end_message
       end
 
       def ping!
         post(:ping)
       end
+
+      private
+      def end_message
+        @stream.write("\n")
+      end
+
+      def empty_arg?(argument)
+        !argument || argument.empty?
+      end
     end
   end
 end

data/lib/rails/sse/version.rb

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

data/spec/rails/channel_spec.rb

@@ -1,18 +1,20 @@
 require 'minitest/autorun'
 require 'rails/sse/channel'
 require 'json'
+require 'stringio'
+require 'support/matchers'
 
 describe Rails::SSE::Channel do
   before(:each) do
-    @input, @output = IO.pipe
-    @channel = Rails::SSE::Channel.new(@output)
+    @input = StringIO.new
+    @channel = Rails::SSE::Channel.new(@input)
   end
 
   it 'encodes data in json' do
     data = { 'test' => 1 }
 
     @channel.post(data)
-    response = @input.gets.match(/data: (.+)/)
+    response = @input.string.match(/data: (.+)\n/)
 
     JSON.parse(response[1]).must_equal(data)
   end
@@ -21,24 +23,37 @@ describe Rails::SSE::Channel do
     options = { event: 'refresh', id: 'test' }
     @channel.post({}, options)
 
-    @input.gets.must_match(/event: refresh/)
-    @input.gets.must_match(/id: test/)
+    @input.string.must_match(/event: refresh\n/)
+    @input.string.must_match(/id: test\n/)
   end
 
   it 'pings client for keep–alive' do
     @channel.ping!
 
-    @input.gets.must_match(/data: (.+)/)
+    @input.string.must_match(/data: (.+)\n/)
   end
 
-  it 'closes the message with two LF' do
-    @channel.post({})
+  it 'closes a data-only message with a blank line' do
+    @channel.post({ test: 'data' })
 
-    @input.gets.wont_be_nil
-    @input.gets.wont_be_nil
+    assert_last_line_blank
   end
 
-  it 'raises an error when data is nil' do
-    lambda { @channel.post(nil) }.must_raise(ArgumentError)
+  it 'closes a options-only message with a blank line' do
+    @channel.post(nil, event: 'test')
+
+    assert_last_line_blank
+  end
+
+  it 'does not include data option when data is empty' do
+    @channel.post(nil, event: 'test')
+
+    @input.string.wont_match(/data: .*/)
+  end
+
+  it 'raises an error when data and options are both nil or empty' do
+    lambda { @channel.post(nil, nil) }.must_raise(ArgumentError)
+    lambda { @channel.post({}, nil) }.must_raise(ArgumentError)
+    lambda { @channel.post(nil, {}) }.must_raise(ArgumentError)
   end
 end

data/spec/support/matchers.rb

@@ -0,0 +1,5 @@
+def assert_last_line_blank
+  lines = @input.string.lines
+  lines[lines.count - 2].wont_equal("\n")
+  lines.last.must_equal("\n")
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sse-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Antonio Scandurra
@@ -14,42 +14,42 @@ dependencies:
   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.
@@ -59,7 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,6 +72,7 @@ files:
 - spec/rails/sse_spec.rb
 - spec/support/fake_controller.rb
 - spec/support/fake_response.rb
+- spec/support/matchers.rb
 - sse-rails.gemspec
 homepage: https://github.com/as-cii/sse-rails
 licenses:
@@ -82,17 +84,17 @@ 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
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: SSE for rails, made easy.
@@ -101,3 +103,5 @@ test_files:
 - spec/rails/sse_spec.rb
 - spec/support/fake_controller.rb
 - spec/support/fake_response.rb
+- spec/support/matchers.rb
+has_rdoc: