sinatra-websocketio 0.0.6 → 0.1.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.1.0 2013-03-16
+
+* support modular style application
+
 === 0.0.6 2013-03-10
 
 * add tests

data/README.md

@@ -37,8 +37,10 @@ set :websocketio, :port => 8080
 run Sinatra::Application
 ```
 ```ruby
-WebSocketIO.push :temperature, 35  # to all clients
-WebSocketIO.push :light, {:value => 150}, {:to => session_id} # to specific client
+io = Sinatra::WebSocketIO
+
+io.push :temperature, 35  # to all clients
+io.push :light, {:value => 150}, {:to => session_id} # to specific client
 ```
 
 Client Side
@@ -69,7 +71,7 @@ io.push("chat", {name: "shokai", message: "hello"}); // client -> server
 Server Side
 
 ```ruby
-WebSocketIO.on :chat do |data, session|
+io.on :chat do |data, session|
   puts "#{data['name']} : #{data['message']}  <#{session}>"
 end
 ## => "shokai : hello  <12abcde345f6g7h8ijk>"
@@ -92,11 +94,11 @@ io.on("disconnect", function(){
 Server Side
 
 ```ruby
-WebSocketIO.on :connect do |session|
+io.on :connect do |session|
   puts "new client <#{session}>"
 end
 
-WebSocketIO.on :disconnect do |session|
+io.on :disconnect do |session|
   puts "client disconnected <#{session}>"
 end
 ```
@@ -113,7 +115,7 @@ io.on("error", function(err){
 
 Server Side
 ```ruby
-WebSocketIO.on :error do |e|
+io.on :error do |e|
   STDERR.puts e
 end
 ```
@@ -123,16 +125,16 @@ end
 Server Side
 
 ```ruby
-event_id = WebSocketIO.on :chat do |data, from|
+event_id = io.on :chat do |data, from|
   puts "#{data} - from#{from}"
 end
-WebSocketIO.removeListener event_id
+io.removeListener event_id
 ```
 
 or
 
 ```ruby
-WebSocketIO.removeListener :chat  # remove all "chat" listener
+io.removeListener :chat  # remove all "chat" listener
 ```
 
 

data/lib/sinatra/websocketio.rb

@@ -5,9 +5,14 @@ require 'digest/md5'
 require 'event_emitter'
 require 'sinatra/streaming'
 require File.expand_path '../sinatra-websocketio/version', File.dirname(__FILE__)
+require File.expand_path '../sinatra-websocketio/helpers', File.dirname(__FILE__)
 require File.expand_path '../sinatra-websocketio/options', File.dirname(__FILE__)
 require File.expand_path '../sinatra-websocketio/websocketio', File.dirname(__FILE__)
 require File.expand_path '../sinatra-websocketio/application', File.dirname(__FILE__)
 
-Sinatra.register Sinatra::WebSocketIO
-WebSocketIO.start
+module Sinatra
+  module WebSocketIO
+  end
+  register WebSocketIO
+end
+Sinatra::WebSocketIO.start

data/lib/sinatra-websocketio/application.rb

@@ -1,35 +1,30 @@
+module Sinatra
+  module WebSocketIO
 
-module Sinatra::WebSocketIO
-
-  def websocketio=(options)
-    WebSocketIO.options = options
-  end
-
-  def websocketio
-    WebSocketIO.options
-  end
+    def websocketio=(options)
+      WebSocketIO.options = options
+    end
 
-  helpers do
-    def websocketio_js
-      "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}#{env['SCRIPT_NAME']}/websocketio/websocketio.js"
+    def websocketio
+      WebSocketIO.options
     end
 
-    def websocketio_url
-      "ws://#{env['SERVER_NAME']}:#{WebSocketIO.options[:port]}"
+    def self.registered(app)
+      app.helpers Sinatra::WebSocketIO::Helpers
+
+      app.get '/websocketio/websocketio.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
     end
-  end
 
-  get '/websocketio/websocketio.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
-
 end

data/lib/sinatra-websocketio/helpers.rb

@@ -0,0 +1,15 @@
+module Sinatra
+  module WebSocketIO
+    module Helpers
+
+      def websocketio_js
+        "#{env['rack.url_scheme']}://#{env['HTTP_HOST']}#{env['SCRIPT_NAME']}/websocketio/websocketio.js"
+      end
+
+      def websocketio_url
+        "ws://#{env['SERVER_NAME']}:#{WebSocketIO.options[:port]}"
+      end
+
+    end
+  end
+end

data/lib/sinatra-websocketio/options.rb

@@ -1,35 +1,37 @@
-class WebSocketIO
+module Sinatra
+  module WebSocketIO
 
-  def self.default_options
-    {
-      :port => [8080, lambda{|v| v.kind_of? Fixnum }]
-    }
-  end
+    def self.default_options
+      {
+        :port => [8080, lambda{|v| v.kind_of? Fixnum and v > 0 }]
+      }
+    end
 
-  def self.options
-    @@options ||= (
-                   opts = {}
-                   default_options.each do |k,v|
-                     opts[k] = v[0]
-                   end
-                   opts
-                   )
-  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
+    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
-    default_options.each do |k, v|
-      @@options[k] = v unless @@options.include? k
-    end
-    @@options
-  end
 
+  end
 end

data/lib/sinatra-websocketio/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module WebSocketIO
-    VERSION = "0.0.6"
+    VERSION = "0.1.0"
   end
 end

data/lib/sinatra-websocketio/websocketio.rb

@@ -1,80 +1,83 @@
-class WebSocketIO
+module Sinatra
+  module WebSocketIO
 
-  def self.start
-    EM::defer do
-      while !EM::reactor_running? do
-        sleep 1
-      end
-      puts "WebSocketIO.start port:#{options[:port]}"
-      EM::WebSocket.run :host => "0.0.0.0", :port => options[:port] do |ws|
-        ws.onopen do |handshake|
-          params = parse_handshake_params handshake.path
-          session_id = params[:session] || (create_session Socket.unpack_sockaddr_in ws.get_peername)
+    def self.start
+      EM::defer do
+        while !EM::reactor_running? do
+          sleep 1
+        end
+        puts "Sinatra::WebSocketIO.start port:#{options[:port]}"
+        EM::WebSocket.run :host => "0.0.0.0", :port => options[:port] do |ws|
+          ws.onopen do |handshake|
+            params = parse_handshake_params handshake.path
+            session_id = params[:session] || (create_session Socket.unpack_sockaddr_in ws.get_peername)
 
-          if self.sessions.include? session_id
-            ws.send({:type => :error, :data => "invalid session_id (#{session_id})"}.to_json)
-            ws.close
-          else
-            self.sessions[session_id] = {
-              :websocket => ws
-            }
-            ws.onclose do
-              self.sessions.delete session_id
-              self.emit :disconnect, session_id
-            end
-            ws.onmessage do |msg|
-              begin
-                data = JSON.parse msg
-              rescue => e
-                self.emit :error, e
+            if self.sessions.include? session_id
+              ws.send({:type => :error, :data => "invalid session_id (#{session_id})"}.to_json)
+              ws.close
+            else
+              self.sessions[session_id] = {
+                :websocket => ws
+              }
+              ws.onclose do
+                self.sessions.delete session_id
+                self.emit :disconnect, session_id
               end
-              self.emit data['type'], data['data'], session_id if data
+              ws.onmessage do |msg|
+                begin
+                  data = ::JSON.parse msg
+                rescue => e
+                  self.emit :error, e
+                end
+                self.emit data['type'], data['data'], session_id if data
+              end
+              ws.send({:type => :__session_id, :data => session_id}.to_json)
+              self.emit :connect, session_id
             end
-            ws.send({:type => :__session_id, :data => session_id}.to_json)
-            self.emit :connect, session_id
-          end
 
+          end
         end
       end
     end
-  end
 
-  def self.push(type, data, opt={})
-    session_ids = opt[:to].to_s.empty? ? self.sessions.keys : [opt[:to]]
-    session_ids.each do |id|
-      s = sessions[id]
-      begin
-        s[:websocket].send({:type => type, :data => data}.to_json)
-      rescue
-        next
+    def self.push(type, data, opt={})
+      session_ids = opt[:to].to_s.empty? ? self.sessions.keys : [opt[:to]]
+      session_ids.each do |id|
+        s = sessions[id]
+        begin
+          s[:websocket].send({:type => type, :data => data}.to_json)
+        rescue
+          next
+        end
       end
     end
-  end
 
-  def self.sessions
-    @@sessions ||= Hash.new{|h,session_id|
-      h[session_id] = {
-        :websocket => nil
+    def self.sessions
+      @@sessions ||= Hash.new{|h,session_id|
+        h[session_id] = {
+          :websocket => nil
+        }
       }
-    }
-  end
+    end
 
-  def self.create_session(ip_addr)
-    Digest::MD5.hexdigest "#{Time.now.to_i}_#{Time.now.usec}_#{ip_addr}"
-  end
+    def self.create_session(ip_addr)
+      Digest::MD5.hexdigest "#{Time.now.to_i}_#{Time.now.usec}_#{ip_addr}"
+    end
 
-  def self.parse_handshake_params(path)
-    tmp = path.gsub(/^\//,'').split(/\=+/)
-    params = {}
-    while !tmp.empty?
-      params[tmp.shift.to_sym] = tmp.shift
+    def self.parse_handshake_params(path)
+      tmp = path.gsub(/^\//,'').split(/\=+/)
+      params = {}
+      while !tmp.empty?
+        params[tmp.shift.to_sym] = tmp.shift
+      end
+      params
     end
-    params
-  end
 
+  end
 end
-EventEmitter.apply WebSocketIO
-WebSocketIO.on :__session_id do |data, from|
-  WebSocketIO.push :__session_id, from, :to => from
+
+EventEmitter.apply Sinatra::WebSocketIO
+Sinatra::WebSocketIO.on :__session_id do |data, from|
+  push :__session_id, from, :to => from
 end
 

data/sample/Gemfile.lock

@@ -11,8 +11,8 @@ GEM
       eventmachine
       libwebsocket
     event_emitter (0.2.3)
-    eventmachine (1.0.1)
-    foreman (0.61.0)
+    eventmachine (1.0.3)
+    foreman (0.62.0)
       thor (>= 0.13.6)
     haml (4.0.0)
       tilt
@@ -22,12 +22,12 @@ GEM
       addressable
       websocket
     rack (1.5.2)
-    rack-protection (1.4.0)
+    rack-protection (1.5.0)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    sass (3.2.6)
-    sinatra (1.3.5)
+    sass (3.2.7)
+    sinatra (1.3.6)
       rack (~> 1.4)
       rack-protection (~> 1.3)
       tilt (~> 1.3, >= 1.3.3)
@@ -43,7 +43,7 @@ GEM
       eventmachine (>= 0.12.6)
       rack (>= 1.0.0)
     thor (0.17.0)
-    tilt (1.3.4)
+    tilt (1.3.5)
     websocket (1.0.7)
 
 PLATFORMS

data/sample/config.ru

@@ -1,12 +1,12 @@
 require 'rubygems'
 require 'bundler/setup'
 Bundler.require
+require 'sinatra/base'
 if development?
   $stdout.sync = true
   require 'sinatra/reloader'
   $:.unshift File.expand_path '../lib', File.dirname(__FILE__)
 end
-require 'eventmachine'
 require 'sinatra/websocketio'
 require File.dirname(__FILE__)+'/main'
 
@@ -19,4 +19,4 @@ when /bsd/i then EM.kqueue
 end
 EM.set_descriptor_table_size 10000
 
-run Sinatra::Application
+run ChatApp

data/sample/main.rb

@@ -1,27 +1,32 @@
-WebSocketIO.on :connect do |session|
-  puts "new client <#{session}>"
-  WebSocketIO.push :chat, {:name => "system", :message => "new client <#{session}> / #{WebSocketIO.sessions.size} clients connecting"}
-  WebSocketIO.push :chat, {:name => "system", :message => "welcome <#{session}>"}, {:to => session}
-end
+class ChatApp < Sinatra::Base
+  register Sinatra::WebSocketIO
+  io = Sinatra::WebSocketIO
 
-WebSocketIO.on :disconnect do |session|
-  puts "disconnect client <#{session}>"
-  WebSocketIO.push :chat, {:name => "system", :message => "bye <#{session}>"}
-end
+  io.on :connect do |session|
+    puts "new client <#{session}>"
+    push :chat, {:name => "system", :message => "new client <#{session}> / #{io.sessions.size} clients connecting"}
+    push :chat, {:name => "system", :message => "welcome <#{session}>"}, {:to => session}
+  end
 
-WebSocketIO.on :chat do |data, from|
-  puts "#{data['name']} : #{data['message']}  (from:#{from})"
-  WebSocketIO.push :chat, data
-end
+  io.on :disconnect do |session|
+    puts "disconnect client <#{session}>"
+    push :chat, {:name => "system", :message => "bye <#{session}>"}
+  end
 
-WebSocketIO.on :error do |err|
-  STDERR.puts "error!! #{err}"
-end
+  io.on :chat do |data, from|
+    puts "#{data['name']} : #{data['message']}  (from:#{from})"
+    push :chat, data
+  end
 
-get '/' do
-  haml :index
-end
+  io.on :error do |err|
+    STDERR.puts "error!! #{err}"
+  end
+
+  get '/' do
+    haml :index
+  end
 
-get '/:source.css' do
-  scss params[:source].to_sym
+  get '/:source.css' do
+    scss params[:source].to_sym
+  end
 end

data/sinatra-websocketio.gemspec

@@ -16,10 +16,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   gem.add_dependency 'rack'
-  gem.add_dependency 'sinatra', '>= 1.3.3'
-  gem.add_dependency 'eventmachine', '>= 1.0.0'
-  gem.add_dependency 'sinatra-contrib', '>= 1.3.2'
-  gem.add_dependency 'json', '>= 1.7.0'
+  gem.add_dependency 'sinatra'
+  gem.add_dependency 'eventmachine'
+  gem.add_dependency 'sinatra-contrib'
+  gem.add_dependency 'json'
   gem.add_dependency 'event_emitter', '>= 0.2.0'
   gem.add_dependency 'em-websocket'
   gem.add_dependency 'em-websocket-client'

data/test/app/config.ru

@@ -1,9 +1,8 @@
 require 'rubygems'
-require 'bundler'
-Bundler.require
+require 'sinatra'
+require 'sinatra/base'
 $stdout.sync = true
 $:.unshift File.expand_path '../../lib', File.dirname(__FILE__)
-require 'sinatra'
 require 'sinatra/websocketio'
 require File.dirname(__FILE__)+'/main'
 

data/test/app/main.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-websocketio
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-10 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra-contrib
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: event_emitter
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +158,7 @@ files:
 - lib/js/websocketio.js
 - lib/sinatra-websocketio.rb
 - lib/sinatra-websocketio/application.rb
+- lib/sinatra-websocketio/helpers.rb
 - lib/sinatra-websocketio/options.rb
 - lib/sinatra-websocketio/version.rb
 - lib/sinatra-websocketio/websocketio.rb