r4s 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,98 @@
+# R4S (Rails 4 Streaming)
+
+R4S is a gem that simplifies sending server side events (SSE) to multiple browsers in Rails 4.
+It is supposed to simulate broadcasting to all the browsers that are connected to it.
+
+Here is a ascii picture that shows how a webpage would send a 'update' event to three browsers.
+
+My ASCII Picture. :)
+
+    |---------|                      /-----------> browser0
+    | Webpage | --['update']--------|------------> browser1
+    |---------|                      \-----------> browser2
+
+
+Most of my code is based on Tenderloves "Is it live?" article. http://tenderlovemaking.com/2012/07/30/is-it-live.html
+
+## NOTE
+This gem works only in Rails 4 (I thinks)
+
+(I think I have found out what's wrong with turbolinks and r4s. Fix should come soon)
+You can not use turbolinks with this project for some strange, inapparent reason. 
+If you make a connection and then close the browser the srv will crash stating that the headers had already been sent.
+who, why, where or how these headers are sent are a mistery to me. My solution was to remove the turbolinks. 
+This might be fixed in the future.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'r4s'
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+You'll need a controller that has included `ActionController::Live` to be able to stream.
+
+A page with javascript EventSource to connect to the stream.
+
+And some controller.action to trigger the stream.event.
+
+R4S uses only two functions
+
+One to create the stream(s)
+
+    R4S.add_stream(response,"key").start
+
+One to push to the stream(s)
+
+    R4S.push_data("key",data,options)
+
+## Example
+I created a "stream" controller to handle my streams
+
+    class StreamController < ApplicationController
+        include ActionController::Live
+        def stream1
+            R4S.add_stream(response,"stream.key").start
+        end
+    end
+
+Create a webpage that connects to the stream.
+    `app/views/home/show.html.erb`
+
+    <h1>Event Page</h1>
+    <p>The time : <span id="time"></span></p>
+    <script>
+    jQuery(document).ready(function() {
+        source = new EventSource('/stream/stream1');
+        source.addEventListener('refresh', function(e) {
+          var data = JSON.parse(e.data);
+          jQuery('#time').html(data["time"]);
+        }); 
+    });
+    </script>
+
+Create a action that triggers the event.
+
+    class HomeController < ApplicationController
+      def index
+        R4S.push_data('kanban',{:time=>Time.now},:event=>"refresh")
+        render :json => {:success=>true}
+      end
+    
+      def show
+      end
+    end
+
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/r4s/version.rb

@@ -0,0 +1,3 @@
+module R4s
+  VERSION = "1.0.0"
+end

data/lib/r4s.rb

@@ -0,0 +1,65 @@
+class R4S
+  SSES = {}
+
+  def self.add_stream(response,key="none")
+
+    if !R4S::SSES.keys.include?(key)
+      R4S::SSES[key] = {}
+      key_count = 0
+    else
+      key_count = R4S::SSES[key].keys.count
+    end
+
+    sse = R4S::SSE.new(response,key,key_count)
+    R4S::SSES[key][key_count] = sse
+
+    return sse
+
+  end
+
+  def self.push_data(key,data,options={})
+    if R4S::SSES.keys.include?(key)
+      R4S::SSES[key].each do |k,sse|
+        sse.write(data,options)
+      end
+    end
+  end
+
+  class SSE
+
+    def initialize response, key, id
+      response.headers['Content-Type'] = 'text/event-stream'
+      @response = response
+      @id = id
+      @key = key
+      @io = response.stream
+    end
+
+    def write object, options = {}
+      options.each do |k,v|
+        @io.write "#{k}: #{v}\n"
+      end
+      @io.write "data: #{JSON.dump(object)}\n\n"
+    end
+
+    def start
+      begin
+        while !@io.closed?; 
+          sleep 30
+        end
+      rescue
+      ensure
+        R4S::SSES[@key][@id].close 
+        R4S::SSES[@key].delete(@id)
+      end
+    end
+
+    def closed?
+      @io.closed?
+    end
+
+    def close
+      @io.close
+    end
+  end
+end

data/r4s.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'r4s/version'
+require 'json'
+
+Gem::Specification.new do |gem|
+  gem.name          = "r4s"
+  gem.version       = R4s::VERSION
+  gem.authors       = ["Birgir Hrafn Sigurðsson"]
+  gem.email         = ["biggihs@gmail.com"]
+  gem.description   = %q{Wrapper for Rails 4 streaming}
+  gem.summary       = %q{Wrapper for Rails 4 streaming}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: r4s
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Birgir Hrafn Sigurðsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-12 00:00:00.000000000 Z
+dependencies: []
+description: Wrapper for Rails 4 streaming
+email:
+- biggihs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/r4s.rb
+- lib/r4s/version.rb
+- r4s.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Wrapper for Rails 4 streaming
+test_files: []