sinatra-cometio 0.1.5 → 0.1.6

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.1.6 2013-3-3
+
+* add IO close function - CometIO.close()
+* set :cometio, :xhr_interval => 15
+* use Sinatra.register
+
 === 0.1.5 2013-3-3
 
 * add tests with ruby client
@@ -17,7 +23,7 @@
 
 === 0.1.1 2013-2-7
 
-* fix
+* little fix
 
 === 0.1.0 2013-2-6
 

data/README.md

@@ -132,6 +132,20 @@ or
 io.removeListener("error");  // remove all "error" listener
 ```
 
+Config
+------
+
+config.ru
+```ruby
+require 'sinatra'
+require 'sinatra/cometio'
+require File.dirname(__FILE__)+'/main'
+
+set :cometio, :xhr_interval => 20
+
+run Sinatra::Application
+```
+
 Sample App
 ----------
 chat app

data/lib/js/cometio.js

@@ -2,6 +2,7 @@ var CometIO = function(){
   new EventEmitter().apply(this);
   this.url = "<%= cometio_url %>";
   this.session = null;
+  var running = false;
   var self = this;
 
   this.push = function(type, data){
@@ -24,15 +25,23 @@ var CometIO = function(){
   };
 
   this.connect = function(){
+    if(running) return self;
     self.on("__session_id", function(session){
       self.session = session;
       self.emit("connect", self.session);
     });
+    running = true;
     self.get();
     return self;
   };
 
+  this.close = function(){
+    running = false;
+    self.removeListener("__session_id");
+  };
+
   this.get = function(){
+    if(!running) return;
     $.ajax(
       {
         url : self.url,
@@ -51,7 +60,7 @@ var CometIO = function(){
         },
         type : "GET",
         dataType : "json",
-        timeout : 60000
+        timeout : <%= (CometIO.options[:xhr_interval]+10)*1000 %>
       }
     );
   };

data/lib/sinatra-cometio/application.rb

@@ -0,0 +1,71 @@
+module Sinatra::CometIO
+
+  def cometio=(options)
+    CometIO.options = options
+  end
+
+  def cometio
+    CometIO.options
+  end
+
+  helpers do
+    def cometio_js
+      "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}#{env['SCRIPT_NAME']}/cometio/cometio.js"
+    end
+
+    def cometio_url
+      "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}#{env['SCRIPT_NAME']}/cometio/io"
+    end
+  end
+
+  get '/cometio/cometio.js' do
+    content_type 'application/javascript'
+    @js ||= (
+             js = ''
+             Dir.glob(File.expand_path '../js/*.js', File.dirname(__FILE__)).each do |i|
+               File.open(i) do |f|
+                 js += f.read
+               end
+             end
+             ERB.new(js).result(binding)
+             )
+  end
+
+  get '/cometio/io' do
+    stream :keep_open do |s|
+      session = params[:session].to_s.empty? ? CometIO.create_session(request.ip) : params[:session]
+      CometIO.sessions[session][:stream] = s
+      CometIO.sessions[session][:last] = Time.now
+      CometIO.emit :connect, session if params[:session].to_s.empty?
+
+      unless CometIO.sessions[session][:queue].empty?
+        begin
+          s.write CometIO.sessions[session][:queue].shift.to_json
+          s.flush
+          s.close
+        rescue
+          s.close
+        end
+      end
+
+      EM::add_timer CometIO.options[:xhr_interval] do
+        begin
+          s.write({:type => :__heartbeat, :data => {:time => Time.now.to_i}}.to_json)
+          s.flush
+          s.close
+        rescue
+          s.close
+        end
+      end
+    end
+  end
+
+  post '/cometio/io' do
+    type = params[:type]
+    data = params[:data]
+    from = params[:session]
+    CometIO.emit type, data, from if type.to_s.size > 0
+    {:session => from, :type => type, :data => data}.to_json
+  end
+
+end

data/lib/sinatra-cometio/options.rb

@@ -0,0 +1,35 @@
+class CometIO
+
+  def self.default_options
+    {
+      :xhr_interval => [15, lambda{|v| v.kind_of? Fixnum and v >= 10 }]
+    }
+  end
+
+  def self.options
+    @@options ||= (
+                   opts = {}
+                   default_options.each do |k,v|
+                     opts[k] = v[0]
+                   end
+                   opts
+                   )
+  end
+
+  def self.options=(opts)
+    @@options = {}
+    opts.each do |k,v|
+      k = k.to_sym
+      if default_options.include? k
+        @@options[k] = default_options[k][1].call(v) ? v : default_options[k][0]
+      else
+        @@options[k] = v
+      end
+    end
+    default_options.each do |k, v|
+      @@options[k] = v unless @@options.include? k
+    end
+    @@options
+  end
+
+end

data/lib/sinatra-cometio/version.rb

@@ -1,3 +1,5 @@
-module SinatraCometIO
-  VERSION = '0.1.5'
+module Sinatra
+  module CometIO
+    VERSION = '0.1.6'
+  end
 end

data/lib/sinatra/cometio.rb

@@ -3,8 +3,10 @@ require 'json'
 require 'digest/md5'
 require 'event_emitter'
 require 'sinatra/streaming'
-require File.expand_path 'application', File.dirname(__FILE__)
 require File.expand_path '../sinatra-cometio/version', File.dirname(__FILE__)
+require File.expand_path '../sinatra-cometio/options', File.dirname(__FILE__)
+require File.expand_path '../sinatra-cometio/application', File.dirname(__FILE__)
+Sinatra.register Sinatra::CometIO
 
 class CometIO
   def self.sessions
@@ -19,7 +21,7 @@ class CometIO
 
   def self.gc
     self.sessions.each do |id, s|
-      next unless s[:last] and s[:last] < Time.now-60
+      next unless s[:last] and s[:last] < Time.now-CometIO.options[:xhr_interval]*2-10
       self.sessions.delete id rescue next
       self.emit :disconnect, id
     end
@@ -28,7 +30,7 @@ class CometIO
   EM::defer do
     loop do
       self.gc
-      sleep 60
+      sleep CometIO.options[:xhr_interval]+5
     end
   end
 

data/lib/sinatra/cometio/client.rb

@@ -15,6 +15,7 @@ class CometIO
       raise ArgumentError, "invalid URL (#{url})" unless url.kind_of? String and url =~ /^https?:\/\/.+/
       @url = url
       @session = nil
+      @running = false
     end
 
     def push(type, data)
@@ -28,18 +29,25 @@ class CometIO
     end
 
     def connect
+      return self if @running
       self.on :__session_id do |session|
         @session = session
         self.emit :connect, @session
       end
+      @running = true
       get
       return self
     end
 
+    def close
+      @running = false
+      self.remove_listener :__session_id
+    end
+
     private
     def get
       Thread.new do
-        loop do
+        while @running do
           begin
             res = HTTParty.get "#{@url}?session=#{@session}", :timeout => 60000
             unless res.code == 200

data/sample/config.ru

@@ -10,5 +10,6 @@ require 'sinatra/cometio'
 require File.dirname(__FILE__)+'/main'
 
 set :haml, :escape_html => true
+set :cometio, :xhr_interval => 20
 
 run Sinatra::Application

data/sample/main.rb

@@ -11,6 +11,7 @@ end
 
 CometIO.on :disconnect do |session|
   puts "disconnect client <#{session}>"
+  CometIO.push :chat, {:name => "system", :message => "bye <#{session}>"}
 end
 
 EM::defer do

data/sample/views/index.haml

@@ -22,6 +22,6 @@
 
       %hr
       %div#footer
-        sinatra-cometio v#{SinatraCometIO::VERSION} -
+        sinatra-cometio v#{Sinatra::CometIO::VERSION} -
         - src_url = 'https://github.com/shokai/sinatra-cometio'
         %a{:href => src_url} #{src_url}

data/sinatra-cometio.gemspec

@@ -4,7 +4,7 @@ require 'sinatra-cometio/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "sinatra-cometio"
-  gem.version       = SinatraCometIO::VERSION
+  gem.version       = Sinatra::CometIO::VERSION
   gem.authors       = ["Sho Hashimoto"]
   gem.email         = ["hashimoto@shokai.org"]
   gem.description   = %q{Node.js like Comet I/O plugin for Sinatra.}

data/test/app/config.ru

@@ -7,4 +7,4 @@ require 'sinatra'
 require 'sinatra/cometio'
 require File.dirname(__FILE__)+'/main'
 
-run Sinatra::Application
+run TestApp

data/test/app/main.rb

@@ -3,25 +3,29 @@ File.open(pid_file, "w+") do |f|
   f.write Process.pid.to_s
 end
 
-get '/' do
-  "sinatra-cometio v#{SinatraCometIO::VERSION}"
-end
+class TestApp < Sinatra::Application
 
-CometIO.on :connect do |session|
-  puts "new client <#{session}>"
-end
+  get '/' do
+    "sinatra-cometio v#{Sinatra::CometIO::VERSION}"
+  end
 
-CometIO.on :disconnect do |session|
-  puts "disconnect client <#{session}>"
-end
+  CometIO.on :connect do |session|
+    puts "new client <#{session}>"
+  end
 
-CometIO.on :broadcast do |data, from|
-  puts from
-  puts "broadcast <#{from}> - #{data.to_json}"
-  push :broadcast, data
-end
+  CometIO.on :disconnect do |session|
+    puts "disconnect client <#{session}>"
+  end
+
+  CometIO.on :broadcast do |data, from|
+    puts from
+    puts "broadcast <#{from}> - #{data.to_json}"
+    push :broadcast, data
+  end
+
+  CometIO.on :message do |data, from|
+    puts "message <#{from}> - #{data.to_json}"
+    push :message, data, :to => data['to']
+  end
 
-CometIO.on :message do |data, from|
-  puts "message <#{from}> - #{data.to_json}"
-  push :message, data, :to => data['to']
 end

data/test/test_cometio.rb

@@ -26,6 +26,7 @@ class TestCometio < MiniTest::Unit::TestCase
       break if res != nil
       sleep 0.1
     end
+    client.close
     assert res != nil, 'server not respond'
     assert res["time"] == post_data[:time]
     assert res["msg"] == post_data[:msg]
@@ -50,6 +51,8 @@ class TestCometio < MiniTest::Unit::TestCase
       end
       client2.on :message do |data|
         res2 = data
+        client2.close
+        client.close
       end
     end
 
@@ -71,6 +74,7 @@ class TestCometio < MiniTest::Unit::TestCase
     res = nil
     client.on :broadcast do |data|
       res = data
+      client.close
     end
 
     res2 = nil
@@ -81,6 +85,7 @@ class TestCometio < MiniTest::Unit::TestCase
       end
       client2.on :broadcast do |data|
         res2 = data
+        client2.close
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-cometio
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -139,8 +139,9 @@ files:
 - lib/js/cometio.js
 - lib/js/event_emitter.js
 - lib/sinatra-cometio.rb
+- lib/sinatra-cometio/application.rb
+- lib/sinatra-cometio/options.rb
 - lib/sinatra-cometio/version.rb
-- lib/sinatra/application.rb
 - lib/sinatra/cometio.rb
 - lib/sinatra/cometio/client.rb
 - sample/.gitignore

data/lib/sinatra/application.rb

@@ -1,67 +0,0 @@
-module Sinatra
-
-  class Application
-
-    helpers do
-      def cometio_js
-        "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}#{env['SCRIPT_NAME']}/cometio/cometio.js"
-      end
-
-      def cometio_url
-        "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}#{env['SCRIPT_NAME']}/cometio/io"
-      end
-    end
-
-    get '/cometio/cometio.js' do
-      content_type 'application/javascript'
-      @js ||= (
-               js = ''
-               Dir.glob(File.expand_path '../js/*.js', File.dirname(__FILE__)).each do |i|
-                 File.open(i) do |f|
-                   js += f.read
-                 end
-               end
-               ERB.new(js).result(binding)
-               )
-    end
-
-    get '/cometio/io' do
-      stream :keep_open do |s|
-        session = params[:session].to_s.empty? ? CometIO.create_session(request.ip) : params[:session]
-        CometIO.sessions[session][:stream] = s
-        CometIO.sessions[session][:last] = Time.now
-        CometIO.emit :connect, session if params[:session].to_s.empty?
-
-        unless CometIO.sessions[session][:queue].empty?
-          begin
-            s.write CometIO.sessions[session][:queue].shift.to_json
-            s.flush
-            s.close
-          rescue
-            s.close
-          end
-        end
-
-        EM::add_timer 10 do
-          begin
-            s.write({:type => :__heartbeat, :data => {:time => Time.now.to_i}}.to_json)
-            s.flush
-            s.close
-          rescue
-            s.close
-          end
-        end
-      end
-    end
-
-    post '/cometio/io' do
-      type = params[:type]
-      data = params[:data]
-      from = params[:session]
-      CometIO.emit type, data, from if type.to_s.size > 0
-      {:session => from, :type => type, :data => data}.to_json
-    end
-    
-  end
-
-end